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

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

@@ -0,0 +1,296 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as CustomCurrenciesAPI 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";
+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.
+     */
+    getAutoRecharge(query: CreditGetAutoRechargeParams, options?: RequestOptions): APIPromise<CreditGetAutoRechargeResponse>;
+    /**
+     * Retrieves credit usage time-series data for a customer, grouped by feature, over
+     * a specified time range.
+     */
+    getUsage(query: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse>;
+    /**
+     * Retrieves a paginated list of credit ledger events for a customer.
+     */
+    listLedger(query: CreditListLedgerParams, options?: RequestOptions): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse>;
+}
+export type CreditListLedgerResponsesMyCursorIDPage = MyCursorIDPage<CreditListLedgerResponse>;
+/**
+ * Response object
+ */
+export interface CreditGetAutoRechargeResponse {
+    /**
+     * Automatic recharge configuration for a customer and currency
+     */
+    data: CreditGetAutoRechargeResponse.Data;
+}
+export declare namespace CreditGetAutoRechargeResponse {
+    /**
+     * Automatic recharge configuration for a customer and currency
+     */
+    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
+ */
+export interface CreditGetUsageResponse {
+    /**
+     * Credit usage data grouped by feature with time-series points
+     */
+    data: CreditGetUsageResponse.Data;
+}
+export declare namespace CreditGetUsageResponse {
+    /**
+     * Credit usage data grouped by feature with time-series points
+     */
+    interface Data {
+        /**
+         * The custom currency used for credit measurement
+         */
+        currency: Data.Currency | null;
+        /**
+         * Credit usage series grouped by feature
+         */
+        series: Array<Data.Series>;
+    }
+    namespace Data {
+        /**
+         * The custom currency used for credit measurement
+         */
+        interface Currency {
+            /**
+             * The currency identifier
+             */
+            currencyId: string;
+            /**
+             * The display name of the currency
+             */
+            displayName: string;
+            /**
+             * Plural unit label
+             */
+            plural: string | null;
+            /**
+             * Singular unit label
+             */
+            singular: string | null;
+            /**
+             * The currency symbol
+             */
+            symbol: string | null;
+        }
+        /**
+         * Credit usage data for a single feature
+         */
+        interface Series {
+            /**
+             * The feature ID; null when grouping by dimensions only
+             */
+            featureId: string | null;
+            /**
+             * The display name of the feature; null when grouping by dimensions only
+             */
+            featureName: string | null;
+            /**
+             * Time-series data points for this feature
+             */
+            points: Array<Series.Point>;
+            /**
+             * 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 {
+            /**
+             * A single data point in the credit usage time series
+             */
+            interface Point {
+                /**
+                 * The timestamp of the data point
+                 */
+                timestamp: string;
+                /**
+                 * The credit usage value at this point
+                 */
+                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;
+            }
+        }
+    }
+}
+/**
+ * A credit ledger event representing a change to credit balance
+ */
+export interface CreditListLedgerResponse {
+    /**
+     * The credit amount for this event
+     */
+    amount: number;
+    /**
+     * The credit currency ID
+     */
+    creditCurrencyId: string;
+    /**
+     * The credit grant ID associated with this event
+     */
+    creditGrantId: string;
+    /**
+     * The customer ID this event belongs to
+     */
+    customerId: string;
+    /**
+     * The unique event identifier
+     */
+    eventId: string | null;
+    /**
+     * The type of credit event
+     */
+    eventType: 'CREDITS_GRANTED' | 'CREDITS_EXPIRED' | 'CREDITS_CONSUMED' | 'CREDITS_VOIDED' | 'CREDITS_UPDATED' | 'CREDITS_CONSUMPTION_TRANSFER_SOURCE' | 'CREDITS_CONSUMPTION_TRANSFER_TARGET';
+    /**
+     * The feature ID associated with this event
+     */
+    featureId: string | null;
+    /**
+     * The resource ID this event is scoped to
+     */
+    resourceId: string | null;
+    /**
+     * The timestamp when the event occurred
+     */
+    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;
+    /**
+     * Filter by currency ID
+     */
+    currencyId?: string;
+    /**
+     * End date for the credit usage time range (ISO 8601). Defaults to now when
+     * 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
+     */
+    resourceId?: string;
+    /**
+     * Start date for the credit usage time range (ISO 8601). Takes precedence over
+     * timeRange when provided
+     */
+    startDate?: string;
+    /**
+     * Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults
+     * to LAST_MONTH
+     */
+    timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR';
+}
+export interface CreditListLedgerParams extends MyCursorIDPageParams {
+    /**
+     * Filter by customer ID (required)
+     */
+    customerId: string;
+    /**
+     * Filter by currency ID
+     */
+    currencyId?: string;
+    /**
+     * Filter by resource ID
+     */
+    resourceId?: string;
+}
+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 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;;;OAGG;IACH,eAAe,CACb,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;OAEG;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/credits/credits.d.ts

@@ -0,0 +1,296 @@
+import { APIResource } from "../../../core/resource.js";
+import * as CustomCurrenciesAPI 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";
+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.
+     */
+    getAutoRecharge(query: CreditGetAutoRechargeParams, options?: RequestOptions): APIPromise<CreditGetAutoRechargeResponse>;
+    /**
+     * Retrieves credit usage time-series data for a customer, grouped by feature, over
+     * a specified time range.
+     */
+    getUsage(query: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse>;
+    /**
+     * Retrieves a paginated list of credit ledger events for a customer.
+     */
+    listLedger(query: CreditListLedgerParams, options?: RequestOptions): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse>;
+}
+export type CreditListLedgerResponsesMyCursorIDPage = MyCursorIDPage<CreditListLedgerResponse>;
+/**
+ * Response object
+ */
+export interface CreditGetAutoRechargeResponse {
+    /**
+     * Automatic recharge configuration for a customer and currency
+     */
+    data: CreditGetAutoRechargeResponse.Data;
+}
+export declare namespace CreditGetAutoRechargeResponse {
+    /**
+     * Automatic recharge configuration for a customer and currency
+     */
+    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
+ */
+export interface CreditGetUsageResponse {
+    /**
+     * Credit usage data grouped by feature with time-series points
+     */
+    data: CreditGetUsageResponse.Data;
+}
+export declare namespace CreditGetUsageResponse {
+    /**
+     * Credit usage data grouped by feature with time-series points
+     */
+    interface Data {
+        /**
+         * The custom currency used for credit measurement
+         */
+        currency: Data.Currency | null;
+        /**
+         * Credit usage series grouped by feature
+         */
+        series: Array<Data.Series>;
+    }
+    namespace Data {
+        /**
+         * The custom currency used for credit measurement
+         */
+        interface Currency {
+            /**
+             * The currency identifier
+             */
+            currencyId: string;
+            /**
+             * The display name of the currency
+             */
+            displayName: string;
+            /**
+             * Plural unit label
+             */
+            plural: string | null;
+            /**
+             * Singular unit label
+             */
+            singular: string | null;
+            /**
+             * The currency symbol
+             */
+            symbol: string | null;
+        }
+        /**
+         * Credit usage data for a single feature
+         */
+        interface Series {
+            /**
+             * The feature ID; null when grouping by dimensions only
+             */
+            featureId: string | null;
+            /**
+             * The display name of the feature; null when grouping by dimensions only
+             */
+            featureName: string | null;
+            /**
+             * Time-series data points for this feature
+             */
+            points: Array<Series.Point>;
+            /**
+             * 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 {
+            /**
+             * A single data point in the credit usage time series
+             */
+            interface Point {
+                /**
+                 * The timestamp of the data point
+                 */
+                timestamp: string;
+                /**
+                 * The credit usage value at this point
+                 */
+                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;
+            }
+        }
+    }
+}
+/**
+ * A credit ledger event representing a change to credit balance
+ */
+export interface CreditListLedgerResponse {
+    /**
+     * The credit amount for this event
+     */
+    amount: number;
+    /**
+     * The credit currency ID
+     */
+    creditCurrencyId: string;
+    /**
+     * The credit grant ID associated with this event
+     */
+    creditGrantId: string;
+    /**
+     * The customer ID this event belongs to
+     */
+    customerId: string;
+    /**
+     * The unique event identifier
+     */
+    eventId: string | null;
+    /**
+     * The type of credit event
+     */
+    eventType: 'CREDITS_GRANTED' | 'CREDITS_EXPIRED' | 'CREDITS_CONSUMED' | 'CREDITS_VOIDED' | 'CREDITS_UPDATED' | 'CREDITS_CONSUMPTION_TRANSFER_SOURCE' | 'CREDITS_CONSUMPTION_TRANSFER_TARGET';
+    /**
+     * The feature ID associated with this event
+     */
+    featureId: string | null;
+    /**
+     * The resource ID this event is scoped to
+     */
+    resourceId: string | null;
+    /**
+     * The timestamp when the event occurred
+     */
+    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;
+    /**
+     * Filter by currency ID
+     */
+    currencyId?: string;
+    /**
+     * End date for the credit usage time range (ISO 8601). Defaults to now when
+     * 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
+     */
+    resourceId?: string;
+    /**
+     * Start date for the credit usage time range (ISO 8601). Takes precedence over
+     * timeRange when provided
+     */
+    startDate?: string;
+    /**
+     * Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults
+     * to LAST_MONTH
+     */
+    timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR';
+}
+export interface CreditListLedgerParams extends MyCursorIDPageParams {
+    /**
+     * Filter by customer ID (required)
+     */
+    customerId: string;
+    /**
+     * Filter by currency ID
+     */
+    currencyId?: string;
+    /**
+     * Filter by resource ID
+     */
+    resourceId?: string;
+}
+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 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;;;OAGG;IACH,eAAe,CACb,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAInG;;OAEG;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/credits/credits.js

@@ -0,0 +1,45 @@
+"use strict";
+// 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 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");
+class Credits extends resource_1.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', (pagination_1.MyCursorIDPage), {
+            query,
+            ...options,
+        });
+    }
+}
+exports.Credits = Credits;
+Credits.Grants = grants_1.Grants;
+Credits.CustomCurrencies = custom_currencies_1.CustomCurrencies;
+//# sourceMappingURL=credits.js.map

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;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,2BAAwC,CAAA,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AArCD,0BAqCC;AAoUD,OAAO,CAAC,MAAM,GAAG,eAAM,CAAC;AACxB,OAAO,CAAC,gBAAgB,GAAG,oCAAgB,CAAC"}