stripe 20.1.0-alpha.4 → 20.1.0

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

@@ -1,306 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Payments {
-        interface OffSessionPaymentCreateParams {
-          /**
-           * The “presentment amount” to be collected from the customer.
-           */
-          amount: OffSessionPaymentCreateParams.Amount;
-
-          /**
-           * The frequency of the underlying payment.
-           */
-          cadence: OffSessionPaymentCreateParams.Cadence;
-
-          /**
-           * ID of the Customer to which this OffSessionPayment belongs.
-           */
-          customer: 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. Learn more about
-           * [storing information in metadata](https://docs.stripe.com/payments/payment-intents#storing-information-in-metadata).
-           */
-          metadata: Stripe.MetadataParam;
-
-          /**
-           * ID of the payment method used in this OffSessionPayment.
-           */
-          payment_method: string;
-
-          /**
-           * Details about the capture configuration for the OffSessionPayment.
-           */
-          capture?: OffSessionPaymentCreateParams.Capture;
-
-          /**
-           * The account (if any) for which the funds of the OffSessionPayment are intended.
-           */
-          on_behalf_of?: string;
-
-          /**
-           * Payment method options for the off-session payment.
-           */
-          payment_method_options?: OffSessionPaymentCreateParams.PaymentMethodOptions;
-
-          /**
-           * Details about the payments orchestration configuration.
-           */
-          payments_orchestration?: OffSessionPaymentCreateParams.PaymentsOrchestration;
-
-          /**
-           * Details about the OffSessionPayment retries.
-           */
-          retry_details?: OffSessionPaymentCreateParams.RetryDetails;
-
-          /**
-           * Text that appears on the customer's statement as the statement descriptor for a
-           * non-card charge. This value overrides the account's default statement descriptor.
-           * For information about requirements, including the 22-character limit, see the
-           * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
-           */
-          statement_descriptor?: string;
-
-          /**
-           * Provides information about a card charge. Concatenated to the account's
-           * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
-           * to form the complete statement descriptor that appears on the customer's statement.
-           */
-          statement_descriptor_suffix?: string;
-
-          /**
-           * Test clock that can be used to advance the retry attempts in a sandbox.
-           */
-          test_clock?: string;
-
-          /**
-           * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.stripe.com/payments/connected-accounts).
-           */
-          transfer_data?: OffSessionPaymentCreateParams.TransferData;
-        }
-
-        namespace OffSessionPaymentCreateParams {
-          interface Amount {
-            /**
-             * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
-             */
-            value?: 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;
-          }
-
-          type Cadence = 'recurring' | 'unscheduled';
-
-          interface Capture {
-            /**
-             * The method to use to capture the payment.
-             */
-            capture_method: Capture.CaptureMethod;
-          }
-
-          namespace Capture {
-            type CaptureMethod = 'automatic' | 'manual';
-          }
-
-          interface PaymentMethodOptions {
-            /**
-             * Payment method options for the card payment type.
-             */
-            card?: PaymentMethodOptions.Card;
-          }
-
-          namespace PaymentMethodOptions {
-            interface Card {
-              /**
-               * If you are making a Credential On File transaction with a previously saved card, you should pass the Network Transaction ID
-               * from a prior initial authorization on Stripe (from a successful SetupIntent or a PaymentIntent with `setup_future_usage` set),
-               * or one that you have obtained from another payment processor. This is a token from the network which uniquely identifies the transaction.
-               * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.
-               * Note that you should pass in a Network Transaction ID if you have one, regardless of whether this is a
-               * Customer-Initiated Transaction (CIT) or a Merchant-Initiated Transaction (MIT).
-               */
-              network_transaction_id: string;
-            }
-          }
-
-          interface PaymentsOrchestration {
-            /**
-             * True when you want to enable payments orchestration for this off-session payment. False otherwise.
-             */
-            enabled: boolean;
-          }
-
-          interface RetryDetails {
-            /**
-             * The pre-configured retry policy to use for the payment.
-             */
-            retry_policy?: string;
-
-            /**
-             * Indicates the strategy for how you want Stripe to retry the payment.
-             */
-            retry_strategy?: RetryDetails.RetryStrategy;
-          }
-
-          namespace RetryDetails {
-            type RetryStrategy = 'best_available' | 'none';
-          }
-
-          interface TransferData {
-            /**
-             * The amount transferred to the destination account. This transfer will occur
-             * automatically after the payment succeeds. If no amount is specified, by default
-             * the entire payment amount is transferred to the destination account. The amount
-             * must be less than or equal to the
-             * [amount_requested](https://docs.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
-             * and must be a positive integer representing how much to transfer in the smallest
-             * currency unit (e.g., 100 cents to charge $1.00).
-             */
-            amount?: number;
-
-            /**
-             * The account (if any) that the payment is attributed to for tax reporting, and
-             * where funds from the payment are transferred to after payment success.
-             */
-            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 {
-        interface OffSessionPaymentCaptureParams {
-          /**
-           * 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. Learn more about
-           * [storing information in metadata](https://docs.stripe.com/payments/payment-intents#storing-information-in-metadata).
-           */
-          metadata: Stripe.MetadataParam;
-
-          /**
-           * The amount to capture.
-           */
-          amount_to_capture?: number;
-
-          /**
-           * Text that appears on the customer's statement as the statement descriptor for a
-           * non-card charge. This value overrides the account's default statement descriptor.
-           * For information about requirements, including the 22-character limit, see the
-           * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
-           */
-          statement_descriptor?: string;
-
-          /**
-           * Provides information about a card charge. Concatenated to the account's
-           * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
-           * to form the complete statement descriptor that appears on the customer's statement.
-           */
-          statement_descriptor_suffix?: string;
-
-          /**
-           * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.stripe.com/payments/connected-accounts).
-           */
-          transfer_data?: OffSessionPaymentCaptureParams.TransferData;
-        }
-
-        namespace OffSessionPaymentCaptureParams {
-          interface TransferData {
-            /**
-             * The amount transferred to the destination account. This transfer will occur
-             * automatically after the payment succeeds. If no amount is specified, by default
-             * the entire payment amount is transferred to the destination account. The amount
-             * must be less than or equal to the
-             * [amount_requested](https://docs.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
-             * and must be a positive integer representing how much to transfer in the smallest
-             * currency unit (e.g., 100 cents to charge $1.00).
-             */
-            amount?: number;
-          }
-        }
-      }
-
-      namespace Payments {
-        class OffSessionPaymentsResource {
-          /**
-           * Creates an OffSessionPayment object.
-           */
-          create(
-            params: OffSessionPaymentCreateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
-
-          /**
-           * Retrieves the details of an OffSessionPayment that has previously been created.
-           */
-          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>>;
-
-          /**
-           * Returns a list of OffSessionPayments matching a filter.
-           */
-          list(
-            params?: OffSessionPaymentListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
-
-          /**
-           * Cancel an OffSessionPayment that has previously been created.
-           */
-          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>>;
-
-          /**
-           * Captures an OffSessionPayment that has previously been created.
-           */
-          capture(
-            id: string,
-            params: OffSessionPaymentCaptureParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
-        }
-      }
-    }
-  }
-}

package/types/V2/Reporting/ReportRuns.d.ts

@@ -1,154 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Reporting {
-        /**
-         * The `ReportRun` object represents an instance of a `Report` generated with specific
-         * run parameters. Once the object is created, Stripe begins processing the report. When
-         * the report has finished running, it will give you a reference to the results.
-         */
-        interface ReportRun {
-          /**
-           * The unique identifier of the `ReportRun` object.
-           */
-          id: string;
-
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.reporting.report_run';
-
-          /**
-           * Time at which the object was created.
-           */
-          created: 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 unique identifier of the `Report` object which was run.
-           */
-          report: string;
-
-          /**
-           * The human-readable name of the `Report` which was run.
-           */
-          report_name: string;
-
-          /**
-           * The parameters used to customize the generation of the report.
-           */
-          report_parameters: ReportRun.ReportParameters;
-
-          /**
-           * Details how to retrieve the results of a successfully completed `ReportRun`.
-           */
-          result?: ReportRun.Result;
-
-          /**
-           * The options specified for customizing the output file of the `ReportRun`.
-           */
-          result_options?: ReportRun.ResultOptions;
-
-          /**
-           * The current status of the `ReportRun`.
-           */
-          status: ReportRun.Status;
-
-          /**
-           * Additional details about the current state of the `ReportRun`. The field is currently only populated when a `ReportRun`
-           * is in the `failed` state, providing more information about why the report failed to generate successfully.
-           */
-          status_details: {
-            [key: string]: ReportRun.StatusDetails;
-          };
-        }
-
-        namespace ReportRun {
-          type ReportParameters = {
-            [key: string]: unknown;
-          };
-
-          interface Result {
-            /**
-             * Contains metadata about the file produced by the `ReportRun`, including
-             * its content type, size, and a URL to download its contents.
-             */
-            file: Result.File;
-
-            /**
-             * The type of the `ReportRun` result.
-             */
-            type: 'file';
-          }
-
-          namespace Result {
-            interface File {
-              /**
-               * The content type of the file.
-               */
-              content_type: File.ContentType;
-
-              /**
-               * A pre-signed URL that allows secure, time-limited access to download the file.
-               */
-              download_url: File.DownloadUrl;
-
-              /**
-               * The total size of the file in bytes.
-               */
-              size: number;
-            }
-
-            namespace File {
-              type ContentType = 'csv' | 'zip';
-
-              interface DownloadUrl {
-                /**
-                 * The time that the URL expires.
-                 */
-                expires_at?: string;
-
-                /**
-                 * The URL that can be used for accessing the file.
-                 */
-                url: string;
-              }
-            }
-          }
-
-          interface ResultOptions {
-            /**
-             * If set, the generated report file will be compressed into a ZIP folder.
-             * This is useful for reducing file size and download time for large reports.
-             */
-            compress_file?: boolean;
-          }
-
-          type Status = 'failed' | 'running' | 'succeeded';
-
-          interface StatusDetails {
-            /**
-             * Error code categorizing the reason the `ReportRun` failed.
-             */
-            error_code?: StatusDetails.ErrorCode;
-
-            /**
-             * Error message with additional details about the failure.
-             */
-            error_message?: string;
-          }
-
-          namespace StatusDetails {
-            type ErrorCode = 'file_size_above_limit' | 'internal_error';
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Reporting/ReportRunsResource.d.ts

@@ -1,75 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Reporting {
-        interface ReportRunCreateParams {
-          /**
-           * The unique identifier of the `Report` being requested.
-           */
-          report: string;
-
-          /**
-           * A map of parameter names to values, specifying how the report should be customized.
-           * The accepted parameters depend on the specific `Report` being run.
-           */
-          report_parameters: ReportRunCreateParams.ReportParameters;
-
-          /**
-           * Optional settings to customize the results of the `ReportRun`.
-           */
-          result_options?: ReportRunCreateParams.ResultOptions;
-        }
-
-        namespace ReportRunCreateParams {
-          type ReportParameters = {
-            [key: string]: unknown;
-          };
-
-          interface ResultOptions {
-            /**
-             * If set, the generated report file will be compressed into a ZIP folder.
-             * This is useful for reducing file size and download time for large reports.
-             */
-            compress_file?: boolean;
-          }
-        }
-      }
-
-      namespace Reporting {
-        interface ReportRunRetrieveParams {}
-      }
-
-      namespace Reporting {
-        class ReportRunsResource {
-          /**
-           * Initiates the generation of a `ReportRun` based on the specified report template
-           * and user-provided parameters. It's the starting point for obtaining report data,
-           * and returns a `ReportRun` object which can be used to track the progress and retrieve
-           * the results of the report.
-           * @throws Stripe.RateLimitError
-           */
-          create(
-            params: ReportRunCreateParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Reporting.ReportRun>>;
-
-          /**
-           * Fetches the current state and details of a previously created `ReportRun`. If the `ReportRun`
-           * has succeeded, the endpoint will provide details for how to retrieve the results.
-           */
-          retrieve(
-            id: string,
-            params?: ReportRunRetrieveParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Reporting.ReportRun>>;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Reporting.ReportRun>>;
-        }
-      }
-    }
-  }
-}

package/types/V2/Reporting/Reports.d.ts

@@ -1,120 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Reporting {
-        /**
-         * The Report resource represents a customizable report template that provides insights into various aspects of your Stripe integration.
-         */
-        interface Report {
-          /**
-           * The unique identifier of the `Report` object.
-           */
-          id: string;
-
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.reporting.report';
-
-          /**
-           * 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 human-readable name of the `Report`.
-           */
-          name: string;
-
-          /**
-           * Specification of the parameters that the `Report` accepts. It details each parameter's
-           * name, description, whether it is required, and any validations performed.
-           */
-          parameters: {
-            [key: string]: Report.Parameters;
-          };
-        }
-
-        namespace Report {
-          interface Parameters {
-            /**
-             * For array parameters, provides details about the array elements.
-             */
-            array_details?: Parameters.ArrayDetails;
-
-            /**
-             * Explains the purpose and usage of the parameter.
-             */
-            description: string;
-
-            /**
-             * For enum parameters, provides the list of allowed values.
-             */
-            enum_details?: Parameters.EnumDetails;
-
-            /**
-             * Indicates whether the parameter must be provided.
-             */
-            required: boolean;
-
-            /**
-             * For timestamp parameters, specifies the allowed date range.
-             */
-            timestamp_details?: Parameters.TimestampDetails;
-
-            /**
-             * The data type of the parameter.
-             */
-            type: Parameters.Type;
-          }
-
-          namespace Parameters {
-            interface ArrayDetails {
-              /**
-               * Data type of the elements in the array.
-               */
-              element_type: 'enum';
-
-              /**
-               * Details about enum elements in the array.
-               */
-              enum_details?: ArrayDetails.EnumDetails;
-            }
-
-            namespace ArrayDetails {
-              interface EnumDetails {
-                /**
-                 * Allowed values of the enum.
-                 */
-                allowed_values: Array<string>;
-              }
-            }
-
-            interface EnumDetails {
-              /**
-               * Allowed values of the enum.
-               */
-              allowed_values: Array<string>;
-            }
-
-            interface TimestampDetails {
-              /**
-               * Maximum permitted timestamp which can be requested.
-               */
-              max: string;
-
-              /**
-               * Minimum permitted timestamp which can be requested.
-               */
-              min: string;
-            }
-
-            type Type = 'array' | 'enum' | 'string' | 'timestamp';
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/Reporting/ReportsResource.d.ts

@@ -1,30 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Reporting {
-        interface ReportRetrieveParams {}
-      }
-
-      namespace Reporting {
-        class ReportsResource {
-          /**
-           * Retrieves metadata about a specific `Report` template, including its name, description,
-           * and the parameters it accepts. It's useful for understanding the capabilities and
-           * requirements of a particular `Report` before requesting a `ReportRun`.
-           */
-          retrieve(
-            id: string,
-            params?: ReportRetrieveParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Reporting.Report>>;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Reporting.Report>>;
-        }
-      }
-    }
-  }
-}