@metronome/sdk 0.1.0-beta.9 → 0.2.0

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

@@ -4,6 +4,16 @@ export class NamedSchedules extends APIResource {
     /**
      * Get a named schedule for the given customer. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * const namedSchedule =
+     *   await client.v1.customers.namedSchedules.retrieve({
+     *     customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *     schedule_name: 'my-schedule',
+     *     covering_date: '2022-02-15T00:00:00Z',
+     *   });
+     * ```
      */
     retrieve(body, options) {
         return this._client.post('/v1/customers/getNamedSchedule', { body, ...options });
@@ -11,6 +21,17 @@ export class NamedSchedules extends APIResource {
     /**
      * Update a named schedule for the given customer. This endpoint's availability is
      * dependent on your client's configuration.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.namedSchedules.update({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   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/customers/updateNamedSchedule', {

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

@@ -1 +1 @@
-{"version":3,"file":"named-schedules.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/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,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE;YAC5D,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/customers/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,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE;YAC5D,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/plans.d.ts

@@ -5,22 +5,65 @@ import { CursorPage, type CursorPageParams } from "../../../pagination.js";
 export declare class Plans extends APIResource {
     /**
      * List the given customer's plans in reverse-chronological order.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.v1.customers.plans.list(
+     *   { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params: PlanListParams, options?: Core.RequestOptions): Core.PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
     /**
      * Associate an existing customer with a plan for a specified date range. See the
      * [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
      * for details on the price adjustments.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.plans.add({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   plan_id: 'd2c06dae-9549-4d7d-bc04-b78dd3d241b8',
+     *   starting_on: '2021-02-01T00:00:00Z',
+     *   ending_before: '2022-02-01T00:00:00Z',
+     * });
+     * ```
      */
     add(params: PlanAddParams, options?: Core.RequestOptions): Core.APIPromise<PlanAddResponse>;
     /**
      * Change the end date of a customer's plan.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.plans.end({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_plan_id: '7aa11640-0703-4600-8eb9-293f535a6b74',
+     *   ending_before: '2021-02-01T00:00:00Z',
+     * });
+     * ```
      */
     end(params: PlanEndParams, options?: Core.RequestOptions): Core.APIPromise<PlanEndResponse>;
     /**
      * Lists a customer plans adjustments. See the
      * [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
      * for details.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListPriceAdjustmentsResponse of client.v1.customers.plans.listPriceAdjustments(
+     *   {
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     customer_plan_id:
+     *       '7aa11640-0703-4600-8eb9-293f535a6b74',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listPriceAdjustments(params: PlanListPriceAdjustmentsParams, options?: Core.RequestOptions): Core.PagePromise<PlanListPriceAdjustmentsResponsesCursorPage, PlanListPriceAdjustmentsResponse>;
 }
@@ -33,7 +76,9 @@ export interface PlanListResponse {
      * the ID of the customer plan
      */
     id: string;
-    custom_fields: Record<string, string>;
+    custom_fields: {
+        [key: string]: string;
+    };
     plan_description: string;
     /**
      * the ID of the plan

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

@@ -1 +1 @@
-{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/plans.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;AACvC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,IAAI,CACF,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAQlE;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAK3F;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAQ3F;;;;OAIG;IACH,oBAAoB,CAClB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2CAA2C,EAAE,gCAAgC,CAAC;CAQnG;AAED,qBAAa,2BAA4B,SAAQ,UAAU,CAAC,gBAAgB,CAAC;CAAG;AAEhF,qBAAa,2CAA4C,SAAQ,UAAU,CAAC,gCAAgC,CAAC;CAAG;AAEhH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;CACzC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB,aAAa,EAAE,MAAM,CAAC;QAEtB,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;KAC7C;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,WAAW;YAC1B,MAAM,EAAE,MAAM,CAAC;YAEf,gBAAgB,EAAE,MAAM,CAAC;YAEzB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;SACpC;KACF;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;CAAG;AAEnC,MAAM,WAAW,gCAAgC;IAC/C,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,MAAM,EAAE,KAAK,CAAC,gCAAgC,CAAC,KAAK,CAAC,CAAC;IAEtD,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,KAAK;QACpB;;WAEG;QACH,eAAe,EAAE,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,CAAC;QAElE;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAEzD;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC;CACtC;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,qBAAqB;QACpC,qBAAqB,EAAE,MAAM,CAAC;QAE9B,4BAA4B,EAAE,MAAM,CAAC;QAErC;;WAEG;QACH,yBAAyB,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,eAAe;QAC9B,eAAe,EAAE,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;QAElE,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;OAIG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC;KACtC;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,WAAW;YAC1B;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;KACF;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,8BAA+B,SAAQ,gBAAgB;IACtE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAKD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,2BAA2B,IAAI,2BAA2B,EAC1D,2CAA2C,IAAI,2CAA2C,EAC1F,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/plans.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;AACvC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAQlE;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAK3F;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAQ3F;;;;;;;;;;;;;;;;;;OAkBG;IACH,oBAAoB,CAClB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2CAA2C,EAAE,gCAAgC,CAAC;CAQnG;AAED,qBAAa,2BAA4B,SAAQ,UAAU,CAAC,gBAAgB,CAAC;CAAG;AAEhF,qBAAa,2CAA4C,SAAQ,UAAU,CAAC,gCAAgC,CAAC;CAAG;AAEhH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;CACzC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB,aAAa,EAAE,MAAM,CAAC;QAEtB,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;KAC7C;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,WAAW;YAC1B,MAAM,EAAE,MAAM,CAAC;YAEf,gBAAgB,EAAE,MAAM,CAAC;YAEzB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;SACpC;KACF;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;CAAG;AAEnC,MAAM,WAAW,gCAAgC;IAC/C,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,MAAM,EAAE,KAAK,CAAC,gCAAgC,CAAC,KAAK,CAAC,CAAC;IAEtD,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,KAAK;QACpB;;WAEG;QACH,eAAe,EAAE,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,CAAC;QAElE;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAEzD;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC;CACtC;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,qBAAqB;QACpC,qBAAqB,EAAE,MAAM,CAAC;QAE9B,4BAA4B,EAAE,MAAM,CAAC;QAErC;;WAEG;QACH,yBAAyB,EAAE,MAAM,CAAC;KACnC;IAED,UAAiB,eAAe;QAC9B,eAAe,EAAE,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;QAElE,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;OAIG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC;KACtC;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,WAAW;YAC1B;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;SACxB;KACF;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,8BAA+B,SAAQ,gBAAgB;IACtE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAKD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,2BAA2B,IAAI,2BAA2B,EAC1D,2CAA2C,IAAI,2CAA2C,EAC1F,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/v1/customers/plans.js

@@ -7,6 +7,16 @@ const pagination_1 = require("../../../pagination.js");
 class Plans extends resource_1.APIResource {
     /**
      * List the given customer's plans in reverse-chronological order.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.v1.customers.plans.list(
+     *   { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params, options) {
         const { customer_id, ...query } = params;
@@ -19,6 +29,16 @@ class Plans extends resource_1.APIResource {
      * Associate an existing customer with a plan for a specified date range. See the
      * [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
      * for details on the price adjustments.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.plans.add({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   plan_id: 'd2c06dae-9549-4d7d-bc04-b78dd3d241b8',
+     *   starting_on: '2021-02-01T00:00:00Z',
+     *   ending_before: '2022-02-01T00:00:00Z',
+     * });
+     * ```
      */
     add(params, options) {
         const { customer_id, ...body } = params;
@@ -26,6 +46,15 @@ class Plans extends resource_1.APIResource {
     }
     /**
      * Change the end date of a customer's plan.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.plans.end({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_plan_id: '7aa11640-0703-4600-8eb9-293f535a6b74',
+     *   ending_before: '2021-02-01T00:00:00Z',
+     * });
+     * ```
      */
     end(params, options) {
         const { customer_id, customer_plan_id, ...body } = params;
@@ -38,6 +67,20 @@ class Plans extends resource_1.APIResource {
      * Lists a customer plans adjustments. See the
      * [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
      * for details.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListPriceAdjustmentsResponse of client.v1.customers.plans.listPriceAdjustments(
+     *   {
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     customer_plan_id:
+     *       '7aa11640-0703-4600-8eb9-293f535a6b74',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listPriceAdjustments(params, options) {
         const { customer_id, customer_plan_id, ...query } = params;

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

@@ -1 +1 @@
-{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,uDAAwE;AAExE,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,IAAI,CACF,MAAsB,EACtB,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,WAAW,QAAQ,EAAE,2BAA2B,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,UAAU,gBAAgB,MAAM,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAClB,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,UAAU,gBAAgB,mBAAmB,EACzE,2CAA2C,EAC3C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AApDD,sBAoDC;AAED,MAAa,2BAA4B,SAAQ,uBAA4B;CAAG;AAAhF,kEAAgF;AAEhF,MAAa,2CAA4C,SAAQ,uBAA4C;CAAG;AAAhH,kGAAgH;AA8PhH,KAAK,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AAChE,KAAK,CAAC,2CAA2C,GAAG,2CAA2C,CAAC"}
+{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,uDAAwE;AAExE,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAsB,EACtB,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,WAAW,QAAQ,EAAE,2BAA2B,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,UAAU,gBAAgB,MAAM,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,oBAAoB,CAClB,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,UAAU,gBAAgB,mBAAmB,EACzE,2CAA2C,EAC3C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA/FD,sBA+FC;AAED,MAAa,2BAA4B,SAAQ,uBAA4B;CAAG;AAAhF,kEAAgF;AAEhF,MAAa,2CAA4C,SAAQ,uBAA4C;CAAG;AAAhH,kGAAgH;AA8PhH,KAAK,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AAChE,KAAK,CAAC,2CAA2C,GAAG,2CAA2C,CAAC"}

package/resources/v1/customers/plans.mjs

@@ -4,6 +4,16 @@ import { CursorPage } from "../../../pagination.mjs";
 export class Plans extends APIResource {
     /**
      * List the given customer's plans in reverse-chronological order.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListResponse of client.v1.customers.plans.list(
+     *   { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params, options) {
         const { customer_id, ...query } = params;
@@ -16,6 +26,16 @@ export class Plans extends APIResource {
      * Associate an existing customer with a plan for a specified date range. See the
      * [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
      * for details on the price adjustments.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.plans.add({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   plan_id: 'd2c06dae-9549-4d7d-bc04-b78dd3d241b8',
+     *   starting_on: '2021-02-01T00:00:00Z',
+     *   ending_before: '2022-02-01T00:00:00Z',
+     * });
+     * ```
      */
     add(params, options) {
         const { customer_id, ...body } = params;
@@ -23,6 +43,15 @@ export class Plans extends APIResource {
     }
     /**
      * Change the end date of a customer's plan.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.plans.end({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_plan_id: '7aa11640-0703-4600-8eb9-293f535a6b74',
+     *   ending_before: '2021-02-01T00:00:00Z',
+     * });
+     * ```
      */
     end(params, options) {
         const { customer_id, customer_plan_id, ...body } = params;
@@ -35,6 +64,20 @@ export class Plans extends APIResource {
      * Lists a customer plans adjustments. See the
      * [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
      * for details.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const planListPriceAdjustmentsResponse of client.v1.customers.plans.listPriceAdjustments(
+     *   {
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     customer_plan_id:
+     *       '7aa11640-0703-4600-8eb9-293f535a6b74',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listPriceAdjustments(params, options) {
         const { customer_id, customer_plan_id, ...query } = params;

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

@@ -1 +1 @@
-{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,IAAI,CACF,MAAsB,EACtB,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,WAAW,QAAQ,EAAE,2BAA2B,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,UAAU,gBAAgB,MAAM,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAClB,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,UAAU,gBAAgB,mBAAmB,EACzE,2CAA2C,EAC3C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,UAA4B;CAAG;AAEhF,MAAM,OAAO,2CAA4C,SAAQ,UAA4C;CAAG;AA8PhH,KAAK,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AAChE,KAAK,CAAC,2CAA2C,GAAG,2CAA2C,CAAC"}
+{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAsB,EACtB,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,WAAW,QAAQ,EAAE,2BAA2B,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,MAAqB,EAAE,OAA6B;QACtD,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,UAAU,gBAAgB,MAAM,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,oBAAoB,CAClB,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,UAAU,gBAAgB,mBAAmB,EACzE,2CAA2C,EAC3C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,UAA4B;CAAG;AAEhF,MAAM,OAAO,2CAA4C,SAAQ,UAA4C;CAAG;AA8PhH,KAAK,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AAChE,KAAK,CAAC,2CAA2C,GAAG,2CAA2C,CAAC"}

package/resources/v1/dashboards.d.ts

@@ -5,6 +5,32 @@ export declare class Dashboards extends APIResource {
      * Retrieve an embeddable dashboard url for a customer. The dashboard can be
      * embedded using an iframe in a website. This will show information such as usage
      * data and customer invoices.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.dashboards.getEmbeddableURL({
+     *     customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *     dashboard: 'invoices',
+     *     bm_group_key_overrides: [
+     *       {
+     *         group_key_name: 'tenant_id',
+     *         display_name: 'Org ID',
+     *         value_display_names: {
+     *           '48ecb18f358f': 'Cluster EU',
+     *           e358f3ce242d: 'Cluster APAC',
+     *         },
+     *       },
+     *     ],
+     *     color_overrides: [
+     *       { name: 'Gray_dark', value: '#ff0000' },
+     *     ],
+     *     dashboard_options: [
+     *       { key: 'show_zero_usage_line_items', value: 'false' },
+     *       { key: 'hide_voided_invoices', value: 'true' },
+     *     ],
+     *   });
+     * ```
      */
     getEmbeddableURL(body: DashboardGetEmbeddableURLParams, options?: Core.RequestOptions): Core.APIPromise<DashboardGetEmbeddableURLResponse>;
 }
@@ -21,7 +47,7 @@ export interface DashboardGetEmbeddableURLParams {
     /**
      * The type of dashboard to retrieve.
      */
-    dashboard: 'invoices' | 'usage' | 'credits';
+    dashboard: 'invoices' | 'usage' | 'credits' | 'commits_and_credits';
     /**
      * Optional list of billable metric group key overrides
      */
@@ -49,13 +75,15 @@ export declare namespace DashboardGetEmbeddableURLParams {
          * <key, value> pairs of the billable metric group key values and their display
          * names. e.g. {"a": "Asia", "b": "Euro"}
          */
-        value_display_names?: Record<string, unknown>;
+        value_display_names?: {
+            [key: string]: unknown;
+        };
     }
     interface ColorOverride {
         /**
          * The color to override
          */
-        name?: 'Gray_dark' | 'Gray_medium' | 'Gray_light' | 'Gray_extralight' | 'White' | 'Primary_medium' | 'Primary_light' | 'UsageLine_0' | 'UsageLine_1' | 'UsageLine_2' | 'UsageLine_3' | 'UsageLine_4' | 'UsageLine_5' | 'UsageLine_6' | 'UsageLine_7' | 'UsageLine_8' | 'UsageLine_9' | 'Primary_green' | 'Primary_red';
+        name?: 'Gray_dark' | 'Gray_medium' | 'Gray_light' | 'Gray_extralight' | 'White' | 'Primary_medium' | 'Primary_light' | 'UsageLine_0' | 'UsageLine_1' | 'UsageLine_2' | 'UsageLine_3' | 'UsageLine_4' | 'UsageLine_5' | 'UsageLine_6' | 'UsageLine_7' | 'UsageLine_8' | 'UsageLine_9' | 'Primary_green' | 'Primary_red' | 'Progress_bar' | 'Progress_bar_background';
         /**
          * Hex value representation of the color
          */

package/resources/v1/dashboards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dashboards.d.ts","sourceRoot":"","sources":["../../src/resources/v1/dashboards.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;OAIG;IACH,gBAAgB,CACd,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC;CAGtD;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IAEnF;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,aAAa,CAAC,CAAC;IAEvE;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,eAAe,CAAC,CAAC;CAC5E;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,kBAAkB;QACjC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC/C;IAED,UAAiB,aAAa;QAC5B;;WAEG;QACH,IAAI,CAAC,EACD,WAAW,GACX,aAAa,GACb,YAAY,GACZ,iBAAiB,GACjB,OAAO,GACP,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,eAAe,GACf,aAAa,CAAC;QAElB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
+{"version":3,"file":"dashboards.d.ts","sourceRoot":"","sources":["../../src/resources/v1/dashboards.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC;CAGtD;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,IAAI;QACnB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,qBAAqB,CAAC;IAEpE;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IAEnF;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,aAAa,CAAC,CAAC;IAEvE;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,eAAe,CAAC,CAAC;CAC5E;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,kBAAkB;QACjC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,mBAAmB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAClD;IAED,UAAiB,aAAa;QAC5B;;WAEG;QACH,IAAI,CAAC,EACD,WAAW,GACX,aAAa,GACb,YAAY,GACZ,iBAAiB,GACjB,OAAO,GACP,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,GACb,eAAe,GACf,aAAa,GACb,cAAc,GACd,yBAAyB,CAAC;QAE9B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}

package/resources/v1/dashboards.js

@@ -8,6 +8,32 @@ class Dashboards extends resource_1.APIResource {
      * Retrieve an embeddable dashboard url for a customer. The dashboard can be
      * embedded using an iframe in a website. This will show information such as usage
      * data and customer invoices.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.dashboards.getEmbeddableURL({
+     *     customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *     dashboard: 'invoices',
+     *     bm_group_key_overrides: [
+     *       {
+     *         group_key_name: 'tenant_id',
+     *         display_name: 'Org ID',
+     *         value_display_names: {
+     *           '48ecb18f358f': 'Cluster EU',
+     *           e358f3ce242d: 'Cluster APAC',
+     *         },
+     *       },
+     *     ],
+     *     color_overrides: [
+     *       { name: 'Gray_dark', value: '#ff0000' },
+     *     ],
+     *     dashboard_options: [
+     *       { key: 'show_zero_usage_line_items', value: 'false' },
+     *       { key: 'hide_voided_invoices', value: 'true' },
+     *     ],
+     *   });
+     * ```
      */
     getEmbeddableURL(body, options) {
         return this._client.post('/v1/dashboards/getEmbeddableUrl', { body, ...options });

package/resources/v1/dashboards.js.map

@@ -1 +1 @@
-{"version":3,"file":"dashboards.js","sourceRoot":"","sources":["../../src/resources/v1/dashboards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;OAIG;IACH,gBAAgB,CACd,IAAqC,EACrC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AAZD,gCAYC"}
+{"version":3,"file":"dashboards.js","sourceRoot":"","sources":["../../src/resources/v1/dashboards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAqC,EACrC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AAtCD,gCAsCC"}

package/resources/v1/dashboards.mjs

@@ -5,6 +5,32 @@ export class Dashboards extends APIResource {
      * Retrieve an embeddable dashboard url for a customer. The dashboard can be
      * embedded using an iframe in a website. This will show information such as usage
      * data and customer invoices.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.dashboards.getEmbeddableURL({
+     *     customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+     *     dashboard: 'invoices',
+     *     bm_group_key_overrides: [
+     *       {
+     *         group_key_name: 'tenant_id',
+     *         display_name: 'Org ID',
+     *         value_display_names: {
+     *           '48ecb18f358f': 'Cluster EU',
+     *           e358f3ce242d: 'Cluster APAC',
+     *         },
+     *       },
+     *     ],
+     *     color_overrides: [
+     *       { name: 'Gray_dark', value: '#ff0000' },
+     *     ],
+     *     dashboard_options: [
+     *       { key: 'show_zero_usage_line_items', value: 'false' },
+     *       { key: 'hide_voided_invoices', value: 'true' },
+     *     ],
+     *   });
+     * ```
      */
     getEmbeddableURL(body, options) {
         return this._client.post('/v1/dashboards/getEmbeddableUrl', { body, ...options });

package/resources/v1/dashboards.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"dashboards.mjs","sourceRoot":"","sources":["../../src/resources/v1/dashboards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;OAIG;IACH,gBAAgB,CACd,IAAqC,EACrC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}
+{"version":3,"file":"dashboards.mjs","sourceRoot":"","sources":["../../src/resources/v1/dashboards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CACd,IAAqC,EACrC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}

package/resources/v1/index.d.ts

@@ -1,15 +1,15 @@
 export { Alerts, type AlertCreateResponse, type AlertArchiveResponse, type AlertCreateParams, type AlertArchiveParams, } from "./alerts.js";
 export { AuditLogListResponsesCursorPage, AuditLogs, type AuditLogListResponse, type AuditLogListParams, } from "./audit-logs.js";
 export { BillableMetricListResponsesCursorPage, BillableMetrics, type BillableMetricCreateResponse, type BillableMetricRetrieveResponse, type BillableMetricListResponse, type BillableMetricArchiveResponse, type BillableMetricCreateParams, type BillableMetricRetrieveParams, type BillableMetricListParams, type BillableMetricArchiveParams, } from "./billable-metrics.js";
-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/index.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/index.js";
 export { CreditGrantListResponsesCursorPage, CreditGrants, type CreditLedgerEntry, type RolloverAmountMaxAmount, type RolloverAmountMaxPercentage, type CreditGrantCreateResponse, type CreditGrantListResponse, type CreditGrantEditResponse, type CreditGrantListEntriesResponse, type CreditGrantVoidResponse, type CreditGrantCreateParams, type CreditGrantListParams, type CreditGrantEditParams, type CreditGrantListEntriesParams, type CreditGrantVoidParams, } from "./credit-grants.js";
 export { CustomFields, type CustomFieldListKeysResponse, type CustomFieldAddKeyParams, type CustomFieldDeleteValuesParams, type CustomFieldListKeysParams, type CustomFieldRemoveKeyParams, type CustomFieldSetValuesParams, } from "./custom-fields.js";
-export { CustomerDetailsCursorPage, CustomerListBillableMetricsResponsesCursorPage, CustomerListCostsResponsesCursorPage, Customers, type Customer, type CustomerDetail, type CustomerCreateResponse, type CustomerRetrieveResponse, type CustomerArchiveResponse, type CustomerListBillableMetricsResponse, type CustomerListCostsResponse, type CustomerSetNameResponse, type CustomerCreateParams, type CustomerRetrieveParams, type CustomerListParams, type CustomerArchiveParams, type CustomerListBillableMetricsParams, type CustomerListCostsParams, type CustomerSetIngestAliasesParams, type CustomerSetNameParams, type CustomerUpdateConfigParams, } from "./customers/index.js";
+export { CustomerDetailsCursorPage, CustomerListBillableMetricsResponsesCursorPage, CustomerListCostsResponsesCursorPage, Customers, type Customer, type CustomerDetail, type CustomerCreateResponse, type CustomerRetrieveResponse, type CustomerArchiveResponse, type CustomerListBillableMetricsResponse, type CustomerListCostsResponse, type CustomerPreviewEventsResponse, type CustomerSetNameResponse, type CustomerCreateParams, type CustomerRetrieveParams, type CustomerListParams, type CustomerArchiveParams, type CustomerListBillableMetricsParams, type CustomerListCostsParams, type CustomerPreviewEventsParams, type CustomerSetIngestAliasesParams, type CustomerSetNameParams, type CustomerUpdateConfigParams, } from "./customers/index.js";
 export { Dashboards, type DashboardGetEmbeddableURLResponse, type DashboardGetEmbeddableURLParams, } from "./dashboards.js";
 export { Invoices, type InvoiceRegenerateResponse, type InvoiceVoidResponse, type InvoiceRegenerateParams, type InvoiceVoidParams, } from "./invoices.js";
 export { PlanListResponsesCursorPage, PlanListChargesResponsesCursorPage, PlanListCustomersResponsesCursorPage, Plans, type PlanDetail, type PlanListResponse, type PlanGetDetailsResponse, type PlanListChargesResponse, type PlanListCustomersResponse, type PlanListParams, type PlanGetDetailsParams, type PlanListChargesParams, type PlanListCustomersParams, } from "./plans.js";
 export { PricingUnitListResponsesCursorPage, PricingUnits, type PricingUnitListResponse, type PricingUnitListParams, } from "./pricing-units.js";
 export { Services, type ServiceListResponse } from "./services.js";
-export { UsageListWithGroupsResponsesCursorPage, Usage, type UsageListResponse, type UsageListWithGroupsResponse, type UsageListParams, type UsageIngestParams, type UsageListWithGroupsParams, } from "./usage.js";
+export { UsageListWithGroupsResponsesCursorPage, Usage, type UsageListResponse, type UsageListWithGroupsResponse, type UsageSearchResponse, type UsageListParams, type UsageIngestParams, type UsageListWithGroupsParams, type UsageSearchParams, } from "./usage.js";
 export { V1 } from "./v1.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,+BAA+B,EAC/B,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,qCAAqC,EACrC,eAAe,EACf,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,0BAA0B,EAC/B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,GACjC,MAAM,oBAAoB,CAAC;AAC5B,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,mBAAmB,CAAC;AAC3B,OAAO,EACL,kCAAkC,EAClC,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,YAAY,EACZ,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,GAChC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,yBAAyB,EACzB,8CAA8C,EAC9C,oCAAoC,EACpC,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,mCAAmC,EACxC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,iCAAiC,EACtC,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,GAChC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,UAAU,EACV,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,GACrC,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,QAAQ,EACR,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,GACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,2BAA2B,EAC3B,kCAAkC,EAClC,oCAAoC,EACpC,KAAK,EACL,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,GAC7B,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,kCAAkC,EAClC,YAAY,EACZ,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,KAAK,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EACL,sCAAsC,EACtC,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,+BAA+B,EAC/B,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,qCAAqC,EACrC,eAAe,EACf,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,0BAA0B,EAC/B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,GACjC,MAAM,oBAAoB,CAAC;AAC5B,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,mBAAmB,CAAC;AAC3B,OAAO,EACL,kCAAkC,EAClC,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,YAAY,EACZ,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,GAChC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,yBAAyB,EACzB,8CAA8C,EAC9C,oCAAoC,EACpC,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,mCAAmC,EACxC,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,iCAAiC,EACtC,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,GAChC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,UAAU,EACV,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,GACrC,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,QAAQ,EACR,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,GACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,2BAA2B,EAC3B,kCAAkC,EAClC,oCAAoC,EACpC,KAAK,EACL,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,GAC7B,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,kCAAkC,EAClC,YAAY,EACZ,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,KAAK,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EACL,sCAAsC,EACtC,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,GACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC"}

package/resources/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAMkB;AALhB,gGAAA,MAAM,OAAA;AAMR,8CAKsB;AAJpB,6HAAA,+BAA+B,OAAA;AAC/B,uGAAA,SAAS,OAAA;AAIX,0DAW4B;AAV1B,yIAAA,qCAAqC,OAAA;AACrC,mHAAA,eAAe,OAAA;AAUjB,8CAwB2B;AAvBzB,kGAAA,SAAS,OAAA;AAwBX,oDAgByB;AAfvB,mIAAA,kCAAkC,OAAA;AAClC,6GAAA,YAAY,OAAA;AAed,oDAQyB;AAPvB,6GAAA,YAAY,OAAA;AAQd,8CAsB2B;AArBzB,kHAAA,yBAAyB,OAAA;AACzB,uIAAA,8CAA8C,OAAA;AAC9C,6HAAA,oCAAoC,OAAA;AACpC,kGAAA,SAAS,OAAA;AAmBX,8CAIsB;AAHpB,wGAAA,UAAU,OAAA;AAIZ,0CAMoB;AALlB,oGAAA,QAAQ,OAAA;AAMV,oCAciB;AAbf,oHAAA,2BAA2B,OAAA;AAC3B,2HAAA,kCAAkC,OAAA;AAClC,6HAAA,oCAAoC,OAAA;AACpC,8FAAA,KAAK,OAAA;AAWP,oDAKyB;AAJvB,mIAAA,kCAAkC,OAAA;AAClC,6GAAA,YAAY,OAAA;AAId,0CAAgE;AAAvD,oGAAA,QAAQ,OAAA;AACjB,oCAQiB;AAPf,+HAAA,sCAAsC,OAAA;AACtC,8FAAA,KAAK,OAAA;AAOP,8BAA0B;AAAjB,wFAAA,EAAE,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAMkB;AALhB,gGAAA,MAAM,OAAA;AAMR,8CAKsB;AAJpB,6HAAA,+BAA+B,OAAA;AAC/B,uGAAA,SAAS,OAAA;AAIX,0DAW4B;AAV1B,yIAAA,qCAAqC,OAAA;AACrC,mHAAA,eAAe,OAAA;AAUjB,8CA0B2B;AAzBzB,kGAAA,SAAS,OAAA;AA0BX,oDAgByB;AAfvB,mIAAA,kCAAkC,OAAA;AAClC,6GAAA,YAAY,OAAA;AAed,oDAQyB;AAPvB,6GAAA,YAAY,OAAA;AAQd,8CAwB2B;AAvBzB,kHAAA,yBAAyB,OAAA;AACzB,uIAAA,8CAA8C,OAAA;AAC9C,6HAAA,oCAAoC,OAAA;AACpC,kGAAA,SAAS,OAAA;AAqBX,8CAIsB;AAHpB,wGAAA,UAAU,OAAA;AAIZ,0CAMoB;AALlB,oGAAA,QAAQ,OAAA;AAMV,oCAciB;AAbf,oHAAA,2BAA2B,OAAA;AAC3B,2HAAA,kCAAkC,OAAA;AAClC,6HAAA,oCAAoC,OAAA;AACpC,8FAAA,KAAK,OAAA;AAWP,oDAKyB;AAJvB,mIAAA,kCAAkC,OAAA;AAClC,6GAAA,YAAY,OAAA;AAId,0CAAgE;AAAvD,oGAAA,QAAQ,OAAA;AACjB,oCAUiB;AATf,+HAAA,sCAAsC,OAAA;AACtC,8FAAA,KAAK,OAAA;AASP,8BAA0B;AAAjB,wFAAA,EAAE,OAAA"}

package/resources/v1/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,MAAM,GAKP;OACM,EACL,+BAA+B,EAC/B,SAAS,GAGV;OACM,EACL,qCAAqC,EACrC,eAAe,GAShB;OACM,EACL,SAAS,GAuBV;OACM,EACL,kCAAkC,EAClC,YAAY,GAcb;OACM,EACL,YAAY,GAOb;OACM,EACL,yBAAyB,EACzB,8CAA8C,EAC9C,oCAAoC,EACpC,SAAS,GAkBV;OACM,EACL,UAAU,GAGX;OACM,EACL,QAAQ,GAKT;OACM,EACL,2BAA2B,EAC3B,kCAAkC,EAClC,oCAAoC,EACpC,KAAK,GAUN;OACM,EACL,kCAAkC,EAClC,YAAY,GAGb;OACM,EAAE,QAAQ,EAA4B;OACtC,EACL,sCAAsC,EACtC,KAAK,GAMN;OACM,EAAE,EAAE,EAAE"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,MAAM,GAKP;OACM,EACL,+BAA+B,EAC/B,SAAS,GAGV;OACM,EACL,qCAAqC,EACrC,eAAe,GAShB;OACM,EACL,SAAS,GAyBV;OACM,EACL,kCAAkC,EAClC,YAAY,GAcb;OACM,EACL,YAAY,GAOb;OACM,EACL,yBAAyB,EACzB,8CAA8C,EAC9C,oCAAoC,EACpC,SAAS,GAoBV;OACM,EACL,UAAU,GAGX;OACM,EACL,QAAQ,GAKT;OACM,EACL,2BAA2B,EAC3B,kCAAkC,EAClC,oCAAoC,EACpC,KAAK,GAUN;OACM,EACL,kCAAkC,EAClC,YAAY,GAGb;OACM,EAAE,QAAQ,EAA4B;OACtC,EACL,sCAAsC,EACtC,KAAK,GAQN;OACM,EAAE,EAAE,EAAE"}

package/resources/v1/invoices.d.ts

@@ -3,10 +3,24 @@ import * as Core from "../../core.js";
 export declare class Invoices extends APIResource {
     /**
      * Regenerate a voided contract invoice
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.invoices.regenerate({
+     *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     * });
+     * ```
      */
     regenerate(body: InvoiceRegenerateParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceRegenerateResponse>;
     /**
      * Void an invoice
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.invoices.void({
+     *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     * });
+     * ```
      */
     void(body: InvoiceVoidParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceVoidResponse>;
 }

package/resources/v1/invoices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,UAAU,CACR,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGnG;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,UAAU,CACR,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGnG;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/v1/invoices.js

@@ -6,12 +6,26 @@ const resource_1 = require("../../resource.js");
 class Invoices extends resource_1.APIResource {
     /**
      * Regenerate a voided contract invoice
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.invoices.regenerate({
+     *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     * });
+     * ```
      */
     regenerate(body, options) {
         return this._client.post('/v1/invoices/regenerate', { body, ...options });
     }
     /**
      * Void an invoice
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.invoices.void({
+     *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     * });
+     * ```
      */
     void(body, options) {
         return this._client.post('/v1/invoices/void', { body, ...options });

package/resources/v1/invoices.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,UAAU,CACR,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAjBD,4BAiBC"}
+{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,UAAU,CACR,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AA/BD,4BA+BC"}

package/resources/v1/invoices.mjs

@@ -3,12 +3,26 @@ import { APIResource } from "../../resource.mjs";
 export class Invoices extends APIResource {
     /**
      * Regenerate a voided contract invoice
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.invoices.regenerate({
+     *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     * });
+     * ```
      */
     regenerate(body, options) {
         return this._client.post('/v1/invoices/regenerate', { body, ...options });
     }
     /**
      * Void an invoice
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.invoices.void({
+     *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+     * });
+     * ```
      */
     void(body, options) {
         return this._client.post('/v1/invoices/void', { body, ...options });

package/resources/v1/invoices.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,UAAU,CACR,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
+{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../../src/resources/v1/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,UAAU,CACR,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAuB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}