@stigg/typescript 0.1.0-alpha.9 → 0.1.0-beta.10

package/resources/v1/credits/credits.mjs

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+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";
+export class Credits extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.grants = new GrantsAPI.Grants(this._client);
+        this.customCurrencies = new CustomCurrenciesAPI.CustomCurrencies(this._client);
+    }
+    /**
+     * Retrieves the automatic recharge configuration for a customer and currency.
+     * Returns default settings if no configuration exists.
+     */
+    getAutoRecharge(query, options) {
+        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.
+     */
+    getUsage(query, options) {
+        return this._client.get('/api/v1/credits/usage', { query, ...options });
+    }
+    /**
+     * Retrieves a paginated list of credit ledger events for a customer.
+     */
+    listLedger(query, options) {
+        return this._client.getAPIList('/api/v1/credits/ledger', (MyCursorIDPage), {
+            query,
+            ...options,
+        });
+    }
+}
+Credits.Grants = Grants;
+Credits.CustomCurrencies = CustomCurrencies;
+//# sourceMappingURL=credits.mjs.map

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;IAiCJ,CAAC;IA/BC;;;OAGG;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;;;OAGG;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;;OAEG;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"}

package/resources/v1/credits/custom-currencies.d.mts

@@ -0,0 +1,290 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Operations related to custom currencies
+ */
+export declare class CustomCurrencies extends APIResource {
+    /**
+     * Creates a new custom currency in the environment.
+     */
+    create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
+    /**
+     * Updates an existing custom currency. Only the supplied fields are modified.
+     */
+    update(currencyID: string, body: CustomCurrencyUpdateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
+    /**
+     * 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.
+     */
+    list(query?: CustomCurrencyListParams | null | undefined, options?: RequestOptions): PagePromise<CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyListResponse>;
+    /**
+     * 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<CustomCurrencyResponse>;
+    /**
+     * Lists the active plans and addons that reference a custom currency. Useful
+     * before archiving to inspect dependencies.
+     */
+    listAssociatedEntities(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyListAssociatedEntitiesResponse>;
+    /**
+     * Restores a previously archived custom currency. Fails if another active currency
+     * with the same ID already exists.
+     */
+    unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
+}
+export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCurrencyListResponse>;
+/**
+ * Response object
+ */
+export interface CustomCurrencyResponse {
+    /**
+     * A custom currency used to denominate credit-based entitlements and pricing
+     */
+    data: CustomCurrencyResponse.Data;
+}
+export declare namespace CustomCurrencyResponse {
+    /**
+     * A custom currency used to denominate credit-based entitlements and pricing
+     */
+    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;
+    }
+    namespace Data {
+        /**
+         * Singular and plural unit labels for a custom currency
+         */
+        interface Units {
+            /**
+             * Plural form of the unit label
+             */
+            plural: string | null;
+            /**
+             * Singular form of the unit label
+             */
+            singular: string | null;
+        }
+    }
+}
+/**
+ * A custom currency used to denominate credit-based entitlements and pricing
+ */
+export interface CustomCurrencyListResponse {
+    /**
+     * 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: CustomCurrencyListResponse.Units | null;
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+}
+export declare namespace CustomCurrencyListResponse {
+    /**
+     * Singular and plural unit labels for a custom currency
+     */
+    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
+ */
+export interface CustomCurrencyListAssociatedEntitiesResponse {
+    data: Array<CustomCurrencyListAssociatedEntitiesResponse.Data>;
+}
+export declare namespace CustomCurrencyListAssociatedEntitiesResponse {
+    /**
+     * An entity (plan or addon) that references a custom currency
+     */
+    interface Data {
+        /**
+         * The reference ID of the associated entity
+         */
+        id: string;
+        /**
+         * The display name of the associated entity
+         */
+        displayName: string;
+        /**
+         * The kind of entity referencing the currency (e.g., Plan)
+         */
+        type: string;
+    }
+}
+export interface CustomCurrencyCreateParams {
+    /**
+     * The unique identifier for the new custom currency
+     */
+    id: string;
+    /**
+     * The display name of the custom currency
+     */
+    displayName: string;
+    /**
+     * Description of the currency
+     */
+    description?: string;
+    /**
+     * Additional metadata to attach to the custom currency
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The symbol used to represent the custom currency
+     */
+    symbol?: string;
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    units?: CustomCurrencyCreateParams.Units;
+}
+export declare namespace CustomCurrencyCreateParams {
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    interface Units {
+        /**
+         * Plural form of the unit label
+         */
+        plural: string;
+        /**
+         * Singular form of the unit label
+         */
+        singular: string;
+    }
+}
+export interface CustomCurrencyUpdateParams {
+    /**
+     * A human-readable description of the custom currency. Send an empty string to
+     * clear.
+     */
+    description?: string | null;
+    /**
+     * The display name of the custom currency
+     */
+    displayName?: string;
+    /**
+     * Additional metadata to attach to the custom currency
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * The symbol used to represent the custom currency. Send an empty string to clear.
+     */
+    symbol?: string | null;
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    units?: CustomCurrencyUpdateParams.Units;
+}
+export declare namespace CustomCurrencyUpdateParams {
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    interface Units {
+        /**
+         * Plural form of the unit label
+         */
+        plural: string;
+        /**
+         * Singular form of the unit label
+         */
+        singular: string;
+    }
+}
+export interface CustomCurrencyListParams extends MyCursorIDPageParams {
+    /**
+     * Filter by custom currency status. Supports comma-separated values (e.g.,
+     * `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.
+     */
+    status?: Array<'ACTIVE' | 'ARCHIVED'>;
+}
+export declare namespace CustomCurrencies {
+    export { 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=custom-currencies.d.mts.map

package/resources/v1/credits/custom-currencies.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-currencies.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/credits/custom-currencies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,qCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItG;;OAEG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,0BAA0B,CAAC;IAQrF;;;;OAIG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIzF;;;OAGG;IACH,sBAAsB,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAO3D;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAG5F;AAED,MAAM,MAAM,yCAAyC,GAAG,cAAc,CAAC,0BAA0B,CAAC,CAAC;AAEnG;;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,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,0BAA0B,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4CAA4C;IAC3D,IAAI,EAAE,KAAK,CAAC,4CAA4C,CAAC,IAAI,CAAC,CAAC;CAChE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,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/credits/custom-currencies.d.ts

@@ -0,0 +1,290 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Operations related to custom currencies
+ */
+export declare class CustomCurrencies extends APIResource {
+    /**
+     * Creates a new custom currency in the environment.
+     */
+    create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
+    /**
+     * Updates an existing custom currency. Only the supplied fields are modified.
+     */
+    update(currencyID: string, body: CustomCurrencyUpdateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
+    /**
+     * 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.
+     */
+    list(query?: CustomCurrencyListParams | null | undefined, options?: RequestOptions): PagePromise<CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyListResponse>;
+    /**
+     * 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<CustomCurrencyResponse>;
+    /**
+     * Lists the active plans and addons that reference a custom currency. Useful
+     * before archiving to inspect dependencies.
+     */
+    listAssociatedEntities(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyListAssociatedEntitiesResponse>;
+    /**
+     * Restores a previously archived custom currency. Fails if another active currency
+     * with the same ID already exists.
+     */
+    unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse>;
+}
+export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCurrencyListResponse>;
+/**
+ * Response object
+ */
+export interface CustomCurrencyResponse {
+    /**
+     * A custom currency used to denominate credit-based entitlements and pricing
+     */
+    data: CustomCurrencyResponse.Data;
+}
+export declare namespace CustomCurrencyResponse {
+    /**
+     * A custom currency used to denominate credit-based entitlements and pricing
+     */
+    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;
+    }
+    namespace Data {
+        /**
+         * Singular and plural unit labels for a custom currency
+         */
+        interface Units {
+            /**
+             * Plural form of the unit label
+             */
+            plural: string | null;
+            /**
+             * Singular form of the unit label
+             */
+            singular: string | null;
+        }
+    }
+}
+/**
+ * A custom currency used to denominate credit-based entitlements and pricing
+ */
+export interface CustomCurrencyListResponse {
+    /**
+     * 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: CustomCurrencyListResponse.Units | null;
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+}
+export declare namespace CustomCurrencyListResponse {
+    /**
+     * Singular and plural unit labels for a custom currency
+     */
+    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
+ */
+export interface CustomCurrencyListAssociatedEntitiesResponse {
+    data: Array<CustomCurrencyListAssociatedEntitiesResponse.Data>;
+}
+export declare namespace CustomCurrencyListAssociatedEntitiesResponse {
+    /**
+     * An entity (plan or addon) that references a custom currency
+     */
+    interface Data {
+        /**
+         * The reference ID of the associated entity
+         */
+        id: string;
+        /**
+         * The display name of the associated entity
+         */
+        displayName: string;
+        /**
+         * The kind of entity referencing the currency (e.g., Plan)
+         */
+        type: string;
+    }
+}
+export interface CustomCurrencyCreateParams {
+    /**
+     * The unique identifier for the new custom currency
+     */
+    id: string;
+    /**
+     * The display name of the custom currency
+     */
+    displayName: string;
+    /**
+     * Description of the currency
+     */
+    description?: string;
+    /**
+     * Additional metadata to attach to the custom currency
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The symbol used to represent the custom currency
+     */
+    symbol?: string;
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    units?: CustomCurrencyCreateParams.Units;
+}
+export declare namespace CustomCurrencyCreateParams {
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    interface Units {
+        /**
+         * Plural form of the unit label
+         */
+        plural: string;
+        /**
+         * Singular form of the unit label
+         */
+        singular: string;
+    }
+}
+export interface CustomCurrencyUpdateParams {
+    /**
+     * A human-readable description of the custom currency. Send an empty string to
+     * clear.
+     */
+    description?: string | null;
+    /**
+     * The display name of the custom currency
+     */
+    displayName?: string;
+    /**
+     * Additional metadata to attach to the custom currency
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * The symbol used to represent the custom currency. Send an empty string to clear.
+     */
+    symbol?: string | null;
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    units?: CustomCurrencyUpdateParams.Units;
+}
+export declare namespace CustomCurrencyUpdateParams {
+    /**
+     * Singular and plural unit labels for a custom currency. Both fields are required
+     * when supplied.
+     */
+    interface Units {
+        /**
+         * Plural form of the unit label
+         */
+        plural: string;
+        /**
+         * Singular form of the unit label
+         */
+        singular: string;
+    }
+}
+export interface CustomCurrencyListParams extends MyCursorIDPageParams {
+    /**
+     * Filter by custom currency status. Supports comma-separated values (e.g.,
+     * `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.
+     */
+    status?: Array<'ACTIVE' | 'ARCHIVED'>;
+}
+export declare namespace CustomCurrencies {
+    export { 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=custom-currencies.d.ts.map

package/resources/v1/credits/custom-currencies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-currencies.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/credits/custom-currencies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItG;;OAEG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,0BAA0B,CAAC;IAQrF;;;;OAIG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIzF;;;OAGG;IACH,sBAAsB,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAO3D;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAG5F;AAED,MAAM,MAAM,yCAAyC,GAAG,cAAc,CAAC,0BAA0B,CAAC,CAAC;AAEnG;;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,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,0BAA0B,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4CAA4C;IAC3D,IAAI,EAAE,KAAK,CAAC,4CAA4C,CAAC,IAAI,CAAC,CAAC;CAChE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,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"}