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

package/src/resources/v1/addons/entitlements.ts

@@ -8,6 +8,14 @@ import { path } from '../../../internal/utils/path';
 export class Entitlements extends APIResource {
   /**
    * Creates one or more entitlements (feature or credit) on a draft addon.
+   *
+   * @example
+   * ```ts
+   * const entitlement =
+   *   await client.v1.addons.entitlements.create('addonId', {
+   *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+   *   });
+   * ```
    */
   create(
     addonID: string,
@@ -19,6 +27,15 @@ export class Entitlements extends APIResource {
 
   /**
    * Updates an existing entitlement on a draft addon.
+   *
+   * @example
+   * ```ts
+   * const addonPackageEntitlement =
+   *   await client.v1.addons.entitlements.update('id', {
+   *     addonId: 'addonId',
+   *     type: 'FEATURE',
+   *   });
+   * ```
    */
   update(
     id: string,
@@ -31,6 +48,12 @@ export class Entitlements extends APIResource {
 
   /**
    * Retrieves a list of entitlements for an addon.
+   *
+   * @example
+   * ```ts
+   * const entitlements =
+   *   await client.v1.addons.entitlements.list('addonId');
+   * ```
    */
   list(addonID: string, options?: RequestOptions): APIPromise<EntitlementListResponse> {
     return this._client.get(path`/api/v1/addons/${addonID}/entitlements`, options);
@@ -38,6 +61,14 @@ export class Entitlements extends APIResource {
 
   /**
    * Deletes an entitlement from a draft addon.
+   *
+   * @example
+   * ```ts
+   * const addonPackageEntitlement =
+   *   await client.v1.addons.entitlements.delete('id', {
+   *     addonId: 'addonId',
+   *   });
+   * ```
    */
   delete(
     id: string,

package/src/resources/v1/addons/index.ts

@@ -4,13 +4,16 @@ export {
   Addons,
   type Addon,
   type AddonListResponse,
+  type AddonListChargesResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
   type AddonCreateParams,
   type AddonUpdateParams,
   type AddonListParams,
+  type AddonListChargesParams,
   type AddonPublishParams,
   type AddonListResponsesMyCursorIDPage,
+  type AddonListChargesResponsesMyCursorIDPage,
 } from './addons';
 export {
   Entitlements,

package/src/resources/v1/coupons.ts

@@ -13,6 +13,19 @@ export class Coupons extends APIResource {
   /**
    * Creates a new discount coupon with percentage or fixed amount off, applicable to
    * customer subscriptions.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.create({
+   *   id: 'id',
+   *   amountsOff: [{ amount: 0, currency: 'usd' }],
+   *   description: 'description',
+   *   durationInMonths: 1,
+   *   metadata: { foo: 'string' },
+   *   name: 'name',
+   *   percentOff: 1,
+   * });
+   * ```
    */
   create(body: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon> {
     return this._client.post('/api/v1/coupons', { body, ...options });
@@ -20,6 +33,11 @@ export class Coupons extends APIResource {
 
   /**
    * Retrieves a coupon by its unique identifier.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.retrieve('x');
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Coupon> {
     return this._client.get(path`/api/v1/coupons/${id}`, options);
@@ -27,6 +45,14 @@ export class Coupons extends APIResource {
 
   /**
    * Retrieves a paginated list of coupons in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const couponListResponse of client.v1.coupons.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: CouponListParams | null | undefined = {},
@@ -40,6 +66,11 @@ export class Coupons extends APIResource {
 
   /**
    * Archives a coupon, preventing it from being applied to new subscriptions.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.archiveCoupon('x');
+   * ```
    */
   archiveCoupon(id: string, options?: RequestOptions): APIPromise<Coupon> {
     return this._client.post(path`/api/v1/coupons/${id}/archive`, options);
@@ -47,6 +78,11 @@ export class Coupons extends APIResource {
 
   /**
    * Updates an existing coupon's properties such as name, description, and metadata.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.updateCoupon('x');
+   * ```
    */
   updateCoupon(id: string, body: CouponUpdateCouponParams, options?: RequestOptions): APIPromise<Coupon> {
     return this._client.patch(path`/api/v1/coupons/${id}`, { body, ...options });

package/src/resources/v1/{events/credits → credits}/credits.ts

@@ -1,19 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
+import { APIResource } from '../../../core/resource';
 import * as CustomCurrenciesAPI from './custom-currencies';
 import {
   CustomCurrencies,
-  CustomCurrencyArchiveResponse,
   CustomCurrencyCreateParams,
-  CustomCurrencyCreateResponse,
   CustomCurrencyListAssociatedEntitiesResponse,
   CustomCurrencyListParams,
   CustomCurrencyListResponse,
   CustomCurrencyListResponsesMyCursorIDPage,
-  CustomCurrencyUnarchiveResponse,
+  CustomCurrencyResponse,
   CustomCurrencyUpdateParams,
-  CustomCurrencyUpdateResponse,
 } from './custom-currencies';
 import * as GrantsAPI from './grants';
 import {
@@ -24,9 +21,9 @@ import {
   GrantListResponsesMyCursorIDPage,
   Grants,
 } from './grants';
-import { APIPromise } from '../../../../core/api-promise';
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../core/pagination';
-import { RequestOptions } from '../../../../internal/request-options';
+import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Credits extends APIResource {
   grants: GrantsAPI.Grants = new GrantsAPI.Grants(this._client);
@@ -37,6 +34,14 @@ export class Credits extends APIResource {
   /**
    * Retrieves the automatic recharge configuration for a customer and currency.
    * Returns default settings if no configuration exists.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.credits.getAutoRecharge({
+   *   currencyId: 'currencyId',
+   *   customerId: 'customerId',
+   * });
+   * ```
    */
   getAutoRecharge(
     query: CreditGetAutoRechargeParams,
@@ -48,6 +53,13 @@ export class Credits extends APIResource {
   /**
    * Retrieves credit usage time-series data for a customer, grouped by feature, over
    * a specified time range.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.credits.getUsage({
+   *   customerId: 'customerId',
+   * });
+   * ```
    */
   getUsage(query: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
     return this._client.get('/api/v1/credits/usage', { query, ...options });
@@ -55,6 +67,16 @@ export class Credits extends APIResource {
 
   /**
    * Retrieves a paginated list of credit ledger events for a customer.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditListLedgerResponse of client.v1.credits.listLedger(
+   *   { customerId: 'customerId' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listLedger(
     query: CreditListLedgerParams,
@@ -203,14 +225,14 @@ export namespace CreditGetUsageResponse {
      */
     export interface Series {
       /**
-       * The feature ID
+       * The feature ID; null when grouping by dimensions only
        */
-      featureId: string;
+      featureId: string | null;
 
       /**
-       * The display name of the feature
+       * The display name of the feature; null when grouping by dimensions only
        */
-      featureName: string;
+      featureName: string | null;
 
       /**
        * Time-series data points for this feature
@@ -221,6 +243,11 @@ export namespace CreditGetUsageResponse {
        * Total credits consumed by this feature in the time range
        */
       totalCredits: number;
+
+      /**
+       * Dimension key/value pairs identifying this series when groupBy is applied
+       */
+      tags?: Array<Series.Tag>;
     }
 
     export namespace Series {
@@ -238,6 +265,21 @@ export namespace CreditGetUsageResponse {
          */
         value: number;
       }
+
+      /**
+       * Dimension key/value pair identifying a credit usage series
+       */
+      export interface Tag {
+        /**
+         * The dimension key
+         */
+        key: string;
+
+        /**
+         * The dimension value for this series
+         */
+        value: string;
+      }
     }
   }
 }
@@ -328,6 +370,12 @@ export interface CreditGetUsageParams {
    */
   endDate?: string;
 
+  /**
+   * Comma-separated list of feature dimension keys to group usage series by (up to
+   * 3). Each key matches /^[a-zA-Z0-9_$-]+$/
+   */
+  groupBy?: string;
+
   /**
    * Filter by resource ID
    */
@@ -388,12 +436,9 @@ export declare namespace Credits {
 
   export {
     CustomCurrencies as CustomCurrencies,
-    type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse,
-    type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
-    type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
-    type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
     type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
     type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,

package/src/resources/v1/{events/credits → credits}/custom-currencies.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
-import { APIPromise } from '../../../../core/api-promise';
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../core/pagination';
-import { RequestOptions } from '../../../../internal/request-options';
-import { path } from '../../../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Operations related to custom currencies
@@ -12,22 +12,36 @@ import { path } from '../../../../internal/utils/path';
 export class CustomCurrencies extends APIResource {
   /**
    * Creates a new custom currency in the environment.
-   */
-  create(
-    body: CustomCurrencyCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<CustomCurrencyCreateResponse> {
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.create({
+   *     id: 'id',
+   *     displayName: 'displayName',
+   *   });
+   * ```
+   */
+  create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     return this._client.post('/api/v1/credits/custom-currencies', { body, ...options });
   }
 
   /**
    * Updates an existing custom currency. Only the supplied fields are modified.
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.update(
+   *     'currencyId',
+   *   );
+   * ```
    */
   update(
     currencyID: string,
     body: CustomCurrencyUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<CustomCurrencyUpdateResponse> {
+  ): APIPromise<CustomCurrencyResponse> {
     return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, { body, ...options });
   }
 
@@ -35,6 +49,14 @@ export class CustomCurrencies extends APIResource {
    * Retrieves a paginated list of custom currencies in the environment. Archived
    * currencies are excluded by default; pass `status=ARCHIVED` (or
    * `status=ACTIVE,ARCHIVED`) to include them.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: CustomCurrencyListParams | null | undefined = {},
@@ -51,14 +73,30 @@ export class CustomCurrencies extends APIResource {
    * Archives a custom currency. Fails if the currency is still associated with any
    * active plan or addon — use the associated-entities endpoint first to inspect
    * dependencies.
-   */
-  archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyArchiveResponse> {
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.archive(
+   *     'currencyId',
+   *   );
+   * ```
+   */
+  archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/archive`, options);
   }
 
   /**
    * Lists the active plans and addons that reference a custom currency. Useful
    * before archiving to inspect dependencies.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.credits.customCurrencies.listAssociatedEntities(
+   *     'currencyId',
+   *   );
+   * ```
    */
   listAssociatedEntities(
     currencyID: string,
@@ -73,8 +111,16 @@ export class CustomCurrencies extends APIResource {
   /**
    * Restores a previously archived custom currency. Fails if another active currency
    * with the same ID already exists.
-   */
-  unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyUnarchiveResponse> {
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.unarchive(
+   *     'currencyId',
+   *   );
+   * ```
+   */
+  unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
     return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/unarchive`, options);
   }
 }
@@ -84,93 +130,14 @@ export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCur
 /**
  * Response object
  */
-export interface CustomCurrencyCreateResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  data: CustomCurrencyCreateResponse.Data;
-}
-
-export namespace CustomCurrencyCreateResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the custom currency
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the currency
-     */
-    description: string | null;
-
-    /**
-     * The display name of the custom currency
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * The symbol used to represent the custom currency
-     */
-    symbol: string | null;
-
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    units: Data.Units | null;
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    export interface Units {
-      /**
-       * Plural form of the unit label
-       */
-      plural: string | null;
-
-      /**
-       * Singular form of the unit label
-       */
-      singular: string | null;
-    }
-  }
-}
-
-/**
- * Response object
- */
-export interface CustomCurrencyUpdateResponse {
+export interface CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
-  data: CustomCurrencyUpdateResponse.Data;
+  data: CustomCurrencyResponse.Data;
 }
 
-export namespace CustomCurrencyUpdateResponse {
+export namespace CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
@@ -306,85 +273,6 @@ export namespace CustomCurrencyListResponse {
   }
 }
 
-/**
- * Response object
- */
-export interface CustomCurrencyArchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  data: CustomCurrencyArchiveResponse.Data;
-}
-
-export namespace CustomCurrencyArchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the custom currency
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the currency
-     */
-    description: string | null;
-
-    /**
-     * The display name of the custom currency
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * The symbol used to represent the custom currency
-     */
-    symbol: string | null;
-
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    units: Data.Units | null;
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    export interface Units {
-      /**
-       * Plural form of the unit label
-       */
-      plural: string | null;
-
-      /**
-       * Singular form of the unit label
-       */
-      singular: string | null;
-    }
-  }
-}
-
 /**
  * List of entities (plans or addons) that reference a custom currency
  */
@@ -414,85 +302,6 @@ export namespace CustomCurrencyListAssociatedEntitiesResponse {
   }
 }
 
-/**
- * Response object
- */
-export interface CustomCurrencyUnarchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  data: CustomCurrencyUnarchiveResponse.Data;
-}
-
-export namespace CustomCurrencyUnarchiveResponse {
-  /**
-   * A custom currency used to denominate credit-based entitlements and pricing
-   */
-  export interface Data {
-    /**
-     * The unique identifier for the custom currency
-     */
-    id: string;
-
-    /**
-     * Timestamp of when the record was deleted
-     */
-    archivedAt: string | null;
-
-    /**
-     * Timestamp of when the record was created
-     */
-    createdAt: string;
-
-    /**
-     * Description of the currency
-     */
-    description: string | null;
-
-    /**
-     * The display name of the custom currency
-     */
-    displayName: string;
-
-    /**
-     * Metadata associated with the entity
-     */
-    metadata: { [key: string]: string };
-
-    /**
-     * The symbol used to represent the custom currency
-     */
-    symbol: string | null;
-
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    units: Data.Units | null;
-
-    /**
-     * Timestamp of when the record was last updated
-     */
-    updatedAt: string;
-  }
-
-  export namespace Data {
-    /**
-     * Singular and plural unit labels for a custom currency
-     */
-    export interface Units {
-      /**
-       * Plural form of the unit label
-       */
-      plural: string | null;
-
-      /**
-       * Singular form of the unit label
-       */
-      singular: string | null;
-    }
-  }
-}
-
 export interface CustomCurrencyCreateParams {
   /**
    * The unique identifier for the new custom currency
@@ -601,12 +410,9 @@ export interface CustomCurrencyListParams extends MyCursorIDPageParams {
 
 export declare namespace CustomCurrencies {
   export {
-    type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse,
-    type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
-    type CustomCurrencyArchiveResponse as CustomCurrencyArchiveResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
-    type CustomCurrencyUnarchiveResponse as CustomCurrencyUnarchiveResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
     type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
     type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,