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

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/credits/credits.ts

@@ -1,21 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as AutoRechargeAPI from './auto-recharge';
-import {
-  AutoRecharge,
-  AutoRechargeGetAutoRechargeParams,
-  AutoRechargeGetAutoRechargeResponse,
-} from './auto-recharge';
 import * as CustomCurrenciesAPI from './custom-currencies';
 import {
   CustomCurrencies,
-  CustomCurrency,
   CustomCurrencyCreateParams,
   CustomCurrencyListAssociatedEntitiesResponse,
   CustomCurrencyListParams,
   CustomCurrencyListResponse,
   CustomCurrencyListResponsesMyCursorIDPage,
+  CustomCurrencyResponse,
   CustomCurrencyUpdateParams,
 } from './custom-currencies';
 import * as GrantsAPI from './grants';
@@ -36,11 +30,36 @@ export class Credits extends APIResource {
   customCurrencies: CustomCurrenciesAPI.CustomCurrencies = new CustomCurrenciesAPI.CustomCurrencies(
     this._client,
   );
-  autoRecharge: AutoRechargeAPI.AutoRecharge = new AutoRechargeAPI.AutoRecharge(this._client);
+
+  /**
+   * 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,
+    options?: RequestOptions,
+  ): APIPromise<CreditGetAutoRechargeResponse> {
+    return this._client.get('/api/v1/credits/auto-recharge', { query, ...options });
+  }
 
   /**
    * 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 });
@@ -48,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,
@@ -62,6 +91,78 @@ export class Credits extends APIResource {
 
 export type CreditListLedgerResponsesMyCursorIDPage = MyCursorIDPage<CreditListLedgerResponse>;
 
+/**
+ * Response object
+ */
+export interface CreditGetAutoRechargeResponse {
+  /**
+   * Automatic recharge configuration for a customer and currency
+   */
+  data: CreditGetAutoRechargeResponse.Data;
+}
+
+export namespace CreditGetAutoRechargeResponse {
+  /**
+   * Automatic recharge configuration for a customer and currency
+   */
+  export interface Data {
+    /**
+     * The unique configuration ID
+     */
+    id: string | null;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string | null;
+
+    /**
+     * The currency ID for this configuration
+     */
+    currencyId: string;
+
+    /**
+     * The customer ID this configuration belongs to
+     */
+    customerId: string;
+
+    /**
+     * Expiration period for auto-recharge grants (1_MONTH or 1_YEAR)
+     */
+    grantExpirationPeriod: '1_MONTH' | '1_YEAR';
+
+    /**
+     * Whether automatic recharge is enabled
+     */
+    isEnabled: boolean;
+
+    /**
+     * Maximum monthly spend limit for automatic recharges
+     */
+    maxSpendLimit: number | null;
+
+    /**
+     * The target credit balance to recharge to
+     */
+    targetBalance: number;
+
+    /**
+     * The threshold type (CREDIT_AMOUNT or DOLLAR_AMOUNT)
+     */
+    thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT';
+
+    /**
+     * The threshold value that triggers a recharge
+     */
+    thresholdValue: number;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string | null;
+  }
+}
+
 /**
  * Response object
  */
@@ -82,6 +183,13 @@ export namespace CreditGetUsageResponse {
      */
     currency: Data.Currency | null;
 
+    /**
+     * Cursor-based pagination for the returned series. `next`/`prev` are opaque
+     * cursors; pass them back as `after`/`before` to traverse pages. The series axis
+     * is `groupBy` when provided, otherwise `featureId`
+     */
+    pagination: Data.Pagination;
+
     /**
      * Credit usage series grouped by feature
      */
@@ -119,19 +227,37 @@ export namespace CreditGetUsageResponse {
       symbol: string | null;
     }
 
+    /**
+     * Cursor-based pagination for the returned series. `next`/`prev` are opaque
+     * cursors; pass them back as `after`/`before` to traverse pages. The series axis
+     * is `groupBy` when provided, otherwise `featureId`
+     */
+    export interface Pagination {
+      /**
+       * Cursor for fetching the next page of results, or null if no additional pages
+       * exist
+       */
+      next: string | null;
+
+      /**
+       * Cursor for fetching the previous page of results, or null if at the beginning
+       */
+      prev: string | null;
+    }
+
     /**
      * Credit usage data for a single feature
      */
     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
@@ -142,6 +268,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 {
@@ -159,6 +290,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;
+      }
     }
   }
 }
@@ -220,12 +366,34 @@ export interface CreditListLedgerResponse {
   timestamp: string;
 }
 
