telnyx 7.25.0 → 7.27.0

package/resources/llm-token-gateway/spend.d.mts

@@ -0,0 +1,223 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as SpendAPI from "./spend.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Manage and report AI Gateway usage.
+ */
+export declare class Spend extends APIResource {
+    /**
+     * Return request-level usage history for the authenticated account. Supply both
+     * UTC dates or neither; omitting both returns the previous full UTC day. Dates use
+     * a half-open range [start_date, end_date) of at most 31 days. Cost reflects
+     * budget reference rates, not invoice charges. Unknown spend is excluded and
+     * reported separately. The report snapshot supports at most 10,000 matching
+     * requests, independently of page size. Exceeding this bound returns HTTP 503
+     * without partial results. Narrow the date range or resource filters before
+     * retrying. A failed report must not be interpreted as zero usage. Request tags
+     * can filter either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveEvents();
+     * ```
+     */
+    retrieveEvents(query?: SpendRetrieveEventsParams | null | undefined, options?: RequestOptions): APIPromise<SpendRetrieveEventsResponse>;
+    /**
+     * Return request counts, token counts and reference spend grouped by one
+     * attribution dimension. Both UTC dates and group_by are required. Dates use a
+     * half-open range [start_date, end_date) of at most 31 days. Cost reflects budget
+     * reference rates, not invoice charges. Unknown spend is excluded and reported
+     * separately. The report snapshot supports at most 10,000 matching requests,
+     * independently of page size. Exceeding this bound returns HTTP 503 without
+     * partial results. Narrow the date range or resource filters before retrying. A
+     * failed report must not be interpreted as zero usage. Request tags can filter
+     * either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveSummary({
+     *     end_date: '2019-12-27',
+     *     group_by: 'token_group',
+     *     start_date: '2019-12-27',
+     *   });
+     * ```
+     */
+    retrieveSummary(query: SpendRetrieveSummaryParams, options?: RequestOptions): APIPromise<SpendRetrieveSummaryResponse>;
+}
+/**
+ * Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+ * (any case) are rejected.
+ */
+export type SpendGroupBy = 'token_group' | 'token_user' | 'token_key' | 'end_user' | (string & {});
+export interface SpendRetrieveEventsResponse {
+    data: Array<SpendRetrieveEventsResponse.Data>;
+    meta: SpendRetrieveEventsResponse.Meta;
+}
+export declare namespace SpendRetrieveEventsResponse {
+    interface Data {
+        id: string;
+        /**
+         * Provider attempts begun for the request (fallbacks included); 0 for a cache hit.
+         * Token and cost totals sum every attempt.
+         */
+        attempts: number;
+        biller: 'telnyx' | 'provider' | 'none';
+        cache_hit: boolean;
+        configuration_version: number;
+        /**
+         * USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+         * never binary float accounting.
+         */
+        cost: number | null;
+        created_at: string;
+        end_user_id: string | null;
+        input_tokens: number | null;
+        /**
+         * Customer request tags from the x-ltg-metadata header: up to 5 entries. Keys are
+         * case-sensitive; keys starting with ltg*, telnyx*, litellm* or cf* (any case) are
+         * reserved. Values are strings (1-256 characters, no control or format
+         * characters), integers within +/-9007199254740991, or booleans; floats, null,
+         * objects and arrays are rejected. Values that look like credentials are rejected.
+         * Tags are attribution only: never forwarded upstream, never part of the response
+         * cache key, never used for budgets or routing. An untagged request reports {}.
+         */
+        metadata: {
+            [key: string]: string | number | boolean;
+        };
+        /**
+         * Public alias that served (the last attempt); rate_version, biller and
+         * provider_key_id follow it.
+         */
+        model: string;
+        output_tokens: number | null;
+        provider_key_id: string | null;
+        rate_version: string;
+        request_id: string;
+        /**
+         * Public alias the caller requested; differs from model only when a group fallback
+         * served.
+         */
+        requested_model: string;
+        reservation_micro_usd: number;
+        status: 'succeeded' | 'failed' | 'partial' | 'unknown';
+        token_group_id: string;
+        token_key_id: string;
+        token_user_id: string | null;
+        usage_status: 'known' | 'unknown' | 'reconciled';
+    }
+    interface Meta {
+        has_more: boolean;
+        page_number: number;
+        page_size: number;
+        snapshot: string;
+    }
+}
+export interface SpendRetrieveSummaryResponse {
+    data: Array<SpendRetrieveSummaryResponse.Data>;
+    meta: SpendRetrieveSummaryResponse.Meta;
+}
+export declare namespace SpendRetrieveSummaryResponse {
+    interface Data {
+        dimension_id: string | null;
+        input_tokens: number;
+        name: string | null;
+        output_tokens: number;
+        requests: number;
+        /**
+         * USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+         * never binary float accounting.
+         */
+        reserved_spend: number;
+        /**
+         * USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+         * never binary float accounting.
+         */
+        spend: number;
+        unknown_requests: number;
+        end_user_id?: string | null;
+        /**
+         * Present only for group_by=metadata:<key>: the tag key. dimension_id is then the
+         * tag value in text form (booleans as true/false, integers in decimal), or null
+         * for requests without the key; name is null.
+         */
+        metadata_key?: string;
+        token_group_id?: string | null;
+        token_key_id?: string | null;
+        token_user_id?: string | null;
+    }
+    interface Meta {
+        end_date: string;
+        /**
+         * Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+         * (any case) are rejected.
+         */
+        group_by: SpendAPI.SpendGroupBy;
+        has_more: boolean;
+        page_number: number;
+        page_size: number;
+        snapshot: string;
+        start_date: string;
+    }
+}
+export interface SpendRetrieveEventsParams {
+    end_date?: string;
+    end_user_id?: string;
+    /**
+     * Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+     * value matches the tag's text form exactly (booleans as true/false, integers in
+     * decimal), so metadata[flag]=true matches both boolean true and the string
+     * "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed:
+     * bounded by the account, the date range and the report timeout.
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    'page[number]'?: number;
+    'page[size]'?: number;
+    /**
+     * Required after page 1; account/filter-bound 15-minute stable snapshot;
+     * expired/mismatch 409.
+     */
+    'page[snapshot]'?: string;
+    start_date?: string;
+    token_group_id?: string;
+    token_key_id?: string;
+    token_user_id?: string;
+}
+export interface SpendRetrieveSummaryParams {
+    end_date: string;
+    /**
+     * A scope, or metadata:<key> to group by one request tag's text-form value;
+     * requests without the key form one group with a null dimension_id.
+     */
+    group_by: SpendGroupBy;
+    start_date: string;
+    end_user_id?: string;
+    /**
+     * Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+     * value matches the tag's text form exactly (booleans as true/false, integers in
+     * decimal), so metadata[flag]=true matches both boolean true and the string
+     * "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed:
+     * bounded by the account, the date range and the report timeout.
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    'page[number]'?: number;
+    'page[size]'?: number;
+    /**
+     * Required after page 1; account/filter-bound 15-minute stable snapshot;
+     * expired/mismatch 409.
+     */
+    'page[snapshot]'?: string;
+    token_group_id?: string;
+    token_key_id?: string;
+    token_user_id?: string;
+}
+export declare namespace Spend {
+    export { type SpendGroupBy as SpendGroupBy, type SpendRetrieveEventsResponse as SpendRetrieveEventsResponse, type SpendRetrieveSummaryResponse as SpendRetrieveSummaryResponse, type SpendRetrieveEventsParams as SpendRetrieveEventsParams, type SpendRetrieveSummaryParams as SpendRetrieveSummaryParams, };
+}
+//# sourceMappingURL=spend.d.mts.map

