@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.20

package/src/resources/v1/products.ts

@@ -13,6 +13,13 @@ 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: string, options?: RequestOptions): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/archive`, options);
@@ -20,6 +27,14 @@ export class Products extends APIResource {
 
   /**
    * Creates a new product.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.createProduct({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   * });
+   * ```
    */
   createProduct(body: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.post('/api/v1/products', { body, ...options });
@@ -27,6 +42,14 @@ export class Products extends APIResource {
 
   /**
    * Duplicates an existing product, including its plans, addons, and configuration.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.duplicateProduct(
+   *   'x',
+   *   { targetId: 'targetId' },
+   * );
+   * ```
    */
   duplicateProduct(
     id: string,
@@ -38,6 +61,14 @@ export class Products extends APIResource {
 
   /**
    * 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: ProductListProductsParams | null | undefined = {},
@@ -51,6 +82,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: string, options?: RequestOptions): APIPromise<Product> {
     return this._client.post(path`/api/v1/products/${id}/unarchive`, options);
@@ -59,6 +97,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: string, body: ProductUpdateProductParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.patch(path`/api/v1/products/${id}`, { body, ...options });

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

@@ -11,6 +11,14 @@ import { path } from '../../../internal/utils/path';
 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: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
@@ -19,6 +27,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: string, options?: RequestOptions): APIPromise<CancelSubscription> {
     return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);

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

@@ -12,6 +12,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: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse> {
     return this._client.post(path`/api/v1/subscriptions/${id}/invoice/paid`, options);

package/src/resources/v1/subscriptions/subscriptions.ts

@@ -20,6 +20,13 @@ export 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> {
     return this._client.get(path`/api/v1/subscriptions/${id}`, options);
@@ -28,6 +35,13 @@ export class Subscriptions extends APIResource {
   /**
    * 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> {
     return this._client.patch(path`/api/v1/subscriptions/${id}`, { body, ...options });
@@ -36,6 +50,14 @@ export class Subscriptions extends APIResource {
   /**
    * 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 = {},
@@ -50,6 +72,13 @@ export class Subscriptions extends APIResource {
   /**
    * 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> {
     return this._client.post(path`/api/v1/subscriptions/${id}/cancel`, { body, ...options });
@@ -58,6 +87,14 @@ export class Subscriptions extends APIResource {
   /**
    * 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> {
     return this._client.post(path`/api/v1/subscriptions/${id}/delegate`, { body, ...options });
@@ -66,6 +103,19 @@ export class Subscriptions extends APIResource {
   /**
    * 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> {
     return this._client.post('/api/v1/subscriptions/import', { body, ...options });
@@ -74,6 +124,13 @@ export class Subscriptions extends APIResource {
   /**
    * 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> {
     return this._client.post(path`/api/v1/subscriptions/${id}/migrate`, { body, ...options });
@@ -82,6 +139,14 @@ export class Subscriptions extends APIResource {
   /**
    * 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,
@@ -93,6 +158,14 @@ export class Subscriptions extends APIResource {
   /**
    * 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,
@@ -104,6 +177,14 @@ export class Subscriptions extends APIResource {
   /**
    * 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> {
     return this._client.post(path`/api/v1/subscriptions/${id}/transfer`, { body, ...options });
@@ -3901,6 +3982,11 @@ export interface SubscriptionUpdateParams {
 
   budget?: SubscriptionUpdateParams.Budget | null;
 
+  /**
+   * Subscription cancellation date
+   */
+  cancellationDate?: string | null;
+
   charges?: Array<SubscriptionUpdateParams.Charge>;
 
   entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
@@ -4780,7 +4866,8 @@ export namespace SubscriptionImportParams {
     }
 
     /**
-     * Charge item
+     * A charge selection for a subscription (references a catalog charge with a
+     * quantity).
      */
     export interface Charge {
       /**
@@ -4789,7 +4876,7 @@ export namespace SubscriptionImportParams {
       id: string;
 
       /**
-       * Charge quantity
+       * Charge quantity. Minimum is 0 (zero is allowed).
        */
       quantity: number;
 
@@ -4885,7 +4972,7 @@ export interface SubscriptionPreviewParams {
   trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
 
   /**
-   * Unit quantity for per-unit pricing
+   * Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
    */
   unitQuantity?: number;
 }
@@ -5118,7 +5205,7 @@ export namespace SubscriptionPreviewParams {
     featureId: string;
 
     /**
-     * Quantity of feature units
+     * Quantity of feature units. Minimum is 0 (zero is allowed).
      */
     quantity: number;
   }
@@ -5218,7 +5305,8 @@ export namespace SubscriptionPreviewParams {
   }
 
   /**
-   * Charge item
+   * A charge selection for a subscription (references a catalog charge with a
+   * quantity).
    */
   export interface Charge {
     /**
@@ -5227,7 +5315,7 @@ export namespace SubscriptionPreviewParams {
     id: string;
 
     /**
-     * Charge quantity
+     * Charge quantity. Minimum is 0 (zero is allowed).
      */
     quantity: number;
 
@@ -5310,6 +5398,11 @@ export interface SubscriptionProvisionParams {
 
   budget?: SubscriptionProvisionParams.Budget | null;
 
+  /**
+   * Subscription cancellation date
+   */
+  cancellationDate?: string;
+
   charges?: Array<SubscriptionProvisionParams.Charge>;
 
   /**
@@ -5367,7 +5460,7 @@ export interface SubscriptionProvisionParams {
   trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
 
   /**
-   * Unit quantity
+   * Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
    */
   unitQuantity?: number;
 }
@@ -5694,7 +5787,8 @@ export namespace SubscriptionProvisionParams {
   }
 
   /**
-   * Charge item
+   * A charge selection for a subscription (references a catalog charge with a
+   * quantity).
    */
   export interface Charge {
     /**
@@ -5703,7 +5797,7 @@ export namespace SubscriptionProvisionParams {
     id: string;
 
     /**
-     * Charge quantity
+     * Charge quantity. Minimum is 0 (zero is allowed).
      */
     quantity: number;
 

package/src/resources/v1/subscriptions/usage.ts

@@ -12,6 +12,12 @@ export class Usage extends APIResource {
   /**
    * Immediately charges usage for a subscription via the billing integration.
    * Calculates usage since the last charge and creates an invoice.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.subscriptions.usage.chargeUsage('x');
+   * ```
    */
   chargeUsage(
     id: string,
@@ -24,6 +30,13 @@ export class Usage extends APIResource {
   /**
    * Triggers a usage sync for a subscription, reporting current usage to the billing
    * provider.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.subscriptions.usage.sync(
+   *   'x',
+   * );
+   * ```
    */
   sync(id: string, options?: RequestOptions): APIPromise<UsageSyncResponse> {
     return this._client.post(path`/api/v1/subscriptions/${id}/usage/sync`, options);

package/src/resources/v1/usage.ts

@@ -11,6 +11,17 @@ import { path } from '../../internal/utils/path';
 export class Usage extends APIResource {
   /**
    * Retrieves historical usage data for a customer's metered feature over time.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.usage.history(
+   *   'featureId',
+   *   {
+   *     customerId: 'customerId',
+   *     startDate: '2019-12-27T18:11:19.117Z',
+   *   },
+   * );
+   * ```
    */
   history(
     featureID: string,
@@ -24,6 +35,19 @@ export class Usage extends APIResource {
   /**
    * Reports usage measurements for metered features. The reported usage is used to
    * track, limit, and bill customer consumption.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.usage.report({
+   *   usages: [
+   *     {
+   *       customerId: 'customerId',
+   *       featureId: 'featureId',
+   *       value: -9007199254740991,
+   *     },
+   *   ],
+   * });
+   * ```
    */
   report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
     return this._client.post('/api/v1/usage', { body, ...options });

package/src/resources/v1/v1.ts

@@ -11,8 +11,6 @@ import {
   CouponUpdateCouponParams,
   Coupons,
 } from './coupons';
-import * as EventsAPI from './events';
-import { EventReportParams, EventReportResponse, Events } from './events';
 import * as FeaturesAPI from './features';
 import {
   Feature,
@@ -46,6 +44,9 @@ import * as AddonsAPI from './addons/addons';
 import {
   Addon,
   AddonCreateParams,
+  AddonListChargesParams,
+  AddonListChargesResponse,
+  AddonListChargesResponsesMyCursorIDPage,
   AddonListParams,
   AddonListResponse,
   AddonListResponsesMyCursorIDPage,
@@ -57,6 +58,8 @@ import {
 } from './addons/addons';
 import * as CreditsAPI from './credits/credits';
 import {
+  CreditGetAutoRechargeParams,
+  CreditGetAutoRechargeResponse,
   CreditGetUsageParams,
   CreditGetUsageResponse,
   CreditListLedgerParams,
@@ -84,10 +87,18 @@ import {
   CustomerUpdateParams,
   Customers,
 } from './customers/customers';
+import * as EventsAPI from './events/events';
+import { EventReportParams, EventReportResponse, Events } from './events/events';
 import * as PlansAPI from './plans/plans';
 import {
   Plan,
   PlanCreateParams,
+  PlanListChargesParams,
+  PlanListChargesResponse,
+  PlanListChargesResponsesMyCursorIDPage,
+  PlanListOverageChargesParams,
+  PlanListOverageChargesResponse,
+  PlanListOverageChargesResponsesMyCursorIDPage,
   PlanListParams,
   PlanListResponse,
   PlanListResponsesMyCursorIDPage,
@@ -199,9 +210,11 @@ export declare namespace V1 {
 
   export {
     Credits as Credits,
+    type CreditGetAutoRechargeResponse as CreditGetAutoRechargeResponse,
     type CreditGetUsageResponse as CreditGetUsageResponse,
     type CreditListLedgerResponse as CreditListLedgerResponse,
     type CreditListLedgerResponsesMyCursorIDPage as CreditListLedgerResponsesMyCursorIDPage,
+    type CreditGetAutoRechargeParams as CreditGetAutoRechargeParams,
     type CreditGetUsageParams as CreditGetUsageParams,
     type CreditListLedgerParams as CreditListLedgerParams,
   };
@@ -220,12 +233,15 @@ export declare namespace V1 {
     Addons as Addons,
     type Addon as Addon,
     type AddonListResponse as AddonListResponse,
+    type AddonListChargesResponse as AddonListChargesResponse,
     type AddonPublishResponse as AddonPublishResponse,
     type AddonRemoveDraftResponse as AddonRemoveDraftResponse,
     type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage,
+    type AddonListChargesResponsesMyCursorIDPage as AddonListChargesResponsesMyCursorIDPage,
     type AddonCreateParams as AddonCreateParams,
     type AddonUpdateParams as AddonUpdateParams,
     type AddonListParams as AddonListParams,
+    type AddonListChargesParams as AddonListChargesParams,
     type AddonPublishParams as AddonPublishParams,
   };
 
@@ -233,12 +249,18 @@ export declare namespace V1 {
     Plans as Plans,
     type Plan as Plan,
     type PlanListResponse as PlanListResponse,
+    type PlanListChargesResponse as PlanListChargesResponse,
+    type PlanListOverageChargesResponse as PlanListOverageChargesResponse,
     type PlanPublishResponse as PlanPublishResponse,
     type PlanRemoveDraftResponse as PlanRemoveDraftResponse,
     type PlanListResponsesMyCursorIDPage as PlanListResponsesMyCursorIDPage,
+    type PlanListChargesResponsesMyCursorIDPage as PlanListChargesResponsesMyCursorIDPage,
+    type PlanListOverageChargesResponsesMyCursorIDPage as PlanListOverageChargesResponsesMyCursorIDPage,
     type PlanCreateParams as PlanCreateParams,
     type PlanUpdateParams as PlanUpdateParams,
     type PlanListParams as PlanListParams,
+    type PlanListChargesParams as PlanListChargesParams,
+    type PlanListOverageChargesParams as PlanListOverageChargesParams,
     type PlanPublishParams as PlanPublishParams,
   };
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-beta.2'; // x-release-please-version
+export const VERSION = '0.1.0-beta.20'; // x-release-please-version

package/uploads.d.mts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/uploads.d.ts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.js";
 //# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}

package/uploads.mjs

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.2";
+export declare const VERSION = "0.1.0-beta.20";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,iBAAiB,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.2";
+export declare const VERSION = "0.1.0-beta.20";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,iBAAiB,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-beta.2'; // x-release-please-version
+exports.VERSION = '0.1.0-beta.20'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,cAAc,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-beta.2'; // x-release-please-version
+export const VERSION = '0.1.0-beta.20'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,cAAc,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}