@depup/stripe 21.0.0-depup.0

package/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts

@@ -0,0 +1,175 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface OutboundTransferUpdateParams {
+          /**
+           * Details about network-specific tracking information.
+           */
+          tracking_details: OutboundTransferUpdateParams.TrackingDetails;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+
+        namespace OutboundTransferUpdateParams {
+          interface TrackingDetails {
+            /**
+             * ACH network tracking details.
+             */
+            ach?: TrackingDetails.Ach;
+
+            /**
+             * The US bank account network used to send funds.
+             */
+            type: TrackingDetails.Type;
+
+            /**
+             * US domestic wire network tracking details.
+             */
+            us_domestic_wire?: TrackingDetails.UsDomesticWire;
+          }
+
+          namespace TrackingDetails {
+            interface Ach {
+              /**
+               * ACH trace ID for funds sent over the `ach` network.
+               */
+              trace_id: string;
+            }
+
+            type Type = 'ach' | 'us_domestic_wire';
+
+            interface UsDomesticWire {
+              /**
+               * CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
+               */
+              chips?: string;
+
+              /**
+               * IMAD for funds sent over the `us_domestic_wire` network.
+               */
+              imad?: string;
+
+              /**
+               * OMAD for funds sent over the `us_domestic_wire` network.
+               */
+              omad?: string;
+            }
+          }
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundTransferFailParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundTransferPostParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundTransferReturnOutboundTransferParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Details about a returned OutboundTransfer.
+           */
+          returned_details?: OutboundTransferReturnOutboundTransferParams.ReturnedDetails;
+        }
+
+        namespace OutboundTransferReturnOutboundTransferParams {
+          interface ReturnedDetails {
+            /**
+             * Reason for the return.
+             */
+            code?: ReturnedDetails.Code;
+          }
+
+          namespace ReturnedDetails {
+            type Code =
+              | 'account_closed'
+              | 'account_frozen'
+              | 'bank_account_restricted'
+              | 'bank_ownership_changed'
+              | 'declined'
+              | 'incorrect_account_holder_name'
+              | 'invalid_account_number'
+              | 'invalid_currency'
+              | 'no_account'
+              | 'other';
+          }
+        }
+      }
+
+      namespace Treasury {
+        class OutboundTransfersResource {
+          /**
+           * Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
+           */
+          update(
+            id: string,
+            params: OutboundTransferUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+
+          /**
+           * Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
+           */
+          fail(
+            id: string,
+            params?: OutboundTransferFailParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+          fail(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+
+          /**
+           * Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
+           */
+          post(
+            id: string,
+            params?: OutboundTransferPostParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+          post(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+
+          /**
+           * Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
+           */
+          returnOutboundTransfer(
+            id: string,
+            params?: OutboundTransferReturnOutboundTransferParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+          returnOutboundTransfer(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundTransfer>>;
+        }
+      }
+    }
+  }
+}

package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts

@@ -0,0 +1,93 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface ReceivedCreditCreateParams {
+          /**
+           * 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 send funds to.
+           */
+          financial_account: string;
+
+          /**
+           * 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: ReceivedCreditCreateParams.Network;
+
+          /**
+           * 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>;
+
+          /**
+           * Initiating payment method details for the object.
+           */
+          initiating_payment_method_details?: ReceivedCreditCreateParams.InitiatingPaymentMethodDetails;
+        }
+
+        namespace ReceivedCreditCreateParams {
+          interface InitiatingPaymentMethodDetails {
+            /**
+             * The source type.
+             */
+            type: 'us_bank_account';
+
+            /**
+             * Optional fields for `us_bank_account`.
+             */
+            us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+          }
+
+          namespace InitiatingPaymentMethodDetails {
+            interface UsBankAccount {
+              /**
+               * The bank account holder's name.
+               */
+              account_holder_name?: string;
+
+              /**
+               * The bank account number.
+               */
+              account_number?: string;
+
+              /**
+               * The bank account's routing number.
+               */
+              routing_number?: string;
+            }
+          }
+
+          type Network = 'ach' | 'us_domestic_wire';
+        }
+      }
+
+      namespace Treasury {
+        class ReceivedCreditsResource {
+          /**
+           * Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
+           */
+          create(
+            params: ReceivedCreditCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.ReceivedCredit>>;
+        }
+      }
+    }
+  }
+}

package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts

@@ -0,0 +1,91 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface ReceivedDebitCreateParams {
+          /**
+           * 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;
+
+          /**
+           * 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: 'ach';
+
+          /**
+           * 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>;
+
+          /**
+           * Initiating payment method details for the object.
+           */
+          initiating_payment_method_details?: ReceivedDebitCreateParams.InitiatingPaymentMethodDetails;
+        }
+
+        namespace ReceivedDebitCreateParams {
+          interface InitiatingPaymentMethodDetails {
+            /**
+             * The source type.
+             */
+            type: 'us_bank_account';
+
+            /**
+             * Optional fields for `us_bank_account`.
+             */
+            us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+          }
+
+          namespace InitiatingPaymentMethodDetails {
+            interface UsBankAccount {
+              /**
+               * The bank account holder's name.
+               */
+              account_holder_name?: string;
+
+              /**
+               * The bank account number.
+               */
+              account_number?: string;
+
+              /**
+               * The bank account's routing number.
+               */
+              routing_number?: string;
+            }
+          }
+        }
+      }
+
+      namespace Treasury {
+        class ReceivedDebitsResource {
+          /**
+           * Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
+           */
+          create(
+            params: ReceivedDebitCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.ReceivedDebit>>;
+        }
+      }
+    }
+  }
+}