+export interface CreditGetAutoRechargeParams {
+  /**
+   * Filter by currency ID (required)
+   */
+  currencyId: string;
+
+  /**
+   * Filter by customer ID (required)
+   */
+  customerId: string;
+}
+
 export interface CreditGetUsageParams {
   /**
    * Filter by customer ID (required)
    */
   customerId: string;
 
+  /**
+   * Return items that come after this cursor
+   */
+  after?: string;
+
+  /**
+   * Return items that come before this cursor
+   */
+  before?: string;
+
   /**
    * Filter by currency ID
    */
@@ -237,6 +405,17 @@ 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;
+
+  /**
+   * Maximum number of items to return
+   */
+  limit?: number;
+
   /**
    * Filter by resource ID
    */
@@ -274,13 +453,14 @@ export interface CreditListLedgerParams extends MyCursorIDPageParams {
 
 Credits.Grants = Grants;
 Credits.CustomCurrencies = CustomCurrencies;
-Credits.AutoRecharge = AutoRecharge;
 
 export declare namespace Credits {
   export {
+    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,
   };
@@ -296,7 +476,7 @@ export declare namespace Credits {
 
   export {
     CustomCurrencies as CustomCurrencies,
-    type CustomCurrency as CustomCurrency,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
@@ -304,10 +484,4 @@ export declare namespace Credits {
     type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,
     type CustomCurrencyListParams as CustomCurrencyListParams,
   };
-
-  export {
-    AutoRecharge as AutoRecharge,
-    type AutoRechargeGetAutoRechargeResponse as AutoRechargeGetAutoRechargeResponse,
-    type AutoRechargeGetAutoRechargeParams as AutoRechargeGetAutoRechargeParams,
-  };
 }

package/src/resources/v1/credits/custom-currencies.ts

@@ -12,19 +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<CustomCurrency> {
+   *
+   * @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<CustomCurrency> {
+  ): APIPromise<CustomCurrencyResponse> {
     return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, { body, ...options });
   }
 
@@ -32,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 = {},
@@ -48,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<CustomCurrency> {
+   *
+   * @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,
@@ -70,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<CustomCurrency> {
+   *
+   * @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);
   }
 }
@@ -81,14 +130,14 @@ export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCur
 /**
  * Response object
  */
-export interface CustomCurrency {
+export interface CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
-  data: CustomCurrency.Data;
+  data: CustomCurrencyResponse.Data;
 }
 
-export namespace CustomCurrency {
+export namespace CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
@@ -361,7 +410,7 @@ export interface CustomCurrencyListParams extends MyCursorIDPageParams {
 
 export declare namespace CustomCurrencies {
   export {
-    type CustomCurrency as CustomCurrency,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,

package/src/resources/v1/credits/grants.ts

@@ -13,6 +13,18 @@ export class Grants extends APIResource {
   /**
    * Creates a new credit grant for a customer with specified amount, type, and
    * optional billing configuration.
+   *
+   * @example
+   * ```ts
+   * const creditGrantResponse =
+   *   await client.v1.credits.grants.create({
+   *     amount: 0,
+   *     currencyId: 'currencyId',
+   *     customerId: 'customerId',
+   *     displayName: 'displayName',
+   *     grantType: 'PAID',
+   *   });
+   * ```
    */
   create(body: GrantCreateParams, options?: RequestOptions): APIPromise<CreditGrantResponse> {
     return this._client.post('/api/v1/credits/grants', { body, ...options });
@@ -20,6 +32,16 @@ export class Grants extends APIResource {
 
   /**
    * Retrieves a paginated list of credit grants for a customer.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const grantListResponse of client.v1.credits.grants.list(
+   *   { customerId: 'customerId' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: GrantListParams,
@@ -34,6 +56,12 @@ export class Grants extends APIResource {
   /**
    * Voids an existing credit grant, preventing further consumption of the remaining
    * credits.
+   *
+   * @example
+   * ```ts
+   * const creditGrantResponse =
+   *   await client.v1.credits.grants.void('x');
+   * ```
    */
   void(id: string, options?: RequestOptions): APIPromise<CreditGrantResponse> {
     return this._client.post(path`/api/v1/credits/grants/${id}/void`, options);

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

@@ -1,21 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  AutoRecharge,
-  type AutoRechargeGetAutoRechargeResponse,
-  type AutoRechargeGetAutoRechargeParams,
-} from './auto-recharge';
 export {
   Credits,
+  type CreditGetAutoRechargeResponse,
   type CreditGetUsageResponse,
   type CreditListLedgerResponse,
+  type CreditGetAutoRechargeParams,
   type CreditGetUsageParams,
   type CreditListLedgerParams,
   type CreditListLedgerResponsesMyCursorIDPage,
 } from './credits';
 export {
   CustomCurrencies,
-  type CustomCurrency,
+  type CustomCurrencyResponse,
   type CustomCurrencyListResponse,
   type CustomCurrencyListAssociatedEntitiesResponse,
   type CustomCurrencyCreateParams,