@depup/stripe 21.0.0-depup.0

package/types/Treasury/OutboundTransfersResource.d.ts

@@ -0,0 +1,179 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      interface OutboundTransferCreateParams {
+        /**
+         * Amount (in cents) to be transferred.
+         */
+        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;
+
+        /**
+         * The FinancialAccount to pull funds from.
+         */
+        financial_account: string;
+
+        /**
+         * An arbitrary string attached to the object. Often useful for displaying to users.
+         */
+        description?: string;
+
+        /**
+         * The PaymentMethod to use as the payment instrument for the OutboundTransfer.
+         */
+        destination_payment_method?: string;
+
+        /**
+         * Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.
+         */
+        destination_payment_method_data?: OutboundTransferCreateParams.DestinationPaymentMethodData;
+
+        /**
+         * Hash describing payment method configuration details.
+         */
+        destination_payment_method_options?: OutboundTransferCreateParams.DestinationPaymentMethodOptions;
+
+        /**
+         * 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;
+
+        /**
+         * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". Can only include -#.$&*, spaces, and alphanumeric characters.
+         */
+        statement_descriptor?: string;
+      }
+
+      namespace OutboundTransferCreateParams {
+        interface DestinationPaymentMethodData {
+          /**
+           * Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
+           */
+          financial_account?: string;
+
+          /**
+           * The type of the destination.
+           */
+          type: 'financial_account';
+        }
+
+        interface DestinationPaymentMethodOptions {
+          /**
+           * Optional fields for `us_bank_account`.
+           */
+          us_bank_account?: Stripe.Emptyable<
+            DestinationPaymentMethodOptions.UsBankAccount
+          >;
+        }
+
+        namespace DestinationPaymentMethodOptions {
+          interface UsBankAccount {
+            /**
+             * Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
+             */
+            network?: UsBankAccount.Network;
+          }
+
+          namespace UsBankAccount {
+            type Network = 'ach' | 'us_domestic_wire';
+          }
+        }
+      }
+
+      interface OutboundTransferRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface OutboundTransferListParams extends PaginationParams {
+        /**
+         * Returns objects associated with this FinancialAccount.
+         */
+        financial_account: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.
+         */
+        status?: OutboundTransferListParams.Status;
+      }
+
+      namespace OutboundTransferListParams {
+        type Status =
+          | 'canceled'
+          | 'failed'
+          | 'posted'
+          | 'processing'
+          | 'returned';
+      }
+
+      interface OutboundTransferCancelParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class OutboundTransfersResource {
+        /**
+         * Creates an OutboundTransfer.
+         */
+        create(
+          params: OutboundTransferCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+
+        /**
+         * Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
+         */
+        retrieve(
+          id: string,
+          params?: OutboundTransferRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+
+        /**
+         * Returns a list of OutboundTransfers sent from the specified FinancialAccount.
+         */
+        list(
+          params: OutboundTransferListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.OutboundTransfer>;
+
+        /**
+         * An OutboundTransfer can be canceled if the funds have not yet been paid out.
+         */
+        cancel(
+          id: string,
+          params?: OutboundTransferCancelParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+        cancel(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+      }
+    }
+  }
+}

package/types/Treasury/ReceivedCredits.d.ts

@@ -0,0 +1,279 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      /**
+       * ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+       */
+      interface ReceivedCredit {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'treasury.received_credit';
+
+        /**
+         * Amount (in cents) transferred.
+         */
+        amount: number;
+
+        /**
+         * 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;
+
+        /**
+         * Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
+         */
+        failure_code: ReceivedCredit.FailureCode | null;
+
+        /**
+         * The FinancialAccount that received the funds.
+         */
+        financial_account: string | null;
+
+        /**
+         * A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+         */
+        hosted_regulatory_receipt_url: string | null;
+
+        initiating_payment_method_details: ReceivedCredit.InitiatingPaymentMethodDetails;
+
+        linked_flows: ReceivedCredit.LinkedFlows;
+
+        /**
+         * 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 rails used to send the funds.
+         */
+        network: ReceivedCredit.Network;
+
+        /**
+         * Details describing when a ReceivedCredit may be reversed.
+         */
+        reversal_details: ReceivedCredit.ReversalDetails | null;
+
+        /**
+         * Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
+         */
+        status: ReceivedCredit.Status;
+
+        /**
+         * The Transaction associated with this object.
+         */
+        transaction: string | Stripe.Treasury.Transaction | null;
+      }
+
+      namespace ReceivedCredit {
+        type FailureCode =
+          | 'account_closed'
+          | 'account_frozen'
+          | 'international_transaction'
+          | 'other';
+
+        interface InitiatingPaymentMethodDetails {
+          /**
+           * Set when `type` is `balance`.
+           */
+          balance?: 'payments';
+
+          billing_details: InitiatingPaymentMethodDetails.BillingDetails;
+
+          financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
+
+          /**
+           * Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID.
+           */
+          issuing_card?: string;
+
+          /**
+           * Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+           */
+          type: InitiatingPaymentMethodDetails.Type;
+
+          us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+        }
+
+        namespace InitiatingPaymentMethodDetails {
+          interface BillingDetails {
+            address: Stripe.Address;
+
+            /**
+             * Email address.
+             */
+            email: string | null;
+
+            /**
+             * Full name.
+             */
+            name: string | null;
+          }
+
+          interface FinancialAccount {
+            /**
+             * The FinancialAccount ID.
+             */
+            id: string;
+
+            /**
+             * The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
+             */
+            network: 'stripe';
+          }
+
+          type Type =
+            | 'balance'
+            | 'financial_account'
+            | 'issuing_card'
+            | 'stripe'
+            | 'us_bank_account';
+
+          interface UsBankAccount {
+            /**
+             * Bank name.
+             */
+            bank_name: string | null;
+
+            /**
+             * The last four digits of the bank account number.
+             */
+            last4: string | null;
+
+            /**
+             * The routing number for the bank account.
+             */
+            routing_number: string | null;
+          }
+        }
+
+        interface LinkedFlows {
+          /**
+           * The CreditReversal created as a result of this ReceivedCredit being reversed.
+           */
+          credit_reversal: string | null;
+
+          /**
+           * Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object.
+           */
+          issuing_authorization: string | null;
+
+          /**
+           * Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object.
+           */
+          issuing_transaction: string | null;
+
+          /**
+           * ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
+           */
+          source_flow: string | null;
+
+          /**
+           * The expandable object of the source flow.
+           */
+          source_flow_details?: LinkedFlows.SourceFlowDetails | null;
+
+          /**
+           * The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
+           */
+          source_flow_type: string | null;
+        }
+
+        namespace LinkedFlows {
+          interface SourceFlowDetails {
+            /**
+             * You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+             */
+            credit_reversal?: Stripe.Treasury.CreditReversal;
+
+            /**
+             * Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers).
+             *
+             * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
+             *
+             * Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
+             */
+            outbound_payment?: Stripe.Treasury.OutboundPayment;
+
+            /**
+             * Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+             *
+             * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
+             *
+             * Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
+             */
+            outbound_transfer?: Stripe.Treasury.OutboundTransfer;
+
+            /**
+             * A `Payout` object is created when you receive funds from Stripe, or when you
+             * initiate a payout to either a bank account or debit card of a [connected
+             * Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
+             * and list all payouts. Payouts are made on [varying
+             * schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
+             * industry.
+             *
+             * Related guide: [Receiving payouts](https://docs.stripe.com/payouts)
+             */
+            payout?: Stripe.Payout;
+
+            /**
+             * The type of the source flow that originated the ReceivedCredit.
+             */
+            type: SourceFlowDetails.Type;
+          }
+
+          namespace SourceFlowDetails {
+            type Type =
+              | 'credit_reversal'
+              | 'other'
+              | 'outbound_payment'
+              | 'outbound_transfer'
+              | 'payout';
+          }
+        }
+
+        type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
+
+        interface ReversalDetails {
+          /**
+           * Time before which a ReceivedCredit can be reversed.
+           */
+          deadline: number | null;
+
+          /**
+           * Set if a ReceivedCredit cannot be reversed.
+           */
+          restricted_reason: ReversalDetails.RestrictedReason | null;
+        }
+
+        namespace ReversalDetails {
+          type RestrictedReason =
+            | 'already_reversed'
+            | 'deadline_passed'
+            | 'network_restricted'
+            | 'other'
+            | 'source_flow_restricted';
+        }
+
+        type Status = 'failed' | 'succeeded';
+      }
+    }
+  }
+}

