stripe 22.2.0 → 22.3.0-beta.1

package/cjs/resources/V2/Billing/BillSettings.d.ts

@@ -0,0 +1,284 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+import { VersionResource } from './BillSettings/Versions.js';
+import { Stripe } from '../../../stripe.core.js';
+export declare class BillSettingResource extends StripeResource {
+    private readonly stripe;
+    versions: VersionResource;
+    constructor(stripe: Stripe);
+    /**
+     * List all BillSetting objects.
+     */
+    list(params?: V2.Billing.BillSettingListParams, options?: RequestOptions): V2ListPromise<BillSetting>;
+    /**
+     * Create a BillSetting object.
+     */
+    create(params?: V2.Billing.BillSettingCreateParams, options?: RequestOptions): Promise<Response<BillSetting>>;
+    /**
+     * Retrieve a BillSetting object by ID.
+     */
+    retrieve(id: string, params?: V2.Billing.BillSettingRetrieveParams, options?: RequestOptions): Promise<Response<BillSetting>>;
+    /**
+     * Update fields on an existing BillSetting object.
+     */
+    update(id: string, params?: V2.Billing.BillSettingUpdateParams, options?: RequestOptions): Promise<Response<BillSetting>>;
+}
+export 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?: V2.Billing.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?: V2.Billing.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 is
+     * 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;
+}
+export declare namespace V2 {
+    namespace Billing {
+        namespace BillSetting {
+            interface Calculation {
+                /**
+                 * Settings for calculating tax.
+                 */
+                tax?: Calculation.Tax;
+            }
+            interface Invoice {
+                /**
+                 * The amount of time until the invoice is overdue for payment.
+                 */
+                time_until_due?: Invoice.TimeUntilDue;
+            }
+            namespace Calculation {
+                interface Tax {
+                    /**
+                     * Determines if tax is calculated automatically based on a PTC or manually based on rules defined by the business. Defaults to "manual".
+                     */
+                    type: Tax.Type;
+                }
+                namespace Tax {
+                    type Type = 'automatic' | 'manual';
+                }
+            }
+            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 is due in 30 days.
+                     */
+                    interval_count: number;
+                }
+                namespace TimeUntilDue {
+                    type Interval = 'day' | 'month' | 'week' | 'year';
+                }
+            }
+        }
+    }
+}
+export declare 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;
+            }
+            interface Invoice {
+                /**
+                 * The amount of time until the invoice is overdue for payment.
+                 */
+                time_until_due?: Invoice.TimeUntilDue;
+            }
+            namespace Calculation {
+                interface Tax {
+                    /**
+                     * Determines if tax is calculated automatically based on a PTC or manually based on rules defined by the business. Defaults to "manual".
+                     */
+                    type: Tax.Type;
+                }
+                namespace Tax {
+                    type Type = 'automatic' | 'manual';
+                }
+            }
+            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 is due in 30 days.
+                     */
+                    interval_count: number;
+                }
+                namespace TimeUntilDue {
+                    type Interval = 'day' | 'month' | 'week' | 'year';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        interface BillSettingRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    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"` sets 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;
+            }
+            interface Invoice {
+                /**
+                 * The amount of time until the invoice is overdue for payment.
+                 */
+                time_until_due?: Invoice.TimeUntilDue;
+            }
+            namespace Calculation {
+                interface Tax {
+                    /**
+                     * Determines if tax is calculated automatically based on a PTC or manually based on rules defined by the business. Defaults to "manual".
+                     */
+                    type: Tax.Type;
+                }
+                namespace Tax {
+                    type Type = 'automatic' | 'manual';
+                }
+            }
+            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 is due in 30 days.
+                     */
+                    interval_count: number;
+                }
+                namespace TimeUntilDue {
+                    type Interval = 'day' | 'month' | 'week' | 'year';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    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>;
+        }
+    }
+}

package/cjs/resources/V2/Billing/BillSettings.js

@@ -0,0 +1,41 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillSettingResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+const Versions_js_1 = require("./BillSettings/Versions.js");
+class BillSettingResource extends StripeResource_js_1.StripeResource {
+    constructor(stripe) {
+        super(stripe);
+        this.stripe = stripe;
+        this.versions = new Versions_js_1.VersionResource(stripe);
+    }
+    /**
+     * List all BillSetting objects.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/billing/bill_settings', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create a BillSetting object.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/billing/bill_settings', params, options);
+    }
+    /**
+     * Retrieve a BillSetting object by ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/billing/bill_settings/${id}`, params, options);
+    }
+    /**
+     * Update fields on an existing BillSetting object.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/billing/bill_settings/${id}`, params, options);
+    }
+}
+exports.BillSettingResource = BillSettingResource;
+//# sourceMappingURL=BillSettings.js.map

package/cjs/resources/V2/Billing/BillSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BillSettings.js","sourceRoot":"","sources":["../../../../src/resources/V2/Billing/BillSettings.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAE1D,4DAA2D;AAE3D,MAAa,mBAAoB,SAAQ,kCAAc;IAGrD,YAA6B,MAAc;QACzC,KAAK,CAAC,MAAM,CAAC,CAAC;QADa,WAAM,GAAN,MAAM,CAAQ;QAEzC,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAe,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,2BAA2B,EAC3B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,2BAA2B,EAC3B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,6BAA6B,EAAE,EAAE,EACjC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,6BAA6B,EAAE,EAAE,EACjC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AApED,kDAoEC"}