@llmpulse/sdk 0.0.0-stage → 1.59.0

package/dist/esm/models/PromptsCreateRequest.d.ts

@@ -0,0 +1,50 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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.
+ */
+/**
+ *
+ * @export
+ * @interface PromptsCreateRequest
+ */
+export interface PromptsCreateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateRequest
+     */
+    projectId: number;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PromptsCreateRequest
+     */
+    prompts: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof PromptsCreateRequest
+     */
+    countryCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PromptsCreateRequest
+     */
+    languageCode: string;
+}
+/**
+ * Check if a given object implements the PromptsCreateRequest interface.
+ */
+export declare function instanceOfPromptsCreateRequest(value: object): value is PromptsCreateRequest;
+export declare function PromptsCreateRequestFromJSON(json: any): PromptsCreateRequest;
+export declare function PromptsCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptsCreateRequest;
+export declare function PromptsCreateRequestToJSON(json: any): PromptsCreateRequest;
+export declare function PromptsCreateRequestToJSONTyped(value?: PromptsCreateRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptsCreateRequest.js

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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.
+ */
+/**
+ * Check if a given object implements the PromptsCreateRequest interface.
+ */
+export function instanceOfPromptsCreateRequest(value) {
+    if ((!('projectId' in value) && !('project_id' in value)) || (value['projectId'] === undefined && value['project_id'] === undefined))
+        return false;
+    if (!('prompts' in value) || value['prompts'] === undefined)
+        return false;
+    if ((!('countryCode' in value) && !('country_code' in value)) || (value['countryCode'] === undefined && value['country_code'] === undefined))
+        return false;
+    if ((!('languageCode' in value) && !('language_code' in value)) || (value['languageCode'] === undefined && value['language_code'] === undefined))
+        return false;
+    return true;
+}
+export function PromptsCreateRequestFromJSON(json) {
+    return PromptsCreateRequestFromJSONTyped(json, false);
+}
+export function PromptsCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'projectId': json['project_id'],
+        'prompts': json['prompts'],
+        'countryCode': json['country_code'],
+        'languageCode': json['language_code'],
+    };
+}
+export function PromptsCreateRequestToJSON(json) {
+    return PromptsCreateRequestToJSONTyped(json, false);
+}
+export function PromptsCreateRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_id': value['projectId'],
+        'prompts': value['prompts'],
+        'country_code': value['countryCode'],
+        'language_code': value['languageCode'],
+    };
+}

package/dist/esm/models/PromptsCreateResponse.d.ts

@@ -0,0 +1,69 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 type { PromptsCreateResponseDataInner } from './PromptsCreateResponseDataInner';
+/**
+ *
+ * @export
+ * @interface PromptsCreateResponse
+ */
+export interface PromptsCreateResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateResponse
+     */
+    projectId?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateResponse
+     */
+    created?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateResponse
+     */
+    skipped?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateResponse
+     */
+    totalAfter?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateResponse
+     */
+    promptsAvailable?: number;
+    /**
+     *
+     * @type {Array<PromptsCreateResponseDataInner>}
+     * @memberof PromptsCreateResponse
+     */
+    data?: Array<PromptsCreateResponseDataInner>;
+    /**
+     *
+     * @type {string}
+     * @memberof PromptsCreateResponse
+     */
+    requestId?: string;
+}
+/**
+ * Check if a given object implements the PromptsCreateResponse interface.
+ */
+export declare function instanceOfPromptsCreateResponse(value: object): value is PromptsCreateResponse;
+export declare function PromptsCreateResponseFromJSON(json: any): PromptsCreateResponse;
+export declare function PromptsCreateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptsCreateResponse;
+export declare function PromptsCreateResponseToJSON(json: any): PromptsCreateResponse;
+export declare function PromptsCreateResponseToJSONTyped(value?: PromptsCreateResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptsCreateResponse.js

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 { PromptsCreateResponseDataInnerFromJSON, PromptsCreateResponseDataInnerToJSON, } from './PromptsCreateResponseDataInner';
+/**
+ * Check if a given object implements the PromptsCreateResponse interface.
+ */
+export function instanceOfPromptsCreateResponse(value) {
+    return true;
+}
+export function PromptsCreateResponseFromJSON(json) {
+    return PromptsCreateResponseFromJSONTyped(json, false);
+}
+export function PromptsCreateResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'created': json['created'] == null ? undefined : json['created'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+        'totalAfter': json['total_after'] == null ? undefined : json['total_after'],
+        'promptsAvailable': json['prompts_available'] == null ? undefined : json['prompts_available'],
+        'data': json['data'] == null ? undefined : (json['data'].map(PromptsCreateResponseDataInnerFromJSON)),
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+export function PromptsCreateResponseToJSON(json) {
+    return PromptsCreateResponseToJSONTyped(json, false);
+}
+export function PromptsCreateResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_id': value['projectId'],
+        'created': value['created'],
+        'skipped': value['skipped'],
+        'total_after': value['totalAfter'],
+        'prompts_available': value['promptsAvailable'],
+        'data': value['data'] == null ? undefined : (value['data'].map(PromptsCreateResponseDataInnerToJSON)),
+        'request_id': value['requestId'],
+    };
+}

