@metronome/sdk 0.1.0-beta.9 → 0.1.0

package/resources/v1/contracts/contracts.mjs

@@ -15,24 +15,66 @@ export class Contracts extends APIResource {
     }
     /**
      * Create a new contract
+     *
+     * @example
+     * ```ts
+     * const contract = await client.v1.contracts.create({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     *   billing_provider_configuration: {
+     *     billing_provider: 'stripe',
+     *     delivery_method: 'direct_to_billing_provider',
+     *   },
+     *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/contracts/create', { body, ...options });
     }
     /**
-     * Get a specific contract
+     * This is the v1 endpoint to get a contract. New clients should implement using
+     * the v2 endpoint.
+     *
+     * @example
+     * ```ts
+     * const contract = await client.v1.contracts.retrieve({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     * });
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/contracts/get', { body, ...options });
     }
     /**
-     * List all contracts for a customer
+     * This is the v1 endpoint to list all contracts for a customer. New clients should
+     * implement using the v2 endpoint.
+     *
+     * @example
+     * ```ts
+     * const contracts = await client.v1.contracts.list({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
      */
     list(body, options) {
         return this._client.post('/v1/contracts/list', { body, ...options });
     }
     /**
      * Add a manual balance entry
+     *
+     * @example
+     * ```ts
+     * await client.v1.contracts.addManualBalanceEntry({
+     *   id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   amount: -1000,
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   reason: 'Reason for entry',
+     *   segment_id: '66368e29-3f97-4d15-a6e9-120897f0070a',
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
      */
     addManualBalanceEntry(body, options) {
         return this._client.post('/v1/contracts/addManualBalanceLedgerEntry', {
@@ -42,31 +84,110 @@ export class Contracts extends APIResource {
         });
     }
     /**
-     * Amend a contract
+     * Amendments will be replaced by Contract editing. New clients should implement
+     * using the editContract endpoint. Read more about the migration to contract
+     * editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
+     * reach out to your Metronome representative for more details. Once contract
+     * editing is enabled, access to this endpoint will be removed.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.amend({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     * });
+     * ```
      */
     amend(body, options) {
         return this._client.post('/v1/contracts/amend', { body, ...options });
     }
     /**
      * Archive a contract
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.archive({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   void_invoices: true,
+     * });
+     * ```
      */
     archive(body, options) {
         return this._client.post('/v1/contracts/archive', { body, ...options });
     }
     /**
      * Creates historical usage invoices for a contract
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.createHistoricalInvoices({
+     *     invoices: [
+     *       {
+     *         customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *         contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *         credit_type_id:
+     *           '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *         inclusive_start_date: '2020-01-01T00:00:00.000Z',
+     *         exclusive_end_date: '2020-02-01T00:00:00.000Z',
+     *         issue_date: '2020-02-01T00:00:00.000Z',
+     *         usage_line_items: [
+     *           {
+     *             product_id:
+     *               'f14d6729-6a44-4b13-9908-9387f1918790',
+     *             inclusive_start_date:
+     *               '2020-01-01T00:00:00.000Z',
+     *             exclusive_end_date: '2020-02-01T00:00:00.000Z',
+     *             quantity: 100,
+     *           },
+     *         ],
+     *       },
+     *     ],
+     *     preview: false,
+     *   });
+     * ```
      */
     createHistoricalInvoices(body, options) {
         return this._client.post('/v1/contracts/createHistoricalInvoices', { body, ...options });
     }
     /**
      * List balances (commits and credits).
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.listBalances({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
      */
     listBalances(body, options) {
         return this._client.post('/v1/contracts/customerBalances/list', { body, ...options });
     }
     /**
      * Get the rate schedule for the rate card on a given contract.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.retrieveRateSchedule({
+     *     contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     at: '2020-01-01T00:00:00.000Z',
+     *     selectors: [
+     *       {
+     *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+     *         partial_pricing_group_values: {
+     *           region: 'us-west-2',
+     *           cloud: 'aws',
+     *         },
+     *       },
+     *     ],
+     *   });
+     * ```
      */
     retrieveRateSchedule(params, options) {
         const { limit, next_page, ...body } = params;
@@ -76,15 +197,62 @@ export class Contracts extends APIResource {
             ...options,
         });
     }
