@llmpulse/sdk 0.0.0-stage → 1.60.0

package/src/models/GeoAlertEventsInner.ts

@@ -0,0 +1,112 @@
+/* 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 GeoAlertEventsInner
+ */
+export interface GeoAlertEventsInner {
+    /**
+     * 
+     * @type {GeoAlertEventsInnerKindEnum}
+     * @memberof GeoAlertEventsInner
+     */
+    kind?: GeoAlertEventsInnerKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAlertEventsInner
+     */
+    checkKey?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAlertEventsInner
+     */
+    subjectKey?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAlertEventsInner
+     */
+    severity?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAlertEventsInner
+     */
+    message?: string;
+}
+
+
+/**
+ * @export
+ */
+export const GeoAlertEventsInnerKindEnum = {
+    NewCritical: 'new_critical',
+    Regression: 'regression',
+    Recovered: 'recovered',
+    ScoreDrop: 'score_drop',
+    Unreachable: 'unreachable',
+    Paused: 'paused'
+} as const;
+export type GeoAlertEventsInnerKindEnum = typeof GeoAlertEventsInnerKindEnum[keyof typeof GeoAlertEventsInnerKindEnum];
+
+
+/**
+ * Check if a given object implements the GeoAlertEventsInner interface.
+ */
+export function instanceOfGeoAlertEventsInner(value: object): value is GeoAlertEventsInner {
+    return true;
+}
+
+export function GeoAlertEventsInnerFromJSON(json: any): GeoAlertEventsInner {
+    return GeoAlertEventsInnerFromJSONTyped(json, false);
+}
+
+export function GeoAlertEventsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoAlertEventsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'kind': json['kind'] == null ? undefined : json['kind'],
+        'checkKey': json['check_key'] === undefined ? undefined : json['check_key'] === null ? null : json['check_key'],
+        'subjectKey': json['subject_key'] === undefined ? undefined : json['subject_key'] === null ? null : json['subject_key'],
+        'severity': json['severity'] == null ? undefined : json['severity'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function GeoAlertEventsInnerToJSON(json: any): GeoAlertEventsInner {
+    return GeoAlertEventsInnerToJSONTyped(json, false);
+}
+
+export function GeoAlertEventsInnerToJSONTyped(value?: GeoAlertEventsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'kind': value['kind'],
+        'check_key': value['checkKey'],
+        'subject_key': value['subjectKey'],
+        'severity': value['severity'],
+        'message': value['message'],
+    };
+}
+

package/src/models/GeoAlertList.ts

@@ -0,0 +1,113 @@
+/* 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 { GeoAlert } from './GeoAlert';
+import {
+    GeoAlertFromJSON,
+    GeoAlertFromJSONTyped,
+    GeoAlertToJSON,
+    GeoAlertToJSONTyped,
+} from './GeoAlert';
+
+/**
+ * 
+ * @export
+ * @interface GeoAlertList
+ */
+export interface GeoAlertList {
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAlertList
+     */
+    projectId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAlertList
+     */
+    page?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAlertList
+     */
+    perPage?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAlertList
+     */
+    total?: number;
+    /**
+     * 
+     * @type {Array<GeoAlert>}
+     * @memberof GeoAlertList
+     */
+    data?: Array<GeoAlert>;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAlertList
+     */
+    requestId?: string;
+}
+
+/**
+ * Check if a given object implements the GeoAlertList interface.
+ */
+export function instanceOfGeoAlertList(value: object): value is GeoAlertList {
+    return true;
+}
+
+export function GeoAlertListFromJSON(json: any): GeoAlertList {
+    return GeoAlertListFromJSONTyped(json, false);
+}
+
+export function GeoAlertListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoAlertList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'page': json['page'] == null ? undefined : json['page'],
+        'perPage': json['per_page'] == null ? undefined : json['per_page'],
+        'total': json['total'] == null ? undefined : json['total'],
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(GeoAlertFromJSON)),
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+
+export function GeoAlertListToJSON(json: any): GeoAlertList {
+    return GeoAlertListToJSONTyped(json, false);
+}
+
+export function GeoAlertListToJSONTyped(value?: GeoAlertList | 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'],
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(GeoAlertToJSON)),
+        'request_id': value['requestId'],
+    };
+}
+