package/types/Treasury/ReceivedCreditsResource.d.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      interface ReceivedCreditRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ReceivedCreditListParams extends PaginationParams {
+        /**
+         * The FinancialAccount that received the funds.
+         */
+        financial_account: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return ReceivedCredits described by the flow.
+         */
+        linked_flows?: ReceivedCreditListParams.LinkedFlows;
+
+        /**
+         * Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
+         */
+        status?: ReceivedCreditListParams.Status;
+      }
+
+      namespace ReceivedCreditListParams {
+        interface LinkedFlows {
+          /**
+           * The source flow type.
+           */
+          source_flow_type: LinkedFlows.SourceFlowType;
+        }
+
+        namespace LinkedFlows {
+          type SourceFlowType =
+            | 'credit_reversal'
+            | 'other'
+            | 'outbound_payment'
+            | 'outbound_transfer'
+            | 'payout';
+        }
+
+        type Status = 'failed' | 'succeeded';
+      }
+
+      class ReceivedCreditsResource {
+        /**
+         * Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
+         */
+        retrieve(
+          id: string,
+          params?: ReceivedCreditRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.ReceivedCredit>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.ReceivedCredit>>;
+
+        /**
+         * Returns a list of ReceivedCredits.
+         */
+        list(
+          params: ReceivedCreditListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.ReceivedCredit>;
+      }
+    }
+  }
+}