stripe 19.2.0 → 19.3.0-beta.1

package/types/V2/MoneyManagement/ReceivedDebits.d.ts

@@ -0,0 +1,176 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * ReceivedDebit resource
+         */
+        interface ReceivedDebit {
+          /**
+           * Unique identifier for the ReceivedDebit.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.money_management.received_debit';
+
+          /**
+           * Amount and currency of the ReceivedDebit.
+           */
+          amount: Amount;
+
+          /**
+           * This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
+           */
+          bank_transfer?: ReceivedDebit.BankTransfer;
+
+          /**
+           * The time at which the ReceivedDebit was created.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+           */
+          created: string;
+
+          /**
+           * Freeform string sent by the originator of the ReceivedDebit.
+           */
+          description?: string;
+
+          /**
+           * Financial Account on which funds for ReceivedDebit were debited.
+           */
+          financial_account: string;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * A link to the Stripe-hosted receipt for this ReceivedDebit.
+           */
+          receipt_url?: string;
+
+          /**
+           * Open Enum. The status of the ReceivedDebit.
+           */
+          status: ReceivedDebit.Status;
+
+          /**
+           * Detailed information about the status of the ReceivedDebit.
+           */
+          status_details?: ReceivedDebit.StatusDetails;
+
+          /**
+           * The time at which the ReceivedDebit transitioned to a particular status.
+           */
+          status_transitions?: ReceivedDebit.StatusTransitions;
+
+          /**
+           * Open Enum. The type of the ReceivedDebit.
+           */
+          type: ReceivedDebit.Type;
+        }
+
+        namespace ReceivedDebit {
+          interface BankTransfer {
+            /**
+             * The Financial Address that was debited.
+             */
+            financial_address: string;
+
+            /**
+             * Open Enum. The type of the payment method used to originate the debit.
+             */
+            payment_method_type: 'us_bank_account';
+
+            /**
+             * The statement descriptor set by the originator of the debit.
+             */
+            statement_descriptor?: string;
+
+            /**
+             * The payment method used to originate the debit.
+             */
+            us_bank_account: BankTransfer.UsBankAccount;
+          }
+
+          namespace BankTransfer {
+            interface UsBankAccount {
+              /**
+               * The name of the bank the debit originated from.
+               */
+              bank_name?: string;
+
+              /**
+               * Open Enum. The bank network the debit was originated on.
+               */
+              network: 'ach';
+
+              /**
+               * The routing number of the bank that originated the debit.
+               */
+              routing_number?: string;
+            }
+          }
+
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'pending'
+            | 'returned'
+            | 'succeeded';
+
+          interface StatusDetails {
+            /**
+             * Information that elaborates on the `failed` status of a ReceivedDebit.
+             * It is only present when the ReceivedDebit status is `failed`.
+             */
+            failed: StatusDetails.Failed;
+          }
+
+          namespace StatusDetails {
+            interface Failed {
+              /**
+               * Open Enum. The reason for the failure of the ReceivedDebit.
+               */
+              reason: Failed.Reason;
+            }
+
+            namespace Failed {
+              type Reason =
+                | 'financial_address_inactive'
+                | 'insufficient_funds'
+                | 'stripe_rejected';
+            }
+          }
+
+          interface StatusTransitions {
+            /**
+             * The time when the ReceivedDebit was marked as `canceled`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+             */
+            canceled_at?: string;
+
+            /**
+             * The time when the ReceivedDebit was marked as `failed`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+             */
+            failed_at?: string;
+
+            /**
+             * The time when the ReceivedDebit was marked as `succeeded`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+             */
+            succeeded_at?: string;
+          }
+
+          type Type = 'bank_transfer' | 'external_debit';
+        }
+      }
+    }
+  }
+}

package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface ReceivedDebitRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface ReceivedDebitListParams {
+          /**
+           * The page limit.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace MoneyManagement {
+        class ReceivedDebitsResource {
+          /**
+           * Retrieves a single ReceivedDebit by ID.
+           */
+          retrieve(
+            id: string,
+            params?: ReceivedDebitRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.ReceivedDebit>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.ReceivedDebit>>;
+
+          /**
+           * Retrieves a list of ReceivedDebits, given the selected filters.
+           */
+          list(
+            params?: ReceivedDebitListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.ReceivedDebit>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.ReceivedDebit>;
+        }
+      }
+    }
+  }
+}