package/resources/llm-token-gateway/spend.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.d.mts","sourceRoot":"","sources":["../../src/resources/llm-token-gateway/spend.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEnG,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAE9C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;QAEvC,SAAS,EAAE,OAAO,CAAC;QAEnB,qBAAqB,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;;;;;WAQG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvD;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB,qBAAqB,EAAE,MAAM,CAAC;QAE9B,MAAM,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;QAEvD,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,EAAE,MAAM,CAAC;QAErB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,YAAY,EAAE,OAAO,GAAG,SAAS,GAAG,YAAY,CAAC;KAClD;IAED,UAAiB,IAAI;QACnB,QAAQ,EAAE,OAAO,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAE/C,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,YAAY,EAAE,MAAM,CAAC;QAErB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,gBAAgB,EAAE,MAAM,CAAC;QAEzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAiB,IAAI;QACnB,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC;QAEhC,QAAQ,EAAE,OAAO,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;QAEjB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/llm-token-gateway/spend.d.ts

@@ -0,0 +1,223 @@
+import { APIResource } from "../../core/resource.js";
+import * as SpendAPI from "./spend.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Manage and report AI Gateway usage.
+ */
+export declare class Spend extends APIResource {
+    /**
+     * Return request-level usage history for the authenticated account. Supply both
+     * UTC dates or neither; omitting both returns the previous full UTC day. Dates use
+     * a half-open range [start_date, end_date) of at most 31 days. Cost reflects
+     * budget reference rates, not invoice charges. Unknown spend is excluded and
+     * reported separately. The report snapshot supports at most 10,000 matching
+     * requests, independently of page size. Exceeding this bound returns HTTP 503
+     * without partial results. Narrow the date range or resource filters before
+     * retrying. A failed report must not be interpreted as zero usage. Request tags
+     * can filter either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveEvents();
+     * ```
+     */
+    retrieveEvents(query?: SpendRetrieveEventsParams | null | undefined, options?: RequestOptions): APIPromise<SpendRetrieveEventsResponse>;
+    /**
+     * Return request counts, token counts and reference spend grouped by one
+     * attribution dimension. Both UTC dates and group_by are required. Dates use a
+     * half-open range [start_date, end_date) of at most 31 days. Cost reflects budget
+     * reference rates, not invoice charges. Unknown spend is excluded and reported
+     * separately. The report snapshot supports at most 10,000 matching requests,
+     * independently of page size. Exceeding this bound returns HTTP 503 without
+     * partial results. Narrow the date range or resource filters before retrying. A
+     * failed report must not be interpreted as zero usage. Request tags can filter
+     * either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveSummary({
+     *     end_date: '2019-12-27',
+     *     group_by: 'token_group',
+     *     start_date: '2019-12-27',
+     *   });
+     * ```
+     */
+    retrieveSummary(query: SpendRetrieveSummaryParams, options?: RequestOptions): APIPromise<SpendRetrieveSummaryResponse>;
+}
+/**
+ * Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+ * (any case) are rejected.
+ */
+export type SpendGroupBy = 'token_group' | 'token_user' | 'token_key' | 'end_user' | (string & {});
+export interface SpendRetrieveEventsResponse {
+    data: Array<SpendRetrieveEventsResponse.Data>;
+    meta: SpendRetrieveEventsResponse.Meta;
+}
+export declare namespace SpendRetrieveEventsResponse {
+    interface Data {
+        id: string;
+        /**
+         * Provider attempts begun for the request (fallbacks included); 0 for a cache hit.
+         * Token and cost totals sum every attempt.
+         */
+        attempts: number;
+        biller: 'telnyx' | 'provider' | 'none';
+        cache_hit: boolean;
+        configuration_version: number;
+        /**
+         * USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+         * never binary float accounting.
+         */
+        cost: number | null;
+        created_at: string;
+        end_user_id: string | null;
+        input_tokens: number | null;
+        /**
+         * Customer request tags from the x-ltg-metadata header: up to 5 entries. Keys are
+         * case-sensitive; keys starting with ltg*, telnyx*, litellm* or cf* (any case) are
+         * reserved. Values are strings (1-256 characters, no control or format
+         * characters), integers within +/-9007199254740991, or booleans; floats, null,
+         * objects and arrays are rejected. Values that look like credentials are rejected.
+         * Tags are attribution only: never forwarded upstream, never part of the response
+         * cache key, never used for budgets or routing. An untagged request reports {}.
+         */
+        metadata: {
+            [key: string]: string | number | boolean;
+        };
+        /**
+         * Public alias that served (the last attempt); rate_version, biller and
+         * provider_key_id follow it.
+         */
+        model: string;
+        output_tokens: number | null;
+        provider_key_id: string | null;
+        rate_version: string;
+        request_id: string;
+        /**
+         * Public alias the caller requested; differs from model only when a group fallback
+         * served.
+         */
+        requested_model: string;
+        reservation_micro_usd: number;
+        status: 'succeeded' | 'failed' | 'partial' | 'unknown';
+        token_group_id: string;
+        token_key_id: string;
+        token_user_id: string | null;
+        usage_status: 'known' | 'unknown' | 'reconciled';
+    }
+    interface Meta {
+        has_more: boolean;
+        page_number: number;
+        page_size: number;
+        snapshot: string;
+    }
+}
+export interface SpendRetrieveSummaryResponse {
+    data: Array<SpendRetrieveSummaryResponse.Data>;
+    meta: SpendRetrieveSummaryResponse.Meta;
+}
+export declare namespace SpendRetrieveSummaryResponse {
+    interface Data {
+        dimension_id: string | null;
+        input_tokens: number;
+        name: string | null;
+        output_tokens: number;
+        requests: number;
+        /**
+         * USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+         * never binary float accounting.
+         */
+        reserved_spend: number;
+        /**
+         * USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+         * never binary float accounting.
+         */
+        spend: number;
+        unknown_requests: number;
+        end_user_id?: string | null;
+        /**
+         * Present only for group_by=metadata:<key>: the tag key. dimension_id is then the
+         * tag value in text form (booleans as true/false, integers in decimal), or null
+         * for requests without the key; name is null.
+         */
+        metadata_key?: string;
+        token_group_id?: string | null;
+        token_key_id?: string | null;
+        token_user_id?: string | null;
+    }
+    interface Meta {
+        end_date: string;
+        /**
+         * Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+         * (any case) are rejected.
+         */
+        group_by: SpendAPI.SpendGroupBy;
+        has_more: boolean;
+        page_number: number;
+        page_size: number;
+        snapshot: string;
+        start_date: string;
+    }
+}
+export interface SpendRetrieveEventsParams {
+    end_date?: string;
+    end_user_id?: string;
+    /**
+     * Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+     * value matches the tag's text form exactly (booleans as true/false, integers in
+     * decimal), so metadata[flag]=true matches both boolean true and the string
+     * "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed:
+     * bounded by the account, the date range and the report timeout.
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    'page[number]'?: number;
+    'page[size]'?: number;
+    /**
+     * Required after page 1; account/filter-bound 15-minute stable snapshot;
+     * expired/mismatch 409.
+     */
+    'page[snapshot]'?: string;
+    start_date?: string;
+    token_group_id?: string;
+    token_key_id?: string;
+    token_user_id?: string;
+}
+export interface SpendRetrieveSummaryParams {
+    end_date: string;
+    /**
+     * A scope, or metadata:<key> to group by one request tag's text-form value;
+     * requests without the key form one group with a null dimension_id.
+     */
+    group_by: SpendGroupBy;
+    start_date: string;
+    end_user_id?: string;
+    /**
+     * Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+     * value matches the tag's text form exactly (booleans as true/false, integers in
+     * decimal), so metadata[flag]=true matches both boolean true and the string
+     * "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed:
+     * bounded by the account, the date range and the report timeout.
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    'page[number]'?: number;
+    'page[size]'?: number;
+    /**
+     * Required after page 1; account/filter-bound 15-minute stable snapshot;
+     * expired/mismatch 409.
+     */
+    'page[snapshot]'?: string;
+    token_group_id?: string;
+    token_key_id?: string;
+    token_user_id?: string;
+}
+export declare namespace Spend {
+    export { type SpendGroupBy as SpendGroupBy, type SpendRetrieveEventsResponse as SpendRetrieveEventsResponse, type SpendRetrieveSummaryResponse as SpendRetrieveSummaryResponse, type SpendRetrieveEventsParams as SpendRetrieveEventsParams, type SpendRetrieveSummaryParams as SpendRetrieveSummaryParams, };
+}
+//# sourceMappingURL=spend.d.ts.map

