@depup/stripe 21.0.0-depup.0

package/types/ConfirmationTokensResource.d.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ConfirmationTokenRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class ConfirmationTokensResource {
+      /**
+       * Retrieves an existing ConfirmationToken object
+       */
+      retrieve(
+        id: string,
+        params?: ConfirmationTokenRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ConfirmationToken>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ConfirmationToken>>;
+    }
+  }
+}

package/types/ConnectCollectionTransfers.d.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The ConnectCollectionTransfer object.
+     */
+    interface ConnectCollectionTransfer {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'connect_collection_transfer';
+
+      /**
+       * Amount transferred, in cents (or local equivalent).
+       */
+      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;
+
+      /**
+       * ID of the account that funds are being collected for.
+       */
+      destination: string | Stripe.Account;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+    }
+  }
+}

package/types/CountrySpecs.d.ts

@@ -0,0 +1,88 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Stripe needs to collect certain pieces of information about each account
+     * created. These requirements can differ depending on the account's country. The
+     * Country Specs API makes these rules available to your integration.
+     *
+     * You can also view the information from this API call as [an online
+     * guide](https://docs.stripe.com/docs/connect/required-verification-information).
+     */
+    interface CountrySpec {
+      /**
+       * Unique identifier for the object. Represented as the ISO country code for this country.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'country_spec';
+
+      /**
+       * The default currency for this country. This applies to both payment methods and bank accounts.
+       */
+      default_currency: string;
+
+      /**
+       * Currencies that can be accepted in the specific country (for transfers).
+       */
+      supported_bank_account_currencies: {
+        [key: string]: Array<string>;
+      };
+
+      /**
+       * Currencies that can be accepted in the specified country (for payments).
+       */
+      supported_payment_currencies: Array<string>;
+
+      /**
+       * Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).
+       */
+      supported_payment_methods: Array<string>;
+
+      /**
+       * Countries that can accept transfers from the specified country.
+       */
+      supported_transfer_countries: Array<string>;
+
+      verification_fields: CountrySpec.VerificationFields;
+    }
+
+    namespace CountrySpec {
+      interface VerificationFields {
+        company: VerificationFields.Company;
+
+        individual: VerificationFields.Individual;
+      }
+
+      namespace VerificationFields {
+        interface Company {
+          /**
+           * Additional fields which are only required for some users.
+           */
+          additional: Array<string>;
+
+          /**
+           * Fields which every account must eventually provide.
+           */
+          minimum: Array<string>;
+        }
+
+        interface Individual {
+          /**
+           * Additional fields which are only required for some users.
+           */
+          additional: Array<string>;
+
+          /**
+           * Fields which every account must eventually provide.
+           */
+          minimum: Array<string>;
+        }
+      }
+    }
+  }
+}

package/types/CountrySpecsResource.d.ts

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface CountrySpecRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface CountrySpecListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class CountrySpecsResource {
+      /**
+       * Returns a Country Spec for a given Country code.
+       */
+      retrieve(
+        id: string,
+        params?: CountrySpecRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.CountrySpec>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.CountrySpec>>;
+
+      /**
+       * Lists all Country Spec objects available in the API.
+       */
+      list(
+        params?: CountrySpecListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.CountrySpec>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.CountrySpec>;
+    }
+  }
+}

package/types/Coupons.d.ts

