@depup/stripe 21.0.0-depup.0

package/types/ShippingRates.d.ts

@@ -0,0 +1,155 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Shipping rates describe the price of shipping presented to your customers and
+     * applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).
+     */
+    interface ShippingRate {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'shipping_rate';
+
+      /**
+       * Whether the shipping rate can be used for new purchases. Defaults to `true`.
+       */
+      active: boolean;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      delivery_estimate: ShippingRate.DeliveryEstimate | null;
+
+      /**
+       * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      display_name: string | null;
+
+      fixed_amount?: ShippingRate.FixedAmount;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      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;
+
+      /**
+       * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+       */
+      tax_behavior: ShippingRate.TaxBehavior | null;
+
+      /**
+       * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+       */
+      tax_code: string | Stripe.TaxCode | null;
+
+      /**
+       * The type of calculation to use on the shipping rate.
+       */
+      type: 'fixed_amount';
+    }
+
+    namespace ShippingRate {
+      interface DeliveryEstimate {
+        /**
+         * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+         */
+        maximum: DeliveryEstimate.Maximum | null;
+
+        /**
+         * The lower bound of the estimated range. If empty, represents no lower bound.
+         */
+        minimum: DeliveryEstimate.Minimum | null;
+      }
+
+      namespace DeliveryEstimate {
+        interface Maximum {
+          /**
+           * A unit of time.
+           */
+          unit: Maximum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Maximum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+
+        interface Minimum {
+          /**
+           * A unit of time.
+           */
+          unit: Minimum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Minimum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+      }
+
+      interface FixedAmount {
+        /**
+         * A non-negative integer in cents representing how much to charge.
+         */
+        amount: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency_options?: {
+          [key: string]: FixedAmount.CurrencyOptions;
+        };
+      }
+
+      namespace FixedAmount {
+        interface CurrencyOptions {
+          /**
+           * A non-negative integer in cents representing how much to charge.
+           */
+          amount: number;
+
+          /**
+           * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+           */
+          tax_behavior: CurrencyOptions.TaxBehavior;
+        }
+
+        namespace CurrencyOptions {
+          type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+        }
+      }
+
+      type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    }
+  }
+}

package/types/ShippingRatesResource.d.ts

