orb-billing 5.48.0 → 5.75.1

package/resources/invoices.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,wCAAwC;AA++D/B,6FA/+DA,qBAAY,OA++DA;AA9+DrB,iDAAsD;AAEtD;;;;;GAKG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAsBD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,qBAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CACZ,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,SAAS,uBAAuB,UAAU,EAAE,EAAE;YACpF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAiB,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,KAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAgBD,KAAK,CACH,SAAiB,EACjB,OAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAsBD,YAAY,CACV,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IA2BD,WAAW,CACT,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,+BAA+B,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,QAAQ,CACN,SAAiB,EACjB,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACH,GAAG,CACD,SAAiB,EACjB,IAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,SAAiB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAtOD,4BAsOC;AAED,MAAa,+BAAgC,SAAQ,iBAAgC;CAAG;AAAxF,0EAAwF;AA0uDxF,QAAQ,CAAC,+BAA+B,GAAG,+BAA+B,CAAC"}
+{"version":3,"file":"invoices.js","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,wCAAwC;AA2rE/B,6FA3rEA,qBAAY,OA2rEA;AA1rErB,iDAAsD;AAEtD;;;;;GAKG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAkCD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,qBAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,SAAS,uBAAuB,UAAU,EAAE,EAAE;YACpF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAiB,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CACX,KAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAqBD,KAAK,CACH,SAAiB,EACjB,OAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IA6BD,YAAY,CACV,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAmCD,WAAW,CACT,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,+BAA+B,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAiB,EACjB,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CACD,SAAiB,EACjB,IAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,SAAiB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAtUD,4BAsUC;AAED,MAAa,+BAAgC,SAAQ,iBAAgC;CAAG;AAAxF,0EAAwF;AAs1DxF,QAAQ,CAAC,+BAA+B,GAAG,+BAA+B,CAAC"}

package/resources/invoices.mjs