@@ -0,0 +1,139 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A coupon contains information about a percent-off or amount-off discount you
+     * might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),
+     * [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](https://docs.stripe.com/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents).
+     */
+    interface Coupon {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'coupon';
+
+      /**
+       * Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
+       */
+      amount_off: number | null;
+
+      applies_to?: Coupon.AppliesTo;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
+       */
+      currency: string | null;
+
+      /**
+       * Coupons 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]: Coupon.CurrencyOptions;
+      };
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      /**
+       * One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.
+       */
+      duration: Coupon.Duration;
+
+      /**
+       * If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.
+       */
+      duration_in_months: number | 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;
+
+      /**
+       * Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
+       */
+      max_redemptions: number | null;
+
+      /**
+       * 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 | null;
+
+      /**
+       * Name of the coupon displayed to customers on for instance invoices or receipts.
+       */
+      name: string | null;
+
+      /**
+       * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
+       */
+      percent_off: number | null;
+
+      /**
+       * Date after which the coupon can no longer be redeemed.
+       */
+      redeem_by: number | null;
+
+      /**
+       * Number of times this coupon has been applied to a customer.
+       */
+      times_redeemed: number;
+
+      /**
+       * Taking account of the above properties, whether this coupon can still be applied to a customer.
+       */
+      valid: boolean;
+    }
+
+    namespace Coupon {
+      interface AppliesTo {
+        /**
+         * A list of product IDs this coupon applies to
+         */
+        products: Array<string>;
+      }
+
+      interface CurrencyOptions {
+        /**
+         * Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
+         */
+        amount_off: number;
+      }
+
+      type Duration = 'forever' | 'once' | 'repeating';
+    }
+
+    /**
+     * The DeletedCoupon object.
+     */
+    interface DeletedCoupon {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'coupon';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+    }
+  }
+}

package/types/CouponsResource.d.ts

@@ -0,0 +1,203 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface CouponCreateParams {
+      /**
+       * A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+       */
+      amount_off?: number;
+
+      /**
+       * A hash containing directions for what this Coupon will apply discounts to.
+       */
+      applies_to?: CouponCreateParams.AppliesTo;
+
+      /**
+       * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+       */
+      currency?: string;
+
+      /**
+       * Coupons defined in each available currency option (only supported if `amount_off` is passed). 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]: CouponCreateParams.CurrencyOptions;
+      };
+
+      /**
+       * Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+       */
+      duration?: CouponCreateParams.Duration;
+
+      /**
+       * Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
+       */
+      duration_in_months?: number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
+       */
+      id?: string;
+
+      /**
+       * A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
+       */
+      max_redemptions?: number;
+
+      /**
+       * 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>;
+
+      /**
+       * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+       */
+      name?: string;
+
+      /**
+       * A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+       */
+      percent_off?: number;
+
+      /**
+       * Unix timestamp specifying the last time at which the coupon can be redeemed (cannot be set to more than 5 years in the future). After the redeem_by date, the coupon can no longer be applied to new customers.
+       */
+      redeem_by?: number;
+    }
+
+    namespace CouponCreateParams {
+      interface AppliesTo {
+        /**
+         * An array of Product IDs that this Coupon will apply to.
+         */
+        products?: Array<string>;
+      }
+
+      interface CurrencyOptions {
+        /**
+         * A positive integer representing the amount to subtract from an invoice total.
+         */
+        amount_off: number;
+      }
+
+      type Duration = 'forever' | 'once' | 'repeating';
+    }
+
+    interface CouponRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface CouponUpdateParams {
+      /**
+       * Coupons defined in each available currency option (only supported if the coupon is amount-based). 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]: CouponUpdateParams.CurrencyOptions;
+      };
+
+      /**
+       * 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.Emptyable<Stripe.MetadataParam>;
+
+      /**
+       * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+       */
+      name?: string;
+    }
+
+    namespace CouponUpdateParams {
+      interface CurrencyOptions {
+        /**
+         * A positive integer representing the amount to subtract from an invoice total.
+         */
+        amount_off: number;
+      }
+    }
+
+    interface CouponListParams extends PaginationParams {
+      /**
+       * 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;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface CouponDeleteParams {}
+
+    class CouponsResource {
+      /**
+       * You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+       *
+       * A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+       */
+      create(
+        params?: CouponCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Coupon>>;
+      create(options?: RequestOptions): Promise<Stripe.Response<Stripe.Coupon>>;
+
+      /**
+       * Retrieves the coupon with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: CouponRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Coupon>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Coupon>>;
+
+      /**
+       * Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+       */
+      update(
+        id: string,
+        params?: CouponUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Coupon>>;
+
+      /**
+       * Returns a list of your coupons.
+       */
+      list(
+        params?: CouponListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Coupon>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.Coupon>;
+
+      /**
+       * You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+       */
+      del(
+        id: string,
+        params?: CouponDeleteParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.DeletedCoupon>>;
+      del(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.DeletedCoupon>>;
+    }
+  }
+}