stripe 9.0.0 → 9.3.0

package/types/2020-08-27/TestHelpers/Treasury/InboundTransfers.d.ts

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface InboundTransferFailParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Details about a failed InboundTransfer.
+           */
+          failure_details?: InboundTransferFailParams.FailureDetails;
+        }
+
+        namespace InboundTransferFailParams {
+          interface FailureDetails {
+            /**
+             * Reason for the failure.
+             */
+            code?: FailureDetails.Code;
+          }
+
+          namespace FailureDetails {
+            type Code =
+              | 'account_closed'
+              | 'account_frozen'
+              | 'bank_account_restricted'
+              | 'bank_ownership_changed'
+              | 'debit_not_authorized'
+              | 'incorrect_account_holder_address'
+              | 'incorrect_account_holder_name'
+              | 'incorrect_account_holder_tax_id'
+              | 'insufficient_funds'
+              | 'invalid_account_number'
+              | 'invalid_currency'
+              | 'no_account'
+              | 'other';
+          }
+        }
+      }
+
+      namespace Treasury {
+        interface InboundTransferReturnInboundTransferParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface InboundTransferSucceedParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        class InboundTransfersResource {
+          /**
+           * Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
+           */
+          fail(
+            id: string,
+            params?: InboundTransferFailParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+          fail(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+
+          /**
+           * Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
+           */
+          returnInboundTransfer(
+            id: string,
+            params?: InboundTransferReturnInboundTransferParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+          returnInboundTransfer(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+
+          /**
+           * Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
+           */
+          succeed(
+            id: string,
+            params?: InboundTransferSucceedParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+          succeed(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+        }
+      }
+    }
+  }
+}

package/types/2020-08-27/TestHelpers/Treasury/OutboundPayments.d.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface OutboundPaymentFailParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundPaymentPostParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundPaymentReturnOutboundPaymentParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Optional hash to set the the return code.
+           */
+          returned_details?: OutboundPaymentReturnOutboundPaymentParams.ReturnedDetails;
+        }
+
+        namespace OutboundPaymentReturnOutboundPaymentParams {
+          interface ReturnedDetails {
+            /**
+             * The return code to be set on the OutboundPayment object.
+             */
+            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 OutboundPaymentsResource {
+          /**
+           * Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
+           */
+          fail(
+            id: string,
+            params?: OutboundPaymentFailParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+          fail(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+
+          /**
+           * Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
+           */
+          post(
+            id: string,
+            params?: OutboundPaymentPostParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+          post(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+
+          /**
+           * Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
+           */
+          returnOutboundPayment(
+            id: string,
+            params?: OutboundPaymentReturnOutboundPaymentParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+          returnOutboundPayment(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+        }
+      }
+    }
+  }
+}

package/types/2020-08-27/TestHelpers/Treasury/OutboundTransfers.d.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      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 {
+          /**
+           * 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/2020-08-27/TestHelpers/Treasury/ReceivedCredits.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;
+
+          /**
+           * The rails used for the object.
+           */
+          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/2020-08-27/TestHelpers/Treasury/ReceivedDebits.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;
+
+          /**
+           * The rails used for the object.
+           */
+          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/2020-08-27/Tokens.d.ts

@@ -351,12 +351,12 @@ declare module 'stripe' {
           last_name?: string;
 
           /**
-           * The Kana varation of the individual's last name (Japan only).
+           * The Kana variation of the individual's last name (Japan only).
            */
           last_name_kana?: string;
 
           /**
-           * The Kanji varation of the individual's last name (Japan only).
+           * The Kanji variation of the individual's last name (Japan only).
            */
           last_name_kanji?: string;
 

package/types/2020-08-27/Treasury/CreditReversals.d.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      /**
+       * The CreditReversal object.
+       */
+      interface CreditReversal {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'treasury.credit_reversal';
+
+        /**
+         * Amount (in cents) 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 reverse funds from.
+         */
+        financial_account: string;
+
+        /**
+         * A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+         */
+        hosted_regulatory_receipt_url: string | null;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/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 rails used to reverse the funds.
+         */
+        network: CreditReversal.Network;
+
+        /**
+         * The ReceivedCredit being reversed.
+         */
+        received_credit: string;
+
+        /**
+         * Status of the CreditReversal
+         */
+        status: CreditReversal.Status;
+
+        status_transitions: CreditReversal.StatusTransitions;
+
+        /**
+         * The Transaction associated with this object.
+         */
+        transaction: string | Stripe.Treasury.Transaction | null;
+      }
+
+      namespace CreditReversal {
+        type Network = 'ach' | 'stripe';
+
+        type Status = 'canceled' | 'posted' | 'processing';
+
+        interface StatusTransitions {
+          /**
+           * Timestamp describing when the CreditReversal changed status to `posted`
+           */
+          posted_at: number | null;
+        }
+      }
+
+      interface CreditReversalCreateParams {
+        /**
+         * The ReceivedCredit to reverse.
+         */
+        received_credit: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/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;
+      }
+
+      interface CreditReversalRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditReversalListParams 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 CreditReversals for the ReceivedCredit ID.
+         */
+        received_credit?: string;
+
+        /**
+         * Only return CreditReversals for a given status.
+         */
+        status?: CreditReversalListParams.Status;
+      }
+
+      namespace CreditReversalListParams {
+        type Status = 'canceled' | 'posted' | 'processing';
+      }
+
+      class CreditReversalsResource {
+        /**
+         * Reverses a ReceivedCredit and creates a CreditReversal object.
+         */
+        create(
+          params: CreditReversalCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.CreditReversal>>;
+
+        /**
+         * Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list
+         */
+        retrieve(
+          id: string,
+          params?: CreditReversalRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.CreditReversal>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.CreditReversal>>;
+
+        /**
+         * Returns a list of CreditReversals.
+         */
+        list(
+          params: CreditReversalListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.CreditReversal>;
+      }
+    }
+  }
+}