@depup/stripe 21.0.0-depup.0

package/types/Climate/Orders.d.ts

@@ -0,0 +1,197 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Climate {
+      /**
+       * Orders represent your intent to purchase a particular Climate product. When you create an order, the
+       * payment is deducted from your merchant balance.
+       */
+      interface Order {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'climate.order';
+
+        /**
+         * Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.
+         */
+        amount_fees: number;
+
+        /**
+         * Total amount of the carbon removal in the currency's smallest unit.
+         */
+        amount_subtotal: number;
+
+        /**
+         * Total amount of the order including fees in the currency's smallest unit.
+         */
+        amount_total: number;
+
+        beneficiary?: Order.Beneficiary;
+
+        /**
+         * Time at which the order was canceled. Measured in seconds since the Unix epoch.
+         */
+        canceled_at: number | null;
+
+        /**
+         * Reason for the cancellation of this order.
+         */
+        cancellation_reason: Order.CancellationReason | null;
+
+        /**
+         * For delivered orders, a URL to a delivery certificate for the order.
+         */
+        certificate: string | null;
+
+        /**
+         * Time at which the order was confirmed. Measured in seconds since the Unix epoch.
+         */
+        confirmed_at: number | null;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.
+         */
+        currency: string;
+
+        /**
+         * Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.
+         */
+        delayed_at: number | null;
+
+        /**
+         * Time at which the order was delivered. Measured in seconds since the Unix epoch.
+         */
+        delivered_at: number | null;
+
+        /**
+         * Details about the delivery of carbon removal for this order.
+         */
+        delivery_details: Array<Order.DeliveryDetail>;
+
+        /**
+         * The year this order is expected to be delivered.
+         */
+        expected_delivery_year: number;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+         */
+        metadata: Stripe.Metadata;
+
+        /**
+         * Quantity of carbon removal that is included in this order.
+         */
+        metric_tons: Decimal;
+
+        /**
+         * Unique ID for the Climate `Product` this order is purchasing.
+         */
+        product: string | Stripe.Climate.Product;
+
+        /**
+         * Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.
+         */
+        product_substituted_at: number | null;
+
+        /**
+         * The current status of this order.
+         */
+        status: Order.Status;
+      }
+
+      namespace Order {
+        interface Beneficiary {
+          /**
+           * Publicly displayable name for the end beneficiary of carbon removal.
+           */
+          public_name: string;
+        }
+
+        type CancellationReason =
+          | 'expired'
+          | 'product_unavailable'
+          | 'requested';
+
+        interface DeliveryDetail {
+          /**
+           * Time at which the delivery occurred. Measured in seconds since the Unix epoch.
+           */
+          delivered_at: number;
+
+          /**
+           * Specific location of this delivery.
+           */
+          location: DeliveryDetail.Location | null;
+
+          /**
+           * Quantity of carbon removal supplied by this delivery.
+           */
+          metric_tons: string;
+
+          /**
+           * Once retired, a URL to the registry entry for the tons from this delivery.
+           */
+          registry_url: string | null;
+
+          /**
+           * A supplier of carbon removal.
+           */
+          supplier: Stripe.Climate.Supplier;
+        }
+
+        namespace DeliveryDetail {
+          interface Location {
+            /**
+             * The city where the supplier is located.
+             */
+            city: string | null;
+
+            /**
+             * Two-letter ISO code representing the country where the supplier is located.
+             */
+            country: string;
+
+            /**
+             * The geographic latitude where the supplier is located.
+             */
+            latitude: number | null;
+
+            /**
+             * The geographic longitude where the supplier is located.
+             */
+            longitude: number | null;
+
+            /**
+             * The state/county/province/region where the supplier is located.
+             */
+            region: string | null;
+          }
+        }
+
+        type Status =
+          | 'awaiting_funds'
+          | 'canceled'
+          | 'confirmed'
+          | 'delivered'
+          | 'open';
+      }
+    }
+  }
+}

package/types/Climate/OrdersResource.d.ts