@@ -12,6 +12,25 @@ import { Page } from "../pagination.mjs";
 export class Invoices extends APIResource {
     /**
      * This endpoint is used to create a one-off invoice for a customer.
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.create({
+     *   currency: 'USD',
+     *   invoice_date: '2019-12-27T18:11:19.117Z',
+     *   line_items: [
+     *     {
+     *       end_date: '2023-09-22',
+     *       item_id: '4khy3nwzktxv7',
+     *       model_type: 'unit',
+     *       name: 'Line Item Name',
+     *       quantity: 1,
+     *       start_date: '2023-09-22',
+     *       unit_config: { unit_amount: 'unit_amount' },
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/invoices', { body, ...options });
@@ -25,6 +44,11 @@ export class Invoices extends APIResource {
      * `invoice_date`, and `auto_collection` can only be modified if the invoice is in
      * a `draft` state. `invoice_date` can only be modified for non-subscription
      * invoices.
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.update('invoice_id');
+     * ```
      */
     update(invoiceId, body, options) {
         return this._client.put(`/invoices/${invoiceId}`, { body, ...options });
@@ -41,6 +65,14 @@ export class Invoices extends APIResource {
      * This endpoint only allows deletion of one-off line items (not subscription-based
      * line items). The invoice must be in a draft status for this operation to
      * succeed.
+     *
+     * @example
+     * ```ts
+     * await client.invoices.deleteLineItem(
+     *   'invoice_id',
+     *   'line_item_id',
+     * );
+     * ```
      */
     deleteLineItem(invoiceId, lineItemId, options) {
         return this._client.delete(`/invoices/${invoiceId}/invoice_line_items/${lineItemId}`, {
@@ -51,6 +83,11 @@ export class Invoices extends APIResource {
     /**
      * This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
      * identifier.
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.fetch('invoice_id');
+     * ```
      */
     fetch(invoiceId, options) {
         return this._client.get(`/invoices/${invoiceId}`, options);
@@ -59,6 +96,13 @@ export class Invoices extends APIResource {
      * This endpoint can be used to fetch the upcoming
      * [invoice](/core-concepts#invoice) for the current billing period given a
      * subscription.
+     *
+     * @example
+     * ```ts
+     * const response = await client.invoices.fetchUpcoming({
+     *   subscription_id: 'subscription_id',
+     * });
+     * ```
      */
     fetchUpcoming(query, options) {
         return this._client.get('/invoices/upcoming', { query, ...options });
@@ -87,6 +131,14 @@ export class Invoices extends APIResource {
     /**
      * This endpoint allows an invoice's status to be set to the `paid` status. This
      * can only be done to invoices that are in the `issued` or `synced` status.
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.markPaid(
+     *   'invoice_id',
+     *   { payment_received_date: '2023-09-22' },
+     * );
+     * ```
      */
     markPaid(invoiceId, body, options) {
         return this._client.post(`/invoices/${invoiceId}/mark_paid`, { body, ...options });
@@ -96,6 +148,13 @@ export class Invoices extends APIResource {
      * customer's default payment method. Optionally, a shared payment token (SPT) can
      * be provided to pay using agent-granted credentials instead. This action can only
      * be taken on invoices with status "issued".
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.pay('invoice_id', {
+     *   shared_payment_token_id: 'shared_payment_token_id',
+     * });
+     * ```
      */
     pay(invoiceId, body, options) {
         return this._client.post(`/invoices/${invoiceId}/pay`, { body, ...options });
@@ -112,6 +171,11 @@ export class Invoices extends APIResource {
      * If the invoice was used to purchase a credit block, but the invoice is not yet
      * paid, the credit block will be voided. If the invoice was created due to a
      * top-up, the top-up will be disabled.
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.void('invoice_id');
+     * ```
      */
     void(invoiceId, options) {
         return this._client.post(`/invoices/${invoiceId}/void`, options);

package/resources/invoices.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,YAAY,EAAE;OAChB,EAAE,IAAI,EAAmB;AAEhC;;;;;GAKG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAsBD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CACZ,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,SAAS,uBAAuB,UAAU,EAAE,EAAE;YACpF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAiB,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,KAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAgBD,KAAK,CACH,SAAiB,EACjB,OAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAsBD,YAAY,CACV,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IA2BD,WAAW,CACT,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,+BAA+B,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,QAAQ,CACN,SAAiB,EACjB,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACH,GAAG,CACD,SAAiB,EACjB,IAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,SAAiB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,IAAgC;CAAG;AA0uDxF,QAAQ,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAoB3E,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"invoices.mjs","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,YAAY,EAAE;OAChB,EAAE,IAAI,EAAmB;AAEhC;;;;;GAKG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAkCD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,SAAS,uBAAuB,UAAU,EAAE,EAAE;YACpF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAiB,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CACX,KAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAqBD,KAAK,CACH,SAAiB,EACjB,OAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IA6BD,YAAY,CACV,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAmCD,WAAW,CACT,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,+BAA+B,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAiB,EACjB,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CACD,SAAiB,EACjB,IAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,SAAiB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,IAAgC;CAAG;AAs1DxF,QAAQ,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAoB3E,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/resources/items.d.ts

@@ -8,24 +8,54 @@ import { Page, type PageParams } from "../pagination.js";
 export declare class Items extends APIResource {
     /**
      * This endpoint is used to create an [Item](/core-concepts#item).
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.create({
+     *   name: 'API requests',
+     * });
+     * ```
      */
     create(body: ItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
     /**
      * This endpoint can be used to update properties on the Item.
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.update('item_id');
+     * ```
      */
     update(itemId: string, body: ItemUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
     /**
      * This endpoint returns a list of all Items, ordered in descending order by
      * creation time.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const item of client.items.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: ItemListParams, options?: Core.RequestOptions): Core.PagePromise<ItemsPage, Item>;
     list(options?: Core.RequestOptions): Core.PagePromise<ItemsPage, Item>;
     /**
      * Archive item
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.archive('item_id');
+     * ```
      */
     archive(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item>;
     /**
      * This endpoint returns an item identified by its item_id.
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.fetch('item_id');
+     * ```
      */
     fetch(itemId: string, options?: Core.RequestOptions): Core.APIPromise<Item>;
 }

package/resources/items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../src/resources/items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAIpF;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAIpG;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAC9F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAWtE;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAI7E;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAG5E;AAED,qBAAa,SAAU,SAAQ,IAAI,CAAC,IAAI,CAAC;CAAG;AAE5C;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,oBAAoB,EAAE,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAErD;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,wBAAwB,EACpB,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,YAAY,CAAC;QAEjB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,gBAAgB;IAC/B,oBAAoB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAEzE;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,wBAAwB,EACpB,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,YAAY,CAAC;QAEjB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;CAAG;AAIrD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,SAAS,IAAI,SAAS,EACtB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../src/resources/items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAIpF;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAIpG;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAC9F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAWtE;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAI7E;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAG5E;AAED,qBAAa,SAAU,SAAQ,IAAI,CAAC,IAAI,CAAC;CAAG;AAE5C;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,oBAAoB,EAAE,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAErD;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,wBAAwB,EACpB,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,YAAY,CAAC;QAEjB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,gBAAgB;IAC/B,oBAAoB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAEzE;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,wBAAwB,EACpB,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,UAAU,GACV,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,YAAY,CAAC;QAEjB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;CAAG;AAIrD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,SAAS,IAAI,SAAS,EACtB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/items.js

@@ -12,12 +12,24 @@ const pagination_1 = require("../pagination.js");
 class Items extends resource_1.APIResource {
     /**
      * This endpoint is used to create an [Item](/core-concepts#item).
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.create({
+     *   name: 'API requests',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/items', { body, ...options });
     }
     /**
      * This endpoint can be used to update properties on the Item.
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.update('item_id');
+     * ```
      */
     update(itemId, body, options) {
         return this._client.put(`/items/${itemId}`, { body, ...options });
@@ -30,12 +42,22 @@ class Items extends resource_1.APIResource {
     }
     /**
      * Archive item
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.archive('item_id');
+     * ```
      */
     archive(itemId, options) {
         return this._client.post(`/items/${itemId}/archive`, options);
     }
     /**
      * This endpoint returns an item identified by its item_id.
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.fetch('item_id');
+     * ```
      */
     fetch(itemId, options) {
         return this._client.get(`/items/${itemId}`, options);

package/resources/items.js.map

@@ -1 +1 @@
-{"version":3,"file":"items.js","sourceRoot":"","sources":["../src/resources/items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD;;;GAGG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAQD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAc,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AA5CD,sBA4CC;AAED,MAAa,SAAU,SAAQ,iBAAU;CAAG;AAA5C,8BAA4C;AA8H5C,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"items.js","sourceRoot":"","sources":["../src/resources/items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD;;;GAGG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAgBD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAc,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AA1ED,sBA0EC;AAED,MAAa,SAAU,SAAQ,iBAAU;CAAG;AAA5C,8BAA4C;AA8H5C,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/resources/items.mjs

@@ -9,12 +9,24 @@ import { Page } from "../pagination.mjs";
 export class Items extends APIResource {
     /**
      * This endpoint is used to create an [Item](/core-concepts#item).
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.create({
+     *   name: 'API requests',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/items', { body, ...options });
     }
     /**
      * This endpoint can be used to update properties on the Item.
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.update('item_id');
+     * ```
      */
     update(itemId, body, options) {
         return this._client.put(`/items/${itemId}`, { body, ...options });
@@ -27,12 +39,22 @@ export class Items extends APIResource {
     }
     /**
      * Archive item
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.archive('item_id');
+     * ```
      */
     archive(itemId, options) {
         return this._client.post(`/items/${itemId}/archive`, options);
     }
     /**
      * This endpoint returns an item identified by its item_id.
+     *
+     * @example
+     * ```ts
+     * const item = await client.items.fetch('item_id');
+     * ```
      */
     fetch(itemId, options) {
         return this._client.get(`/items/${itemId}`, options);

package/resources/items.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"items.mjs","sourceRoot":"","sources":["../src/resources/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC;;;GAGG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAQD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAc,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,IAAU;CAAG;AA8H5C,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"items.mjs","sourceRoot":"","sources":["../src/resources/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC;;;GAGG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAgBD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAc,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,IAAU;CAAG;AA8H5C,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/resources/licenses/external-licenses.d.ts

@@ -7,6 +7,18 @@ export declare class ExternalLicenses extends APIResource {
      * license ID.
      *
      * Date range defaults to the current billing period if not specified.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.licenses.externalLicenses.getUsage(
+     *     'external_license_id',
+     *     {
+     *       license_type_id: 'license_type_id',
+     *       subscription_id: 'subscription_id',
+     *     },
+     *   );
+     * ```
      */
     getUsage(externalLicenseId: string, query: ExternalLicenseGetUsageParams, options?: Core.RequestOptions): Core.APIPromise<ExternalLicenseGetUsageResponse>;
 }
@@ -97,7 +109,7 @@ export interface ExternalLicenseGetUsageParams {
      * How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
      * 'license,day').
      */
-    group_by?: Array<string> | null;
+    group_by?: string | null;
     /**
      * Maximum number of rows in the response data (default 20, max 100).
      */

package/resources/licenses/external-licenses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"external-licenses.d.ts","sourceRoot":"","sources":["../../src/resources/licenses/external-licenses.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;OAKG;IACH,QAAQ,CACN,iBAAiB,EAAE,MAAM,EACzB,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAGpD;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,KAAK,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAElD,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,CAAC;CAChD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
+{"version":3,"file":"external-licenses.d.ts","sourceRoot":"","sources":["../../src/resources/licenses/external-licenses.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,iBAAiB,EAAE,MAAM,EACzB,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAGpD;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,KAAK,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAElD,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,CAAC;CAChD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/licenses/external-licenses.js

@@ -9,6 +9,18 @@ class ExternalLicenses extends resource_1.APIResource {
      * license ID.
      *
      * Date range defaults to the current billing period if not specified.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.licenses.externalLicenses.getUsage(
+     *     'external_license_id',
+     *     {
+     *       license_type_id: 'license_type_id',
+     *       subscription_id: 'subscription_id',
+     *     },
+     *   );
+     * ```
      */
     getUsage(externalLicenseId, query, options) {
         return this._client.get(`/licenses/external_licenses/${externalLicenseId}/usage`, { query, ...options });

package/resources/licenses/external-licenses.js.map

@@ -1 +1 @@
-{"version":3,"file":"external-licenses.js","sourceRoot":"","sources":["../../src/resources/licenses/external-licenses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAI7C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;OAKG;IACH,QAAQ,CACN,iBAAyB,EACzB,KAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,iBAAiB,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AAdD,4CAcC"}
+{"version":3,"file":"external-licenses.js","sourceRoot":"","sources":["../../src/resources/licenses/external-licenses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAI7C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,iBAAyB,EACzB,KAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,iBAAiB,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AA1BD,4CA0BC"}

package/resources/licenses/external-licenses.mjs

@@ -6,6 +6,18 @@ export class ExternalLicenses extends APIResource {
      * license ID.
      *
      * Date range defaults to the current billing period if not specified.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.licenses.externalLicenses.getUsage(
+     *     'external_license_id',
+     *     {
+     *       license_type_id: 'license_type_id',
+     *       subscription_id: 'subscription_id',
+     *     },
+     *   );
+     * ```
      */
     getUsage(externalLicenseId, query, options) {
         return this._client.get(`/licenses/external_licenses/${externalLicenseId}/usage`, { query, ...options });

package/resources/licenses/external-licenses.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"external-licenses.mjs","sourceRoot":"","sources":["../../src/resources/licenses/external-licenses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;OAKG;IACH,QAAQ,CACN,iBAAyB,EACzB,KAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,iBAAiB,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF"}
+{"version":3,"file":"external-licenses.mjs","sourceRoot":"","sources":["../../src/resources/licenses/external-licenses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,iBAAyB,EACzB,KAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,iBAAiB,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF"}

package/resources/licenses/licenses.d.ts

@@ -14,14 +14,40 @@ export declare class Licenses extends APIResource {
      * If a start date is provided, the license will be activated at the **start** of
      * the specified date in the customer's timezone. Otherwise, the activation time
      * will default to the **start** of the current day in the customer's timezone.
+     *
+     * @example
+     * ```ts
+     * const license = await client.licenses.create({
+     *   external_license_id: 'external_license_id',
+     *   license_type_id: 'license_type_id',
+     *   subscription_id: 'subscription_id',
+     * });
+     * ```
      */
     create(body: LicenseCreateParams, options?: Core.RequestOptions): Core.APIPromise<LicenseCreateResponse>;
     /**
      * This endpoint is used to fetch a license given an identifier.
+     *
+     * @example
+     * ```ts
+     * const license = await client.licenses.retrieve(
+     *   'license_id',
+     * );
+     * ```
      */
     retrieve(licenseId: string, options?: Core.RequestOptions): Core.APIPromise<LicenseRetrieveResponse>;
     /**
      * This endpoint returns a list of all licenses for a subscription.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const licenseListResponse of client.licenses.list(
+     *   { subscription_id: 'subscription_id' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(query: LicenseListParams, options?: Core.RequestOptions): Core.PagePromise<LicenseListResponsesPage, LicenseListResponse>;
     /**
@@ -30,10 +56,28 @@ export declare class Licenses extends APIResource {
      * If an end date is provided, the license will be deactivated at the **start** of
      * the specified date in the customer's timezone. Otherwise, the deactivation time
      * will default to the **end** of the current day in the customer's timezone.
+     *
+     * @example
+     * ```ts
+     * const response = await client.licenses.deactivate(
+     *   'license_id',
+     * );
+     * ```
      */
     deactivate(licenseId: string, body: LicenseDeactivateParams, options?: Core.RequestOptions): Core.APIPromise<LicenseDeactivateResponse>;
     /**
      * This endpoint is used to fetch a license given an external license identifier.
+     *
+     * @example
+     * ```ts
+     * const response = await client.licenses.retrieveByExternalId(
+     *   'external_license_id',
+     *   {
+     *     license_type_id: 'license_type_id',
+     *     subscription_id: 'subscription_id',
+     *   },
+     * );
+     * ```
      */
     retrieveByExternalId(externalLicenseId: string, query: LicenseRetrieveByExternalIDParams, options?: Core.RequestOptions): Core.APIPromise<LicenseRetrieveByExternalIDResponse>;
 }

package/resources/licenses/licenses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"licenses.d.ts","sourceRoot":"","sources":["../../src/resources/licenses/licenses.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,mBAAmB,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,gBAAgB,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,KAAK,EACL,sBAAsB,EACtB,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,QAAS,SAAQ,WAAW;IACvC,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IACF,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAIpG;;OAEG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE,mBAAmB,CAAC;IAIlE;;;;;;OAMG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;OAEG;IACH,oBAAoB,CAClB,iBAAiB,EAAE,MAAM,EACzB,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC;CAGxD;AAED,qBAAa,wBAAyB,SAAQ,IAAI,CAAC,mBAAmB,CAAC;CAAG;AAE1E,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mCAAmC;IAClD,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,eAAe,EAAE,MAAM,CAAC;IAExB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,wBAAwB,IAAI,wBAAwB,EACpD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"licenses.d.ts","sourceRoot":"","sources":["../../src/resources/licenses/licenses.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,mBAAmB,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EACL,6BAA6B,EAC7B,+BAA+B,EAC/B,gBAAgB,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,KAAK,EACL,sBAAsB,EACtB,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,QAAS,SAAQ,WAAW;IACvC,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IACF,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAIpG;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE,mBAAmB,CAAC;IAIlE;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,iBAAiB,EAAE,MAAM,EACzB,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC;CAGxD;AAED,qBAAa,wBAAyB,SAAQ,IAAI,CAAC,mBAAmB,CAAC;CAAG;AAE1E,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mCAAmC;IAClD,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,eAAe,EAAE,MAAM,CAAC;IAExB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,wBAAwB,IAAI,wBAAwB,EACpD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/licenses/licenses.js

@@ -43,18 +43,44 @@ class Licenses extends resource_1.APIResource {
      * If a start date is provided, the license will be activated at the **start** of
      * the specified date in the customer's timezone. Otherwise, the activation time
      * will default to the **start** of the current day in the customer's timezone.
+     *
+     * @example
+     * ```ts
+     * const license = await client.licenses.create({
+     *   external_license_id: 'external_license_id',
+     *   license_type_id: 'license_type_id',
+     *   subscription_id: 'subscription_id',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/licenses', { body, ...options });
     }
     /**
      * This endpoint is used to fetch a license given an identifier.
+     *
+     * @example
+     * ```ts
+     * const license = await client.licenses.retrieve(
+     *   'license_id',
+     * );
+     * ```
      */
     retrieve(licenseId, options) {
         return this._client.get(`/licenses/${licenseId}`, options);
     }
     /**
      * This endpoint returns a list of all licenses for a subscription.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const licenseListResponse of client.licenses.list(
+     *   { subscription_id: 'subscription_id' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(query, options) {
         return this._client.getAPIList('/licenses', LicenseListResponsesPage, { query, ...options });
@@ -65,12 +91,30 @@ class Licenses extends resource_1.APIResource {
      * If an end date is provided, the license will be deactivated at the **start** of
      * the specified date in the customer's timezone. Otherwise, the deactivation time
      * will default to the **end** of the current day in the customer's timezone.
+     *
+     * @example
+     * ```ts
+     * const response = await client.licenses.deactivate(
+     *   'license_id',
+     * );
+     * ```
      */
     deactivate(licenseId, body, options) {
         return this._client.post(`/licenses/${licenseId}/deactivate`, { body, ...options });
     }
     /**
      * This endpoint is used to fetch a license given an external license identifier.
+     *
+     * @example
+     * ```ts
+     * const response = await client.licenses.retrieveByExternalId(
+     *   'external_license_id',
+     *   {
+     *     license_type_id: 'license_type_id',
+     *     subscription_id: 'subscription_id',
+     *   },
+     * );
+     * ```
      */
     retrieveByExternalId(externalLicenseId, query, options) {
         return this._client.get(`/licenses/external_license_id/${externalLicenseId}`, { query, ...options });

package/resources/licenses/licenses.js.map

@@ -1 +1 @@
-{"version":3,"file":"licenses.js","sourceRoot":"","sources":["../../src/resources/licenses/licenses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAE7C,4EAA2D;AAC3D,8DAI6B;AAC7B,qDAAoC;AACpC,sCAMiB;AACjB,oDAAyD;AAEzD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;QACF,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuD3D,CAAC;IArDC;;;;;;OAMG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACR,SAAiB,EACjB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,oBAAoB,CAClB,iBAAyB,EACzB,KAAwC,EACxC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,iBAAiB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AA3DD,4BA2DC;AAED,MAAa,wBAAyB,SAAQ,iBAAyB;CAAG;AAA1E,4DAA0E;AAuI1E,QAAQ,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;AAC7D,QAAQ,CAAC,gBAAgB,GAAG,oCAAgB,CAAC;AAC7C,QAAQ,CAAC,KAAK,GAAG,aAAK,CAAC"}
+{"version":3,"file":"licenses.js","sourceRoot":"","sources":["../../src/resources/licenses/licenses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAE7C,4EAA2D;AAC3D,8DAI6B;AAC7B,qDAAoC;AACpC,sCAMiB;AACjB,oDAAyD;AAEzD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;QACF,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmG3D,CAAC;IAjGC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAiB,EACjB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,iBAAyB,EACzB,KAAwC,EACxC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,iBAAiB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAvGD,4BAuGC;AAED,MAAa,wBAAyB,SAAQ,iBAAyB;CAAG;AAA1E,4DAA0E;AAuI1E,QAAQ,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;AAC7D,QAAQ,CAAC,gBAAgB,GAAG,oCAAgB,CAAC;AAC7C,QAAQ,CAAC,KAAK,GAAG,aAAK,CAAC"}