This commit is contained in:
Iliyan Angelov
2025-11-17 18:26:30 +02:00
parent 48353cde9c
commit 0c59fe1173
2535 changed files with 278997 additions and 2480 deletions

View File

@@ -0,0 +1,41 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe.climate._order import Order as Order
from stripe.climate._order_service import OrderService as OrderService
from stripe.climate._product import Product as Product
from stripe.climate._product_service import (
ProductService as ProductService,
)
from stripe.climate._supplier import Supplier as Supplier
from stripe.climate._supplier_service import (
SupplierService as SupplierService,
)
# name -> (import_target, is_submodule)
_import_map = {
"Order": ("stripe.climate._order", False),
"OrderService": ("stripe.climate._order_service", False),
"Product": ("stripe.climate._product", False),
"ProductService": ("stripe.climate._product_service", False),
"Supplier": ("stripe.climate._supplier", False),
"SupplierService": ("stripe.climate._supplier_service", False),
}
if not TYPE_CHECKING:
def __getattr__(name):
try:
target, is_submodule = _import_map[name]
module = import_module(target)
if is_submodule:
return module
return getattr(
module,
name,
)
except KeyError:
raise AttributeError()

View File

@@ -0,0 +1,437 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import class_method_variant, sanitize_id
from typing import ClassVar, Dict, List, Optional, cast, overload
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.climate._product import Product
from stripe.climate._supplier import Supplier
from stripe.params.climate._order_cancel_params import OrderCancelParams
from stripe.params.climate._order_create_params import OrderCreateParams
from stripe.params.climate._order_list_params import OrderListParams
from stripe.params.climate._order_modify_params import OrderModifyParams
from stripe.params.climate._order_retrieve_params import (
OrderRetrieveParams,
)
class Order(
CreateableAPIResource["Order"],
ListableAPIResource["Order"],
UpdateableAPIResource["Order"],
):
"""
Orders represent your intent to purchase a particular Climate product. When you create an order, the
payment is deducted from your merchant balance.
"""
OBJECT_NAME: ClassVar[Literal["climate.order"]] = "climate.order"
class Beneficiary(StripeObject):
public_name: str
"""
Publicly displayable name for the end beneficiary of carbon removal.
"""
class DeliveryDetail(StripeObject):
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.
"""
delivered_at: int
"""
Time at which the delivery occurred. Measured in seconds since the Unix epoch.
"""
location: Optional[Location]
"""
Specific location of this delivery.
"""
metric_tons: str
"""
Quantity of carbon removal supplied by this delivery.
"""
registry_url: Optional[str]
"""
Once retired, a URL to the registry entry for the tons from this delivery.
"""
supplier: "Supplier"
"""
A supplier of carbon removal.
"""
_inner_class_types = {"location": Location}
amount_fees: int
"""
Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.
"""
amount_subtotal: int
"""
Total amount of the carbon removal in the currency's smallest unit.
"""
amount_total: int
"""
Total amount of the order including fees in the currency's smallest unit.
"""
beneficiary: Optional[Beneficiary]
canceled_at: Optional[int]
"""
Time at which the order was canceled. Measured in seconds since the Unix epoch.
"""
cancellation_reason: Optional[
Literal["expired", "product_unavailable", "requested"]
]
"""
Reason for the cancellation of this order.
"""
certificate: Optional[str]
"""
For delivered orders, a URL to a delivery certificate for the order.
"""
confirmed_at: Optional[int]
"""
Time at which the order was confirmed. Measured in seconds since the Unix epoch.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
currency: str
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.
"""
delayed_at: Optional[int]
"""
Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.
"""
delivered_at: Optional[int]
"""
Time at which the order was delivered. Measured in seconds since the Unix epoch.
"""
delivery_details: List[DeliveryDetail]
"""
Details about the delivery of carbon removal for this order.
"""
expected_delivery_year: int
"""
The year this order is expected to be delivered.
"""
id: str
"""
Unique identifier for the object.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
metadata: Dict[str, str]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
"""
metric_tons: str
"""
Quantity of carbon removal that is included in this order.
"""
object: Literal["climate.order"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
product: ExpandableField["Product"]
"""
Unique ID for the Climate `Product` this order is purchasing.
"""
product_substituted_at: Optional[int]
"""
Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.
"""
status: Literal[
"awaiting_funds", "canceled", "confirmed", "delivered", "open"
]
"""
The current status of this order.
"""
@classmethod
def _cls_cancel(
cls, order: str, **params: Unpack["OrderCancelParams"]
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
cls._static_request(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(order)
),
params=params,
),
)
@overload
@staticmethod
def cancel(order: str, **params: Unpack["OrderCancelParams"]) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
...
@overload
def cancel(self, **params: Unpack["OrderCancelParams"]) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
...
@class_method_variant("_cls_cancel")
def cancel( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["OrderCancelParams"]
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
async def _cls_cancel_async(
cls, order: str, **params: Unpack["OrderCancelParams"]
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
await cls._static_request_async(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(order)
),
params=params,
),
)
@overload
@staticmethod
async def cancel_async(
order: str, **params: Unpack["OrderCancelParams"]
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
...
@overload
async def cancel_async(
self, **params: Unpack["OrderCancelParams"]
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
...
@class_method_variant("_cls_cancel_async")
async def cancel_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["OrderCancelParams"]
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
def create(cls, **params: Unpack["OrderCreateParams"]) -> "Order":
"""
Creates a Climate order object for a given Climate product. The order will be processed immediately
after creation and payment will be deducted your Stripe balance.
"""
return cast(
"Order",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["OrderCreateParams"]
) -> "Order":
"""
Creates a Climate order object for a given Climate product. The order will be processed immediately
after creation and payment will be deducted your Stripe balance.
"""
return cast(
"Order",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(cls, **params: Unpack["OrderListParams"]) -> ListObject["Order"]:
"""
Lists all Climate order objects. The orders are returned sorted by creation date, with the
most recently created orders appearing first.
"""
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["OrderListParams"]
) -> ListObject["Order"]:
"""
Lists all Climate order objects. The orders are returned sorted by creation date, with the
most recently created orders appearing first.
"""
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 modify(cls, id: str, **params: Unpack["OrderModifyParams"]) -> "Order":
"""
Updates the specified order by setting the values of the parameters passed.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Order",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["OrderModifyParams"]
) -> "Order":
"""
Updates the specified order by setting the values of the parameters passed.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Order",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["OrderRetrieveParams"]
) -> "Order":
"""
Retrieves the details of a Climate order object with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["OrderRetrieveParams"]
) -> "Order":
"""
Retrieves the details of a Climate order object with the given ID.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {
"beneficiary": Beneficiary,
"delivery_details": DeliveryDetail,
}

View File

@@ -0,0 +1,230 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.climate._order import Order
from stripe.params.climate._order_cancel_params import OrderCancelParams
from stripe.params.climate._order_create_params import OrderCreateParams
from stripe.params.climate._order_list_params import OrderListParams
from stripe.params.climate._order_retrieve_params import (
OrderRetrieveParams,
)
from stripe.params.climate._order_update_params import OrderUpdateParams
class OrderService(StripeService):
def list(
self,
params: Optional["OrderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Order]":
"""
Lists all Climate order objects. The orders are returned sorted by creation date, with the
most recently created orders appearing first.
"""
return cast(
"ListObject[Order]",
self._request(
"get",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["OrderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Order]":
"""
Lists all Climate order objects. The orders are returned sorted by creation date, with the
most recently created orders appearing first.
"""
return cast(
"ListObject[Order]",
await self._request_async(
"get",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "OrderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Creates a Climate order object for a given Climate product. The order will be processed immediately
after creation and payment will be deducted your Stripe balance.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "OrderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Creates a Climate order object for a given Climate product. The order will be processed immediately
after creation and payment will be deducted your Stripe balance.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
order: str,
params: Optional["OrderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Retrieves the details of a Climate order object with the given ID.
"""
return cast(
"Order",
self._request(
"get",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
order: str,
params: Optional["OrderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Retrieves the details of a Climate order object with the given ID.
"""
return cast(
"Order",
await self._request_async(
"get",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
order: str,
params: Optional["OrderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Updates the specified order by setting the values of the parameters passed.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
order: str,
params: Optional["OrderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Updates the specified order by setting the values of the parameters passed.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
order: str,
params: Optional["OrderCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(order),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
order: str,
params: Optional["OrderCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(order),
),
base_address="api",
params=params,
options=options,
),
)

View File

@@ -0,0 +1,142 @@
# -*- 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, Dict, List, Optional
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.climate._supplier import Supplier
from stripe.params.climate._product_list_params import ProductListParams
from stripe.params.climate._product_retrieve_params import (
ProductRetrieveParams,
)
class Product(ListableAPIResource["Product"]):
"""
A Climate product represents a type of carbon removal unit available for reservation.
You can retrieve it to see the current price and availability.
"""
OBJECT_NAME: ClassVar[Literal["climate.product"]] = "climate.product"
class CurrentPricesPerMetricTon(StripeObject):
amount_fees: int
"""
Fees for one metric ton of carbon removal in the currency's smallest unit.
"""
amount_subtotal: int
"""
Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.
"""
amount_total: int
"""
Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
current_prices_per_metric_ton: Dict[str, CurrentPricesPerMetricTon]
"""
Current prices for a metric ton of carbon removal in a currency's smallest unit.
"""
delivery_year: Optional[int]
"""
The year in which the carbon removal is expected to be delivered.
"""
id: str
"""
Unique identifier for the object. For convenience, Climate product IDs are human-readable strings
that start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)
for a list of available carbon removal products.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
metric_tons_available: str
"""
The quantity of metric tons available for reservation.
"""
name: str
"""
The Climate product's name.
"""
object: Literal["climate.product"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
suppliers: List["Supplier"]
"""
The carbon removal suppliers that fulfill orders for this Climate product.
"""
@classmethod
def list(
cls, **params: Unpack["ProductListParams"]
) -> ListObject["Product"]:
"""
Lists all available Climate product 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["ProductListParams"]
) -> ListObject["Product"]:
"""
Lists all available Climate product 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["ProductRetrieveParams"]
) -> "Product":
"""
Retrieves the details of a Climate product with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["ProductRetrieveParams"]
) -> "Product":
"""
Retrieves the details of a Climate product with the given ID.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {
"current_prices_per_metric_ton": CurrentPricesPerMetricTon,
}

View File

@@ -0,0 +1,99 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.climate._product import Product
from stripe.params.climate._product_list_params import ProductListParams
from stripe.params.climate._product_retrieve_params import (
ProductRetrieveParams,
)
class ProductService(StripeService):
def list(
self,
params: Optional["ProductListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Product]":
"""
Lists all available Climate product objects.
"""
return cast(
"ListObject[Product]",
self._request(
"get",
"/v1/climate/products",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["ProductListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Product]":
"""
Lists all available Climate product objects.
"""
return cast(
"ListObject[Product]",
await self._request_async(
"get",
"/v1/climate/products",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
product: str,
params: Optional["ProductRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Retrieves the details of a Climate product with the given ID.
"""
return cast(
"Product",
self._request(
"get",
"/v1/climate/products/{product}".format(
product=sanitize_id(product),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
product: str,
params: Optional["ProductRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Retrieves the details of a Climate product with the given ID.
"""
return cast(
"Product",
await self._request_async(
"get",
"/v1/climate/products/{product}".format(
product=sanitize_id(product),
),
base_address="api",
params=params,
options=options,
),
)

View File

@@ -0,0 +1,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}

View File

@@ -0,0 +1,99 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.climate._supplier import Supplier
from stripe.params.climate._supplier_list_params import SupplierListParams
from stripe.params.climate._supplier_retrieve_params import (
SupplierRetrieveParams,
)
class SupplierService(StripeService):
def list(
self,
params: Optional["SupplierListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Supplier]":
"""
Lists all available Climate supplier objects.
"""
return cast(
"ListObject[Supplier]",
self._request(
"get",
"/v1/climate/suppliers",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["SupplierListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Supplier]":
"""
Lists all available Climate supplier objects.
"""
return cast(
"ListObject[Supplier]",
await self._request_async(
"get",
"/v1/climate/suppliers",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
supplier: str,
params: Optional["SupplierRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Supplier":
"""
Retrieves a Climate supplier object.
"""
return cast(
"Supplier",
self._request(
"get",
"/v1/climate/suppliers/{supplier}".format(
supplier=sanitize_id(supplier),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
supplier: str,
params: Optional["SupplierRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Supplier":
"""
Retrieves a Climate supplier object.
"""
return cast(
"Supplier",
await self._request_async(
"get",
"/v1/climate/suppliers/{supplier}".format(
supplier=sanitize_id(supplier),
),
base_address="api",
params=params,
options=options,
),
)