+    /**
+     * Fetch the quantity and price for a subscription over time. End-point does not
+     * return future scheduled changes.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.retrieveSubscriptionQuantityHistory(
+     *     {
+     *       contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *       customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *       subscription_id:
+     *         '1a824d53-bde6-4d82-96d7-6347ff227d5c',
+     *     },
+     *   );
+     * ```
+     */
+    retrieveSubscriptionQuantityHistory(body, options) {
+        return this._client.post('/v1/contracts/getSubscriptionQuantityHistory', { body, ...options });
+    }
     /**
      * Create a new scheduled invoice for Professional Services terms on a contract.
      * This endpoint's availability is dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.scheduleProServicesInvoice({
+     *     contract_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     customer_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     issued_at: '2019-12-27T18:11:19.117Z',
+     *     line_items: [
+     *       {
+     *         professional_service_id:
+     *           '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       },
+     *     ],
+     *   });
+     * ```
      */
     scheduleProServicesInvoice(body, options) {
         return this._client.post('/v1/contracts/scheduleProServicesInvoice', { body, ...options });
     }
     /**
      * Set usage filter for a contract
+     *
+     * @example
+     * ```ts
+     * await client.v1.contracts.setUsageFilter({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   group_key: 'business_subscription_id',
+     *   group_values: ['ID-1', 'ID-2'],
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     * });
+     * ```
      */
     setUsageFilter(body, options) {
         return this._client.post('/v1/contracts/setUsageFilter', {
@@ -95,6 +263,15 @@ export class Contracts extends APIResource {
     }
     /**
      * Update the end date of a contract
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.updateEndDate({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   ending_before: '2020-01-01T00:00:00.000Z',
+     * });
+     * ```
      */
     updateEndDate(body, options) {
         return this._client.post('/v1/contracts/updateEndDate', { body, ...options });

package/resources/v1/contracts/contracts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/contracts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,WAAW;OAChB,EAQL,8BAA8B,EAK9B,QAAQ,GAGT;OAEM,KAAK,YAAY;OACjB,EAKL,+BAA+B,EAO/B,SAAS,GACV;AAED,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2HxG,CAAC;IAzHC;;OAEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAwB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,qBAAqB,CACnB,IAAyC,EACzC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2CAA2C,EAAE;YACpE,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,KAAK,CAAC,IAAyB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,OAAO,CACL,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,wBAAwB,CACtB,IAA4C,EAC5C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,YAAY,CACV,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAA6B;QAE7B,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE;YAChE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,0BAA0B,CACxB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAkC,EAAE,OAA6B;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,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,aAAa,CACX,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AA04FD,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,8BAA8B,GAAG,8BAA8B,CAAC;AAC1E,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;AAChC,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAC5E,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}
+{"version":3,"file":"contracts.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/contracts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,WAAW;OAChB,EAQL,8BAA8B,EAK9B,QAAQ,GAGT;OAEM,KAAK,YAAY;OACjB,EAOL,+BAA+B,EAO/B,SAAS,GACV;AAED,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgTxG,CAAC;IA9SC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,IAAwB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CACnB,IAAyC,EACzC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2CAA2C,EAAE;YACpE,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,KAAK,CAAC,IAAyB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,wBAAwB,CACtB,IAA4C,EAC5C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAA6B;QAE7B,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE;YAChE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,mCAAmC,CACjC,IAAuD,EACvD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8CAA8C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0BAA0B,CACxB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,IAAkC,EAAE,OAA6B;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,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,aAAa,CACX,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AA8rID,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,8BAA8B,GAAG,8BAA8B,CAAC;AAC1E,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;AAChC,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAC5E,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}

package/resources/v1/contracts/index.d.ts

@@ -1,5 +1,5 @@
-export { Contracts, type ContractCreateResponse, type ContractRetrieveResponse, type ContractListResponse, type ContractAmendResponse, type ContractArchiveResponse, type ContractCreateHistoricalInvoicesResponse, type ContractListBalancesResponse, type ContractRetrieveRateScheduleResponse, type ContractScheduleProServicesInvoiceResponse, type ContractUpdateEndDateResponse, type ContractCreateParams, type ContractRetrieveParams, type ContractListParams, type ContractAddManualBalanceEntryParams, type ContractAmendParams, type ContractArchiveParams, type ContractCreateHistoricalInvoicesParams, type ContractListBalancesParams, type ContractRetrieveRateScheduleParams, type ContractScheduleProServicesInvoiceParams, type ContractSetUsageFilterParams, type ContractUpdateEndDateParams, } from "./contracts.js";
+export { Contracts, type ContractCreateResponse, type ContractRetrieveResponse, type ContractListResponse, type ContractAmendResponse, type ContractArchiveResponse, type ContractCreateHistoricalInvoicesResponse, type ContractListBalancesResponse, type ContractRetrieveRateScheduleResponse, type ContractRetrieveSubscriptionQuantityHistoryResponse, type ContractScheduleProServicesInvoiceResponse, type ContractUpdateEndDateResponse, type ContractCreateParams, type ContractRetrieveParams, type ContractListParams, type ContractAddManualBalanceEntryParams, type ContractAmendParams, type ContractArchiveParams, type ContractCreateHistoricalInvoicesParams, type ContractListBalancesParams, type ContractRetrieveRateScheduleParams, type ContractRetrieveSubscriptionQuantityHistoryParams, type ContractScheduleProServicesInvoiceParams, type ContractSetUsageFilterParams, type ContractUpdateEndDateParams, } from "./contracts.js";
 export { NamedSchedules, type NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams, type NamedScheduleUpdateParams, } from "./named-schedules.js";
 export { ProductListResponsesCursorPage, Products, type ProductListItemState, type QuantityConversion, type QuantityRounding, type ProductCreateResponse, type ProductRetrieveResponse, type ProductUpdateResponse, type ProductListResponse, type ProductArchiveResponse, type ProductCreateParams, type ProductRetrieveParams, type ProductUpdateParams, type ProductListParams, type ProductArchiveParams, } from "./products.js";
-export { RateCardListResponsesCursorPage, RateCards, type RateCardCreateResponse, type RateCardRetrieveResponse, type RateCardUpdateResponse, type RateCardListResponse, type RateCardRetrieveRateScheduleResponse, type RateCardCreateParams, type RateCardRetrieveParams, type RateCardUpdateParams, type RateCardListParams, type RateCardRetrieveRateScheduleParams, } from "./rate-cards/index.js";
+export { RateCardListResponsesCursorPage, RateCards, type RateCardCreateResponse, type RateCardRetrieveResponse, type RateCardUpdateResponse, type RateCardListResponse, type RateCardArchiveResponse, type RateCardRetrieveRateScheduleResponse, type RateCardCreateParams, type RateCardRetrieveParams, type RateCardUpdateParams, type RateCardListParams, type RateCardArchiveParams, type RateCardRetrieveRateScheduleParams, } from "./rate-cards/index.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/v1/contracts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,oCAAoC,EACzC,KAAK,0CAA0C,EAC/C,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,mCAAmC,EACxC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sCAAsC,EAC3C,KAAK,0BAA0B,EAC/B,KAAK,kCAAkC,EACvC,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,2BAA2B,GACjC,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,8BAA8B,EAC9B,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,+BAA+B,EAC/B,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oCAAoC,EACzC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kCAAkC,GACxC,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,oCAAoC,EACzC,KAAK,mDAAmD,EACxD,KAAK,0CAA0C,EAC/C,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,mCAAmC,EACxC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sCAAsC,EAC3C,KAAK,0BAA0B,EAC/B,KAAK,kCAAkC,EACvC,KAAK,iDAAiD,EACtD,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,2BAA2B,GACjC,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,8BAA8B,EAC9B,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,+BAA+B,EAC/B,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,oCAAoC,EACzC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,kCAAkC,GACxC,MAAM,oBAAoB,CAAC"}

package/resources/v1/contracts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAwBqB;AAvBnB,sGAAA,SAAS,OAAA;AAwBX,wDAK2B;AAJzB,iHAAA,cAAc,OAAA;AAKhB,0CAgBoB;AAflB,0HAAA,8BAA8B,OAAA;AAC9B,oGAAA,QAAQ,OAAA;AAeV,+CAa4B;AAZ1B,wHAAA,+BAA+B,OAAA;AAC/B,kGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CA0BqB;AAzBnB,sGAAA,SAAS,OAAA;AA0BX,wDAK2B;AAJzB,iHAAA,cAAc,OAAA;AAKhB,0CAgBoB;AAflB,0HAAA,8BAA8B,OAAA;AAC9B,oGAAA,QAAQ,OAAA;AAeV,+CAe4B;AAd1B,wHAAA,+BAA+B,OAAA;AAC/B,kGAAA,SAAS,OAAA"}

package/resources/v1/contracts/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAuBV;OACM,EACL,cAAc,GAIf;OACM,EACL,8BAA8B,EAC9B,QAAQ,GAcT;OACM,EACL,+BAA+B,EAC/B,SAAS,GAWV"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAyBV;OACM,EACL,cAAc,GAIf;OACM,EACL,8BAA8B,EAC9B,QAAQ,GAcT;OACM,EACL,+BAA+B,EAC/B,SAAS,GAaV"}

package/resources/v1/contracts/named-schedules.d.ts

@@ -4,11 +4,32 @@ export declare class NamedSchedules extends APIResource {
     /**
      * Get a named schedule for the given rate card. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * const namedSchedule =
+     *   await client.v1.contracts.namedSchedules.retrieve({
+     *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     schedule_name: 'my-schedule',
+     *     covering_date: '2022-02-15T00:00:00Z',
+     *   });
+     * ```
      */
     retrieve(body: NamedScheduleRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<NamedScheduleRetrieveResponse>;
     /**
      * Update a named schedule for the given rate card. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * await client.v1.contracts.namedSchedules.update({
+     *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   schedule_name: 'my-schedule',
+     *   starting_at: '2022-02-01T00:00:00Z',
+     *   value: { my_key: 'my_value' },
+     *   ending_before: '2022-02-15T00:00:00Z',
+     * });
+     * ```
      */
     update(body: NamedScheduleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void>;
 }

package/resources/v1/contracts/named-schedules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"named-schedules.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;OAGG;IACH,QAAQ,CACN,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAIjD;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAO9F;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,OAAO,CAAC;QAEf,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"named-schedules.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAIjD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAO9F;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,OAAO,CAAC;QAEf,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/v1/contracts/named-schedules.js

@@ -7,6 +7,16 @@ class NamedSchedules extends resource_1.APIResource {
     /**
      * Get a named schedule for the given rate card. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * const namedSchedule =
+     *   await client.v1.contracts.namedSchedules.retrieve({
+     *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     schedule_name: 'my-schedule',
+     *     covering_date: '2022-02-15T00:00:00Z',
+     *   });
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/contract-pricing/rate-cards/getNamedSchedule', { body, ...options });
@@ -14,6 +24,17 @@ class NamedSchedules extends resource_1.APIResource {
     /**
      * Update a named schedule for the given rate card. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * await client.v1.contracts.namedSchedules.update({
+     *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   schedule_name: 'my-schedule',
+     *   starting_at: '2022-02-01T00:00:00Z',
+     *   value: { my_key: 'my_value' },
+     *   ending_before: '2022-02-15T00:00:00Z',
+     * });
+     * ```
      */
     update(body, options) {
         return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {

package/resources/v1/contracts/named-schedules.js.map

@@ -1 +1 @@
-{"version":3,"file":"named-schedules.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;OAGG;IACH,QAAQ,CACN,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,wCAuBC"}
+{"version":3,"file":"named-schedules.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA5CD,wCA4CC"}

package/resources/v1/contracts/named-schedules.mjs

@@ -4,6 +4,16 @@ export class NamedSchedules extends APIResource {
     /**
      * Get a named schedule for the given rate card. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * const namedSchedule =
+     *   await client.v1.contracts.namedSchedules.retrieve({
+     *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     schedule_name: 'my-schedule',
+     *     covering_date: '2022-02-15T00:00:00Z',
+     *   });
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/contract-pricing/rate-cards/getNamedSchedule', { body, ...options });
@@ -11,6 +21,17 @@ export class NamedSchedules extends APIResource {
     /**
      * Update a named schedule for the given rate card. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * await client.v1.contracts.namedSchedules.update({
+     *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   schedule_name: 'my-schedule',
+     *   starting_at: '2022-02-01T00:00:00Z',
+     *   value: { my_key: 'my_value' },
+     *   ending_before: '2022-02-15T00:00:00Z',
+     * });
+     * ```
      */
     update(body, options) {
         return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {

package/resources/v1/contracts/named-schedules.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"named-schedules.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;OAGG;IACH,QAAQ,CACN,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,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":"named-schedules.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,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/contracts/products.d.ts

@@ -6,23 +6,66 @@ import { CursorPage, type CursorPageParams } from "../../../pagination.js";
 export declare class Products extends APIResource {
     /**
      * Create a new product
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.create({
+     *   name: 'My Product',
+     *   type: 'USAGE',
+     *   billable_metric_id:
+     *     '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     * });
+     * ```
      */
     create(body: ProductCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProductCreateResponse>;
     /**
      * Get a specific product
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.retrieve(
+     *   { id: 'd84e7f4e-7a70-4fe4-be02-7a5027beffcc' },
+     * );
+     * ```
      */
     retrieve(body: ProductRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<ProductRetrieveResponse>;
     /**
      * Update a product
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.update({
+     *   product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     *   name: 'My Updated Product',
+     * });
+     * ```
      */
     update(body: ProductUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ProductUpdateResponse>;
     /**
      * List products
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const productListResponse of client.v1.contracts.products.list(
+     *   { archive_filter: 'NOT_ARCHIVED' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params?: ProductListParams, options?: Core.RequestOptions): Core.PagePromise<ProductListResponsesCursorPage, ProductListResponse>;
     list(options?: Core.RequestOptions): Core.PagePromise<ProductListResponsesCursorPage, ProductListResponse>;
     /**
      * Archive a product
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.products.archive(
+     *   { product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * );
+     * ```
      */
     archive(body: ProductArchiveParams, options?: Core.RequestOptions): Core.APIPromise<ProductArchiveResponse>;
 }
@@ -128,7 +171,9 @@ export declare namespace ProductRetrieveResponse {
         type: 'USAGE' | 'SUBSCRIPTION' | 'COMPOSITE' | 'FIXED' | 'PRO_SERVICE';
         updates: Array<Data.Update>;
         archived_at?: string | null;
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
     }
     namespace Data {
         interface Update {
@@ -193,7 +238,9 @@ export interface ProductListResponse {
     type: 'USAGE' | 'SUBSCRIPTION' | 'COMPOSITE' | 'FIXED' | 'PRO_SERVICE';
     updates: Array<ProductListResponse.Update>;
     archived_at?: string | null;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
 }
 export declare namespace ProductListResponse {
     interface Update {
@@ -408,7 +455,8 @@ export interface ProductUpdateParams {
 }
 export interface ProductListParams extends CursorPageParams {
     /**
-     * Body param: Filter options for the product list
+     * Body param: Filter options for the product list. If not provided, defaults to
+     * not archived.
      */
     archive_filter?: 'ARCHIVED' | 'NOT_ARCHIVED' | 'ALL';
 }

package/resources/v1/contracts/products.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/products.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAI3C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;OAEG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAiB1G;;OAEG;IACH,OAAO,CACL,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;CAG3C;AAED,qBAAa,8BAA+B,SAAQ,UAAU,CAAC,mBAAmB,CAAC;CAAG;AAEtF,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,UAAU,GAAG,QAAQ,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IAEvB,eAAe,EAAE,UAAU,GAAG,YAAY,GAAG,eAAe,CAAC;CAC9D;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;QAE1C,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;QAE1C,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;QAEvE,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACxC;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,UAAU,EAAE,MAAM,CAAC;YAEnB,UAAU,EAAE,MAAM,CAAC;YAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;YAElC;;;;eAIG;YACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvC;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAElC;;;;;;;;eAQG;YACH,mBAAmB,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAE5D;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAExD,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,oBAAoB,CAAC;IAE9B,OAAO,EAAE,oBAAoB,CAAC;IAE9B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;IAEvE,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAE3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;WAEG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAElC;;;;WAIG;QACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvC;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAElC;;;;;;;;WAQG;QACH,mBAAmB,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE5D;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAExD,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,GAAG,sBAAsB,GAAG,aAAa,CAAC;IAEhG;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,cAAc,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,KAAK,CAAC;CACtD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,8BAA8B,IAAI,8BAA8B,EAChE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/products.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;;;;;;;;OASG;IACH,QAAQ,CACN,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAI3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAiB1G;;;;;;;;;OASG;IACH,OAAO,CACL,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;CAG3C;AAED,qBAAa,8BAA+B,SAAQ,UAAU,CAAC,mBAAmB,CAAC;CAAG;AAEtF,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,UAAU,GAAG,QAAQ,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IAEvB,eAAe,EAAE,UAAU,GAAG,YAAY,GAAG,eAAe,CAAC;CAC9D;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;QAE1C,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;QAE1C,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;QAEvE,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KAC3C;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,UAAU,EAAE,MAAM,CAAC;YAEnB,UAAU,EAAE,MAAM,CAAC;YAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;YAElC;;;;eAIG;YACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvC;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAElC;;;;;;;;eAQG;YACH,mBAAmB,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAE5D;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAExD,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,oBAAoB,CAAC;IAE9B,OAAO,EAAE,oBAAoB,CAAC;IAE9B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;IAEvE,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAE3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;WAEG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAElC;;;;WAIG;QACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvC;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAElC;;;;;;;;WAQG;QACH,mBAAmB,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE5D;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAExD,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,GAAG,sBAAsB,GAAG,aAAa,CAAC;IAEhG;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,cAAc,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,KAAK,CAAC;CACtD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,8BAA8B,IAAI,8BAA8B,EAChE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/v1/contracts/products.js

@@ -8,18 +8,44 @@ const pagination_1 = require("../../../pagination.js");
 class Products extends resource_1.APIResource {
     /**
      * Create a new product
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.create({
+     *   name: 'My Product',
+     *   type: 'USAGE',
+     *   billable_metric_id:
+     *     '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v1/contract-pricing/products/create', { body, ...options });
     }
     /**
      * Get a specific product
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.retrieve(
+     *   { id: 'd84e7f4e-7a70-4fe4-be02-7a5027beffcc' },
+     * );
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/contract-pricing/products/get', { body, ...options });
     }
     /**
      * Update a product
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.update({
+     *   product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     *   name: 'My Updated Product',
+     * });
+     * ```
      */
     update(body, options) {
         return this._client.post('/v1/contract-pricing/products/update', { body, ...options });
@@ -38,6 +64,13 @@ class Products extends resource_1.APIResource {
     }
     /**
      * Archive a product
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.products.archive(
+     *   { product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * );
+     * ```
      */
     archive(body, options) {
         return this._client.post('/v1/contract-pricing/products/archive', { body, ...options });

package/resources/v1/contracts/products.js.map

@@ -1 +1 @@
-{"version":3,"file":"products.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAIjD,uDAAwE;AAExE,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAUD,IAAI,CACF,SAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oCAAoC,EAAE,8BAA8B,EAAE;YACnG,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO,CACL,IAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA1DD,4BA0DC;AAED,MAAa,8BAA+B,SAAQ,uBAA+B;CAAG;AAAtF,wEAAsF;AA+etF,QAAQ,CAAC,8BAA8B,GAAG,8BAA8B,CAAC"}
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAIjD,uDAAwE;AAExE,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAoBD,IAAI,CACF,SAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oCAAoC,EAAE,8BAA8B,EAAE;YACnG,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,IAA0B,EAC1B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AArGD,4BAqGC;AAED,MAAa,8BAA+B,SAAQ,uBAA+B;CAAG;AAAtF,wEAAsF;AAgftF,QAAQ,CAAC,8BAA8B,GAAG,8BAA8B,CAAC"}