package/dist/esm/models/PromptsCreateResponseDataInner.d.ts

@@ -0,0 +1,52 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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.
+ */
+/**
+ *
+ * @export
+ * @interface PromptsCreateResponseDataInner
+ */
+export interface PromptsCreateResponseDataInner {
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsCreateResponseDataInner
+     */
+    id?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PromptsCreateResponseDataInner
+     */
+    rawInput?: string;
+    /**
+     *
+     * @type {PromptsCreateResponseDataInnerStatusEnum}
+     * @memberof PromptsCreateResponseDataInner
+     */
+    status?: PromptsCreateResponseDataInnerStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const PromptsCreateResponseDataInnerStatusEnum: {
+    readonly Created: "created";
+    readonly Exists: "exists";
+};
+export type PromptsCreateResponseDataInnerStatusEnum = typeof PromptsCreateResponseDataInnerStatusEnum[keyof typeof PromptsCreateResponseDataInnerStatusEnum];
+/**
+ * Check if a given object implements the PromptsCreateResponseDataInner interface.
+ */
+export declare function instanceOfPromptsCreateResponseDataInner(value: object): value is PromptsCreateResponseDataInner;
+export declare function PromptsCreateResponseDataInnerFromJSON(json: any): PromptsCreateResponseDataInner;
+export declare function PromptsCreateResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptsCreateResponseDataInner;
+export declare function PromptsCreateResponseDataInnerToJSON(json: any): PromptsCreateResponseDataInner;
+export declare function PromptsCreateResponseDataInnerToJSONTyped(value?: PromptsCreateResponseDataInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptsCreateResponseDataInner.js

@@ -0,0 +1,52 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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.
+ */
+/**
+ * @export
+ */
+export const PromptsCreateResponseDataInnerStatusEnum = {
+    Created: 'created',
+    Exists: 'exists'
+};
+/**
+ * Check if a given object implements the PromptsCreateResponseDataInner interface.
+ */
+export function instanceOfPromptsCreateResponseDataInner(value) {
+    return true;
+}
+export function PromptsCreateResponseDataInnerFromJSON(json) {
+    return PromptsCreateResponseDataInnerFromJSONTyped(json, false);
+}
+export function PromptsCreateResponseDataInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'rawInput': json['raw_input'] == null ? undefined : json['raw_input'],
+        'status': json['status'] == null ? undefined : json['status'],
+    };
+}
+export function PromptsCreateResponseDataInnerToJSON(json) {
+    return PromptsCreateResponseDataInnerToJSONTyped(json, false);
+}
+export function PromptsCreateResponseDataInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'raw_input': value['rawInput'],
+        'status': value['status'],
+    };
+}

