@depup/stripe 21.0.0-depup.0

package/types/Apps/SecretsResource.d.ts

@@ -0,0 +1,186 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Apps {
+      interface SecretCreateParams {
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * The plaintext secret value to be stored.
+         */
+        payload: string;
+
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretCreateParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+         */
+        expires_at?: number;
+      }
+
+      namespace SecretCreateParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretListParams extends PaginationParams {
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretListParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretListParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretDeleteWhereParams {
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretDeleteWhereParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretDeleteWhereParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretFindParams {
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretFindParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretFindParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      class SecretsResource {
+        /**
+         * Create or replace a secret in the secret store.
+         */
+        create(
+          params: SecretCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
+
+        /**
+         * List all secrets stored on the given scope.
+         */
+        list(
+          params: SecretListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Apps.Secret>;
+
+        /**
+         * Deletes a secret from the secret store by name and scope.
+         */
+        deleteWhere(
+          params: SecretDeleteWhereParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
+
+        /**
+         * Finds a secret in the secret store by name and scope.
+         */
+        find(
+          params: SecretFindParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
+      }
+    }
+  }
+}

package/types/Balance.d.ts

@@ -0,0 +1,343 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * This is an object representing your Stripe balance. You can retrieve it to see
+     * the balance currently on your Stripe account.
+     *
+     * The top-level `available` and `pending` comprise your "payments balance."
+     *
+     * Related guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances)
+     */
+    interface Balance {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'balance';
+
+      /**
+       * Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
+       */
+      available: Array<Balance.Available>;
+
+      /**
+       * Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
+       */
+      connect_reserved?: Array<Balance.ConnectReserved>;
+
+      /**
+       * Funds that you can pay out using Instant Payouts.
+       */
+      instant_available?: Array<Balance.InstantAvailable>;
+
+      issuing?: Balance.Issuing;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.
+       */
+      pending: Array<Balance.Pending>;
+
+      refund_and_dispute_prefunding?: Balance.RefundAndDisputePrefunding;
+    }
+
+    namespace Balance {
+      interface Available {
+        /**
+         * Balance amount.
+         */
+        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;
+
+        source_types?: Available.SourceTypes;
+      }
+
+      namespace Available {
+        interface SourceTypes {
+          /**
+           * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+           */
+          bank_account?: number;
+
+          /**
+           * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+           */
+          card?: number;
+
+          /**
+           * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+           */
+          fpx?: number;
+        }
+      }
+
+      interface ConnectReserved {
+        /**
+         * Balance amount.
+         */
+        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;
+
+        source_types?: ConnectReserved.SourceTypes;
+      }
+
+      namespace ConnectReserved {
+        interface SourceTypes {
+          /**
+           * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+           */
+          bank_account?: number;
+
+          /**
+           * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+           */
+          card?: number;
+
+          /**
+           * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+           */
+          fpx?: number;
+        }
+      }
+
+      interface InstantAvailable {
+        /**
+         * Balance amount.
+         */
+        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;
+
+        /**
+         * Breakdown of balance by destination.
+         */
+        net_available?: Array<InstantAvailable.NetAvailable>;
+
+        source_types?: InstantAvailable.SourceTypes;
+      }
+
+      namespace InstantAvailable {
+        interface NetAvailable {
+          /**
+           * Net balance amount, subtracting fees from platform-set pricing.
+           */
+          amount: number;
+
+          /**
+           * ID of the external account for this net balance (not expandable).
+           */
+          destination: string;
+
+          source_types?: NetAvailable.SourceTypes;
+        }
+
+        namespace NetAvailable {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+
+        interface SourceTypes {
+          /**
+           * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+           */
+          bank_account?: number;
+
+          /**
+           * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+           */
+          card?: number;
+
+          /**
+           * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+           */
+          fpx?: number;
+        }
+      }
+
+      interface Issuing {
+        /**
+         * Funds that are available for use.
+         */
+        available: Array<Issuing.Available>;
+      }
+
+      namespace Issuing {
+        interface Available {
+          /**
+           * Balance amount.
+           */
+          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;
+
+          source_types?: Available.SourceTypes;
+        }
+
+        namespace Available {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+      }
+
+      interface Pending {
+        /**
+         * Balance amount.
+         */
+        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;
+
+        source_types?: Pending.SourceTypes;
+      }
+
+      namespace Pending {
+        interface SourceTypes {
+          /**
+           * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+           */
+          bank_account?: number;
+
+          /**
+           * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+           */
+          card?: number;
+
+          /**
+           * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+           */
+          fpx?: number;
+        }
+      }
+
+      interface RefundAndDisputePrefunding {
+        /**
+         * Funds that are available for use.
+         */
+        available: Array<RefundAndDisputePrefunding.Available>;
+
+        /**
+         * Funds that are pending
+         */
+        pending: Array<RefundAndDisputePrefunding.Pending>;
+      }
+
+      namespace RefundAndDisputePrefunding {
+        interface Available {
+          /**
+           * Balance amount.
+           */
+          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;
+
+          source_types?: Available.SourceTypes;
+        }
+
+        namespace Available {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+
+        interface Pending {
+          /**
+           * Balance amount.
+           */
+          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;
+
+          source_types?: Pending.SourceTypes;
+        }
+
+        namespace Pending {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+      }
+    }
+  }
+}

package/types/BalanceResource.d.ts

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface BalanceRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class BalanceResource {
+      /**
+       * Retrieves the current account balance, based on the authentication that was used to make the request.
+       *  For a sample request, see [Accounting for negative balances](https://docs.stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
+       */
+      retrieve(
+        params?: BalanceRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Balance>>;
+      retrieve(
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Balance>>;
+    }
+  }
+}

package/types/BalanceSettings.d.ts

@@ -0,0 +1,103 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Options for customizing account balances and payout settings for a Stripe platform's connected accounts.
+     */
+    interface BalanceSettings {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'balance_settings';
+
+      payments: BalanceSettings.Payments;
+    }
+
+    namespace BalanceSettings {
+      interface Payments {
+        /**
+         * A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
+         */
+        debit_negative_balances: boolean | null;
+
+        /**
+         * Settings specific to the account's payouts.
+         */
+        payouts: Payments.Payouts | null;
+
+        settlement_timing: Payments.SettlementTiming;
+      }
+
+      namespace Payments {
+        interface Payouts {
+          /**
+           * The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](https://docs.stripe.com/payouts/minimum-balances-for-automatic-payouts).
+           */
+          minimum_balance_by_currency: {
+            [key: string]: number;
+          } | null;
+
+          /**
+           * Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details.
+           */
+          schedule: Payouts.Schedule | null;
+
+          /**
+           * The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
+           */
+          statement_descriptor: string | null;
+
+          /**
+           * Whether the funds in this account can be paid out.
+           */
+          status: Payouts.Status;
+        }
+
+        namespace Payouts {
+          interface Schedule {
+            /**
+             * How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
+             */
+            interval: Schedule.Interval | null;
+
+            /**
+             * The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
+             */
+            monthly_payout_days?: Array<number>;
+
+            /**
+             * The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
+             */
+            weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
+          }
+
+          namespace Schedule {
+            type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+
+            type WeeklyPayoutDay =
+              | 'friday'
+              | 'monday'
+              | 'thursday'
+              | 'tuesday'
+              | 'wednesday';
+          }
+
+          type Status = 'disabled' | 'enabled';
+        }
+
+        interface SettlementTiming {
+          /**
+           * The number of days charge funds are held before becoming available.
+           */
+          delay_days: number;
+
+          /**
+           * The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account.
+           */
+          delay_days_override?: number;
+        }
+      }
+    }
+  }
+}