@@ -0,0 +1,262 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ShippingRateCreateParams {
+      /**
+       * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      display_name: string;
+
+      /**
+       * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      delivery_estimate?: ShippingRateCreateParams.DeliveryEstimate;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
+       */
+      fixed_amount?: ShippingRateCreateParams.FixedAmount;
+
+      /**
+       * 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;
+
+      /**
+       * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+       */
+      tax_behavior?: ShippingRateCreateParams.TaxBehavior;
+
+      /**
+       * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+       */
+      tax_code?: string;
+
+      /**
+       * The type of calculation to use on the shipping rate.
+       */
+      type?: 'fixed_amount';
+    }
+
+    namespace ShippingRateCreateParams {
+      interface DeliveryEstimate {
+        /**
+         * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+         */
+        maximum?: DeliveryEstimate.Maximum;
+
+        /**
+         * The lower bound of the estimated range. If empty, represents no lower bound.
+         */
+        minimum?: DeliveryEstimate.Minimum;
+      }
+
+      namespace DeliveryEstimate {
+        interface Maximum {
+          /**
+           * A unit of time.
+           */
+          unit: Maximum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Maximum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+
+        interface Minimum {
+          /**
+           * A unit of time.
+           */
+          unit: Minimum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Minimum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+      }
+
+      interface FixedAmount {
+        /**
+         * A non-negative integer in cents representing how much to charge.
+         */
+        amount: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency_options?: {
+          [key: string]: FixedAmount.CurrencyOptions;
+        };
+      }
+
+      namespace FixedAmount {
+        interface CurrencyOptions {
+          /**
+           * A non-negative integer in cents representing how much to charge.
+           */
+          amount: number;
+
+          /**
+           * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+           */
+          tax_behavior?: CurrencyOptions.TaxBehavior;
+        }
+
+        namespace CurrencyOptions {
+          type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+        }
+      }
+
+      type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    }
+
+    interface ShippingRateRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ShippingRateUpdateParams {
+      /**
+       * Whether the shipping rate can be used for new purchases. Defaults to `true`.
+       */
+      active?: boolean;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
+       */
+      fixed_amount?: ShippingRateUpdateParams.FixedAmount;
+
+      /**
+       * 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.Emptyable<Stripe.MetadataParam>;
+
+      /**
+       * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+       */
+      tax_behavior?: ShippingRateUpdateParams.TaxBehavior;
+    }
+
+    namespace ShippingRateUpdateParams {
+      interface FixedAmount {
+        /**
+         * Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency_options?: {
+          [key: string]: FixedAmount.CurrencyOptions;
+        };
+      }
+
+      namespace FixedAmount {
+        interface CurrencyOptions {
+          /**
+           * A non-negative integer in cents representing how much to charge.
+           */
+          amount?: number;
+
+          /**
+           * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+           */
+          tax_behavior?: CurrencyOptions.TaxBehavior;
+        }
+
+        namespace CurrencyOptions {
+          type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+        }
+      }
+
+      type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    }
+
+    interface ShippingRateListParams extends PaginationParams {
+      /**
+       * Only return shipping rates that are active or inactive.
+       */
+      active?: boolean;
+
+      /**
+       * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Only return shipping rates for the given currency.
+       */
+      currency?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class ShippingRatesResource {
+      /**
+       * Creates a new shipping rate object.
+       */
+      create(
+        params: ShippingRateCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+
+      /**
+       * Returns the shipping rate object with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: ShippingRateRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+
+      /**
+       * Updates an existing shipping rate object.
+       */
+      update(
+        id: string,
+        params?: ShippingRateUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+
+      /**
+       * Returns a list of your shipping rates.
+       */
+      list(
+        params?: ShippingRateListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.ShippingRate>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.ShippingRate>;
+    }
+  }
+}

package/types/Sigma/ScheduledQueryRuns.d.ts

@@ -0,0 +1,76 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Sigma {
+      /**
+       * If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll
+       * receive a `sigma.scheduled_query_run.created` webhook each time the query
+       * runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
+       * retrieve the query results.
+       */
+      interface ScheduledQueryRun {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'scheduled_query_run';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * When the query was run, Sigma contained a snapshot of your Stripe data at this time.
+         */
+        data_load_time: number;
+
+        error?: ScheduledQueryRun.Error;
+
+        /**
+         * The file object representing the results of the query.
+         */
+        file: Stripe.File | null;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * Time at which the result expires and is no longer available for download.
+         */
+        result_available_until: number;
+
+        /**
+         * SQL for the query.
+         */
+        sql: string;
+
+        /**
+         * The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
+         */
+        status: string;
+
+        /**
+         * Title of the query.
+         */
+        title: string;
+      }
+
+      namespace ScheduledQueryRun {
+        interface Error {
+          /**
+           * Information about the run failure.
+           */
+          message: string;
+        }
+      }
+    }
+  }
+}

package/types/Sigma/ScheduledQueryRunsResource.d.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Sigma {
+      interface ScheduledQueryRunRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ScheduledQueryRunListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class ScheduledQueryRunsResource {
+        /**
+         * Retrieves the details of an scheduled query run.
+         */
+        retrieve(
+          id: string,
+          params?: ScheduledQueryRunRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Sigma.ScheduledQueryRun>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Sigma.ScheduledQueryRun>>;
+
+        /**
+         * Returns a list of scheduled query runs.
+         */
+        list(
+          params?: ScheduledQueryRunListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Sigma.ScheduledQueryRun>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Sigma.ScheduledQueryRun>;
+      }
+    }
+  }
+}

package/types/SourceMandateNotifications.d.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Source mandate notifications should be created when a notification related to
+     * a source mandate must be sent to the payer. They will trigger a webhook or
+     * deliver an email to the customer.
+     */
+    interface SourceMandateNotification {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'source_mandate_notification';
+
+      acss_debit?: SourceMandateNotification.AcssDebit;
+
+      /**
+       * A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.
+       */
+      amount: number | null;
+
+      bacs_debit?: SourceMandateNotification.BacsDebit;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.
+       */
+      reason: string;
+
+      sepa_debit?: SourceMandateNotification.SepaDebit;
+
+      /**
+       * `Source` objects allow you to accept a variety of payment methods. They
+       * represent a customer's payment instrument, and can be used with the Stripe API
+       * just like a `Card` object: once chargeable, they can be charged, or can be
+       * attached to customers.
+       *
+       * Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
+       * We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
+       * This newer API provides access to our latest features and payment method types.
+       *
+       * Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
+       */
+      source: Stripe.Source;
+
+      /**
+       * The status of the mandate notification. Valid statuses are `pending` or `submitted`.
+       */
+      status: string;
+
+      /**
+       * The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.
+       */
+      type: string;
+    }
+
+    namespace SourceMandateNotification {
+      interface AcssDebit {
+        /**
+         * The statement descriptor associate with the debit.
+         */
+        statement_descriptor?: string;
+      }
+
+      interface BacsDebit {
+        /**
+         * Last 4 digits of the account number associated with the debit.
+         */
+        last4?: string;
+      }
+
+      interface SepaDebit {
+        /**
+         * SEPA creditor ID.
+         */
+        creditor_identifier?: string;
+
+        /**
+         * Last 4 digits of the account number associated with the debit.
+         */
+        last4?: string;
+
+        /**
+         * Mandate reference associated with the debit.
+         */
+        mandate_reference?: string;
+      }
+    }
+  }
+}