@depup/stripe 21.0.0-depup.0

package/types/Topups.d.ts

@@ -0,0 +1,103 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * To top up your Stripe balance, you create a top-up object. You can retrieve
+     * individual top-ups, as well as list all top-ups. Top-ups are identified by a
+     * unique, random ID.
+     *
+     * Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups)
+     */
+    interface Topup {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'topup';
+
+      /**
+       * Amount transferred.
+       */
+      amount: number;
+
+      /**
+       * ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
+       */
+      balance_transaction: string | Stripe.BalanceTransaction | 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. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
+       */
+      expected_availability_date: number | null;
+
+      /**
+       * Error code explaining reason for top-up failure if available (see [the errors section](https://docs.stripe.com/api/errors) for a list of codes).
+       */
+      failure_code: string | null;
+
+      /**
+       * Message to user further explaining reason for top-up failure if available.
+       */
+      failure_message: string | 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;
+
+      /**
+       * 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;
+
+      /**
+       * The source field is deprecated. It might not always be present in the API response.
+       */
+      source: Stripe.Source | null;
+
+      /**
+       * Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
+       */
+      statement_descriptor: string | null;
+
+      /**
+       * The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
+       */
+      status: Topup.Status;
+
+      /**
+       * A string that identifies this top-up as part of a group.
+       */
+      transfer_group: string | null;
+    }
+
+    namespace Topup {
+      type Status =
+        | 'canceled'
+        | 'failed'
+        | 'pending'
+        | 'reversed'
+        | 'succeeded';
+    }
+  }
+}

package/types/TopupsResource.d.ts

