@llmpulse/sdk 0.0.0-stage → 1.60.0

package/src/apis/WebhooksApi.ts

@@ -0,0 +1,436 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type ApiError,
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+} from '../models/ApiError';
+import {
+    type CreateWebhook201Response,
+    CreateWebhook201ResponseFromJSON,
+    CreateWebhook201ResponseToJSON,
+} from '../models/CreateWebhook201Response';
+import {
+    type CreateWebhookRequest,
+    CreateWebhookRequestFromJSON,
+    CreateWebhookRequestToJSON,
+} from '../models/CreateWebhookRequest';
+import {
+    type DeleteWebhook200Response,
+    DeleteWebhook200ResponseFromJSON,
+    DeleteWebhook200ResponseToJSON,
+} from '../models/DeleteWebhook200Response';
+import {
+    type ListWebhooks200Response,
+    ListWebhooks200ResponseFromJSON,
+    ListWebhooks200ResponseToJSON,
+} from '../models/ListWebhooks200Response';
+import {
+    type SampleWebhookPayloads200Response,
+    SampleWebhookPayloads200ResponseFromJSON,
+    SampleWebhookPayloads200ResponseToJSON,
+} from '../models/SampleWebhookPayloads200Response';
+
+export interface CreateWebhookOperationRequest {
+    createWebhookRequest: CreateWebhookRequest;
+}
+
+export interface DeleteWebhookRequest {
+    id: number;
+}
+
+export interface ListWebhooksRequest {
+    projectId?: number;
+    page?: number;
+    perPage?: number;
+}
+
+export interface SampleWebhookPayloadsRequest {
+    eventType: SampleWebhookPayloadsEventTypeEnum;
+    projectId: number;
+}
+
+/**
+ * WebhooksApi - interface
+ * 
+ * @export
+ * @interface WebhooksApiInterface
+ */
+export interface WebhooksApiInterface {
+    /**
+     * Creates request options for createWebhook without sending the request
+     * @param {CreateWebhookRequest} createWebhookRequest 
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    createWebhookRequestOpts(requestParameters: CreateWebhookOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Subscribes a public HTTPS URL to a project event. LLM Pulse POSTs a JSON envelope (`event`, `occurred_at`, `project_id`, `subscription_id`, `data`) to the URL every time the event occurs, signed via the `X-LLMPulse-Signature` header (HMAC-SHA256 of the raw body computed with the subscription secret). Failed deliveries receive up to 5 attempts in total, including the first, with backoff; subscriptions auto-disable after 20 consecutive failed deliveries. Idempotent for the same project + event + URL: re-posting returns the existing subscription, unless the API key or OAuth connection that created it was revoked; then it is replaced by a new subscription with a new secret. Requires a `read_write` scope API key and the Scale plan or above.
+     * @summary Create a webhook subscription
+     * @param {CreateWebhookRequest} createWebhookRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    createWebhookRaw(requestParameters: CreateWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWebhook201Response>>;
+
+    /**
+     * Subscribes a public HTTPS URL to a project event. LLM Pulse POSTs a JSON envelope (`event`, `occurred_at`, `project_id`, `subscription_id`, `data`) to the URL every time the event occurs, signed via the `X-LLMPulse-Signature` header (HMAC-SHA256 of the raw body computed with the subscription secret). Failed deliveries receive up to 5 attempts in total, including the first, with backoff; subscriptions auto-disable after 20 consecutive failed deliveries. Idempotent for the same project + event + URL: re-posting returns the existing subscription, unless the API key or OAuth connection that created it was revoked; then it is replaced by a new subscription with a new secret. Requires a `read_write` scope API key and the Scale plan or above.
+     * Create a webhook subscription
+     */
+    createWebhook(requestParameters: CreateWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWebhook201Response>;
+
+    /**
+     * Creates request options for deleteWebhook without sending the request
+     * @param {number} id 
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    deleteWebhookRequestOpts(requestParameters: DeleteWebhookRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Deletes a webhook subscription; the target URL stops receiving events immediately. Requires a `read_write` scope API key and the Scale plan or above.
+     * @summary Delete a webhook subscription
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteWebhook200Response>>;
+
+    /**
+     * Deletes a webhook subscription; the target URL stops receiving events immediately. Requires a `read_write` scope API key and the Scale plan or above.
+     * Delete a webhook subscription
+     */
+    deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteWebhook200Response>;
+
+    /**
+     * Creates request options for listWebhooks without sending the request
+     * @param {number} [projectId] Optional project filter
+     * @param {number} [page] 
+     * @param {number} [perPage] Max 100
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    listWebhooksRequestOpts(requestParameters: ListWebhooksRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Lists active webhook subscriptions for the account, optionally filtered by project. Requires the Scale plan or above.
+     * @summary List webhook subscriptions
+     * @param {number} [projectId] Optional project filter
+     * @param {number} [page] 
+     * @param {number} [perPage] Max 100
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    listWebhooksRaw(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWebhooks200Response>>;
+
+    /**
+     * Lists active webhook subscriptions for the account, optionally filtered by project. Requires the Scale plan or above.
+     * List webhook subscriptions
+     */
+    listWebhooks(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWebhooks200Response>;
+
+    /**
+     * Creates request options for sampleWebhookPayloads without sending the request
+     * @param {'mention.created' | 'competitor_mention.created' | 'citation.created' | 'prompt_execution.completed' | 'sentiment.negative_detected' | 'recommendation.completed' | 'intelligence_task.completed' | 'intelligence_task.updated' | 'geo_audit_run.completed' | 'geo_audit_alert.triggered'} eventType 
+     * @param {number} projectId 
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    sampleWebhookPayloadsRequestOpts(requestParameters: SampleWebhookPayloadsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns up to 3 example event payloads for the event type, built from the project\'s most recent real data (or a static sample when the project has no data). Used by integration editors such as the Zapier sample loader. Requires the Scale plan or above.
+     * @summary Sample event payloads
+     * @param {'mention.created' | 'competitor_mention.created' | 'citation.created' | 'prompt_execution.completed' | 'sentiment.negative_detected' | 'recommendation.completed' | 'intelligence_task.completed' | 'intelligence_task.updated' | 'geo_audit_run.completed' | 'geo_audit_alert.triggered'} eventType 
+     * @param {number} projectId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebhooksApiInterface
+     */
+    sampleWebhookPayloadsRaw(requestParameters: SampleWebhookPayloadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SampleWebhookPayloads200Response>>;
+
+    /**
+     * Returns up to 3 example event payloads for the event type, built from the project\'s most recent real data (or a static sample when the project has no data). Used by integration editors such as the Zapier sample loader. Requires the Scale plan or above.
+     * Sample event payloads
+     */
+    sampleWebhookPayloads(requestParameters: SampleWebhookPayloadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SampleWebhookPayloads200Response>;
+
+}
+
+/**
+ * 
+ */
+export class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface {
+
+    /**
+     * Creates request options for createWebhook without sending the request
+     */
+    async createWebhookRequestOpts(requestParameters: CreateWebhookOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createWebhookRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createWebhookRequest',
+                'Required parameter "createWebhookRequest" was null or undefined when calling createWebhook().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/webhooks`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateWebhookRequestToJSON(requestParameters['createWebhookRequest']),
+        };
+    }
+
+    /**
+     * Subscribes a public HTTPS URL to a project event. LLM Pulse POSTs a JSON envelope (`event`, `occurred_at`, `project_id`, `subscription_id`, `data`) to the URL every time the event occurs, signed via the `X-LLMPulse-Signature` header (HMAC-SHA256 of the raw body computed with the subscription secret). Failed deliveries receive up to 5 attempts in total, including the first, with backoff; subscriptions auto-disable after 20 consecutive failed deliveries. Idempotent for the same project + event + URL: re-posting returns the existing subscription, unless the API key or OAuth connection that created it was revoked; then it is replaced by a new subscription with a new secret. Requires a `read_write` scope API key and the Scale plan or above.
+     * Create a webhook subscription
+     */
+    async createWebhookRaw(requestParameters: CreateWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWebhook201Response>> {
+        const requestOptions = await this.createWebhookRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWebhook201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Subscribes a public HTTPS URL to a project event. LLM Pulse POSTs a JSON envelope (`event`, `occurred_at`, `project_id`, `subscription_id`, `data`) to the URL every time the event occurs, signed via the `X-LLMPulse-Signature` header (HMAC-SHA256 of the raw body computed with the subscription secret). Failed deliveries receive up to 5 attempts in total, including the first, with backoff; subscriptions auto-disable after 20 consecutive failed deliveries. Idempotent for the same project + event + URL: re-posting returns the existing subscription, unless the API key or OAuth connection that created it was revoked; then it is replaced by a new subscription with a new secret. Requires a `read_write` scope API key and the Scale plan or above.
+     * Create a webhook subscription
+     */
+    async createWebhook(requestParameters: CreateWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWebhook201Response> {
+        const response = await this.createWebhookRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteWebhook without sending the request
+     */
+    async deleteWebhookRequestOpts(requestParameters: DeleteWebhookRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteWebhook().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/webhooks/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Deletes a webhook subscription; the target URL stops receiving events immediately. Requires a `read_write` scope API key and the Scale plan or above.
+     * Delete a webhook subscription
+     */
+    async deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteWebhook200Response>> {
+        const requestOptions = await this.deleteWebhookRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeleteWebhook200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Deletes a webhook subscription; the target URL stops receiving events immediately. Requires a `read_write` scope API key and the Scale plan or above.
+     * Delete a webhook subscription
+     */
+    async deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteWebhook200Response> {
+        const response = await this.deleteWebhookRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listWebhooks without sending the request
+     */
+    async listWebhooksRequestOpts(requestParameters: ListWebhooksRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/webhooks`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Lists active webhook subscriptions for the account, optionally filtered by project. Requires the Scale plan or above.
+     * List webhook subscriptions
+     */
+    async listWebhooksRaw(requestParameters: ListWebhooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWebhooks200Response>> {
+        const requestOptions = await this.listWebhooksRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListWebhooks200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists active webhook subscriptions for the account, optionally filtered by project. Requires the Scale plan or above.
+     * List webhook subscriptions
+     */
+    async listWebhooks(requestParameters: ListWebhooksRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWebhooks200Response> {
+        const response = await this.listWebhooksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for sampleWebhookPayloads without sending the request
+     */
+    async sampleWebhookPayloadsRequestOpts(requestParameters: SampleWebhookPayloadsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['eventType'] == null) {
+            throw new runtime.RequiredError(
+                'eventType',
+                'Required parameter "eventType" was null or undefined when calling sampleWebhookPayloads().'
+            );
+        }
+
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling sampleWebhookPayloads().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/webhooks/sample/{event_type}`;
+        urlPath = urlPath.replace('{event_type}', encodeURIComponent(String(requestParameters['eventType'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns up to 3 example event payloads for the event type, built from the project\'s most recent real data (or a static sample when the project has no data). Used by integration editors such as the Zapier sample loader. Requires the Scale plan or above.
+     * Sample event payloads
+     */
+    async sampleWebhookPayloadsRaw(requestParameters: SampleWebhookPayloadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SampleWebhookPayloads200Response>> {
+        const requestOptions = await this.sampleWebhookPayloadsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SampleWebhookPayloads200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns up to 3 example event payloads for the event type, built from the project\'s most recent real data (or a static sample when the project has no data). Used by integration editors such as the Zapier sample loader. Requires the Scale plan or above.
+     * Sample event payloads
+     */
+    async sampleWebhookPayloads(requestParameters: SampleWebhookPayloadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SampleWebhookPayloads200Response> {
+        const response = await this.sampleWebhookPayloadsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const SampleWebhookPayloadsEventTypeEnum = {
+    MentionCreated: 'mention.created',
+    CompetitorMentionCreated: 'competitor_mention.created',
+    CitationCreated: 'citation.created',
+    PromptExecutionCompleted: 'prompt_execution.completed',
+    SentimentNegativeDetected: 'sentiment.negative_detected',
+    RecommendationCompleted: 'recommendation.completed',
+    IntelligenceTaskCompleted: 'intelligence_task.completed',
+    IntelligenceTaskUpdated: 'intelligence_task.updated',
+    GeoAuditRunCompleted: 'geo_audit_run.completed',
+    GeoAuditAlertTriggered: 'geo_audit_alert.triggered'
+} as const;
+export type SampleWebhookPayloadsEventTypeEnum = typeof SampleWebhookPayloadsEventTypeEnum[keyof typeof SampleWebhookPayloadsEventTypeEnum];

package/src/apis/index.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AIAgentTrafficApi';
+export * from './AIModelInsightsApi';
+export * from './AccountApi';
+export * from './AnnotationsApi';
+export * from './AnswersApi';
+export * from './CollectionsTagsApi';
+export * from './CompetitorsApi';
+export * from './GEOAuditsApi';
+export * from './GEOWriterApi';
+export * from './HealthApi';
+export * from './MentionsCitationsApi';
+export * from './MetricsApi';
+export * from './OwnedMediaCommunitiesApi';
+export * from './ProjectsApi';
+export * from './PromptsApi';
+export * from './RecommendationsApi';
+export * from './ReputationStudiesApi';
+export * from './SearchConsoleApi';
+export * from './SentimentsApi';
+export * from './ShoppingAdsApi';
+export * from './SourcesCitationIntelligenceApi';
+export * from './StoreIntegrationsApi';
+export * from './TeamApi';
+export * from './TechnicalGEOReportsApi';
+export * from './WebhooksApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/AccountCapacity.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A ceiling with no usage counter attached. limit is null when unlimited is true.
+ * @export
+ * @interface AccountCapacity
+ */
+export interface AccountCapacity {
+    /**
+     * 
+     * @type {number}
+     * @memberof AccountCapacity
+     */
+    limit?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AccountCapacity
+     */
+    unlimited?: boolean;
+}
+
+/**
+ * Check if a given object implements the AccountCapacity interface.
+ */
+export function instanceOfAccountCapacity(value: object): value is AccountCapacity {
+    return true;
+}
+
+export function AccountCapacityFromJSON(json: any): AccountCapacity {
+    return AccountCapacityFromJSONTyped(json, false);
+}
+
+export function AccountCapacityFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountCapacity {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'] === undefined ? undefined : json['limit'] === null ? null : json['limit'],
+        'unlimited': json['unlimited'] == null ? undefined : json['unlimited'],
+    };
+}
+
+export function AccountCapacityToJSON(json: any): AccountCapacity {
+    return AccountCapacityToJSONTyped(json, false);
+}
+
+export function AccountCapacityToJSONTyped(value?: AccountCapacity | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'limit': value['limit'],
+        'unlimited': value['unlimited'],
+    };
+}
+

package/src/models/AccountQuota.ts

@@ -0,0 +1,97 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A consumable quota. limit and remaining are null when unlimited is true. For a key limited to some projects, prompts and intelligence_tasks carry no limit (and intelligence_tasks no used): only the capacity left.
+ * @export
+ * @interface AccountQuota
+ */
+export interface AccountQuota {
+    /**
+     * 
+     * @type {number}
+     * @memberof AccountQuota
+     */
+    limit?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof AccountQuota
+     */
+    used?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AccountQuota
+     */
+    remaining?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AccountQuota
+     */
+    unlimited?: boolean;
+    /**
+     * Reset window for quotas that reset (e.g. month)
+     * @type {string}
+     * @memberof AccountQuota
+     */
+    period?: string;
+}
+
+/**
+ * Check if a given object implements the AccountQuota interface.
+ */
+export function instanceOfAccountQuota(value: object): value is AccountQuota {
+    return true;
+}
+
+export function AccountQuotaFromJSON(json: any): AccountQuota {
+    return AccountQuotaFromJSONTyped(json, false);
+}
+
+export function AccountQuotaFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountQuota {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'] === undefined ? undefined : json['limit'] === null ? null : json['limit'],
+        'used': json['used'] == null ? undefined : json['used'],
+        'remaining': json['remaining'] === undefined ? undefined : json['remaining'] === null ? null : json['remaining'],
+        'unlimited': json['unlimited'] == null ? undefined : json['unlimited'],
+        'period': json['period'] == null ? undefined : json['period'],
+    };
+}
+
+export function AccountQuotaToJSON(json: any): AccountQuota {
+    return AccountQuotaToJSONTyped(json, false);
+}
+
+export function AccountQuotaToJSONTyped(value?: AccountQuota | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'limit': value['limit'],
+        'used': value['used'],
+        'remaining': value['remaining'],
+        'unlimited': value['unlimited'],
+        'period': value['period'],
+    };
+}
+