package/resources/llm-token-gateway/spend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.d.ts","sourceRoot":"","sources":["../../src/resources/llm-token-gateway/spend.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEnG,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAE9C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;QAEvC,SAAS,EAAE,OAAO,CAAC;QAEnB,qBAAqB,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;;;;;WAQG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvD;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB,qBAAqB,EAAE,MAAM,CAAC;QAE9B,MAAM,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;QAEvD,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,EAAE,MAAM,CAAC;QAErB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,YAAY,EAAE,OAAO,GAAG,SAAS,GAAG,YAAY,CAAC;KAClD;IAED,UAAiB,IAAI;QACnB,QAAQ,EAAE,OAAO,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAE/C,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,YAAY,EAAE,MAAM,CAAC;QAErB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,gBAAgB,EAAE,MAAM,CAAC;QAEzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAiB,IAAI;QACnB,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC;QAEhC,QAAQ,EAAE,OAAO,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;QAEjB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/llm-token-gateway/spend.js

@@ -0,0 +1,56 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Spend = void 0;
+const resource_1 = require("../../core/resource.js");
+/**
+ * Manage and report AI Gateway usage.
+ */
+class Spend extends resource_1.APIResource {
+    /**
+     * Return request-level usage history for the authenticated account. Supply both
+     * UTC dates or neither; omitting both returns the previous full UTC day. Dates use
+     * a half-open range [start_date, end_date) of at most 31 days. Cost reflects
+     * budget reference rates, not invoice charges. Unknown spend is excluded and
+     * reported separately. The report snapshot supports at most 10,000 matching
+     * requests, independently of page size. Exceeding this bound returns HTTP 503
+     * without partial results. Narrow the date range or resource filters before
+     * retrying. A failed report must not be interpreted as zero usage. Request tags
+     * can filter either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveEvents();
+     * ```
+     */
+    retrieveEvents(query = {}, options) {
+        return this._client.get('/llm_token_gateway/spend/events', { query, ...options });
+    }
+    /**
+     * Return request counts, token counts and reference spend grouped by one
+     * attribution dimension. Both UTC dates and group_by are required. Dates use a
+     * half-open range [start_date, end_date) of at most 31 days. Cost reflects budget
+     * reference rates, not invoice charges. Unknown spend is excluded and reported
+     * separately. The report snapshot supports at most 10,000 matching requests,
+     * independently of page size. Exceeding this bound returns HTTP 503 without
+     * partial results. Narrow the date range or resource filters before retrying. A
+     * failed report must not be interpreted as zero usage. Request tags can filter
+     * either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveSummary({
+     *     end_date: '2019-12-27',
+     *     group_by: 'token_group',
+     *     start_date: '2019-12-27',
+     *   });
+     * ```
+     */
+    retrieveSummary(query, options) {
+        return this._client.get('/llm_token_gateway/spend/summary', { query, ...options });
+    }
+}
+exports.Spend = Spend;
+//# sourceMappingURL=spend.js.map

