@llmpulse/sdk 0.0.0-stage → 1.60.0

package/src/models/CitationsResponse.ts

@@ -0,0 +1,119 @@
+/* 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';
+import type { CitationRecord } from './CitationRecord';
+import {
+    CitationRecordFromJSON,
+    CitationRecordFromJSONTyped,
+    CitationRecordToJSON,
+    CitationRecordToJSONTyped,
+} from './CitationRecord';
+
+/**
+ * 
+ * @export
+ * @interface CitationsResponse
+ */
+export interface CitationsResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof CitationsResponse
+     */
+    projectId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CitationsResponse
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CitationsResponse
+     */
+    perPage: number;
+    /**
+     * Rows matching the filters across every page
+     * @type {number}
+     * @memberof CitationsResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CitationsResponse
+     */
+    requestId: string;
+    /**
+     * 
+     * @type {Array<CitationRecord>}
+     * @memberof CitationsResponse
+     */
+    data: Array<CitationRecord>;
+}
+
+/**
+ * Check if a given object implements the CitationsResponse interface.
+ */
+export function instanceOfCitationsResponse(value: object): value is CitationsResponse {
+    if ((!('projectId' in (value as Record<string, any>)) && !('project_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['projectId'] === undefined && (value as Record<string, any>)['project_id'] === undefined)) return false;
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if ((!('perPage' in (value as Record<string, any>)) && !('per_page' in (value as Record<string, any>))) || ((value as Record<string, any>)['perPage'] === undefined && (value as Record<string, any>)['per_page'] === undefined)) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if ((!('requestId' in (value as Record<string, any>)) && !('request_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['requestId'] === undefined && (value as Record<string, any>)['request_id'] === undefined)) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function CitationsResponseFromJSON(json: any): CitationsResponse {
+    return CitationsResponseFromJSONTyped(json, false);
+}
+
+export function CitationsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CitationsResponse {
+    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'] as Array<any>).map(CitationRecordFromJSON)),
+    };
+}
+
+export function CitationsResponseToJSON(json: any): CitationsResponse {
+    return CitationsResponseToJSONTyped(json, false);
+}
+
+export function CitationsResponseToJSONTyped(value?: CitationsResponse | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(CitationRecordToJSON)),
+    };
+}
+

package/src/models/CollectionCreateResponse.ts

@@ -0,0 +1,110 @@
+/* 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';
+import type { CollectionCreateResponseCollection } from './CollectionCreateResponseCollection';
+import {
+    CollectionCreateResponseCollectionFromJSON,
+    CollectionCreateResponseCollectionFromJSONTyped,
+    CollectionCreateResponseCollectionToJSON,
+    CollectionCreateResponseCollectionToJSONTyped,
+} from './CollectionCreateResponseCollection';
+
+/**
+ * 
+ * @export
+ * @interface CollectionCreateResponse
+ */
+export interface CollectionCreateResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof CollectionCreateResponse
+     */
+    projectId: number;
+    /**
+     * 
+     * @type {CollectionCreateResponseCollection}
+     * @memberof CollectionCreateResponse
+     */
+    collection: CollectionCreateResponseCollection;
+    /**
+     * Existing prompts attached through prompt_ids
+     * @type {number}
+     * @memberof CollectionCreateResponse
+     */
+    promptsAttached: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CollectionCreateResponse
+     */
+    totalCollections: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CollectionCreateResponse
+     */
+    requestId: string;
+}
+
+/**
+ * Check if a given object implements the CollectionCreateResponse interface.
+ */
+export function instanceOfCollectionCreateResponse(value: object): value is CollectionCreateResponse {
+    if ((!('projectId' in (value as Record<string, any>)) && !('project_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['projectId'] === undefined && (value as Record<string, any>)['project_id'] === undefined)) return false;
+    if (!('collection' in value) || value['collection'] === undefined) return false;
+    if ((!('promptsAttached' in (value as Record<string, any>)) && !('prompts_attached' in (value as Record<string, any>))) || ((value as Record<string, any>)['promptsAttached'] === undefined && (value as Record<string, any>)['prompts_attached'] === undefined)) return false;
+    if ((!('totalCollections' in (value as Record<string, any>)) && !('total_collections' in (value as Record<string, any>))) || ((value as Record<string, any>)['totalCollections'] === undefined && (value as Record<string, any>)['total_collections'] === undefined)) return false;
+    if ((!('requestId' in (value as Record<string, any>)) && !('request_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['requestId'] === undefined && (value as Record<string, any>)['request_id'] === undefined)) return false;
+    return true;
+}
+
+export function CollectionCreateResponseFromJSON(json: any): CollectionCreateResponse {
+    return CollectionCreateResponseFromJSONTyped(json, false);
+}
+
+export function CollectionCreateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CollectionCreateResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectId': json['project_id'],
+        'collection': CollectionCreateResponseCollectionFromJSON(json['collection']),
+        'promptsAttached': json['prompts_attached'],
+        'totalCollections': json['total_collections'],
+        'requestId': json['request_id'],
+    };
+}
+
+export function CollectionCreateResponseToJSON(json: any): CollectionCreateResponse {
+    return CollectionCreateResponseToJSONTyped(json, false);
+}
+
+export function CollectionCreateResponseToJSONTyped(value?: CollectionCreateResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'project_id': value['projectId'],
+        'collection': CollectionCreateResponseCollectionToJSON(value['collection']),
+        'prompts_attached': value['promptsAttached'],
+        'total_collections': value['totalCollections'],
+        'request_id': value['requestId'],
+    };
+}
+

package/src/models/CollectionCreateResponseCollection.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface CollectionCreateResponseCollection
+ */
+export interface CollectionCreateResponseCollection {
+    /**
+     * 
+     * @type {number}
+     * @memberof CollectionCreateResponseCollection
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CollectionCreateResponseCollection
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CollectionCreateResponseCollection
+     */
+    description: string | null;
+}
+
+/**
+ * Check if a given object implements the CollectionCreateResponseCollection interface.
+ */
+export function instanceOfCollectionCreateResponseCollection(value: object): value is CollectionCreateResponseCollection {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function CollectionCreateResponseCollectionFromJSON(json: any): CollectionCreateResponseCollection {
+    return CollectionCreateResponseCollectionFromJSONTyped(json, false);
+}
+
+export function CollectionCreateResponseCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CollectionCreateResponseCollection {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+
+export function CollectionCreateResponseCollectionToJSON(json: any): CollectionCreateResponseCollection {
+    return CollectionCreateResponseCollectionToJSONTyped(json, false);
+}
+
+export function CollectionCreateResponseCollectionToJSONTyped(value?: CollectionCreateResponseCollection | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+

package/src/models/CollectionsResponse.ts

@@ -0,0 +1,92 @@
+/* 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';
+import type { TagRef } from './TagRef';
+import {
+    TagRefFromJSON,
+    TagRefFromJSONTyped,
+    TagRefToJSON,
+    TagRefToJSONTyped,
+} from './TagRef';
+
+/**
+ * 
+ * @export
+ * @interface CollectionsResponse
+ */
+export interface CollectionsResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof CollectionsResponse
+     */
+    projectId: number;
+    /**
+     * 
+     * @type {Array<TagRef>}
+     * @memberof CollectionsResponse
+     */
+    collections: Array<TagRef>;
+    /**
+     * 
+     * @type {string}
+     * @memberof CollectionsResponse
+     */
+    requestId: string;
+}
+
+/**
+ * Check if a given object implements the CollectionsResponse interface.
+ */
+export function instanceOfCollectionsResponse(value: object): value is CollectionsResponse {
+    if ((!('projectId' in (value as Record<string, any>)) && !('project_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['projectId'] === undefined && (value as Record<string, any>)['project_id'] === undefined)) return false;
+    if (!('collections' in value) || value['collections'] === undefined) return false;
+    if ((!('requestId' in (value as Record<string, any>)) && !('request_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['requestId'] === undefined && (value as Record<string, any>)['request_id'] === undefined)) return false;
+    return true;
+}
+
+export function CollectionsResponseFromJSON(json: any): CollectionsResponse {
+    return CollectionsResponseFromJSONTyped(json, false);
+}
+
+export function CollectionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CollectionsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectId': json['project_id'],
+        'collections': ((json['collections'] as Array<any>).map(TagRefFromJSON)),
+        'requestId': json['request_id'],
+    };
+}
+
+export function CollectionsResponseToJSON(json: any): CollectionsResponse {
+    return CollectionsResponseToJSONTyped(json, false);
+}
+
+export function CollectionsResponseToJSONTyped(value?: CollectionsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'project_id': value['projectId'],
+        'collections': ((value['collections'] as Array<any>).map(TagRefToJSON)),
+        'request_id': value['requestId'],
+    };
+}
+

package/src/models/Competitor.ts

@@ -0,0 +1,140 @@
+/* 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';
+import type { CitationMatchMode } from './CitationMatchMode';
+import {
+    CitationMatchModeFromJSON,
+    CitationMatchModeFromJSONTyped,
+    CitationMatchModeToJSON,
+    CitationMatchModeToJSONTyped,
+} from './CitationMatchMode';
+
+/**
+ * 
+ * @export
+ * @interface Competitor
+ */
+export interface Competitor {
+    /**
+     * 
+     * @type {number}
+     * @memberof Competitor
+     */
+    id?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Competitor
+     */
+    name?: string;
+    /**
+     * Bare (scheme-less) domain. Null only on the own-brand row (include_project_brand=true) when the project has no URL.
+     * @type {string}
+     * @memberof Competitor
+     */
+    domain?: string | null;
+    /**
+     * Alternative names matched as this competitor. Absent on the own-brand row
+     * @type {Array<string>}
+     * @memberof Competitor
+     */
+    matchingNames?: Array<string>;
+    /**
+     * 
+     * @type {CitationMatchMode}
+     * @memberof Competitor
+     */
+    citationMatchMode?: CitationMatchMode;
+    /**
+     * Set only when citation_match_mode is path_prefix
+     * @type {string}
+     * @memberof Competitor
+     */
+    citationMatchPath?: string | null;
+    /**
+     * Only present when include_project_brand=true
+     * @type {CompetitorActorTypeEnum}
+     * @memberof Competitor
+     */
+    actorType?: CompetitorActorTypeEnum;
+    /**
+     * Only present when include_project_brand=true
+     * @type {boolean}
+     * @memberof Competitor
+     */
+    isOwn?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const CompetitorActorTypeEnum = {
+    Project: 'project',
+    Competitor: 'competitor'
+} as const;
+export type CompetitorActorTypeEnum = typeof CompetitorActorTypeEnum[keyof typeof CompetitorActorTypeEnum];
+
+
+/**
+ * Check if a given object implements the Competitor interface.
+ */
+export function instanceOfCompetitor(value: object): value is Competitor {
+    return true;
+}
+
+export function CompetitorFromJSON(json: any): Competitor {
+    return CompetitorFromJSONTyped(json, false);
+}
+
+export function CompetitorFromJSONTyped(json: any, ignoreDiscriminator: boolean): Competitor {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'domain': json['domain'] === undefined ? undefined : json['domain'] === null ? null : json['domain'],
+        'matchingNames': json['matching_names'] == null ? undefined : json['matching_names'],
+        'citationMatchMode': json['citation_match_mode'] == null ? undefined : CitationMatchModeFromJSON(json['citation_match_mode']),
+        'citationMatchPath': json['citation_match_path'] === undefined ? undefined : json['citation_match_path'] === null ? null : json['citation_match_path'],
+        'actorType': json['actor_type'] == null ? undefined : json['actor_type'],
+        'isOwn': json['is_own'] == null ? undefined : json['is_own'],
+    };
+}
+
+export function CompetitorToJSON(json: any): Competitor {
+    return CompetitorToJSONTyped(json, false);
+}
+
+export function CompetitorToJSONTyped(value?: Competitor | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'domain': value['domain'],
+        'matching_names': value['matchingNames'],
+        'citation_match_mode': CitationMatchModeToJSON(value['citationMatchMode']),
+        'citation_match_path': value['citationMatchPath'],
+        'actor_type': value['actorType'],
+        'is_own': value['isOwn'],
+    };
+}
+

package/src/models/CompetitorCreateResponse.ts

@@ -0,0 +1,110 @@
+/* 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';
+import type { CompetitorCreateResponseCompetitor } from './CompetitorCreateResponseCompetitor';
+import {
+    CompetitorCreateResponseCompetitorFromJSON,
+    CompetitorCreateResponseCompetitorFromJSONTyped,
+    CompetitorCreateResponseCompetitorToJSON,
+    CompetitorCreateResponseCompetitorToJSONTyped,
+} from './CompetitorCreateResponseCompetitor';
+
+/**
+ * 
+ * @export
+ * @interface CompetitorCreateResponse
+ */
+export interface CompetitorCreateResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof CompetitorCreateResponse
+     */
+    projectId: number;
+    /**
+     * 
+     * @type {CompetitorCreateResponseCompetitor}
+     * @memberof CompetitorCreateResponse
+     */
+    competitor: CompetitorCreateResponseCompetitor;
+    /**
+     * Competitors the plan still allows in this project; null when unlimited
+     * @type {number}
+     * @memberof CompetitorCreateResponse
+     */
+    competitorsRemaining: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CompetitorCreateResponse
+     */
+    totalCompetitors: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompetitorCreateResponse
+     */
+    requestId: string;
+}
+
+/**
+ * Check if a given object implements the CompetitorCreateResponse interface.
+ */
+export function instanceOfCompetitorCreateResponse(value: object): value is CompetitorCreateResponse {
+    if ((!('projectId' in (value as Record<string, any>)) && !('project_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['projectId'] === undefined && (value as Record<string, any>)['project_id'] === undefined)) return false;
+    if (!('competitor' in value) || value['competitor'] === undefined) return false;
+    if ((!('competitorsRemaining' in (value as Record<string, any>)) && !('competitors_remaining' in (value as Record<string, any>))) || ((value as Record<string, any>)['competitorsRemaining'] === undefined && (value as Record<string, any>)['competitors_remaining'] === undefined)) return false;
+    if ((!('totalCompetitors' in (value as Record<string, any>)) && !('total_competitors' in (value as Record<string, any>))) || ((value as Record<string, any>)['totalCompetitors'] === undefined && (value as Record<string, any>)['total_competitors'] === undefined)) return false;
+    if ((!('requestId' in (value as Record<string, any>)) && !('request_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['requestId'] === undefined && (value as Record<string, any>)['request_id'] === undefined)) return false;
+    return true;
+}
+
+export function CompetitorCreateResponseFromJSON(json: any): CompetitorCreateResponse {
+    return CompetitorCreateResponseFromJSONTyped(json, false);
+}
+
+export function CompetitorCreateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompetitorCreateResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectId': json['project_id'],
+        'competitor': CompetitorCreateResponseCompetitorFromJSON(json['competitor']),
+        'competitorsRemaining': json['competitors_remaining'],
+        'totalCompetitors': json['total_competitors'],
+        'requestId': json['request_id'],
+    };
+}
+
+export function CompetitorCreateResponseToJSON(json: any): CompetitorCreateResponse {
+    return CompetitorCreateResponseToJSONTyped(json, false);
+}
+
+export function CompetitorCreateResponseToJSONTyped(value?: CompetitorCreateResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'project_id': value['projectId'],
+        'competitor': CompetitorCreateResponseCompetitorToJSON(value['competitor']),
+        'competitors_remaining': value['competitorsRemaining'],
+        'total_competitors': value['totalCompetitors'],
+        'request_id': value['requestId'],
+    };
+}
+