package/dist/esm/models/PromptsResponse.d.ts

@@ -0,0 +1,63 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 type { PromptRecord } from './PromptRecord';
+/**
+ *
+ * @export
+ * @interface PromptsResponse
+ */
+export interface PromptsResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsResponse
+     */
+    projectId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsResponse
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PromptsResponse
+     */
+    perPage: number;
+    /**
+     * Rows matching the filters across every page
+     * @type {number}
+     * @memberof PromptsResponse
+     */
+    total: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PromptsResponse
+     */
+    requestId: string;
+    /**
+     *
+     * @type {Array<PromptRecord>}
+     * @memberof PromptsResponse
+     */
+    data: Array<PromptRecord>;
+}
+/**
+ * Check if a given object implements the PromptsResponse interface.
+ */
+export declare function instanceOfPromptsResponse(value: object): value is PromptsResponse;
+export declare function PromptsResponseFromJSON(json: any): PromptsResponse;
+export declare function PromptsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromptsResponse;
+export declare function PromptsResponseToJSON(json: any): PromptsResponse;
+export declare function PromptsResponseToJSONTyped(value?: PromptsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PromptsResponse.js

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 { PromptRecordFromJSON, PromptRecordToJSON, } from './PromptRecord';
+/**
+ * Check if a given object implements the PromptsResponse interface.
+ */
+export function instanceOfPromptsResponse(value) {
+    if ((!('projectId' in value) && !('project_id' in value)) || (value['projectId'] === undefined && value['project_id'] === undefined))
+        return false;
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if ((!('perPage' in value) && !('per_page' in value)) || (value['perPage'] === undefined && value['per_page'] === undefined))
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if ((!('requestId' in value) && !('request_id' in value)) || (value['requestId'] === undefined && value['request_id'] === undefined))
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function PromptsResponseFromJSON(json) {
+    return PromptsResponseFromJSONTyped(json, false);
+}
+export function PromptsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'projectId': json['project_id'],
+        'page': json['page'],
+        'perPage': json['per_page'],
+        'total': json['total'],
+        'requestId': json['request_id'],
+        'data': (json['data'].map(PromptRecordFromJSON)),
+    };
+}
+export function PromptsResponseToJSON(json) {
+    return PromptsResponseToJSONTyped(json, false);
+}
+export function PromptsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_id': value['projectId'],
+        'page': value['page'],
+        'per_page': value['perPage'],
+        'total': value['total'],
+        'request_id': value['requestId'],
+        'data': (value['data'].map(PromptRecordToJSON)),
+    };
+}

package/dist/esm/models/QueryWebAnalyticsRequest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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.
+ */
+/**
+ *
+ * @export
+ * @interface QueryWebAnalyticsRequest
+ */
+export interface QueryWebAnalyticsRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof QueryWebAnalyticsRequest
+     */
+    projectId: number;
+    /**
+     * The query in the provider's native format (see GET /web_analytics/schema): a JSON object for GA4, Adobe, Matomo, Plausible and Piano; for PostHog, {"query": "<HogQL>"} or the HogQL string. Deliberately untyped so generated clients accept either shape.
+     * @type {any}
+     * @memberof QueryWebAnalyticsRequest
+     */
+    query: any | null;
+}
+/**
+ * Check if a given object implements the QueryWebAnalyticsRequest interface.
+ */
+export declare function instanceOfQueryWebAnalyticsRequest(value: object): value is QueryWebAnalyticsRequest;
+export declare function QueryWebAnalyticsRequestFromJSON(json: any): QueryWebAnalyticsRequest;
+export declare function QueryWebAnalyticsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): QueryWebAnalyticsRequest;
+export declare function QueryWebAnalyticsRequestToJSON(json: any): QueryWebAnalyticsRequest;
+export declare function QueryWebAnalyticsRequestToJSONTyped(value?: QueryWebAnalyticsRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QueryWebAnalyticsRequest.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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.
+ */
+/**
+ * Check if a given object implements the QueryWebAnalyticsRequest interface.
+ */
+export function instanceOfQueryWebAnalyticsRequest(value) {
+    if ((!('projectId' in value) && !('project_id' in value)) || (value['projectId'] === undefined && value['project_id'] === undefined))
+        return false;
+    if (!('query' in value) || value['query'] === undefined)
+        return false;
+    return true;
+}
+export function QueryWebAnalyticsRequestFromJSON(json) {
+    return QueryWebAnalyticsRequestFromJSONTyped(json, false);
+}
+export function QueryWebAnalyticsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'projectId': json['project_id'],
+        'query': json['query'],
+    };
+}
+export function QueryWebAnalyticsRequestToJSON(json) {
+    return QueryWebAnalyticsRequestToJSONTyped(json, false);
+}
+export function QueryWebAnalyticsRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_id': value['projectId'],
+        'query': value['query'],
+    };
+}

