stripe 18.5.0-beta.2 → 18.6.0-alpha.1

package/types/V2/Events.d.ts

@@ -4,6 +4,8 @@ declare module 'stripe' {
   namespace Stripe {
     namespace V2 {
       namespace Event {
+        interface Changes {}
+
         interface Reason {
           /**
            * Event reason type.
@@ -45,6 +47,11 @@ declare module 'stripe' {
          */
         object: 'v2.core.event';
 
+        /**
+         * Before and after changes for the primary related object.
+         */
+        changes: Event.Changes;
+
         /**
          * Authentication context needed to fetch the event or related object.
          */

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

@@ -5,7 +5,7 @@ declare module 'stripe' {
     namespace V2 {
       namespace MoneyManagement {
         /**
-         * The Financial Account is the container that allows for the configuration of money movement.
+         * A FinancialAccount represents a balance and can be used as the source or destination for the money management (`/v2/money_management`) APIs.
          */
         interface FinancialAccount {
           /**
@@ -33,13 +33,18 @@ declare module 'stripe' {
            */
           created: string;
 
+          /**
+           * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+           */
+          display_name: string | null;
+
           /**
            * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
            */
           livemode: boolean;
 
           /**
-           * Metadata associated with the FinancialAccount
+           * Metadata associated with the FinancialAccount.
            */
           metadata: Stripe.Metadata | null;
 

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

@@ -10,6 +10,11 @@ declare module 'stripe' {
            */
           type: 'storage';
 
+          /**
+           * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+           */
+          display_name?: string;
+
           /**
            * Metadata associated with the FinancialAccount.
            */

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

@@ -5,7 +5,7 @@ declare module 'stripe' {
     namespace V2 {
       namespace MoneyManagement {
         /**
-         * OutboundPaymentQuote represents a quote
+         * OutboundPaymentQuote represents a quote that provides fee and amount estimates for OutboundPayment.
          */
         interface OutboundPaymentQuote {
           /**

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

@@ -87,6 +87,7 @@ declare module 'stripe' {
           namespace TransactionDetails {
             type Category =
               | 'adjustment'
+              | 'currency_conversion'
               | 'inbound_transfer'
               | 'outbound_payment'
               | 'outbound_transfer'
@@ -106,6 +107,11 @@ declare module 'stripe' {
                */
               adjustment: string | null;
 
+              /**
+               * 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 | null;
+
               /**
                * If applicable, the ID of the FeeTransaction that created this Transaction.
                */
@@ -140,6 +146,7 @@ declare module 'stripe' {
             namespace Flow {
               type Type =
                 | 'adjustment'
+                | 'currency_conversion'
                 | 'fee_transaction'
                 | 'inbound_transfer'
                 | 'outbound_payment'

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

@@ -89,6 +89,7 @@ declare module 'stripe' {
 
           type Category =
             | 'adjustment'
+            | 'currency_conversion'
             | 'inbound_transfer'
             | 'outbound_payment'
             | 'outbound_transfer'
@@ -108,6 +109,11 @@ declare module 'stripe' {
              */
             adjustment: string | null;
 
+            /**
+             * 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 | null;
+
             /**
              * If applicable, the ID of the FeeTransaction that created this Transaction.
              */
@@ -142,6 +148,7 @@ declare module 'stripe' {
           namespace Flow {
             type Type =
               | 'adjustment'
+              | 'currency_conversion'
               | 'fee_transaction'
               | 'inbound_transfer'
               | 'outbound_payment'

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

@@ -0,0 +1,178 @@
+// 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: {
+            [key: string]: ReportRun.ReportParameters;
+          };
+
+          /**
+           * Details how to retrieve the results of a successfully completed `ReportRun`.
+           */
+          result: ReportRun.Result | null;
+
+          /**
+           * The options specified for customizing the output file of the `ReportRun`.
+           */
+          result_options: ReportRun.ResultOptions | null;
+
+          /**
+           * 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 {
+          interface ReportParameters {
+            /**
+             * Parameter with an array data type.
+             */
+            array_value: ReportParameters.ArrayValue | null;
+
+            /**
+             * Parameter with a string data type.
+             */
+            string_value: string | null;
+
+            /**
+             * Parameter with a timestamp data type.
+             */
+            timestamp_value: string | null;
+          }
+
+          namespace ReportParameters {
+            interface ArrayValue {
+              /**
+               * The list of string values in the array.
+               */
+              items: Array<string>;
+            }
+          }
+
+          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 | null;
+
+                /**
+                 * 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 | null;
+          }
+
+          type Status = 'failed' | 'running' | 'succeeded';
+
+          interface StatusDetails {
+            /**
+             * Error code categorizing the reason the `ReportRun` failed.
+             */
+            error_code: StatusDetails.ErrorCode | null;
+
+            /**
+             * Error message with additional details about the failure.
+             */
+            error_message: string | null;
+          }
+
+          namespace StatusDetails {
+            type ErrorCode = 'file_size_above_limit' | 'internal_error';
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,99 @@
+// 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: {
+            [key: string]: ReportRunCreateParams.ReportParameters;
+          };
+
+          /**
+           * Optional settings to customize the results of the `ReportRun`.
+           */
+          result_options?: ReportRunCreateParams.ResultOptions;
+        }
+
+        namespace ReportRunCreateParams {
+          interface ReportParameters {
+            /**
+             * Parameter with an array data type.
+             */
+            array_value?: ReportParameters.ArrayValue;
+
+            /**
+             * Parameter with a string data type.
+             */
+            string_value?: string;
+
+            /**
+             * Parameter with a timestamp data type.
+             */
+            timestamp_value?: string;
+          }
+
+          namespace ReportParameters {
+            interface ArrayValue {
+              /**
+               * The list of string values in the array.
+               */
+              items: Array<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;
+          }
+        }
+      }
+
+      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 | null;
+
+            /**
+             * Explains the purpose and usage of the parameter.
+             */
+            description: string;
+
+            /**
+             * For enum parameters, provides the list of allowed values.
+             */
+            enum_details: Parameters.EnumDetails | null;
+
+            /**
+             * Indicates whether the parameter must be provided.
+             */
+            required: boolean;
+
+            /**
+             * For timestamp parameters, specifies the allowed date range.
+             */
+            timestamp_details: Parameters.TimestampDetails | null;
+
+            /**
+             * 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 | null;
+            }
+
+            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/Tax/AutomaticRules.d.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Tax {
+        /**
+         * An AutomaticRule holds automatic Tax configuration for a BillableItem.
+         */
+        interface AutomaticRule {
+          /**
+           * The ID of the AutomaticRule object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.tax.automatic_rule';
+
+          /**
+           * The ID of the BillableItem.
+           */
+          billable_item: string;
+
+          /**
+           * The time at which the AutomaticRule 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 status of the AutomaticRule object.
+           */
+          status: AutomaticRule.Status;
+
+          /**
+           * A TaxCode object that will be used for automatic tax calculations.
+           */
+          tax_code: string;
+        }
+
+        namespace AutomaticRule {
+          type Status = 'active' | 'inactive';
+        }
+      }
+    }
+  }
+}