@depup/stripe 21.0.0-depup.0

package/types/FinancialConnections/SessionsResource.d.ts

@@ -0,0 +1,128 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      interface SessionCreateParams {
+        /**
+         * The account holder to link accounts for.
+         */
+        account_holder: SessionCreateParams.AccountHolder;
+
+        /**
+         * List of data features that you would like to request access to.
+         *
+         * Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
+         */
+        permissions: Array<SessionCreateParams.Permission>;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Filters to restrict the kinds of accounts to collect.
+         */
+        filters?: SessionCreateParams.Filters;
+
+        /**
+         * List of data features that you would like to retrieve upon account creation.
+         */
+        prefetch?: Array<SessionCreateParams.Prefetch>;
+
+        /**
+         * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
+         */
+        return_url?: string;
+      }
+
+      namespace SessionCreateParams {
+        interface AccountHolder {
+          /**
+           * The ID of the Stripe account whose accounts you will retrieve. Only available when `type` is `account`.
+           */
+          account?: string;
+
+          /**
+           * The ID of the Stripe customer whose accounts you will retrieve. Only available when `type` is `customer`.
+           */
+          customer?: string;
+
+          /**
+           * The ID of Account representing a customer whose accounts you will retrieve. Only available when `type` is `customer`.
+           */
+          customer_account?: string;
+
+          /**
+           * Type of account holder to collect accounts for.
+           */
+          type: AccountHolder.Type;
+        }
+
+        namespace AccountHolder {
+          type Type = 'account' | 'customer';
+        }
+
+        interface Filters {
+          /**
+           * Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
+           */
+          account_subcategories?: Array<Filters.AccountSubcategory>;
+
+          /**
+           * List of countries from which to collect accounts.
+           */
+          countries?: Array<string>;
+        }
+
+        namespace Filters {
+          type AccountSubcategory =
+            | 'checking'
+            | 'credit_card'
+            | 'line_of_credit'
+            | 'mortgage'
+            | 'savings';
+        }
+
+        type Permission =
+          | 'balances'
+          | 'ownership'
+          | 'payment_method'
+          | 'transactions';
+
+        type Prefetch = 'balances' | 'ownership' | 'transactions';
+      }
+
+      interface SessionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class SessionsResource {
+        /**
+         * To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
+         */
+        create(
+          params: SessionCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Session>>;
+
+        /**
+         * Retrieves the details of a Financial Connections Session
+         */
+        retrieve(
+          id: string,
+          params?: SessionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Session>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Session>>;
+      }
+    }
+  }
+}

package/types/FinancialConnections/Transactions.d.ts

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * A Transaction represents a real transaction that affects a Financial Connections Account balance.
+       */
+      interface Transaction {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.transaction';
+
+        /**
+         * The ID of the Financial Connections Account this transaction belongs to.
+         */
+        account: string;
+
+        /**
+         * The amount of this transaction, in cents (or local equivalent).
+         */
+        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 description of this transaction.
+         */
+        description: string;
+
+        /**
+         * 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 status of the transaction.
+         */
+        status: Transaction.Status;
+
+        status_transitions: Transaction.StatusTransitions;
+
+        /**
+         * Time at which the transaction was transacted. Measured in seconds since the Unix epoch.
+         */
+        transacted_at: number;
+
+        /**
+         * The token of the transaction refresh that last updated or created this transaction.
+         */
+        transaction_refresh: string;
+
+        /**
+         * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+         */
+        updated: number;
+      }
+
+      namespace Transaction {
+        type Status = 'pending' | 'posted' | 'void';
+
+        interface StatusTransitions {
+          /**
+           * Time at which this transaction posted. Measured in seconds since the Unix epoch.
+           */
+          posted_at: number | null;
+
+          /**
+           * Time at which this transaction was voided. Measured in seconds since the Unix epoch.
+           */
+          void_at: number | null;
+        }
+      }
+    }
+  }
+}

package/types/FinancialConnections/TransactionsResource.d.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      interface TransactionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface TransactionListParams extends PaginationParams {
+        /**
+         * The ID of the Financial Connections Account whose transactions will be retrieved.
+         */
+        account: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
+         */
+        transacted_at?: Stripe.RangeQueryParam | number;
+
+        /**
+         * A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:
+         */
+        transaction_refresh?: TransactionListParams.TransactionRefresh;
+      }
+
+      namespace TransactionListParams {
+        interface TransactionRefresh {
+          /**
+           * Return results where the transactions were created or updated by a refresh that took place after this refresh (non-inclusive).
+           */
+          after: string;
+        }
+      }
+
+      class TransactionsResource {
+        /**
+         * Retrieves the details of a Financial Connections Transaction
+         */
+        retrieve(
+          id: string,
+          params?: TransactionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Transaction>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Transaction>>;
+
+        /**
+         * Returns a list of Financial Connections Transaction objects.
+         */
+        list(
+          params: TransactionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.Transaction>;
+      }
+    }
+  }
+}

package/types/Forwarding/Requests.d.ts

