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

package/resources/v1/coupons.js

@@ -12,18 +12,44 @@ class Coupons extends resource_1.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, options) {
         return this._client.post('/api/v1/coupons', { body, ...options });
     }
     /**
      * Retrieves a coupon by its unique identifier.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.v1.coupons.retrieve('x');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/api/v1/coupons/${id}`, options);
     }
     /**
      * 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 = {}, options) {
         return this._client.getAPIList('/api/v1/coupons', (pagination_1.MyCursorIDPage), {
@@ -33,12 +59,22 @@ class Coupons extends resource_1.APIResource {
     }
     /**
      * Archives a coupon, preventing it from being applied to new subscriptions.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.v1.coupons.archiveCoupon('x');
+     * ```
      */
     archiveCoupon(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/coupons/${id}/archive`, options);
     }
     /**
      * Updates an existing coupon's properties such as name, description, and metadata.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.v1.coupons.updateCoupon('x');
+     * ```
      */
     updateCoupon(id, body, options) {
         return this._client.patch((0, path_1.path) `/api/v1/coupons/${id}`, { body, ...options });

package/resources/v1/coupons.js.map

@@ -1 +1 @@
-{"version":3,"file":"coupons.js","sourceRoot":"","sources":["../../src/resources/v1/coupons.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAE/F,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,2BAAkC,CAAA,EAAE;YACpF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,EAAU,EAAE,IAA8B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA1CD,0BA0CC"}
+{"version":3,"file":"coupons.js","sourceRoot":"","sources":["../../src/resources/v1/coupons.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAE/F,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,2BAAkC,CAAA,EAAE;YACpF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,EAAU,EAAE,IAA8B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA9ED,0BA8EC"}

package/resources/v1/coupons.mjs

@@ -9,18 +9,44 @@ 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, options) {
         return this._client.post('/api/v1/coupons', { body, ...options });
     }
     /**
      * Retrieves a coupon by its unique identifier.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.v1.coupons.retrieve('x');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(path `/api/v1/coupons/${id}`, options);
     }
     /**
      * 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 = {}, options) {
         return this._client.getAPIList('/api/v1/coupons', (MyCursorIDPage), {
@@ -30,12 +56,22 @@ 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, options) {
         return this._client.post(path `/api/v1/coupons/${id}/archive`, options);
     }
     /**
      * Updates an existing coupon's properties such as name, description, and metadata.
+     *
+     * @example
+     * ```ts
+     * const coupon = await client.v1.coupons.updateCoupon('x');
+     * ```
      */
     updateCoupon(id, body, options) {
         return this._client.patch(path `/api/v1/coupons/${id}`, { body, ...options });

package/resources/v1/coupons.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"coupons.mjs","sourceRoot":"","sources":["../../src/resources/v1/coupons.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,cAAc,EAA0C;OAE1D,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,cAAkC,CAAA,EAAE;YACpF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,mBAAmB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,EAAU,EAAE,IAA8B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}
+{"version":3,"file":"coupons.mjs","sourceRoot":"","sources":["../../src/resources/v1/coupons.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAA,cAAkC,CAAA,EAAE;YACpF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,mBAAmB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,EAAU,EAAE,IAA8B,EAAE,OAAwB;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}

package/resources/v1/{events/credits → credits}/credits.d.mts

@@ -1,26 +1,51 @@
-import { APIResource } from "../../../../core/resource.mjs";
+import { APIResource } from "../../../core/resource.mjs";
 import * as CustomCurrenciesAPI from "./custom-currencies.mjs";
-import { CustomCurrencies, CustomCurrencyArchiveResponse, CustomCurrencyCreateParams, CustomCurrencyCreateResponse, CustomCurrencyListAssociatedEntitiesResponse, CustomCurrencyListParams, CustomCurrencyListResponse, CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyUnarchiveResponse, CustomCurrencyUpdateParams, CustomCurrencyUpdateResponse } from "./custom-currencies.mjs";
+import { CustomCurrencies, CustomCurrencyCreateParams, CustomCurrencyListAssociatedEntitiesResponse, CustomCurrencyListParams, CustomCurrencyListResponse, CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyResponse, CustomCurrencyUpdateParams } from "./custom-currencies.mjs";
 import * as GrantsAPI from "./grants.mjs";
 import { CreditGrantResponse, GrantCreateParams, GrantListParams, GrantListResponse, GrantListResponsesMyCursorIDPage, Grants } from "./grants.mjs";
-import { APIPromise } from "../../../../core/api-promise.mjs";
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../../core/pagination.mjs";
-import { RequestOptions } from "../../../../internal/request-options.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Credits extends APIResource {
     grants: GrantsAPI.Grants;
     customCurrencies: CustomCurrenciesAPI.CustomCurrencies;
     /**
      * 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>;
     /**
      * 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>;
     /**
      * 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, options?: RequestOptions): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse>;
 }
@@ -139,13 +164,13 @@ export declare namespace CreditGetUsageResponse {
          */
         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
              */
@@ -154,6 +179,10 @@ export declare 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>;
         }
         namespace Series {
             /**
@@ -169,6 +198,19 @@ export declare namespace CreditGetUsageResponse {
                  */
                 value: number;
             }
+            /**
+             * Dimension key/value pair identifying a credit usage series
+             */
+            interface Tag {
+                /**
+                 * The dimension key
+                 */
+                key: string;
+                /**
+                 * The dimension value for this series
+                 */
+                value: string;
+            }
         }
     }
 }
@@ -237,6 +279,11 @@ export interface CreditGetUsageParams {
      * startDate is provided
      */
     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
      */
@@ -269,6 +316,6 @@ export interface CreditListLedgerParams extends MyCursorIDPageParams {
 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, };
     export { Grants as Grants, type CreditGrantResponse as CreditGrantResponse, type GrantListResponse as GrantListResponse, type GrantListResponsesMyCursorIDPage as GrantListResponsesMyCursorIDPage, type GrantCreateParams as GrantCreateParams, type GrantListParams as GrantListParams, };
-    export { CustomCurrencies as CustomCurrencies, type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse, type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse, 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, type CustomCurrencyListParams as CustomCurrencyListParams, };
+    export { CustomCurrencies as CustomCurrencies, type CustomCurrencyResponse as CustomCurrencyResponse, type CustomCurrencyListResponse as CustomCurrencyListResponse, type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse, type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage, type CustomCurrencyCreateParams as CustomCurrencyCreateParams, type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams, type CustomCurrencyListParams as CustomCurrencyListParams, };
 }
 //# sourceMappingURL=credits.d.mts.map

package/resources/v1/credits/credits.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/credits/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,4CAA4C,EAC5C,wBAAwB,EACxB,0BAA0B,EAC1B,yCAAyC,EACzC,sBAAsB,EACtB,0BAA0B,EAC3B,gCAA4B;AAC7B,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,gCAAgC,EAChC,MAAM,EACP,qBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,qCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAEnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;;;;;;;;;;OAWG;IACH,eAAe,CACb,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,wBAAwB,CAAC;CAMlF;AAED,MAAM,MAAM,uCAAuC,GAAG,cAAc,CAAC,wBAAwB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,qBAAqB,EAAE,SAAS,GAAG,QAAQ,CAAC;QAE5C;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,eAAe,GAAG,eAAe,CAAC;QAEjD;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;YAED;;eAEG;YACH,UAAiB,GAAG;gBAClB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EACL,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,GACjB,qCAAqC,GACrC,qCAAqC,CAAC;IAE1C;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;CACnE;AAED,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IAClE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

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

@@ -1,26 +1,51 @@
-import { APIResource } from "../../../../core/resource.js";
+import { APIResource } from "../../../core/resource.js";
 import * as CustomCurrenciesAPI from "./custom-currencies.js";
-import { CustomCurrencies, CustomCurrencyArchiveResponse, CustomCurrencyCreateParams, CustomCurrencyCreateResponse, CustomCurrencyListAssociatedEntitiesResponse, CustomCurrencyListParams, CustomCurrencyListResponse, CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyUnarchiveResponse, CustomCurrencyUpdateParams, CustomCurrencyUpdateResponse } from "./custom-currencies.js";
+import { CustomCurrencies, CustomCurrencyCreateParams, CustomCurrencyListAssociatedEntitiesResponse, CustomCurrencyListParams, CustomCurrencyListResponse, CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyResponse, CustomCurrencyUpdateParams } from "./custom-currencies.js";
 import * as GrantsAPI from "./grants.js";
 import { CreditGrantResponse, GrantCreateParams, GrantListParams, GrantListResponse, GrantListResponsesMyCursorIDPage, Grants } from "./grants.js";
-import { APIPromise } from "../../../../core/api-promise.js";
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../../core/pagination.js";
-import { RequestOptions } from "../../../../internal/request-options.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Credits extends APIResource {
     grants: GrantsAPI.Grants;
     customCurrencies: CustomCurrenciesAPI.CustomCurrencies;
     /**
      * 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>;
     /**
      * 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>;
     /**
      * 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, options?: RequestOptions): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse>;
 }
@@ -139,13 +164,13 @@ export declare namespace CreditGetUsageResponse {
          */
         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
              */
@@ -154,6 +179,10 @@ export declare 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>;
         }
         namespace Series {
             /**
@@ -169,6 +198,19 @@ export declare namespace CreditGetUsageResponse {
                  */
                 value: number;
             }
+            /**
+             * Dimension key/value pair identifying a credit usage series
+             */
+            interface Tag {
+                /**
+                 * The dimension key
+                 */
+                key: string;
+                /**
+                 * The dimension value for this series
+                 */
+                value: string;
+            }
         }
     }
 }