package/types/Tokens.d.ts

@@ -0,0 +1,84 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Tokenization is the process Stripe uses to collect sensitive card or bank
+     * account details, or personally identifiable information (PII), directly from
+     * your customers in a secure manner. A token representing this information is
+     * returned to your server to use. Use our
+     * [recommended payments integrations](https://docs.stripe.com/payments) to perform this process
+     * on the client-side. This guarantees that no sensitive card data touches your server,
+     * and allows your integration to operate in a PCI-compliant way.
+     *
+     * If you can't use client-side tokenization, you can also create tokens using
+     * the API with either your publishable or secret API key. If
+     * your integration uses this method, you're responsible for any PCI compliance
+     * that it might require, and you must keep your secret API key safe. Unlike with
+     * client-side tokenization, your customer's information isn't sent directly to
+     * Stripe, so we can't determine how it's handled or stored.
+     *
+     * You can't store or use tokens more than once. To store card or bank account
+     * information for later use, create [Customer](https://docs.stripe.com/api#customers)
+     * objects or [External accounts](https://docs.stripe.com/api#external_accounts).
+     * [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection,
+     * performs best with integrations that use client-side tokenization.
+     */
+    interface Token {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'token';
+
+      /**
+       * These bank accounts are payment methods on `Customer` objects.
+       *
+       * On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer
+       * destinations on `Account` objects for connected accounts.
+       * They can be bank accounts or debit cards as well, and are documented in the links above.
+       *
+       * Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers)
+       */
+      bank_account?: Stripe.BankAccount;
+
+      /**
+       * You can store multiple cards on a customer in order to charge the customer
+       * later. You can also store multiple debit cards on a recipient in order to
+       * transfer to those cards later.
+       *
+       * Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)
+       */
+      card?: Stripe.Card;
+
+      /**
+       * IP address of the client that generates the token.
+       */
+      client_ip: string | null;
+
+      /**
+       * 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;
+
+      /**
+       * Type of the token: `account`, `bank_account`, `card`, or `pii`.
+       */
+      type: string;
+
+      /**
+       * Determines if you have already used this token (you can only use tokens once).
+       */
+      used: boolean;
+    }
+  }
+}