package/src/models/GeoAudit.ts

@@ -0,0 +1,244 @@
+/* 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 { GeoAuditRun } from './GeoAuditRun';
+import {
+    GeoAuditRunFromJSON,
+    GeoAuditRunFromJSONTyped,
+    GeoAuditRunToJSON,
+    GeoAuditRunToJSONTyped,
+} from './GeoAuditRun';
+import type { GeoAuditSchedule } from './GeoAuditSchedule';
+import {
+    GeoAuditScheduleFromJSON,
+    GeoAuditScheduleFromJSONTyped,
+    GeoAuditScheduleToJSON,
+    GeoAuditScheduleToJSONTyped,
+} from './GeoAuditSchedule';
+
+/**
+ * 
+ * @export
+ * @interface GeoAudit
+ */
+export interface GeoAudit {
+    /**
+     * Stable audit id
+     * @type {string}
+     * @memberof GeoAudit
+     */
+    id?: string;
+    /**
+     * 
+     * @type {GeoAuditAuditTypeEnum}
+     * @memberof GeoAudit
+     */
+    auditType?: GeoAuditAuditTypeEnum;
+    /**
+     * The audited domain (site-wide types) or page URL, normalized
+     * @type {string}
+     * @memberof GeoAudit
+     */
+    target?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAudit
+     */
+    countryCode?: string | null;
+    /**
+     * 
+     * @type {GeoAuditCadenceEnum}
+     * @memberof GeoAudit
+     */
+    cadence?: GeoAuditCadenceEnum;
+    /**
+     * 
+     * @type {GeoAuditStatusEnum}
+     * @memberof GeoAudit
+     */
+    status?: GeoAuditStatusEnum;
+    /**
+     * user, or unreachable when three runs in a row could not reach the site
+     * @type {string}
+     * @memberof GeoAudit
+     */
+    pausedReason?: string | null;
+    /**
+     * 
+     * @type {GeoAuditSchedule}
+     * @memberof GeoAudit
+     */
+    schedule?: GeoAuditSchedule | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GeoAudit
+     */
+    nextRunAt?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GeoAudit
+     */
+    emailAlerts?: boolean;
+    /**
+     * Whether this audit type can run weekly or monthly
+     * @type {boolean}
+     * @memberof GeoAudit
+     */
+    recurringAvailable?: boolean;
+    /**
+     * Whether runs of this type produce findings and issues, or a score only
+     * @type {boolean}
+     * @memberof GeoAudit
+     */
+    checksTracked?: boolean;
+    /**
+     * 
+     * @type {GeoAuditRun}
+     * @memberof GeoAudit
+     */
+    latestRun?: GeoAuditRun | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAudit
+     */
+    openIssues?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAudit
+     */
+    openCriticalIssues?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GeoAudit
+     */
+    createdAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAudit
+     */
+    appUrl?: string;
+}
+
+
+/**
+ * @export
+ */
+export const GeoAuditAuditTypeEnum = {
+    AgentReadiness: 'agent_readiness',
+    RobotsTxt: 'robots_txt',
+    Crawlability: 'crawlability',
+    Schema: 'schema',
+    ContentReadiness: 'content_readiness',
+    Discoverability: 'discoverability',
+    SiteStructure: 'site_structure'
+} as const;
+export type GeoAuditAuditTypeEnum = typeof GeoAuditAuditTypeEnum[keyof typeof GeoAuditAuditTypeEnum];
+
+/**
+ * @export
+ */
+export const GeoAuditCadenceEnum = {
+    Once: 'once',
+    Weekly: 'weekly',
+    Monthly: 'monthly'
+} as const;
+export type GeoAuditCadenceEnum = typeof GeoAuditCadenceEnum[keyof typeof GeoAuditCadenceEnum];
+
+/**
+ * @export
+ */
+export const GeoAuditStatusEnum = {
+    Active: 'active',
+    Paused: 'paused',
+    Archived: 'archived'
+} as const;
+export type GeoAuditStatusEnum = typeof GeoAuditStatusEnum[keyof typeof GeoAuditStatusEnum];
+
+
+/**
+ * Check if a given object implements the GeoAudit interface.
+ */
+export function instanceOfGeoAudit(value: object): value is GeoAudit {
+    return true;
+}
+
+export function GeoAuditFromJSON(json: any): GeoAudit {
+    return GeoAuditFromJSONTyped(json, false);
+}
+
+export function GeoAuditFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoAudit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'auditType': json['audit_type'] == null ? undefined : json['audit_type'],
+        'target': json['target'] == null ? undefined : json['target'],
+        'countryCode': json['country_code'] === undefined ? undefined : json['country_code'] === null ? null : json['country_code'],
+        'cadence': json['cadence'] == null ? undefined : json['cadence'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'pausedReason': json['paused_reason'] === undefined ? undefined : json['paused_reason'] === null ? null : json['paused_reason'],
+        'schedule': json['schedule'] === undefined ? undefined : json['schedule'] === null ? null : GeoAuditScheduleFromJSON(json['schedule']),
+        'nextRunAt': json['next_run_at'] === undefined ? undefined : json['next_run_at'] === null ? null : (new Date(json['next_run_at'])),
+        'emailAlerts': json['email_alerts'] == null ? undefined : json['email_alerts'],
+        'recurringAvailable': json['recurring_available'] == null ? undefined : json['recurring_available'],
+        'checksTracked': json['checks_tracked'] == null ? undefined : json['checks_tracked'],
+        'latestRun': json['latest_run'] === undefined ? undefined : json['latest_run'] === null ? null : GeoAuditRunFromJSON(json['latest_run']),
+        'openIssues': json['open_issues'] == null ? undefined : json['open_issues'],
+        'openCriticalIssues': json['open_critical_issues'] == null ? undefined : json['open_critical_issues'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'appUrl': json['app_url'] == null ? undefined : json['app_url'],
+    };
+}
+
+export function GeoAuditToJSON(json: any): GeoAudit {
+    return GeoAuditToJSONTyped(json, false);
+}
+
+export function GeoAuditToJSONTyped(value?: GeoAudit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'audit_type': value['auditType'],
+        'target': value['target'],
+        'country_code': value['countryCode'],
+        'cadence': value['cadence'],
+        'status': value['status'],
+        'paused_reason': value['pausedReason'],
+        'schedule': GeoAuditScheduleToJSON(value['schedule']),
+        'next_run_at': value['nextRunAt'] == null ? value['nextRunAt'] : value['nextRunAt'].toISOString(),
+        'email_alerts': value['emailAlerts'],
+        'recurring_available': value['recurringAvailable'],
+        'checks_tracked': value['checksTracked'],
+        'latest_run': GeoAuditRunToJSON(value['latestRun']),
+        'open_issues': value['openIssues'],
+        'open_critical_issues': value['openCriticalIssues'],
+        'created_at': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'app_url': value['appUrl'],
+    };
+}
+