@@ -237,6 +279,11 @@ export interface CreditGetUsageParams {
      * startDate is provided
      */
     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
      */
@@ -269,6 +316,6 @@ export interface CreditListLedgerParams extends MyCursorIDPageParams {
 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, };
     export { Grants as Grants, type CreditGrantResponse as CreditGrantResponse, type GrantListResponse as GrantListResponse, type GrantListResponsesMyCursorIDPage as GrantListResponsesMyCursorIDPage, type GrantCreateParams as GrantCreateParams, type GrantListParams as GrantListParams, };
-    export { CustomCurrencies as CustomCurrencies, type CustomCurrencyCreateResponse as CustomCurrencyCreateResponse, type CustomCurrencyUpdateResponse as CustomCurrencyUpdateResponse, 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, type CustomCurrencyListParams as CustomCurrencyListParams, };
+    export { CustomCurrencies as CustomCurrencies, type CustomCurrencyResponse as CustomCurrencyResponse, type CustomCurrencyListResponse as CustomCurrencyListResponse, type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse, type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage, type CustomCurrencyCreateParams as CustomCurrencyCreateParams, type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams, type CustomCurrencyListParams as CustomCurrencyListParams, };
 }
 //# sourceMappingURL=credits.d.ts.map

package/resources/v1/credits/credits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/credits/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,4CAA4C,EAC5C,wBAAwB,EACxB,0BAA0B,EAC1B,yCAAyC,EACzC,sBAAsB,EACtB,0BAA0B,EAC3B,+BAA4B;AAC7B,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,gCAAgC,EAChC,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;;;;;;;;;;OAWG;IACH,eAAe,CACb,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,wBAAwB,CAAC;CAMlF;AAED,MAAM,MAAM,uCAAuC,GAAG,cAAc,CAAC,wBAAwB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,qBAAqB,EAAE,SAAS,GAAG,QAAQ,CAAC;QAE5C;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,eAAe,GAAG,eAAe,CAAC;QAEjD;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;YAED;;eAEG;YACH,UAAiB,GAAG;gBAClB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EACL,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,GACjB,qCAAqC,GACrC,qCAAqC,CAAC;IAE1C;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;CACnE;AAED,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IAClE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/v1/{events/credits → credits}/credits.js

