stripe 20.0.0 → 20.1.0-alpha.2

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

@@ -0,0 +1,154 @@
+// 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

@@ -0,0 +1,75 @@
+// 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

@@ -0,0 +1,120 @@
+// 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

@@ -0,0 +1,30 @@
+// 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>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/TestHelpers/FinancialAddressesResource.d.ts

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace TestHelpers {
+        interface FinancialAddressCreditParams {
+          /**
+           * Object containing the amount value and currency to credit.
+           */
+          amount: FinancialAddressCreditParams.Amount;
+
+          /**
+           * Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
+           */
+          network: FinancialAddressCreditParams.Network;
+
+          /**
+           * String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
+           */
+          statement_descriptor?: string;
+        }
+
+        namespace FinancialAddressCreditParams {
+          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 Network =
+            | 'ach'
+            | 'fps'
+            | 'rtp'
+            | 'sepa_credit_transfer'
+            | 'wire';
+        }
+      }
+
+      namespace TestHelpers {
+        interface FinancialAddressGenerateMicrodepositsParams {}
+      }
+
+      namespace TestHelpers {
+        class FinancialAddressesResource {
+          /**
+           * Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          credit(
+            id: string,
+            params: FinancialAddressCreditParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressCreditSimulation>
+          >;
+
+          /**
+           * Generates microdeposits for a FinancialAddress in a Sandbox environment.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          generateMicrodeposits(
+            id: string,
+            params?: FinancialAddressGenerateMicrodepositsParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
+          >;
+          generateMicrodeposits(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
+          >;
+        }
+      }
+    }
+  }
+}

package/types/V2/TestHelpers/MoneyManagementResource.d.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace TestHelpers {
+        interface MoneyManagementRecipientVerificationsParams {
+          /**
+           * Expected match level of the RecipientVerification to be created: `match`, `close_match`, `no_match`, `unavailable`.
+           * For `close_match`, the simulated response appends "close_match" to the provided name in match_result_details.matched_name.
+           */
+          match_result: MoneyManagementRecipientVerificationsParams.MatchResult;
+
+          /**
+           * ID of the payout method.
+           */
+          payout_method: string;
+
+          /**
+           * ID of the recipient account. Required if the recipient distinct from the sender. Leave empty if the recipient and sender are the same entity (i.e. for me-to-me payouts).
+           */
+          recipient?: string;
+        }
+
+        namespace MoneyManagementRecipientVerificationsParams {
+          type MatchResult =
+            | 'close_match'
+            | 'match'
+            | 'no_match'
+            | 'unavailable';
+        }
+      }
+
+      namespace TestHelpers {
+        class MoneyManagementResource {
+          /**
+           * Creates a RecipientVerification with a specified match result for testing purposes in a Sandbox environment.
+           */
+          recipientVerifications(
+            params: MoneyManagementRecipientVerificationsParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+        }
+      }
+    }
+  }
+}