@metronome/sdk 0.1.0-beta.9 → 0.1.0

package/resources/v1/customers/alerts.js

@@ -7,12 +7,27 @@ class Alerts extends resource_1.APIResource {
     /**
      * Get the customer alert status and alert information for the specified customer
      * and alert
+     *
+     * @example
+     * ```ts
+     * const alert = await client.v1.customers.alerts.retrieve({
+     *   alert_id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/customer-alerts/get', { body, ...options });
     }
     /**
      * Fetch all customer alert statuses and alert information for a customer
+     *
+     * @example
+     * ```ts
+     * const alerts = await client.v1.customers.alerts.list({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
      */
     list(params, options) {
         const { next_page, ...body } = params;
@@ -20,6 +35,14 @@ class Alerts extends resource_1.APIResource {
     }
     /**
      * Reset state for an alert by customer id and force re-evaluation
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.alerts.reset({
+     *   alert_id: '5e8691bf-b22a-4672-922d-f80eee940f01',
+     *   customer_id: '4c83caf3-8af4-44e2-9aeb-e290531726d9',
+     * });
+     * ```
      */
     reset(body, options) {
         return this._client.post('/v1/customer-alerts/reset', {

package/resources/v1/customers/alerts.js.map

@@ -1 +1 @@
-{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAIhD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;OAGG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAuB,EAAE,OAA6B;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,wBA2BC"}
+{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAIhD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,MAAuB,EAAE,OAA6B;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAlDD,wBAkDC"}

package/resources/v1/customers/alerts.mjs

@@ -4,12 +4,27 @@ export class Alerts extends APIResource {
     /**
      * Get the customer alert status and alert information for the specified customer
      * and alert
+     *
+     * @example
+     * ```ts
+     * const alert = await client.v1.customers.alerts.retrieve({
+     *   alert_id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/customer-alerts/get', { body, ...options });
     }
     /**
      * Fetch all customer alert statuses and alert information for a customer
+     *
+     * @example
+     * ```ts
+     * const alerts = await client.v1.customers.alerts.list({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
      */
     list(params, options) {
         const { next_page, ...body } = params;
@@ -17,6 +32,14 @@ export class Alerts extends APIResource {
     }
     /**
      * Reset state for an alert by customer id and force re-evaluation
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.alerts.reset({
+     *   alert_id: '5e8691bf-b22a-4672-922d-f80eee940f01',
+     *   customer_id: '4c83caf3-8af4-44e2-9aeb-e290531726d9',
+     * });
+     * ```
      */
     reset(body, options) {
         return this._client.post('/v1/customer-alerts/reset', {

package/resources/v1/customers/alerts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAuB,EAAE,OAA6B;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,MAAuB,EAAE,OAA6B;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/v1/customers/billing-config.d.ts

@@ -3,15 +3,42 @@ import * as Core from "../../../core.js";
 export declare class BillingConfig extends APIResource {
     /**
      * Set the billing configuration for a given customer.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.billingConfig.create({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   billing_provider_type: 'stripe',
+     *   billing_provider_customer_id: 'cus_AJ6y20bjkOOayM',
+     *   stripe_collection_method: 'charge_automatically',
+     * });
+     * ```
      */
     create(params: BillingConfigCreateParams, options?: Core.RequestOptions): Core.APIPromise<void>;
     /**
      * Fetch the billing configuration for the given customer.
+     *
+     * @example
+     * ```ts
+     * const billingConfig =
+     *   await client.v1.customers.billingConfig.retrieve({
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     billing_provider_type: 'stripe',
+     *   });
+     * ```
      */
     retrieve(params: BillingConfigRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<BillingConfigRetrieveResponse>;
     /**
      * Delete the billing configuration for a given customer. Note: this is unsupported
      * for Azure and AWS Marketplace customers.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.billingConfig.delete({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   billing_provider_type: 'stripe',
+     * });
+     * ```
      */
     delete(params: BillingConfigDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void>;
 }
@@ -26,6 +53,10 @@ export declare namespace BillingConfigRetrieveResponse {
          * [AWS's GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).
          */
         aws_expiration_date?: string;
+        /**
+         * True if the aws_product_code is a SAAS subscription product, false otherwise.
+         */
+        aws_is_subscription_product?: boolean;
         aws_product_code?: string;
         aws_region?: 'af-south-1' | 'ap-east-1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ca-central-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-north-1' | 'eu-south-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'me-south-1' | 'sa-east-1' | 'us-east-1' | 'us-east-2' | 'us-gov-east-1' | 'us-gov-west-1' | 'us-west-1' | 'us-west-2';
         /**

package/resources/v1/customers/billing-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"billing-config.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/billing-config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAS/F;;OAEG;IACH,QAAQ,CACN,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAKjD;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAOhG;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB;;;;WAIG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,UAAU,CAAC,EACP,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,eAAe,GACf,WAAW,GACX,WAAW,CAAC;QAEhB;;;;WAIG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAE/B,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,yBAAyB,CAAC,EAAE,YAAY,GAAG,cAAc,GAAG,WAAW,GAAG,yBAAyB,CAAC;QAEpG,4BAA4B,CAAC,EAAE,MAAM,CAAC;QAEtC,wBAAwB,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC;KACpE;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EACP,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,eAAe,GACf,WAAW,GACX,WAAW,CAAC;IAEhB;;OAEG;IACH,wBAAwB,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC;CACpE;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"billing-config.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/billing-config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAS/F;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAKjD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAOhG;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB;;;;WAIG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;QAEtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,UAAU,CAAC,EACP,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,eAAe,GACf,WAAW,GACX,WAAW,CAAC;QAEhB;;;;WAIG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAE/B,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,yBAAyB,CAAC,EAAE,YAAY,GAAG,cAAc,GAAG,WAAW,GAAG,yBAAyB,CAAC;QAEpG,4BAA4B,CAAC,EAAE,MAAM,CAAC;QAEtC,wBAAwB,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC;KACpE;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EACP,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,eAAe,GACf,WAAW,GACX,WAAW,CAAC;IAEhB;;OAEG;IACH,wBAAwB,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC;CACpE;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/v1/customers/billing-config.js

@@ -6,6 +6,16 @@ const resource_1 = require("../../../resource.js");
 class BillingConfig extends resource_1.APIResource {
     /**
      * Set the billing configuration for a given customer.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.billingConfig.create({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   billing_provider_type: 'stripe',
+     *   billing_provider_customer_id: 'cus_AJ6y20bjkOOayM',
+     *   stripe_collection_method: 'charge_automatically',
+     * });
+     * ```
      */
     create(params, options) {
         const { customer_id, billing_provider_type, ...body } = params;
@@ -17,6 +27,15 @@ class BillingConfig extends resource_1.APIResource {
     }
     /**
      * Fetch the billing configuration for the given customer.
+     *
+     * @example
+     * ```ts
+     * const billingConfig =
+     *   await client.v1.customers.billingConfig.retrieve({
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     billing_provider_type: 'stripe',
+     *   });
+     * ```
      */
     retrieve(params, options) {
         const { customer_id, billing_provider_type } = params;
@@ -25,6 +44,14 @@ class BillingConfig extends resource_1.APIResource {
     /**
      * Delete the billing configuration for a given customer. Note: this is unsupported
      * for Azure and AWS Marketplace customers.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.billingConfig.delete({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   billing_provider_type: 'stripe',
+     * });
+     * ```
      */
     delete(params, options) {
         const { customer_id, billing_provider_type } = params;

package/resources/v1/customers/billing-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-config.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/billing-config.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YAC/F,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YACjG,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,sCAmCC"}
+{"version":3,"file":"billing-config.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/billing-config.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YAC/F,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YACjG,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,sCA8DC"}

package/resources/v1/customers/billing-config.mjs

@@ -3,6 +3,16 @@ import { APIResource } from "../../../resource.mjs";
 export class BillingConfig extends APIResource {
     /**
      * Set the billing configuration for a given customer.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.billingConfig.create({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   billing_provider_type: 'stripe',
+     *   billing_provider_customer_id: 'cus_AJ6y20bjkOOayM',
+     *   stripe_collection_method: 'charge_automatically',
+     * });
+     * ```
      */
     create(params, options) {
         const { customer_id, billing_provider_type, ...body } = params;
@@ -14,6 +24,15 @@ export class BillingConfig extends APIResource {
     }
     /**
      * Fetch the billing configuration for the given customer.
+     *
+     * @example
+     * ```ts
+     * const billingConfig =
+     *   await client.v1.customers.billingConfig.retrieve({
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     billing_provider_type: 'stripe',
+     *   });
+     * ```
      */
     retrieve(params, options) {
         const { customer_id, billing_provider_type } = params;
@@ -22,6 +41,14 @@ export class BillingConfig extends APIResource {
     /**
      * Delete the billing configuration for a given customer. Note: this is unsupported
      * for Azure and AWS Marketplace customers.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.billingConfig.delete({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   billing_provider_type: 'stripe',
+     * });
+     * ```
      */
     delete(params, options) {
         const { customer_id, billing_provider_type } = params;

package/resources/v1/customers/billing-config.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"billing-config.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/billing-config.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YAC/F,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YACjG,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"billing-config.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/billing-config.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YAC/F,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAiC,EAAE,OAA6B;QACrE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,WAAW,mBAAmB,qBAAqB,EAAE,EAAE;YACjG,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/v1/customers/commits.d.ts

@@ -4,14 +4,69 @@ import * as Shared from "../../shared.js";
 export declare class Commits extends APIResource {
     /**
      * Create a new commit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const commit = await client.v1.customers.commits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   type: 'prepaid',
+     *   invoice_contract_id:
+     *     'e57d6929-c2f1-4796-a9a8-63cedefe848d',
+     *   invoice_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         unit_price: 10000000,
+     *         quantity: 1,
+     *         timestamp: '2020-03-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   name: 'My Commit',
+     * });
+     * ```
      */
     create(body: CommitCreateParams, options?: Core.RequestOptions): Core.APIPromise<CommitCreateResponse>;
     /**
      * List commits.
+     *
+     * @example
+     * ```ts
+     * const commits = await client.v1.customers.commits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
      */
     list(body: CommitListParams, options?: Core.RequestOptions): Core.APIPromise<CommitListResponse>;
     /**
-     * Update the end date of a PREPAID commit
+     * Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
+     * to extend the end date of a prepaid commit, or to make other edits to the
+     * commit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.commits.updateEndDate({
+     *     commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     invoices_ending_before: '2020-01-01T00:00:00.000Z',
+     *   });
+     * ```
      */
     updateEndDate(body: CommitUpdateEndDateParams, options?: Core.RequestOptions): Core.APIPromise<CommitUpdateEndDateResponse>;
 }
@@ -49,16 +104,20 @@ export interface CommitCreateParams {
      */
     applicable_contract_ids?: Array<string>;
     /**
-     * Which products the commit applies to. If both applicable_product_ids and
-     * applicable_product_tags are not provided, the commit applies to all products.
+     * Which products the commit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * all products.
      */
     applicable_product_ids?: Array<string>;
     /**
-     * Which tags the commit applies to. If both applicable_product_ids and
-     * applicable_product_tags are not provided, the commit applies to all products.
+     * Which tags the commit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * all products.
      */
     applicable_product_tags?: Array<string>;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     /**
      * Used only in UI/API. It is not exposed to end customers.
      */
@@ -89,6 +148,13 @@ export interface CommitCreateParams {
      * This field's availability is dependent on your client's configuration.
      */
     salesforce_opportunity_id?: string;
+    /**
+     * List of filters that determine what kind of customer usage draws down a commit
+     * or credit. A customer's usage needs to meet the condition of at least one of the
+     * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+     * be used together with `applicable_product_ids` or `applicable_product_tags`.
+     */
+    specifiers?: Array<CommitCreateParams.Specifier>;
     /**
      * Prevents the creation of duplicates. If a request to create a commit or credit
      * is made with a uniqueness key that was previously used to create a commit or
@@ -205,6 +271,23 @@ export declare namespace CommitCreateParams {
             unit_price?: number;
         }
     }
+    interface Specifier {
+        presentation_group_values?: {
+            [key: string]: string;
+        };
+        pricing_group_values?: {
+            [key: string]: string;
+        };
+        /**
+         * If provided, the specifier will only apply to the product with the specified ID.
+         */
+        product_id?: string;
+        /**
+         * If provided, the specifier will only apply to products with all the specified
+         * tags.
+         */
+        product_tags?: Array<string>;
+    }
 }
 export interface CommitListParams {
     customer_id: string;
@@ -218,7 +301,7 @@ export interface CommitListParams {
      */
     effective_before?: string;
     /**
-     * Include commits from archived contracts.
+     * Include archived commits and commits from archived contracts.
      */
     include_archived?: boolean;
     /**
@@ -235,6 +318,10 @@ export interface CommitListParams {
      * be slower.
      */
     include_ledgers?: boolean;
+    /**
+     * The maximum number of commits to return. Defaults to 25.
+     */
+    limit?: number;
     /**
      * The next page token from a previous response.
      */

package/resources/v1/customers/commits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commits.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AAEvC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAItG;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAIhG;;OAEG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,eAAe,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,SAAS,GAAG,UAAU,CAAC;IAE7B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC;IAEtD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;IAExC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,cAAc;QAC7B,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAEnD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,YAAY;YAC3B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;IAED;;;;;OAKG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;;WAIG;QACH,kBAAkB,CAAC,EAAE,eAAe,CAAC,iBAAiB,CAAC;QAEvD;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;KACtD;IAED,UAAiB,eAAe,CAAC;QAC/B;;;;WAIG;QACH,UAAiB,iBAAiB;YAChC,mBAAmB,EAAE,SAAS,GAAG,iBAAiB,GAAG,MAAM,CAAC;YAE5D;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAC;YAE9D;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;;;eAIG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;;eAIG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;;;eAIG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;;eAIG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"commits.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AAEvC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAIhG;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,eAAe,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,SAAS,GAAG,UAAU,CAAC;IAE7B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC;IAEtD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;IAExC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,cAAc;QAC7B,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAEnD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,YAAY;YAC3B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;IAED;;;;;OAKG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;;WAIG;QACH,kBAAkB,CAAC,EAAE,eAAe,CAAC,iBAAiB,CAAC;QAEvD;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;KACtD;IAED,UAAiB,eAAe,CAAC;QAC/B;;;;WAIG;QACH,UAAiB,iBAAiB;YAChC,mBAAmB,EAAE,SAAS,GAAG,iBAAiB,GAAG,MAAM,CAAC;YAE5D;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAC;YAE9D;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;;;eAIG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;;eAIG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;;;eAIG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;;eAIG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;KACF;IAED,UAAiB,SAAS;QACxB,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEtD,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/v1/customers/commits.js

@@ -6,18 +6,73 @@ const resource_1 = require("../../../resource.js");
 class Commits extends resource_1.APIResource {
     /**
      * Create a new commit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const commit = await client.v1.customers.commits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   type: 'prepaid',
+     *   invoice_contract_id:
+     *     'e57d6929-c2f1-4796-a9a8-63cedefe848d',
+     *   invoice_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         unit_price: 10000000,
+     *         quantity: 1,
+     *         timestamp: '2020-03-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   name: 'My Commit',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/contracts/customerCommits/create', { body, ...options });
     }
     /**
      * List commits.
+     *
+     * @example
+     * ```ts
+     * const commits = await client.v1.customers.commits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
      */
     list(body, options) {
         return this._client.post('/v1/contracts/customerCommits/list', { body, ...options });
     }
     /**
-     * Update the end date of a PREPAID commit
+     * Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
+     * to extend the end date of a prepaid commit, or to make other edits to the
+     * commit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.commits.updateEndDate({
+     *     commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     invoices_ending_before: '2020-01-01T00:00:00.000Z',
+     *   });
+     * ```
      */
     updateEndDate(body, options) {
         return this._client.post('/v1/contracts/customerCommits/updateEndDate', { body, ...options });

package/resources/v1/customers/commits.js.map

@@ -1 +1 @@
-{"version":3,"file":"commits.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAIhD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF;AAxBD,0BAwBC"}
+{"version":3,"file":"commits.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAIhD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF;AA/ED,0BA+EC"}

package/resources/v1/customers/commits.mjs

@@ -3,18 +3,73 @@ import { APIResource } from "../../../resource.mjs";
 export class Commits extends APIResource {
     /**
      * Create a new commit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const commit = await client.v1.customers.commits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   type: 'prepaid',
+     *   invoice_contract_id:
+     *     'e57d6929-c2f1-4796-a9a8-63cedefe848d',
+     *   invoice_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         unit_price: 10000000,
+     *         quantity: 1,
+     *         timestamp: '2020-03-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   name: 'My Commit',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/contracts/customerCommits/create', { body, ...options });
     }
     /**
      * List commits.
+     *
+     * @example
+     * ```ts
+     * const commits = await client.v1.customers.commits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
      */
     list(body, options) {
         return this._client.post('/v1/contracts/customerCommits/list', { body, ...options });
     }
     /**
-     * Update the end date of a PREPAID commit
+     * Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
+     * to extend the end date of a prepaid commit, or to make other edits to the
+     * commit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.commits.updateEndDate({
+     *     commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     invoices_ending_before: '2020-01-01T00:00:00.000Z',
+     *   });
+     * ```
      */
     updateEndDate(body, options) {
         return this._client.post('/v1/contracts/customerCommits/updateEndDate', { body, ...options });

package/resources/v1/customers/commits.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"commits.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF"}
+{"version":3,"file":"commits.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF"}