1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._stripe_object import StripeObject
from typing import ClassVar, List, Optional
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.climate._supplier_list_params import SupplierListParams
from stripe.params.climate._supplier_retrieve_params import (
SupplierRetrieveParams,
)
class Supplier(ListableAPIResource["Supplier"]):
"""
A supplier of carbon removal.
"""
OBJECT_NAME: ClassVar[Literal["climate.supplier"]] = "climate.supplier"
class Location(StripeObject):
city: Optional[str]
"""
The city where the supplier is located.
"""
country: str
"""
Two-letter ISO code representing the country where the supplier is located.
"""
latitude: Optional[float]
"""
The geographic latitude where the supplier is located.
"""
longitude: Optional[float]
"""
The geographic longitude where the supplier is located.
"""
region: Optional[str]
"""
The state/county/province/region where the supplier is located.
"""
id: str
"""
Unique identifier for the object.
"""
info_url: str
"""
Link to a webpage to learn more about the supplier.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
locations: List[Location]
"""
The locations in which this supplier operates.
"""
name: str
"""
Name of this carbon removal supplier.
"""
object: Literal["climate.supplier"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
removal_pathway: Literal[
"biomass_carbon_removal_and_storage",
"direct_air_capture",
"enhanced_weathering",
]
"""
The scientific pathway used for carbon removal.
"""
@classmethod
def list(
cls, **params: Unpack["SupplierListParams"]
) -> ListObject["Supplier"]:
"""
Lists all available Climate supplier objects.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["SupplierListParams"]
) -> ListObject["Supplier"]:
"""
Lists all available Climate supplier objects.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def retrieve(
cls, id: str, **params: Unpack["SupplierRetrieveParams"]
) -> "Supplier":
"""
Retrieves a Climate supplier object.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["SupplierRetrieveParams"]
) -> "Supplier":
"""
Retrieves a Climate supplier object.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {"locations": Location}
|