package/dist/esm/models/RecommendationSummary.d.ts

@@ -0,0 +1,119 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 type { RecommendationSummarySummary } from './RecommendationSummarySummary';
+/**
+ *
+ * @export
+ * @interface RecommendationSummary
+ */
+export interface RecommendationSummary {
+    /**
+     *
+     * @type {number}
+     * @memberof RecommendationSummary
+     */
+    id: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RecommendationSummary
+     */
+    projectId: number;
+    /**
+     *
+     * @type {RecommendationSummaryRecommendationTypeEnum}
+     * @memberof RecommendationSummary
+     */
+    recommendationType: RecommendationSummaryRecommendationTypeEnum;
+    /**
+     *
+     * @type {RecommendationSummaryStatusEnum}
+     * @memberof RecommendationSummary
+     */
+    status: RecommendationSummaryStatusEnum;
+    /**
+     * Set only when status is failed
+     * @type {string}
+     * @memberof RecommendationSummary
+     */
+    errorMessage: string | null;
+    /**
+     * Null until the generation completes
+     * @type {Date}
+     * @memberof RecommendationSummary
+     */
+    generatedAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof RecommendationSummary
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof RecommendationSummary
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof RecommendationSummary
+     */
+    totalRecommendations: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RecommendationSummary
+     */
+    highPriorityCount: number;
+    /**
+     *
+     * @type {RecommendationSummarySummary}
+     * @memberof RecommendationSummary
+     */
+    summary: RecommendationSummarySummary;
+    /**
+     * Generation context and run diagnostics as stored; empty until the generation completes. Its keys are not a stable contract
+     * @type {object}
+     * @memberof RecommendationSummary
+     */
+    context: object;
+}
+/**
+ * @export
+ */
+export declare const RecommendationSummaryRecommendationTypeEnum: {
+    readonly AiVisibility: "ai_visibility";
+    readonly SocialCommunity: "social_community";
+    readonly BrandBuilding: "brand_building";
+    readonly SentimentReputation: "sentiment_reputation";
+};
+export type RecommendationSummaryRecommendationTypeEnum = typeof RecommendationSummaryRecommendationTypeEnum[keyof typeof RecommendationSummaryRecommendationTypeEnum];
+/**
+ * @export
+ */
+export declare const RecommendationSummaryStatusEnum: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+};
+export type RecommendationSummaryStatusEnum = typeof RecommendationSummaryStatusEnum[keyof typeof RecommendationSummaryStatusEnum];
+/**
+ * Check if a given object implements the RecommendationSummary interface.
+ */
+export declare function instanceOfRecommendationSummary(value: object): value is RecommendationSummary;
+export declare function RecommendationSummaryFromJSON(json: any): RecommendationSummary;
+export declare function RecommendationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendationSummary;
+export declare function RecommendationSummaryToJSON(json: any): RecommendationSummary;
+export declare function RecommendationSummaryToJSONTyped(value?: RecommendationSummary | null, ignoreDiscriminator?: boolean): any;