stripe 19.2.1 → 19.3.0-alpha.2

package/types/Treasury/ReceivedCredits.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
          */
         network: ReceivedCredit.Network;
 
+        /**
+         * Details specific to the money movement rails.
+         */
+        network_details?: ReceivedCredit.NetworkDetails | null;
+
         /**
          * Details describing when a ReceivedCredit may be reversed.
          */
@@ -251,6 +256,27 @@ declare module 'stripe' {
 
         type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the ReceivedCredit.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReversalDetails {
           /**
            * Time before which a ReceivedCredit can be reversed.

package/types/Treasury/ReceivedDebits.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
          */
         network: ReceivedDebit.Network;
 
+        /**
+         * Details specific to the money movement rails.
+         */
+        network_details?: ReceivedDebit.NetworkDetails | null;
+
         /**
          * Details describing when a ReceivedDebit might be reversed.
          */
@@ -190,10 +195,36 @@ declare module 'stripe' {
            * Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
            */
           payout: string | null;
+
+          /**
+           * The ReceivedCredit that Capital withheld from
+           */
+          received_credit_capital_withholding?: string | null;
         }
 
         type Network = 'ach' | 'card' | 'stripe';
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the ReceivedDebit.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReversalDetails {
           /**
            * Time before which a ReceivedDebit can be reversed.

package/types/V2/Billing/BillSettingVersions.d.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The BillSettingVersion object.
+         */
+        interface BillSettingVersion {
+          /**
+           * The ID of the BillSettingVersion object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.bill_setting_version';
+
+          /**
+           * Settings related to calculating a bill.
+           */
+          calculation?: BillSettingVersion.Calculation;
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: string;
+
+          /**
+           * Settings related to invoice behavior.
+           */
+          invoice?: BillSettingVersion.Invoice;
+
+          /**
+           * The ID of the invoice rendering template to be used when generating invoices.
+           */
+          invoice_rendering_template?: 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;
+        }
+
+        namespace BillSettingVersion {
+          interface Calculation {
+            /**
+             * Settings for calculating tax.
+             */
+            tax?: Calculation.Tax;
+          }
+
+          namespace Calculation {
+            interface Tax {
+              /**
+               * Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+               */
+              type: Tax.Type;
+            }
+
+            namespace Tax {
+              type Type = 'automatic' | 'manual';
+            }
+          }
+
+          interface Invoice {
+            /**
+             * The amount of time until the invoice will be overdue for payment.
+             */
+            time_until_due?: Invoice.TimeUntilDue;
+          }
+
+          namespace Invoice {
+            interface TimeUntilDue {
+              /**
+               * The interval unit for the time until due.
+               */
+              interval: TimeUntilDue.Interval;
+
+              /**
+               * The number of interval units. For example, if interval=day and interval_count=30,
+               * the invoice will be due in 30 days.
+               */
+              interval_count: number;
+            }
+
+            namespace TimeUntilDue {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/BillSettings/VersionsResource.d.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace BillSettings {
+          interface VersionRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace BillSettings {
+          interface VersionListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace BillSettings {
+          class VersionsResource {
+            /**
+             * Retrieve a BillSettingVersion by ID.
+             */
+            retrieve(
+              billSettingId: string,
+              id: string,
+              params?: VersionRetrieveParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.BillSettingVersion>>;
+            retrieve(
+              billSettingId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.BillSettingVersion>>;
+
+            /**
+             * List all BillSettingVersions by BillSetting ID.
+             */
+            list(
+              id: string,
+              params?: VersionListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.BillSettingVersion>;
+            list(
+              id: string,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.BillSettingVersion>;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/BillSettings.d.ts

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * BillSetting is responsible for settings which dictate generating bills, which include settings for calculating totals on bills, tax on bill items, as well as how to generate and present invoices.
+         */
+        interface BillSetting {
+          /**
+           * The ID of the BillSetting object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.bill_setting';
+
+          /**
+           * Settings related to calculating a bill.
+           */
+          calculation?: BillSetting.Calculation;
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: string;
+
+          /**
+           * An optional field for adding a display name for the BillSetting object.
+           */
+          display_name?: string;
+
+          /**
+           * Settings related to invoice behavior.
+           */
+          invoice?: BillSetting.Invoice;
+
+          /**
+           * The ID of the invoice rendering template to be used when generating invoices.
+           */
+          invoice_rendering_template?: string;
+
+          /**
+           * The latest version of the current settings object. This will be
+           * Updated every time an attribute of the settings is updated.
+           */
+          latest_version: string;
+
+          /**
+           * The current live version of the settings object. This can be different from
+           * latest_version if settings are updated without setting live_version='latest'.
+           */
+          live_version: 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;
+
+          /**
+           * A lookup key used to retrieve settings dynamically from a static string.
+           * This may be up to 200 characters.
+           */
+          lookup_key?: string;
+        }
+
+        namespace BillSetting {
+          interface Calculation {
+            /**
+             * Settings for calculating tax.
+             */
+            tax?: Calculation.Tax;
+          }
+
+          namespace Calculation {
+            interface Tax {
+              /**
+               * Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+               */
+              type: Tax.Type;
+            }
+
+            namespace Tax {
+              type Type = 'automatic' | 'manual';
+            }
+          }
+
+          interface Invoice {
+            /**
+             * The amount of time until the invoice will be overdue for payment.
+             */
+            time_until_due?: Invoice.TimeUntilDue;
+          }
+
+          namespace Invoice {
+            interface TimeUntilDue {
+              /**
+               * The interval unit for the time until due.
+               */
+              interval: TimeUntilDue.Interval;
+
+              /**
+               * The number of interval units. For example, if interval=day and interval_count=30,
+               * the invoice will be due in 30 days.
+               */
+              interval_count: number;
+            }
+
+            namespace TimeUntilDue {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/BillSettingsResource.d.ts

@@ -0,0 +1,241 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface BillSettingCreateParams {
+          /**
+           * Settings related to calculating a bill.
+           */
+          calculation?: BillSettingCreateParams.Calculation;
+
+          /**
+           * An optional customer-facing display name for the CollectionSetting object.
+           * Maximum length of 250 characters.
+           */
+          display_name?: string;
+
+          /**
+           * Settings related to invoice behavior.
+           */
+          invoice?: BillSettingCreateParams.Invoice;
+
+          /**
+           * The ID of the invoice rendering template to be used when generating invoices.
+           */
+          invoice_rendering_template?: string;
+
+          /**
+           * A lookup key used to retrieve settings dynamically from a static string.
+           * This may be up to 200 characters.
+           */
+          lookup_key?: string;
+        }
+
+        namespace BillSettingCreateParams {
+          interface Calculation {
+            /**
+             * Settings for calculating tax.
+             */
+            tax?: Calculation.Tax;
+          }
+
+          namespace Calculation {
+            interface Tax {
+              /**
+               * Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+               */
+              type: Tax.Type;
+            }
+
+            namespace Tax {
+              type Type = 'automatic' | 'manual';
+            }
+          }
+
+          interface Invoice {
+            /**
+             * The amount of time until the invoice will be overdue for payment.
+             */
+            time_until_due?: Invoice.TimeUntilDue;
+          }
+
+          namespace Invoice {
+            interface TimeUntilDue {
+              /**
+               * The interval unit for the time until due.
+               */
+              interval: TimeUntilDue.Interval;
+
+              /**
+               * The number of interval units. For example, if interval=day and interval_count=30,
+               * the invoice will be due in 30 days.
+               */
+              interval_count: number;
+            }
+
+            namespace TimeUntilDue {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+          }
+        }
+      }
+
+      namespace Billing {
+        interface BillSettingRetrieveParams {}
+      }
+
+      namespace Billing {
+        interface BillSettingUpdateParams {
+          /**
+           * Settings related to calculating a bill.
+           */
+          calculation?: BillSettingUpdateParams.Calculation;
+
+          /**
+           * An optional customer-facing display name for the BillSetting object.
+           * To remove the display name, set it to an empty string in the request.
+           * Maximum length of 250 characters.
+           */
+          display_name?: string;
+
+          /**
+           * Settings related to invoice behavior.
+           */
+          invoice?: BillSettingUpdateParams.Invoice;
+
+          /**
+           * The ID of the invoice rendering template to be used when generating invoices.
+           */
+          invoice_rendering_template?: string;
+
+          /**
+           * Optionally change the live version of the BillSetting. Providing `live_version = "latest"` will set the
+           * BillSetting' `live_version` to its latest version.
+           */
+          live_version?: string;
+
+          /**
+           * A lookup key used to retrieve settings dynamically from a static string.
+           * This may be up to 200 characters.
+           */
+          lookup_key?: string;
+        }
+
+        namespace BillSettingUpdateParams {
+          interface Calculation {
+            /**
+             * Settings for calculating tax.
+             */
+            tax?: Calculation.Tax;
+          }
+
+          namespace Calculation {
+            interface Tax {
+              /**
+               * Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+               */
+              type: Tax.Type;
+            }
+
+            namespace Tax {
+              type Type = 'automatic' | 'manual';
+            }
+          }
+
+          interface Invoice {
+            /**
+             * The amount of time until the invoice will be overdue for payment.
+             */
+            time_until_due?: Invoice.TimeUntilDue;
+          }
+
+          namespace Invoice {
+            interface TimeUntilDue {
+              /**
+               * The interval unit for the time until due.
+               */
+              interval: TimeUntilDue.Interval;
+
+              /**
+               * The number of interval units. For example, if interval=day and interval_count=30,
+               * the invoice will be due in 30 days.
+               */
+              interval_count: number;
+            }
+
+            namespace TimeUntilDue {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+          }
+        }
+      }
+
+      namespace Billing {
+        interface BillSettingListParams {
+          /**
+           * Optionally set the maximum number of results per page. Defaults to 20.
+           */
+          limit?: number;
+
+          /**
+           * Only return the settings with these lookup_keys, if any exist.
+           * You can specify up to 10 lookup_keys.
+           */
+          lookup_keys?: Array<string>;
+        }
+      }
+
+      namespace Billing {
+        class BillSettingsResource {
+          versions: Stripe.V2.Billing.BillSettings.VersionsResource;
+
+          /**
+           * Create a BillSetting object.
+           */
+          create(
+            params?: BillSettingCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.BillSetting>>;
+          create(
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.BillSetting>>;
+
+          /**
+           * Retrieve a BillSetting object by ID.
+           */
+          retrieve(
+            id: string,
+            params?: BillSettingRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.BillSetting>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.BillSetting>>;
+
+          /**
+           * Update fields on an existing BillSetting object.
+           */
+          update(
+            id: string,
+            params?: BillSettingUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.BillSetting>>;
+
+          /**
+           * List all BillSetting objects.
+           */
+          list(
+            params?: BillSettingListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.BillSetting>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Billing.BillSetting>;
+        }
+      }
+    }
+  }
+}