package/resources/llm-token-gateway/spend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.js","sourceRoot":"","sources":["../../src/resources/llm-token-gateway/spend.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AApDD,sBAoDC"}

package/resources/llm-token-gateway/spend.mjs

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+/**
+ * Manage and report AI Gateway usage.
+ */
+export class Spend extends APIResource {
+    /**
+     * Return request-level usage history for the authenticated account. Supply both
+     * UTC dates or neither; omitting both returns the previous full UTC day. Dates use
+     * a half-open range [start_date, end_date) of at most 31 days. Cost reflects
+     * budget reference rates, not invoice charges. Unknown spend is excluded and
+     * reported separately. The report snapshot supports at most 10,000 matching
+     * requests, independently of page size. Exceeding this bound returns HTTP 503
+     * without partial results. Narrow the date range or resource filters before
+     * retrying. A failed report must not be interpreted as zero usage. Request tags
+     * can filter either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveEvents();
+     * ```
+     */
+    retrieveEvents(query = {}, options) {
+        return this._client.get('/llm_token_gateway/spend/events', { query, ...options });
+    }
+    /**
+     * Return request counts, token counts and reference spend grouped by one
+     * attribution dimension. Both UTC dates and group_by are required. Dates use a
+     * half-open range [start_date, end_date) of at most 31 days. Cost reflects budget
+     * reference rates, not invoice charges. Unknown spend is excluded and reported
+     * separately. The report snapshot supports at most 10,000 matching requests,
+     * independently of page size. Exceeding this bound returns HTTP 503 without
+     * partial results. Narrow the date range or resource filters before retrying. A
+     * failed report must not be interpreted as zero usage. Request tags can filter
+     * either report and metadata:<key> can group the summary.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.llmTokenGateway.spend.retrieveSummary({
+     *     end_date: '2019-12-27',
+     *     group_by: 'token_group',
+     *     start_date: '2019-12-27',
+     *   });
+     * ```
+     */
+    retrieveSummary(query, options) {
+        return this._client.get('/llm_token_gateway/spend/summary', { query, ...options });
+    }
+}
+//# sourceMappingURL=spend.mjs.map

package/resources/llm-token-gateway/spend.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.mjs","sourceRoot":"","sources":["../../src/resources/llm-token-gateway/spend.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}