package/src/models/GeoAuditArchived.ts

@@ -0,0 +1,89 @@
+/* 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 GeoAuditArchived
+ */
+export interface GeoAuditArchived {
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAuditArchived
+     */
+    projectId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAuditArchived
+     */
+    id?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GeoAuditArchived
+     */
+    archived?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAuditArchived
+     */
+    requestId?: string;
+}
+
+/**
+ * Check if a given object implements the GeoAuditArchived interface.
+ */
+export function instanceOfGeoAuditArchived(value: object): value is GeoAuditArchived {
+    return true;
+}
+
+export function GeoAuditArchivedFromJSON(json: any): GeoAuditArchived {
+    return GeoAuditArchivedFromJSONTyped(json, false);
+}
+
+export function GeoAuditArchivedFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoAuditArchived {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'archived': json['archived'] == null ? undefined : json['archived'],
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+
+export function GeoAuditArchivedToJSON(json: any): GeoAuditArchived {
+    return GeoAuditArchivedToJSONTyped(json, false);
+}
+
+export function GeoAuditArchivedToJSONTyped(value?: GeoAuditArchived | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'project_id': value['projectId'],
+        'id': value['id'],
+        'archived': value['archived'],
+        'request_id': value['requestId'],
+    };
+}
+

package/src/models/GeoAuditComparison.ts

