stripe 18.5.0 → 18.6.0-alpha.1

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';
+        }
+      }
+    }
+  }
+}

package/types/V2/Tax/AutomaticRulesResource.d.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Tax {
+        interface AutomaticRuleCreateParams {
+          /**
+           * The BillableItem ID to set automatic Tax configuration for.
+           */
+          billable_item: string;
+
+          /**
+           * The TaxCode object to be used for automatic tax calculations.
+           */
+          tax_code: string;
+        }
+      }
+
+      namespace Tax {
+        interface AutomaticRuleRetrieveParams {}
+      }
+
+      namespace Tax {
+        interface AutomaticRuleUpdateParams {
+          /**
+           * The TaxCode object to be used for automatic tax calculations.
+           */
+          tax_code: string;
+        }
+      }
+
+      namespace Tax {
+        interface AutomaticRuleDeactivateParams {}
+      }
+
+      namespace Tax {
+        interface AutomaticRuleFindParams {
+          /**
+           * The BillableItem ID to search by.
+           */
+          billable_item: string;
+        }
+      }
+
+      namespace Tax {
+        class AutomaticRulesResource {
+          /**
+           * Creates an AutomaticRule object.
+           */
+          create(
+            params: AutomaticRuleCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Retrieves an AutomaticRule object by ID.
+           */
+          retrieve(
+            id: string,
+            params?: AutomaticRuleRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Updates the automatic Tax configuration for an AutomaticRule object.
+           */
+          update(
+            id: string,
+            params: AutomaticRuleUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Deactivates an AutomaticRule object. Deactivated AutomaticRule objects are ignored in future tax calculations.
+           */
+          deactivate(
+            id: string,
+            params?: AutomaticRuleDeactivateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+          deactivate(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Finds an AutomaticRule object by BillableItem ID.
+           */
+          find(
+            params: AutomaticRuleFindParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,68 @@
+// 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: 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 {
+          type Network = 'ach' | 'fps' | 'rtp' | '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>
+          >;
+        }
+      }
+    }
+  }
+}