@@ -2,13 +2,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Credits = void 0;
-const tslib_1 = require("../../../../internal/tslib.js");
-const resource_1 = require("../../../../core/resource.js");
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
 const CustomCurrenciesAPI = tslib_1.__importStar(require("./custom-currencies.js"));
 const custom_currencies_1 = require("./custom-currencies.js");
 const GrantsAPI = tslib_1.__importStar(require("./grants.js"));
 const grants_1 = require("./grants.js");
-const pagination_1 = require("../../../../core/pagination.js");
+const pagination_1 = require("../../../core/pagination.js");
 class Credits extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -18,6 +18,14 @@ class Credits extends resource_1.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, options) {
         return this._client.get('/api/v1/credits/auto-recharge', { query, ...options });
@@ -25,12 +33,29 @@ class Credits extends resource_1.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, options) {
         return this._client.get('/api/v1/credits/usage', { query, ...options });
     }
     /**
      * 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, options) {
         return this._client.getAPIList('/api/v1/credits/ledger', (pagination_1.MyCursorIDPage), {

package/resources/v1/credits/credits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.js","sourceRoot":"","sources":["../../../src/resources/v1/credits/credits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,oFAA2D;AAC3D,8DAS6B;AAC7B,+DAAsC;AACtC,wCAOkB;AAElB,4DAAkG;AAGlG,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IA0DJ,CAAC;IAxDC;;;;;;;;;;;OAWG;IACH,eAAe,CACb,KAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAA2B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,2BAAwC,CAAA,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,0BA8DC;AAoUD,OAAO,CAAC,MAAM,GAAG,eAAM,CAAC;AACxB,OAAO,CAAC,gBAAgB,GAAG,oCAAgB,CAAC"}

package/resources/v1/{events/credits → credits}/credits.mjs

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../../core/resource.mjs";
+import { APIResource } from "../../../core/resource.mjs";
 import * as CustomCurrenciesAPI from "./custom-currencies.mjs";
 import { CustomCurrencies, } from "./custom-currencies.mjs";
 import * as GrantsAPI from "./grants.mjs";
 import { Grants, } from "./grants.mjs";
-import { MyCursorIDPage } from "../../../../core/pagination.mjs";
+import { MyCursorIDPage } from "../../../core/pagination.mjs";
 export class Credits extends APIResource {
     constructor() {
         super(...arguments);
@@ -14,6 +14,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, options) {
         return this._client.get('/api/v1/credits/auto-recharge', { query, ...options });
@@ -21,12 +29,29 @@ 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, options) {
         return this._client.get('/api/v1/credits/usage', { query, ...options });
     }
     /**
      * 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, options) {
         return this._client.getAPIList('/api/v1/credits/ledger', (MyCursorIDPage), {

package/resources/v1/credits/credits.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../../../src/resources/v1/credits/credits.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EACL,gBAAgB,GAQjB,gCAA4B;AAC7B,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAML,MAAM,GACP,qBAAiB;AAElB,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAGlG,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IA0DJ,CAAC;IAxDC;;;;;;;;;;;OAWG;IACH,eAAe,CACb,KAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAA2B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,cAAwC,CAAA,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAoUD,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;AACxB,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAC"}