@@ -0,0 +1,158 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface TopupCreateParams {
+      /**
+       * A positive integer representing how much to transfer.
+       */
+      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;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description?: 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.Emptyable<Stripe.MetadataParam>;
+
+      /**
+       * The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://docs.stripe.com/connect/testing#testing-top-ups)).
+       */
+      source?: string;
+
+      /**
+       * Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
+       */
+      statement_descriptor?: string;
+
+      /**
+       * A string that identifies this top-up as part of a group.
+       */
+      transfer_group?: string;
+    }
+
+    interface TopupRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface TopupUpdateParams {
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description?: 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.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface TopupListParams extends PaginationParams {
+      /**
+       * A positive integer representing how much to transfer.
+       */
+      amount?: Stripe.RangeQueryParam | number;
+
+      /**
+       * 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>;
+
+      /**
+       * Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
+       */
+      status?: TopupListParams.Status;
+    }
+
+    namespace TopupListParams {
+      type Status = 'canceled' | 'failed' | 'pending' | 'succeeded';
+    }
+
+    interface TopupCancelParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class TopupsResource {
+      /**
+       * Top up the balance of an account
+       */
+      create(
+        params: TopupCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Topup>>;
+
+      /**
+       * Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
+       */
+      retrieve(
+        id: string,
+        params?: TopupRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Topup>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Topup>>;
+
+      /**
+       * Updates the metadata of a top-up. Other top-up details are not editable by design.
+       */
+      update(
+        id: string,
+        params?: TopupUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Topup>>;
+
+      /**
+       * Returns a list of top-ups.
+       */
+      list(
+        params?: TopupListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Topup>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.Topup>;
+
+      /**
+       * Cancels a top-up. Only pending top-ups can be canceled.
+       */
+      cancel(
+        id: string,
+        params?: TopupCancelParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Topup>>;
+      cancel(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Topup>>;
+    }
+  }
+}

package/types/TransferReversals.d.ts

@@ -0,0 +1,72 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * [Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a
+     * connected account, either entirely or partially, and can also specify whether
+     * to refund any related application fees. Transfer reversals add to the
+     * platform's balance and subtract from the destination account's balance.
+     *
+     * Reversing a transfer that was made for a [destination
+     * charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
+     * the charge. It is possible to reverse a
+     * [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options)
+     * transfer only if the destination account has enough balance to cover the
+     * reversal.
+     *
+     * Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers)
+     */
+    interface TransferReversal {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'transfer_reversal';
+
+      /**
+       * Amount, in cents (or local equivalent).
+       */
+      amount: number;
+
+      /**
+       * Balance transaction that describes the impact on your account balance.
+       */
+      balance_transaction: string | Stripe.BalanceTransaction | 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. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * Linked payment refund for the transfer reversal.
+       */
+      destination_payment_refund: string | Stripe.Refund | 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;
+
+      /**
+       * ID of the refund responsible for the transfer reversal.
+       */
+      source_refund: string | Stripe.Refund | null;
+
+      /**
+       * ID of the transfer that was reversed.
+       */
+      transfer: string | Stripe.Transfer;
+    }
+  }
+}

package/types/Transfers.d.ts

@@ -0,0 +1,104 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A `Transfer` object is created when you move funds between Stripe accounts as
+     * part of Connect.
+     *
+     * Before April 6, 2017, transfers also represented movement of funds from a
+     * Stripe account to a card or bank account. This behavior has since been split
+     * out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more
+     * information, read about the
+     * [transfer/payout split](https://docs.stripe.com/transfer-payout-split).
+     *
+     * Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)
+     */
+    interface Transfer {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'transfer';
+
+      /**
+       * Amount in cents (or local equivalent) to be transferred.
+       */
+      amount: number;
+
+      /**
+       * Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
+       */
+      amount_reversed: number;
+
+      /**
+       * Balance transaction that describes the impact of this transfer on your account balance.
+       */
+      balance_transaction: string | Stripe.BalanceTransaction | null;
+
+      /**
+       * Time that this record of the transfer was first created.
+       */
+      created: 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;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * ID of the Stripe account the transfer was sent to.
+       */
+      destination: string | Stripe.Account | null;
+
+      /**
+       * If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
+       */
+      destination_payment?: string | Stripe.Charge;
+
+      /**
+       * 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;
+
+      /**
+       * A list of reversals that have been applied to the transfer.
+       */
+      reversals: ApiList<Stripe.TransferReversal>;
+
+      /**
+       * Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
+       */
+      reversed: boolean;
+
+      /**
+       * ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.
+       */
+      source_transaction: string | Stripe.Charge | null;
+
+      /**
+       * The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
+       */
+      source_type?: string;
+
+      /**
+       * A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
+       */
+      transfer_group: string | null;
+    }
+  }
+}

package/types/TransfersResource.d.ts

@@ -0,0 +1,260 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface TransferCreateParams {
+      /**
+       * Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).
+       */
+      currency: string;
+
+      /**
+       * The ID of a connected Stripe account. [See the Connect documentation](https://docs.stripe.com/docs/connect/separate-charges-and-transfers) for details.
+       */
+      destination: string;
+
+      /**
+       * A positive integer in cents (or local equivalent) representing how much to transfer.
+       */
+      amount?: number;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description?: 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;
+
+      /**
+       * You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability) for details.
+       */
+      source_transaction?: string;
+
+      /**
+       * The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
+       */
+      source_type?: TransferCreateParams.SourceType;
+
+      /**
+       * A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
+       */
+      transfer_group?: string;
+    }
+
+    namespace TransferCreateParams {
+      type SourceType = 'bank_account' | 'card' | 'fpx';
+    }
+
+    interface TransferRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface TransferUpdateParams {
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description?: 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.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface TransferListParams extends PaginationParams {
+      /**
+       * Only return transfers that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Only return transfers for the destination specified by this account ID.
+       */
+      destination?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Only return transfers with the specified transfer group.
+       */
+      transfer_group?: string;
+    }
+
+    interface TransferCreateReversalParams {
+      /**
+       * A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.
+       */
+      amount?: number;
+
+      /**
+       * An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.
+       */
+      description?: 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.Emptyable<Stripe.MetadataParam>;
+
+      /**
+       * Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.
+       */
+      refund_application_fee?: boolean;
+    }
+
+    interface TransferListReversalsParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface TransferRetrieveReversalParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface TransferUpdateReversalParams {
+      /**
+       * 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>;
+    }
+
+    class TransfersResource {
+      /**
+       * To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
+       */
+      create(
+        params: TransferCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Transfer>>;
+
+      /**
+       * Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
+       */
+      retrieve(
+        id: string,
+        params?: TransferRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Transfer>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Transfer>>;
+
+      /**
+       * Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+       *
+       * This request accepts only metadata as an argument.
+       */
+      update(
+        id: string,
+        params?: TransferUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Transfer>>;
+
+      /**
+       * Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
+       */
+      list(
+        params?: TransferListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Transfer>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.Transfer>;
+
+      /**
+       * When you create a new reversal, you must specify a transfer to create it on.
+       *
+       * When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
+       *
+       * Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.
+       */
+      createReversal(
+        id: string,
+        params?: TransferCreateReversalParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TransferReversal>>;
+      createReversal(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TransferReversal>>;
+
+      /**
+       * You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.
+       */
+      listReversals(
+        id: string,
+        params?: TransferListReversalsParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.TransferReversal>;
+      listReversals(
+        id: string,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.TransferReversal>;
+
+      /**
+       * By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
+       */
+      retrieveReversal(
+        transferId: string,
+        id: string,
+        params?: TransferRetrieveReversalParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TransferReversal>>;
+      retrieveReversal(
+        transferId: string,
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TransferReversal>>;
+
+      /**
+       * Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+       *
+       * This request only accepts metadata and description as arguments.
+       */
+      updateReversal(
+        transferId: string,
+        id: string,
+        params?: TransferUpdateReversalParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TransferReversal>>;
+      updateReversal(
+        transferId: string,
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TransferReversal>>;
+    }
+  }
+}