@stigg/typescript 0.1.0-beta.10 → 0.1.0-beta.13

package/resources/v1/products.js

@@ -12,24 +12,55 @@ class Products extends resource_1.APIResource {
     /**
      * Archives a product, preventing new subscriptions. All plans and addons are
      * archived.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.archiveProduct(
+     *   'x',
+     * );
+     * ```
      */
     archiveProduct(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/products/${id}/archive`, options);
     }
     /**
      * Creates a new product.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.createProduct({
+     *   id: 'id',
+     *   displayName: 'displayName',
+     * });
+     * ```
      */
     createProduct(body, options) {
         return this._client.post('/api/v1/products', { body, ...options });
     }
     /**
      * Duplicates an existing product, including its plans, addons, and configuration.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.duplicateProduct(
+     *   'x',
+     *   { targetId: 'targetId' },
+     * );
+     * ```
      */
     duplicateProduct(id, body, options) {
         return this._client.post((0, path_1.path) `/api/v1/products/${id}/duplicate`, { body, ...options });
     }
     /**
      * Retrieves a paginated list of products in the environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const productListProductsResponse of client.v1.products.listProducts()) {
+     *   // ...
+     * }
+     * ```
      */
     listProducts(query = {}, options) {
         return this._client.getAPIList('/api/v1/products', (pagination_1.MyCursorIDPage), {
@@ -39,6 +70,13 @@ class Products extends resource_1.APIResource {
     }
     /**
      * Restores an archived product, allowing new subscriptions to be created.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.unarchiveProduct(
+     *   'x',
+     * );
+     * ```
      */
     unarchiveProduct(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/products/${id}/unarchive`, options);
@@ -46,6 +84,11 @@ class Products extends resource_1.APIResource {
     /**
      * Updates an existing product's properties such as display name, description, and
      * metadata.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.updateProduct('x');
+     * ```
      */
     updateProduct(id, body, options) {
         return this._client.patch((0, path_1.path) `/api/v1/products/${id}`, { body, ...options });

package/resources/v1/products.js.map

@@ -1 +1 @@
-{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/v1/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAE/F,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,IAAgC,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,YAAY,CACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,2BAA2C,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,EAAU,EAAE,IAAgC,EAAE,OAAwB;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAtDD,4BAsDC"}
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/v1/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAE/F,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,IAAgC,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,2BAA2C,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAU,EAAE,IAAgC,EAAE,OAAwB;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAjGD,4BAiGC"}

package/resources/v1/products.mjs

@@ -9,24 +9,55 @@ export class Products extends APIResource {
     /**
      * Archives a product, preventing new subscriptions. All plans and addons are
      * archived.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.archiveProduct(
+     *   'x',
+     * );
+     * ```
      */
     archiveProduct(id, options) {
         return this._client.post(path `/api/v1/products/${id}/archive`, options);
     }
     /**
      * Creates a new product.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.createProduct({
+     *   id: 'id',
+     *   displayName: 'displayName',
+     * });
+     * ```
      */
     createProduct(body, options) {
         return this._client.post('/api/v1/products', { body, ...options });
     }
     /**
      * Duplicates an existing product, including its plans, addons, and configuration.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.duplicateProduct(
+     *   'x',
+     *   { targetId: 'targetId' },
+     * );
+     * ```
      */
     duplicateProduct(id, body, options) {
         return this._client.post(path `/api/v1/products/${id}/duplicate`, { body, ...options });
     }
     /**
      * Retrieves a paginated list of products in the environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const productListProductsResponse of client.v1.products.listProducts()) {
+     *   // ...
+     * }
+     * ```
      */
     listProducts(query = {}, options) {
         return this._client.getAPIList('/api/v1/products', (MyCursorIDPage), {
@@ -36,6 +67,13 @@ export class Products extends APIResource {
     }
     /**
      * Restores an archived product, allowing new subscriptions to be created.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.unarchiveProduct(
+     *   'x',
+     * );
+     * ```
      */
     unarchiveProduct(id, options) {
         return this._client.post(path `/api/v1/products/${id}/unarchive`, options);
@@ -43,6 +81,11 @@ export class Products extends APIResource {
     /**
      * Updates an existing product's properties such as display name, description, and
      * metadata.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.products.updateProduct('x');
+     * ```
      */
     updateProduct(id, body, options) {
         return this._client.patch(path `/api/v1/products/${id}`, { body, ...options });

package/resources/v1/products.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/v1/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAE/F,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,IAAgC,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,YAAY,CACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,cAA2C,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,EAAU,EAAE,IAAgC,EAAE,OAAwB;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/v1/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAE/F,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,IAAgC,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,cAA2C,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAU,EAAE,IAAgC,EAAE,OAAwB;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}

package/resources/v1/subscriptions/future-update.d.mts

@@ -7,11 +7,27 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class FutureUpdate extends APIResource {
     /**
      * Cancels a subscription update that is pending payment completion.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
+     *     'x',
+     *   );
+     * ```
      */
     cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
     /**
      * Cancels a scheduled subscription update, such as a future downgrade or plan
      * change.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
+     *     'x',
+     *   );
+     * ```
      */
     cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
 }

package/resources/v1/subscriptions/future-update.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"future-update.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}
+{"version":3,"file":"future-update.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}

package/resources/v1/subscriptions/future-update.d.ts

@@ -7,11 +7,27 @@ import { RequestOptions } from "../../../internal/request-options.js";
 export declare class FutureUpdate extends APIResource {
     /**
      * Cancels a subscription update that is pending payment completion.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
+     *     'x',
+     *   );
+     * ```
      */
     cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
     /**
      * Cancels a scheduled subscription update, such as a future downgrade or plan
      * change.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
+     *     'x',
+     *   );
+     * ```
      */
     cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription>;
 }

package/resources/v1/subscriptions/future-update.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"future-update.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;OAGG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}
+{"version":3,"file":"future-update.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC1D"}

package/resources/v1/subscriptions/future-update.js

@@ -10,6 +10,14 @@ const path_1 = require("../../../internal/utils/path.js");
 class FutureUpdate extends resource_1.APIResource {
     /**
      * Cancels a subscription update that is pending payment completion.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
+     *     'x',
+     *   );
+     * ```
      */
     cancelPendingPayment(id, options) {
         return this._client.delete((0, path_1.path) `/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
@@ -17,6 +25,14 @@ class FutureUpdate extends resource_1.APIResource {
     /**
      * Cancels a scheduled subscription update, such as a future downgrade or plan
      * change.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
+     *     'x',
+     *   );
+     * ```
      */
     cancelSchedule(id, options) {
         return this._client.delete((0, path_1.path) `/api/v1/subscriptions/${id}/future-update/schedule`, options);

package/resources/v1/subscriptions/future-update.js.map

@@ -1 +1 @@
-{"version":3,"file":"future-update.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF;AAfD,oCAeC"}
+{"version":3,"file":"future-update.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF;AA/BD,oCA+BC"}

package/resources/v1/subscriptions/future-update.mjs

@@ -7,6 +7,14 @@ import { path } from "../../../internal/utils/path.mjs";
 export class FutureUpdate extends APIResource {
     /**
      * Cancels a subscription update that is pending payment completion.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
+     *     'x',
+     *   );
+     * ```
      */
     cancelPendingPayment(id, options) {
         return this._client.delete(path `/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
@@ -14,6 +22,14 @@ export class FutureUpdate extends APIResource {
     /**
      * Cancels a scheduled subscription update, such as a future downgrade or plan
      * change.
+     *
+     * @example
+     * ```ts
+     * const cancelSubscription =
+     *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
+     *     'x',
+     *   );
+     * ```
      */
     cancelSchedule(id, options) {
         return this._client.delete(path `/api/v1/subscriptions/${id}/future-update/schedule`, options);

package/resources/v1/subscriptions/future-update.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"future-update.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF"}
+{"version":3,"file":"future-update.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/future-update.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAU,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF"}

package/resources/v1/subscriptions/invoice.d.mts

@@ -8,6 +8,12 @@ export declare class Invoice extends APIResource {
     /**
      * Marks the latest invoice of a subscription as paid in the billing provider. The
      * invoice must exist and have an OPEN status.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.subscriptions.invoice.markAsPaid('x');
+     * ```
      */
     markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse>;
 }

package/resources/v1/subscriptions/invoice.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"invoice.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
+{"version":3,"file":"invoice.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}

package/resources/v1/subscriptions/invoice.d.ts

@@ -8,6 +8,12 @@ export declare class Invoice extends APIResource {
     /**
      * Marks the latest invoice of a subscription as paid in the billing provider. The
      * invoice must exist and have an OPEN status.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.subscriptions.invoice.markAsPaid('x');
+     * ```
      */
     markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse>;
 }

package/resources/v1/subscriptions/invoice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoice.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
+{"version":3,"file":"invoice.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}

package/resources/v1/subscriptions/invoice.js

@@ -11,6 +11,12 @@ class Invoice extends resource_1.APIResource {
     /**
      * Marks the latest invoice of a subscription as paid in the billing provider. The
      * invoice must exist and have an OPEN status.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.subscriptions.invoice.markAsPaid('x');
+     * ```
      */
     markAsPaid(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/subscriptions/${id}/invoice/paid`, options);

package/resources/v1/subscriptions/invoice.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoice.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF;AARD,0BAQC"}
+{"version":3,"file":"invoice.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF;AAdD,0BAcC"}

package/resources/v1/subscriptions/invoice.mjs

@@ -8,6 +8,12 @@ export class Invoice extends APIResource {
     /**
      * Marks the latest invoice of a subscription as paid in the billing provider. The
      * invoice must exist and have an OPEN status.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.subscriptions.invoice.markAsPaid('x');
+     * ```
      */
     markAsPaid(id, options) {
         return this._client.post(path `/api/v1/subscriptions/${id}/invoice/paid`, options);

package/resources/v1/subscriptions/invoice.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"invoice.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF"}
+{"version":3,"file":"invoice.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/invoice.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF"}

package/resources/v1/subscriptions/subscriptions.d.mts

@@ -15,51 +15,132 @@ export declare class Subscriptions extends APIResource {
     /**
      * Retrieves a subscription by its unique identifier, including plan details,
      * billing period, status, and add-ons.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.retrieve(
+     *   'x',
+     * );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Updates an active subscription's properties including billing period, add-ons,
      * unit quantities, and discounts.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.update(
+     *   'x',
+     * );
+     * ```
      */
     update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Retrieves a paginated list of subscriptions, with optional filters for customer,
      * status, and plan.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
     /**
      * Cancels an active subscription, either immediately or at a specified time such
      * as end of billing period.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.cancel(
+     *   'x',
+     * );
+     * ```
      */
     cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Delegates the payment responsibility of a subscription to a different customer.
      * The delegated customer will be billed for this subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.delegate(
+     *   'x',
+     *   { targetCustomerId: 'targetCustomerId' },
+     * );
+     * ```
      */
     delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Imports multiple subscriptions in bulk. Used for migrating subscription data
      * from external systems.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.subscriptions.import({
+     *   subscriptions: [
+     *     {
+     *       id: 'id',
+     *       customerId: 'customerId',
+     *       planId: 'planId',
+     *     },
+     *   ],
+     * });
+     * ```
      */
     import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
     /**
      * Migrates a subscription to the latest published version of its plan or add-ons.
      * Handles prorated charges or credits automatically.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.migrate(
+     *   'x',
+     * );
+     * ```
      */
     migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Previews the pricing impact of creating or updating a subscription without
      * making changes. Returns estimated costs, taxes, and proration details.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.subscriptions.preview({
+     *   customerId: 'customerId',
+     *   planId: 'planId',
+     * });
+     * ```
      */
     preview(body: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
     /**
      * Creates a new subscription for an existing customer. When payment is required
      * and no payment method exists, returns a checkout URL.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.subscriptions.provision({
+     *   customerId: 'customerId',
+     *   planId: 'planId',
+     * });
+     * ```
      */
     provision(body: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
     /**
      * Transfers a subscription to a different resource ID. Used for multi-resource
      * products where subscriptions apply to specific entities like websites or apps.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.transfer(
+     *   'x',
+     *   { destinationResourceId: 'destinationResourceId' },
+     * );
+     * ```
      */
     transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
 }