stripe 18.2.0 → 18.3.0-beta.1

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,170 @@
+// 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'
+            | '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 | null;
+
+            /**
+             * If applicable, the ID of the FeeTransaction that created this Transaction.
+             */
+            fee_transaction: string | null;
+
+            /**
+             * If applicable, the ID of the InboundTransfer that created this Transaction.
+             */
+            inbound_transfer: string | null;
+
+            /**
+             * If applicable, the ID of the OutboundPayment that created this Transaction.
+             */
+            outbound_payment: string | null;
+
+            /**
+             * If applicable, the ID of the OutboundTransfer that created this Transaction.
+             */
+            outbound_transfer: string | null;
+
+            /**
+             * If applicable, the ID of the ReceivedCredit that created this Transaction.
+             */
+            received_credit: string | null;
+
+            /**
+             * If applicable, the ID of the ReceivedDebit that created this Transaction.
+             */
+            received_debit: string | null;
+          }
+
+          namespace Flow {
+            type Type =
+              | 'adjustment'
+              | '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 | null;
+
+            /**
+             * The time at which the Transaction became void. Only present if status == void.
+             */
+            void_at: string | null;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,83 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface TransactionRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface TransactionListParams {
+          /**
+           * 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;
+
+          /**
+           * Filter for Transactions belonging to a FinancialAccount.
+           */
+          financial_account?: string;
+
+          /**
+           * Filter for Transactions corresponding to a Flow.
+           */
+          flow?: string;
+
+          /**
+           * The page limit.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace MoneyManagement {
+        class TransactionsResource {
+          /**
+           * Retrieves the details of a Transaction by ID.
+           */
+          retrieve(
+            id: string,
+            params?: TransactionRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Transaction>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Transaction>>;
+
+          /**
+           * Returns a list of Transactions that match the provided filters.
+           */
+          list(
+            params?: TransactionListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.Transaction>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.Transaction>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Payments/OffSessionPayments.d.ts

@@ -0,0 +1,167 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Payments {
+        /**
+         * Off-session payment resource.
+         */
+        interface OffSessionPayment {
+          /**
+           * ID of the OSP.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.payments.off_session_payment';
+
+          /**
+           * The amount you requested to be collected on the OSP upon creation.
+           */
+          amount_requested: Amount;
+
+          /**
+           * Number of authorization attempts.
+           */
+          attempts: number;
+
+          /**
+           * The frequency of the underlying payment that this OSP represents.
+           */
+          cadence: OffSessionPayment.Cadence;
+
+          /**
+           * ID of owning compartment.
+           */
+          compartment_id: string;
+
+          /**
+           * Timestamp of creation.
+           */
+          created: string;
+
+          /**
+           * Customer owning the supplied payment method.
+           */
+          customer: string;
+
+          /**
+           * Reason why the OSP failed.
+           */
+          failure_reason: OffSessionPayment.FailureReason | null;
+
+          /**
+           * Last error returned by the financial partner for a failed authorization.
+           */
+          last_authorization_attempt_error: string | null;
+
+          /**
+           * Payment attempt record for the latest attempt, if one exists.
+           */
+          latest_payment_attempt_record: string | null;
+
+          /**
+           * True if the txn is livemode, false otherwise.
+           */
+          livemode: boolean;
+
+          /**
+           * Metadata you provided.
+           */
+          metadata: Stripe.Metadata;
+
+          /**
+           * OBO, same as on the PI.
+           */
+          on_behalf_of: string | null;
+
+          /**
+           * ID of payment method.
+           */
+          payment_method: string;
+
+          /**
+           * Payment record associated with the OSP. consistent across attempts.
+           */
+          payment_record: string | null;
+
+          /**
+           * Details about the OSP retries.
+           */
+          retry_details: OffSessionPayment.RetryDetails;
+
+          /**
+           * Statement descriptor you provided.
+           */
+          statement_descriptor: string | null;
+
+          /**
+           * Statement descriptor suffix you provided, similar to that on the PI.
+           */
+          statement_descriptor_suffix: string | null;
+
+          /**
+           * Status of the OSP.
+           */
+          status: OffSessionPayment.Status;
+
+          /**
+           * Test clock to be used to advance the retry attempts.
+           */
+          test_clock: string | null;
+
+          /**
+           * Instructions for the transfer to be made with this OSP after successful money movement.
+           */
+          transfer_data: OffSessionPayment.TransferData | null;
+        }
+
+        namespace OffSessionPayment {
+          type Cadence = 'recurring' | 'unscheduled';
+
+          type FailureReason = 'rejected_by_partner' | 'retries_exhausted';
+
+          interface RetryDetails {
+            /**
+             * Number of authorization attempts so far.
+             */
+            attempts: number;
+
+            /**
+             * How you want Stripe to retry the payment.
+             */
+            retry_strategy: RetryDetails.RetryStrategy;
+          }
+
+          namespace RetryDetails {
+            type RetryStrategy = 'none' | 'smart';
+          }
+
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'pending'
+            | 'pending_retry'
+            | 'processing'
+            | 'requires_capture'
+            | 'succeeded';
+
+          interface TransferData {
+            /**
+             * Amount in minor units that you want to transfer.
+             */
+            amount: number;
+
+            /**
+             * ID of the connected account where you want money to go.
+             */
+            destination: string;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Payments/OffSessionPaymentsResource.d.ts

@@ -0,0 +1,159 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Payments {
+        interface OffSessionPaymentCreateParams {
+          /**
+           * Amount you want to collect.
+           */
+          amount: Amount;
+
+          /**
+           * The frequency of the OSP.
+           */
+          cadence: OffSessionPaymentCreateParams.Cadence;
+
+          /**
+           * Customer that owns the provided payment method.
+           */
+          customer: string;
+
+          /**
+           * Any of your internal data you want to track here.
+           */
+          metadata: Stripe.MetadataParam;
+
+          /**
+           * Payment method you want to debit. Must be attached to a customer and set up for off-session usage.
+           */
+          payment_method: string;
+
+          /**
+           * The OBO merchant you want to use.
+           */
+          on_behalf_of?: string;
+
+          /**
+           * How you want stripe to retry the OSP.
+           */
+          retry_details?: OffSessionPaymentCreateParams.RetryDetails;
+
+          /**
+           * String you want to appear on your customer's statement.
+           */
+          statement_descriptor?: string;
+
+          /**
+           * Suffix appended to your account level descriptor.
+           */
+          statement_descriptor_suffix?: string;
+
+          /**
+           * Test clock to be used for testing your retry handling. Only usable in a sandbox.
+           */
+          test_clock?: string;
+
+          /**
+           * How you want to transfer the funds to your connected accounts.
+           */
+          transfer_data?: OffSessionPaymentCreateParams.TransferData;
+        }
+
+        namespace OffSessionPaymentCreateParams {
+          type Cadence = 'recurring' | 'unscheduled';
+
+          interface RetryDetails {
+            /**
+             * How you want Stripe to retry the payment.
+             */
+            retry_strategy: RetryDetails.RetryStrategy;
+          }
+
+          namespace RetryDetails {
+            type RetryStrategy = 'none' | 'smart';
+          }
+
+          interface TransferData {
+            /**
+             * Amount in minor units that you want to transfer.
+             */
+            amount: number;
+
+            /**
+             * ID of the connected account where you want money to go.
+             */
+            destination: string;
+          }
+        }
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentRetrieveParams {}
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentListParams {
+          /**
+           * The page size limit, if not provided the default is 20.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentCancelParams {}
+      }
+
+      namespace Payments {
+        class OffSessionPaymentsResource {
+          /**
+           * Create OSP.
+           */
+          create(
+            params: OffSessionPaymentCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * Retrieve OSP by ID.
+           */
+          retrieve(
+            id: string,
+            params?: OffSessionPaymentRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * List OSPs matching filter.
+           */
+          list(
+            params?: OffSessionPaymentListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
+
+          /**
+           * Cancel OSP.
+           */
+          cancel(
+            id: string,
+            params?: OffSessionPaymentCancelParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+        }
+      }
+    }
+  }
+}