@@ -0,0 +1,159 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Climate {
+      interface OrderCreateParams {
+        /**
+         * Unique identifier of the Climate product.
+         */
+        product: string;
+
+        /**
+         * Requested amount of carbon removal units. Either this or `metric_tons` must be specified.
+         */
+        amount?: number;
+
+        /**
+         * Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
+         */
+        beneficiary?: OrderCreateParams.Beneficiary;
+
+        /**
+         * Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.
+         */
+        currency?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * Requested number of tons for the order. Either this or `amount` must be specified.
+         */
+        metric_tons?: Decimal;
+      }
+
+      namespace OrderCreateParams {
+        interface Beneficiary {
+          /**
+           * Publicly displayable name for the end beneficiary of carbon removal.
+           */
+          public_name: string;
+        }
+      }
+
+      interface OrderRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface OrderUpdateParams {
+        /**
+         * Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
+         */
+        beneficiary?: Stripe.Emptyable<OrderUpdateParams.Beneficiary>;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+      }
+
+      namespace OrderUpdateParams {
+        interface Beneficiary {
+          /**
+           * Publicly displayable name for the end beneficiary of carbon removal.
+           */
+          public_name: Stripe.Emptyable<string>;
+        }
+      }
+
+      interface OrderListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface OrderCancelParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class OrdersResource {
+        /**
+         * 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.
+         */
+        create(
+          params: OrderCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Order>>;
+
+        /**
+         * Retrieves the details of a Climate order object with the given ID.
+         */
+        retrieve(
+          id: string,
+          params?: OrderRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Order>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Order>>;
+
+        /**
+         * Updates the specified order by setting the values of the parameters passed.
+         */
+        update(
+          id: string,
+          params?: OrderUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Order>>;
+
+        /**
+         * Lists all Climate order objects. The orders are returned sorted by creation date, with the
+         * most recently created orders appearing first.
+         */
+        list(
+          params?: OrderListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Climate.Order>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Climate.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.
+         */
+        cancel(
+          id: string,
+          params?: OrderCancelParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Order>>;
+        cancel(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Order>>;
+      }
+    }
+  }
+}

package/types/Climate/Products.d.ts

@@ -0,0 +1,81 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Climate {
+      /**
+       * A Climate product represents a type of carbon removal unit available for reservation.
+       * You can retrieve it to see the current price and availability.
+       */
+      interface Product {
+        /**
+         * 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.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'climate.product';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Current prices for a metric ton of carbon removal in a currency's smallest unit.
+         */
+        current_prices_per_metric_ton: {
+          [key: string]: Product.CurrentPricesPerMetricTon;
+        };
+
+        /**
+         * The year in which the carbon removal is expected to be delivered.
+         */
+        delivery_year: number | null;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * The quantity of metric tons available for reservation.
+         */
+        metric_tons_available: Decimal;
+
+        /**
+         * The Climate product's name.
+         */
+        name: string;
+
+        /**
+         * The carbon removal suppliers that fulfill orders for this Climate product.
+         */
+        suppliers: Array<Stripe.Climate.Supplier>;
+      }
+
+      namespace Product {
+        interface CurrentPricesPerMetricTon {
+          /**
+           * Fees for one metric ton of carbon removal in the currency's smallest unit.
+           */
+          amount_fees: number;
+
+          /**
+           * Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.
+           */
+          amount_subtotal: number;
+
+          /**
+           * Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.
+           */
+          amount_total: number;
+        }
+      }
+    }
+  }
+}

package/types/Climate/ProductsResource.d.ts

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Climate {
+      interface ProductRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ProductListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class ProductsResource {
+        /**
+         * Retrieves the details of a Climate product with the given ID.
+         */
+        retrieve(
+          id: string,
+          params?: ProductRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Product>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Product>>;
+
+        /**
+         * Lists all available Climate product objects.
+         */
+        list(
+          params?: ProductListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Climate.Product>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Climate.Product>;
+      }
+    }
+  }
+}

package/types/Climate/Suppliers.d.ts

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Climate {
+      /**
+       * A supplier of carbon removal.
+       */
+      interface Supplier {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'climate.supplier';
+
+        /**
+         * Link to a webpage to learn more about the supplier.
+         */
+        info_url: string;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * The locations in which this supplier operates.
+         */
+        locations: Array<Supplier.Location>;
+
+        /**
+         * Name of this carbon removal supplier.
+         */
+        name: string;
+
+        /**
+         * The scientific pathway used for carbon removal.
+         */
+        removal_pathway: Supplier.RemovalPathway;
+      }
+
+      namespace Supplier {
+        interface Location {
+          /**
+           * The city where the supplier is located.
+           */
+          city: string | null;
+
+          /**
+           * Two-letter ISO code representing the country where the supplier is located.
+           */
+          country: string;
+
+          /**
+           * The geographic latitude where the supplier is located.
+           */
+          latitude: number | null;
+
+          /**
+           * The geographic longitude where the supplier is located.
+           */
+          longitude: number | null;
+
+          /**
+           * The state/county/province/region where the supplier is located.
+           */
+          region: string | null;
+        }
+
+        type RemovalPathway =
+          | 'biomass_carbon_removal_and_storage'
+          | 'direct_air_capture'
+          | 'enhanced_weathering'
+          | 'marine_carbon_removal';
+      }
+    }
+  }
+}

package/types/Climate/SuppliersResource.d.ts

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Climate {
+      interface SupplierRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface SupplierListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class SuppliersResource {
+        /**
+         * Retrieves a Climate supplier object.
+         */
+        retrieve(
+          id: string,
+          params?: SupplierRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Supplier>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Climate.Supplier>>;
+
+        /**
+         * Lists all available Climate supplier objects.
+         */
+        list(
+          params?: SupplierListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Climate.Supplier>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Climate.Supplier>;
+      }
+    }
+  }
+}