@@ -0,0 +1,165 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Forwarding {
+      /**
+       * Instructs Stripe to make a request on your behalf using the destination URL. The destination URL
+       * is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials
+       * provided during onboarding, and injects card details from the payment_method into the request.
+       *
+       * Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers,
+       * before storing the request and response data in the forwarding Request object, which are subject to a
+       * 30-day retention period.
+       *
+       * You can provide a Stripe idempotency key to make sure that requests with the same key result in only one
+       * outbound request. The Stripe idempotency key provided should be unique and different from any idempotency
+       * keys provided on the underlying third-party request.
+       *
+       * Forwarding Requests are synchronous requests that return a response or time out according to
+       * Stripe's limits.
+       *
+       * Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).
+       */
+      interface Request {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'forwarding.request';
+
+        /**
+         * 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;
+
+        /**
+         * 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.
+         */
+        metadata?: Stripe.Metadata | null;
+
+        /**
+         * The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
+         */
+        payment_method: string;
+
+        /**
+         * The field kinds to be replaced in the forwarded request.
+         */
+        replacements: Array<Request.Replacement>;
+
+        /**
+         * Context about the request from Stripe's servers to the destination endpoint.
+         */
+        request_context: Request.RequestContext | null;
+
+        /**
+         * The request that was sent to the destination endpoint. We redact any sensitive fields.
+         */
+        request_details: Request.RequestDetails | null;
+
+        /**
+         * The response that the destination endpoint returned to us. We redact any sensitive fields.
+         */
+        response_details: Request.ResponseDetails | null;
+
+        /**
+         * The destination URL for the forwarded request. Must be supported by the config.
+         */
+        url: string | null;
+      }
+
+      namespace Request {
+        type Replacement =
+          | 'card_cvc'
+          | 'card_expiry'
+          | 'card_number'
+          | 'cardholder_name'
+          | 'request_signature';
+
+        interface RequestContext {
+          /**
+           * The time it took in milliseconds for the destination endpoint to respond.
+           */
+          destination_duration: number;
+
+          /**
+           * The IP address of the destination.
+           */
+          destination_ip_address: string;
+        }
+
+        interface RequestDetails {
+          /**
+           * The body payload to send to the destination endpoint.
+           */
+          body: string;
+
+          /**
+           * The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
+           */
+          headers: Array<RequestDetails.Header>;
+
+          /**
+           * The HTTP method used to call the destination endpoint.
+           */
+          http_method: 'POST';
+        }
+
+        namespace RequestDetails {
+          interface Header {
+            /**
+             * The header name.
+             */
+            name: string;
+
+            /**
+             * The header value.
+             */
+            value: string;
+          }
+        }
+
+        interface ResponseDetails {
+          /**
+           * The response body from the destination endpoint to Stripe.
+           */
+          body: string;
+
+          /**
+           * HTTP headers that the destination endpoint returned.
+           */
+          headers: Array<ResponseDetails.Header>;
+
+          /**
+           * The HTTP status code that the destination endpoint returned.
+           */
+          status: number;
+        }
+
+        namespace ResponseDetails {
+          interface Header {
+            /**
+             * The header name.
+             */
+            name: string;
+
+            /**
+             * The header value.
+             */
+            value: string;
+          }
+        }
+      }
+    }
+  }
+}

package/types/Forwarding/RequestsResource.d.ts

@@ -0,0 +1,127 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Forwarding {
+      interface RequestCreateParams {
+        /**
+         * The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
+         */
+        payment_method: string;
+
+        /**
+         * The field kinds to be replaced in the forwarded request.
+         */
+        replacements: Array<RequestCreateParams.Replacement>;
+
+        /**
+         * The request body and headers to be sent to the destination endpoint.
+         */
+        request: RequestCreateParams.Request;
+
+        /**
+         * The destination URL for the forwarded request. Must be supported by the config.
+         */
+        url: string;
+
+        /**
+         * 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;
+      }
+
+      namespace RequestCreateParams {
+        type Replacement =
+          | 'card_cvc'
+          | 'card_expiry'
+          | 'card_number'
+          | 'cardholder_name'
+          | 'request_signature';
+
+        interface Request {
+          /**
+           * The body payload to send to the destination endpoint.
+           */
+          body?: string;
+
+          /**
+           * The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
+           */
+          headers?: Array<Request.Header>;
+        }
+
+        namespace Request {
+          interface Header {
+            /**
+             * The header name.
+             */
+            name: string;
+
+            /**
+             * The header value.
+             */
+            value: string;
+          }
+        }
+      }
+
+      interface RequestRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface RequestListParams extends PaginationParams {
+        /**
+         * Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
+         */
+        created?: Stripe.RangeQueryParam;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class RequestsResource {
+        /**
+         * Creates a ForwardingRequest object.
+         */
+        create(
+          params: RequestCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Forwarding.Request>>;
+
+        /**
+         * Retrieves a ForwardingRequest object.
+         */
+        retrieve(
+          id: string,
+          params?: RequestRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Forwarding.Request>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Forwarding.Request>>;
+
+        /**
+         * Lists all ForwardingRequest objects.
+         */
+        list(
+          params?: RequestListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Forwarding.Request>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Forwarding.Request>;
+      }
+    }
+  }
+}