@@ -0,0 +1,144 @@
+/* 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 { GeoAuditComparisonChangesInner } from './GeoAuditComparisonChangesInner';
+import {
+    GeoAuditComparisonChangesInnerFromJSON,
+    GeoAuditComparisonChangesInnerFromJSONTyped,
+    GeoAuditComparisonChangesInnerToJSON,
+    GeoAuditComparisonChangesInnerToJSONTyped,
+} from './GeoAuditComparisonChangesInner';
+import type { GeoAuditRun } from './GeoAuditRun';
+import {
+    GeoAuditRunFromJSON,
+    GeoAuditRunFromJSONTyped,
+    GeoAuditRunToJSON,
+    GeoAuditRunToJSONTyped,
+} from './GeoAuditRun';
+
+/**
+ * 
+ * @export
+ * @interface GeoAuditComparison
+ */
+export interface GeoAuditComparison {
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAuditComparison
+     */
+    projectId?: number;
+    /**
+     * 
+     * @type {GeoAuditRun}
+     * @memberof GeoAuditComparison
+     */
+    fromRun?: GeoAuditRun | null;
+    /**
+     * 
+     * @type {GeoAuditRun}
+     * @memberof GeoAuditComparison
+     */
+    toRun?: GeoAuditRun | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GeoAuditComparison
+     */
+    comparable?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof GeoAuditComparison
+     */
+    scoreDelta?: number | null;
+    /**
+     * 
+     * @type {{ [key: string]: number; }}
+     * @memberof GeoAuditComparison
+     */
+    metricDeltas?: { [key: string]: number; };
+    /**
+     * 
+     * @type {{ [key: string]: number; }}
+     * @memberof GeoAuditComparison
+     */
+    counts?: { [key: string]: number; };
+    /**
+     * 
+     * @type {Array<GeoAuditComparisonChangesInner>}
+     * @memberof GeoAuditComparison
+     */
+    changes?: Array<GeoAuditComparisonChangesInner>;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoAuditComparison
+     */
+    requestId?: string;
+}
+
+/**
+ * Check if a given object implements the GeoAuditComparison interface.
+ */
+export function instanceOfGeoAuditComparison(value: object): value is GeoAuditComparison {
+    return true;
+}
+
+export function GeoAuditComparisonFromJSON(json: any): GeoAuditComparison {
+    return GeoAuditComparisonFromJSONTyped(json, false);
+}
+
+export function GeoAuditComparisonFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoAuditComparison {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'fromRun': json['from_run'] === undefined ? undefined : json['from_run'] === null ? null : GeoAuditRunFromJSON(json['from_run']),
+        'toRun': json['to_run'] === undefined ? undefined : json['to_run'] === null ? null : GeoAuditRunFromJSON(json['to_run']),
+        'comparable': json['comparable'] == null ? undefined : json['comparable'],
+        'scoreDelta': json['score_delta'] === undefined ? undefined : json['score_delta'] === null ? null : json['score_delta'],
+        'metricDeltas': json['metric_deltas'] == null ? undefined : json['metric_deltas'],
+        'counts': json['counts'] == null ? undefined : json['counts'],
+        'changes': json['changes'] == null ? undefined : ((json['changes'] as Array<any>).map(GeoAuditComparisonChangesInnerFromJSON)),
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+
+export function GeoAuditComparisonToJSON(json: any): GeoAuditComparison {
+    return GeoAuditComparisonToJSONTyped(json, false);
+}
+
+export function GeoAuditComparisonToJSONTyped(value?: GeoAuditComparison | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'project_id': value['projectId'],
+        'from_run': GeoAuditRunToJSON(value['fromRun']),
+        'to_run': GeoAuditRunToJSON(value['toRun']),
+        'comparable': value['comparable'],
+        'score_delta': value['scoreDelta'],
+        'metric_deltas': value['metricDeltas'],
+        'counts': value['counts'],
+        'changes': value['changes'] == null ? undefined : ((value['changes'] as Array<any>).map(GeoAuditComparisonChangesInnerToJSON)),
+        'request_id': value['requestId'],
+    };
+}
+