package/types/V2/MoneyManagement/TransactionEntries.d.ts

@@ -0,0 +1,162 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * TransactionEntries represent individual money movements across different states within a Transaction.
+         */
+        interface TransactionEntry {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.money_management.transaction_entry';
+
+          /**
+           * The delta to the FinancialAccount's balance.
+           */
+          balance_impact: TransactionEntry.BalanceImpact;
+
+          /**
+           * Time at which the object was created.
+           */
+          created: string;
+
+          /**
+           * Time at which the entry impacted (or will impact if it's in the future) the FinancialAccount balance.
+           */
+          effective_at: string;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * The Transaction that this TransactionEntry belongs to.
+           */
+          transaction: string;
+
+          /**
+           * Details copied from the transaction that this TransactionEntry belongs to.
+           */
+          transaction_details: TransactionEntry.TransactionDetails;
+        }
+
+        namespace TransactionEntry {
+          interface BalanceImpact {
+            /**
+             * Impact to the available balance.
+             */
+            available: Amount;
+
+            /**
+             * Impact to the inbound_pending balance.
+             */
+            inbound_pending: Amount;
+
+            /**
+             * Impact to the outbound_pending balance.
+             */
+            outbound_pending: Amount;
+          }
+
+          interface TransactionDetails {
+            /**
+             * Closed Enum for now, and will be turned into an Open Enum soon. A descriptive category used to classify the Transaction.
+             */
+            category: TransactionDetails.Category;
+
+            /**
+             * Indicates the FinancialAccount affected by this Transaction.
+             */
+            financial_account: string;
+
+            /**
+             * Details about the Flow object that created the Transaction.
+             */
+            flow: TransactionDetails.Flow;
+          }
+
+          namespace TransactionDetails {
+            type Category =
+              | 'adjustment'
+              | 'currency_conversion'
+              | 'inbound_transfer'
+              | 'outbound_payment'
+              | 'outbound_transfer'
+              | 'received_credit'
+              | 'received_debit'
+              | 'return'
+              | 'stripe_fee';
+
+            interface Flow {
+              /**
+               * Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
+               */
+              type: Flow.Type;
+
+              /**
+               * If applicable, the ID of the Adjustment that created this Transaction.
+               */
+              adjustment?: string;
+
+              /**
+               * In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
+               */
+              currency_conversion?: string;
+
+              /**
+               * If applicable, the ID of the FeeTransaction that created this Transaction.
+               */
+              fee_transaction?: string;
+
+              /**
+               * If applicable, the ID of the InboundTransfer that created this Transaction.
+               */
+              inbound_transfer?: string;
+
+              /**
+               * If applicable, the ID of the OutboundPayment that created this Transaction.
+               */
+              outbound_payment?: string;
+
+              /**
+               * If applicable, the ID of the OutboundTransfer that created this Transaction.
+               */
+              outbound_transfer?: string;
+
+              /**
+               * If applicable, the ID of the ReceivedCredit that created this Transaction.
+               */
+              received_credit?: string;
+
+              /**
+               * If applicable, the ID of the ReceivedDebit that created this Transaction.
+               */
+              received_debit?: string;
+            }
+
+            namespace Flow {
+              type Type =
+                | 'adjustment'
+                | 'currency_conversion'
+                | 'fee_transaction'
+                | 'inbound_transfer'
+                | 'outbound_payment'
+                | 'outbound_transfer'
+                | 'received_credit'
+                | 'received_debit';
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface TransactionEntryRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface TransactionEntryListParams {
+          /**
+           * Filter for Transactions created at an exact time.
+           */
+          created?: string;
+
+          /**
+           * Filter for Transactions created after the specified timestamp.
+           */
+          created_gt?: string;
+
+          /**
+           * Filter for Transactions created at or after the specified timestamp.
+           */
+          created_gte?: string;
+
+          /**
+           * Filter for Transactions created before the specified timestamp.
+           */
+          created_lt?: string;
+
+          /**
+           * Filter for Transactions created at or before the specified timestamp.
+           */
+          created_lte?: string;
+
+          /**
+           * The page limit.
+           */
+          limit?: number;
+
+          /**
+           * Filter for TransactionEntries belonging to a Transaction.
+           */
+          transaction?: string;
+        }
+      }
+
+      namespace MoneyManagement {
+        class TransactionEntriesResource {
+          /**
+           * Retrieves the details of a TransactionEntry by ID.
+           */
+          retrieve(
+            id: string,
+            params?: TransactionEntryRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.TransactionEntry>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.TransactionEntry>
+          >;
+
+          /**
+           * Returns a list of TransactionEntries that match the provided filters.
+           */
+          list(
+            params?: TransactionEntryListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.TransactionEntry>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.TransactionEntry>;
+        }
+      }
+    }
+  }
+}

package/types/V2/MoneyManagement/Transactions.d.ts

@@ -0,0 +1,177 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.
+         */
+        interface Transaction {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.money_management.transaction';
+
+          /**
+           * The amount of the Transaction.
+           */
+          amount: Amount;
+
+          /**
+           * The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its
+           * TransactionEntries that have `effective_at`s in the past.
+           */
+          balance_impact: Transaction.BalanceImpact;
+
+          /**
+           * Open Enum. A descriptive category used to classify the Transaction.
+           */
+          category: Transaction.Category;
+
+          /**
+           * Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * Indicates the FinancialAccount affected by this Transaction.
+           */
+          financial_account: string;
+
+          /**
+           * Details about the Flow object that created the Transaction.
+           */
+          flow: Transaction.Flow;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * Closed Enum. Current status of the Transaction.
+           * A Transaction is `pending` if either `balance_impact.inbound_pending` or `balance_impact.outbound_pending` is non-zero.
+           * A Transaction is `posted` if only `balance_impact.available` is non-zero.
+           * A Transaction is `void` if there is no balance impact.
+           * `posted` and `void` are terminal states, and no additional entries will be added to the Transaction.
+           */
+          status: Transaction.Status;
+
+          /**
+           * Timestamps for when the Transaction transitioned to a particular status.
+           */
+          status_transitions: Transaction.StatusTransitions;
+        }
+
+        namespace Transaction {
+          interface BalanceImpact {
+            /**
+             * Impact to the available balance.
+             */
+            available: Amount;
+
+            /**
+             * Impact to the inbound_pending balance.
+             */
+            inbound_pending: Amount;
+
+            /**
+             * Impact to the outbound_pending balance.
+             */
+            outbound_pending: Amount;
+          }
+
+          type Category =
+            | 'adjustment'
+            | 'currency_conversion'
+            | 'inbound_transfer'
+            | 'outbound_payment'
+            | 'outbound_transfer'
+            | 'received_credit'
+            | 'received_debit'
+            | 'return'
+            | 'stripe_fee';
+
+          interface Flow {
+            /**
+             * Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
+             */
+            type: Flow.Type;
+
+            /**
+             * If applicable, the ID of the Adjustment that created this Transaction.
+             */
+            adjustment?: string;
+
+            /**
+             * In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
+             */
+            currency_conversion?: string;
+
+            /**
+             * If applicable, the ID of the FeeTransaction that created this Transaction.
+             */
+            fee_transaction?: string;
+
+            /**
+             * If applicable, the ID of the InboundTransfer that created this Transaction.
+             */
+            inbound_transfer?: string;
+
+            /**
+             * If applicable, the ID of the OutboundPayment that created this Transaction.
+             */
+            outbound_payment?: string;
+
+            /**
+             * If applicable, the ID of the OutboundTransfer that created this Transaction.
+             */
+            outbound_transfer?: string;
+
+            /**
+             * If applicable, the ID of the ReceivedCredit that created this Transaction.
+             */
+            received_credit?: string;
+
+            /**
+             * If applicable, the ID of the ReceivedDebit that created this Transaction.
+             */
+            received_debit?: string;
+          }
+
+          namespace Flow {
+            type Type =
+              | 'adjustment'
+              | 'currency_conversion'
+              | 'fee_transaction'
+              | 'inbound_transfer'
+              | 'outbound_payment'
+              | 'outbound_transfer'
+              | 'received_credit'
+              | 'received_debit';
+          }
+
+          type Status = 'pending' | 'posted' | 'void';
+
+          interface StatusTransitions {
+            /**
+             * The time at which the Transaction became posted. Only present if status == posted.
+             */
+            posted_at?: string;
+
+            /**
+             * The time at which the Transaction became void. Only present if status == void.
+             */
+            void_at?: string;
+          }
+        }
+      }
+    }
+  }
+}