@llmpulse/sdk 1.62.0 → 1.63.0

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

@@ -0,0 +1,157 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.63.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 { CustomReportSchedule } from './CustomReportSchedule';
+import type { CustomReportWidget } from './CustomReportWidget';
+import type { CustomReportBlock } from './CustomReportBlock';
+import type { CustomReportFilters } from './CustomReportFilters';
+import type { CustomReportDateRange } from './CustomReportDateRange';
+/**
+ *
+ * @export
+ * @interface CustomReportDetailResponse
+ */
+export interface CustomReportDetailResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportDetailResponse
+     */
+    projectId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportDetailResponse
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportDetailResponse
+     */
+    name: string;
+    /**
+     *
+     * @type {CustomReportDateRange}
+     * @memberof CustomReportDetailResponse
+     */
+    dateRange: CustomReportDateRange;
+    /**
+     *
+     * @type {CustomReportSchedule}
+     * @memberof CustomReportDetailResponse
+     */
+    schedule: CustomReportSchedule;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportDetailResponse
+     */
+    recipientsCount?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportDetailResponse
+     */
+    published?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportDetailResponse
+     */
+    publicLinkActive?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportDetailResponse
+     */
+    passwordProtected?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportDetailResponse
+     */
+    portalOnly?: boolean;
+    /**
+     * When the report was last emailed, on its schedule or with Send now
+     * @type {Date}
+     * @memberof CustomReportDetailResponse
+     */
+    lastSentAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomReportDetailResponse
+     */
+    createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomReportDetailResponse
+     */
+    updatedAt?: Date;
+    /**
+     *
+     * @type {CustomReportFilters}
+     * @memberof CustomReportDetailResponse
+     */
+    filters: CustomReportFilters;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportDetailResponse
+     */
+    comparePrevious?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportDetailResponse
+     */
+    attachExcel?: boolean;
+    /**
+     * When the 10-minute cooldown after the last manual send ends; null when none is running
+     * @type {Date}
+     * @memberof CustomReportDetailResponse
+     */
+    manualSendAvailableAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CustomReportDetailResponse
+     */
+    generatedAt: Date;
+    /**
+     * The report layout in order
+     * @type {Array<CustomReportBlock>}
+     * @memberof CustomReportDetailResponse
+     */
+    blocks: Array<CustomReportBlock>;
+    /**
+     *
+     * @type {Array<CustomReportWidget>}
+     * @memberof CustomReportDetailResponse
+     */
+    widgets: Array<CustomReportWidget>;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportDetailResponse
+     */
+    requestId: string;
+}
+/**
+ * Check if a given object implements the CustomReportDetailResponse interface.
+ */
+export declare function instanceOfCustomReportDetailResponse(value: object): value is CustomReportDetailResponse;
+export declare function CustomReportDetailResponseFromJSON(json: any): CustomReportDetailResponse;
+export declare function CustomReportDetailResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportDetailResponse;
+export declare function CustomReportDetailResponseToJSON(json: any): CustomReportDetailResponse;
+export declare function CustomReportDetailResponseToJSONTyped(value?: CustomReportDetailResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomReportDetailResponse.js

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.63.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 { CustomReportScheduleFromJSON, CustomReportScheduleToJSON, } from './CustomReportSchedule';
+import { CustomReportWidgetFromJSON, CustomReportWidgetToJSON, } from './CustomReportWidget';
+import { CustomReportBlockFromJSON, CustomReportBlockToJSON, } from './CustomReportBlock';
+import { CustomReportFiltersFromJSON, CustomReportFiltersToJSON, } from './CustomReportFilters';
+import { CustomReportDateRangeFromJSON, CustomReportDateRangeToJSON, } from './CustomReportDateRange';
+/**
+ * Check if a given object implements the CustomReportDetailResponse interface.
+ */
+export function instanceOfCustomReportDetailResponse(value) {
+    if ((!('projectId' in value) && !('project_id' in value)) || (value['projectId'] === undefined && value['project_id'] === undefined))
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if ((!('dateRange' in value) && !('date_range' in value)) || (value['dateRange'] === undefined && value['date_range'] === undefined))
+        return false;
+    if (!('schedule' in value) || value['schedule'] === undefined)
+        return false;
+    if (!('filters' in value) || value['filters'] === undefined)
+        return false;
+    if ((!('generatedAt' in value) && !('generated_at' in value)) || (value['generatedAt'] === undefined && value['generated_at'] === undefined))
+        return false;
+    if (!('blocks' in value) || value['blocks'] === undefined)
+        return false;
+    if (!('widgets' in value) || value['widgets'] === undefined)
+        return false;
+    if ((!('requestId' in value) && !('request_id' in value)) || (value['requestId'] === undefined && value['request_id'] === undefined))
+        return false;
+    return true;
+}
+export function CustomReportDetailResponseFromJSON(json) {
+    return CustomReportDetailResponseFromJSONTyped(json, false);
+}
+export function CustomReportDetailResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'projectId': json['project_id'],
+        'id': json['id'],
+        'name': json['name'],
+        'dateRange': CustomReportDateRangeFromJSON(json['date_range']),
+        'schedule': CustomReportScheduleFromJSON(json['schedule']),
+        'recipientsCount': json['recipients_count'] == null ? undefined : json['recipients_count'],
+        'published': json['published'] == null ? undefined : json['published'],
+        'publicLinkActive': json['public_link_active'] == null ? undefined : json['public_link_active'],
+        'passwordProtected': json['password_protected'] == null ? undefined : json['password_protected'],
+        'portalOnly': json['portal_only'] == null ? undefined : json['portal_only'],
+        'lastSentAt': json['last_sent_at'] === undefined ? undefined : json['last_sent_at'] === null ? null : (new Date(json['last_sent_at'])),
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+        'filters': CustomReportFiltersFromJSON(json['filters']),
+        'comparePrevious': json['compare_previous'] == null ? undefined : json['compare_previous'],
+        'attachExcel': json['attach_excel'] == null ? undefined : json['attach_excel'],
+        'manualSendAvailableAt': json['manual_send_available_at'] === undefined ? undefined : json['manual_send_available_at'] === null ? null : (new Date(json['manual_send_available_at'])),
+        'generatedAt': (new Date(json['generated_at'])),
+        'blocks': (json['blocks'].map(CustomReportBlockFromJSON)),
+        'widgets': (json['widgets'].map(CustomReportWidgetFromJSON)),
+        'requestId': json['request_id'],
+    };
+}
+export function CustomReportDetailResponseToJSON(json) {
+    return CustomReportDetailResponseToJSONTyped(json, false);
+}
+export function CustomReportDetailResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_id': value['projectId'],
+        'id': value['id'],
+        'name': value['name'],
+        'date_range': CustomReportDateRangeToJSON(value['dateRange']),
+        'schedule': CustomReportScheduleToJSON(value['schedule']),
+        'recipients_count': value['recipientsCount'],
+        'published': value['published'],
+        'public_link_active': value['publicLinkActive'],
+        'password_protected': value['passwordProtected'],
+        'portal_only': value['portalOnly'],
+        'last_sent_at': value['lastSentAt'] == null ? value['lastSentAt'] : value['lastSentAt'].toISOString(),
+        'created_at': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'filters': CustomReportFiltersToJSON(value['filters']),
+        'compare_previous': value['comparePrevious'],
+        'attach_excel': value['attachExcel'],
+        'manual_send_available_at': value['manualSendAvailableAt'] == null ? value['manualSendAvailableAt'] : value['manualSendAvailableAt'].toISOString(),
+        'generated_at': value['generatedAt'].toISOString(),
+        'blocks': (value['blocks'].map(CustomReportBlockToJSON)),
+        'widgets': (value['widgets'].map(CustomReportWidgetToJSON)),
+        'request_id': value['requestId'],
+    };
+}

package/dist/esm/models/CustomReportFilters.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.63.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 CustomReportFilters
+ */
+export interface CustomReportFilters {
+    /**
+     * AI models the report covers; empty means every enabled model
+     * @type {Array<string>}
+     * @memberof CustomReportFilters
+     */
+    models: Array<string>;
+    /**
+     * Tags the report is limited to; empty means every prompt
+     * @type {Array<number>}
+     * @memberof CustomReportFilters
+     */
+    collectionIds: Array<number>;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportFilters
+     */
+    brandKind?: string | null;
+    /**
+     * Competitors compared, the report's own choice or else the Overview selection
+     * @type {Array<number>}
+     * @memberof CustomReportFilters
+     */
+    competitorIds: Array<number>;
+}
+/**
+ * Check if a given object implements the CustomReportFilters interface.
+ */
+export declare function instanceOfCustomReportFilters(value: object): value is CustomReportFilters;
+export declare function CustomReportFiltersFromJSON(json: any): CustomReportFilters;
+export declare function CustomReportFiltersFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportFilters;
+export declare function CustomReportFiltersToJSON(json: any): CustomReportFilters;
+export declare function CustomReportFiltersToJSONTyped(value?: CustomReportFilters | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomReportFilters.js

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.63.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 CustomReportFilters interface.
+ */
+export function instanceOfCustomReportFilters(value) {
+    if (!('models' in value) || value['models'] === undefined)
+        return false;
+    if ((!('collectionIds' in value) && !('collection_ids' in value)) || (value['collectionIds'] === undefined && value['collection_ids'] === undefined))
+        return false;
+    if ((!('competitorIds' in value) && !('competitor_ids' in value)) || (value['competitorIds'] === undefined && value['competitor_ids'] === undefined))
+        return false;
+    return true;
+}
+export function CustomReportFiltersFromJSON(json) {
+    return CustomReportFiltersFromJSONTyped(json, false);
+}
+export function CustomReportFiltersFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'models': json['models'],
+        'collectionIds': json['collection_ids'],
+        'brandKind': json['brand_kind'] === undefined ? undefined : json['brand_kind'] === null ? null : json['brand_kind'],
+        'competitorIds': json['competitor_ids'],
+    };
+}
+export function CustomReportFiltersToJSON(json) {
+    return CustomReportFiltersToJSONTyped(json, false);
+}
+export function CustomReportFiltersToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'models': value['models'],
+        'collection_ids': value['collectionIds'],
+        'brand_kind': value['brandKind'],
+        'competitor_ids': value['competitorIds'],
+    };
+}

package/dist/esm/models/CustomReportSchedule.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.63.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 CustomReportSchedule
+ */
+export interface CustomReportSchedule {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportSchedule
+     */
+    enabled: boolean;
+    /**
+     * 0 (Sunday) to 6 (Saturday)
+     * @type {number}
+     * @memberof CustomReportSchedule
+     */
+    dayOfWeek?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportSchedule
+     */
+    hour?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportSchedule
+     */
+    timezone?: string | null;
+}
+/**
+ * Check if a given object implements the CustomReportSchedule interface.
+ */
+export declare function instanceOfCustomReportSchedule(value: object): value is CustomReportSchedule;
+export declare function CustomReportScheduleFromJSON(json: any): CustomReportSchedule;
+export declare function CustomReportScheduleFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportSchedule;
+export declare function CustomReportScheduleToJSON(json: any): CustomReportSchedule;
+export declare function CustomReportScheduleToJSONTyped(value?: CustomReportSchedule | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomReportSchedule.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.63.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 CustomReportSchedule interface.
+ */
+export function instanceOfCustomReportSchedule(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    return true;
+}
+export function CustomReportScheduleFromJSON(json) {
+    return CustomReportScheduleFromJSONTyped(json, false);
+}
+export function CustomReportScheduleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'],
+        'dayOfWeek': json['day_of_week'] === undefined ? undefined : json['day_of_week'] === null ? null : json['day_of_week'],
+        'hour': json['hour'] === undefined ? undefined : json['hour'] === null ? null : json['hour'],
+        'timezone': json['timezone'] === undefined ? undefined : json['timezone'] === null ? null : json['timezone'],
+    };
+}
+export function CustomReportScheduleToJSON(json) {
+    return CustomReportScheduleToJSONTyped(json, false);
+}
+export function CustomReportScheduleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'day_of_week': value['dayOfWeek'],
+        'hour': value['hour'],
+        'timezone': value['timezone'],
+    };
+}

package/dist/esm/models/CustomReportSendResponse.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.63.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 CustomReportSendResponse
+ */
+export interface CustomReportSendResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportSendResponse
+     */
+    projectId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportSendResponse
+     */
+    id: number;
+    /**
+     *
+     * @type {CustomReportSendResponseStatusEnum}
+     * @memberof CustomReportSendResponse
+     */
+    status: CustomReportSendResponseStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomReportSendResponse
+     */
+    recipientsCount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportSendResponse
+     */
+    requestId: string;
+}
+/**
+ * @export
+ */
+export declare const CustomReportSendResponseStatusEnum: {
+    readonly Queued: "queued";
+};
+export type CustomReportSendResponseStatusEnum = typeof CustomReportSendResponseStatusEnum[keyof typeof CustomReportSendResponseStatusEnum];
+/**
+ * Check if a given object implements the CustomReportSendResponse interface.
+ */
+export declare function instanceOfCustomReportSendResponse(value: object): value is CustomReportSendResponse;
+export declare function CustomReportSendResponseFromJSON(json: any): CustomReportSendResponse;
+export declare function CustomReportSendResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportSendResponse;
+export declare function CustomReportSendResponseToJSON(json: any): CustomReportSendResponse;
+export declare function CustomReportSendResponseToJSONTyped(value?: CustomReportSendResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomReportSendResponse.js

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.63.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 CustomReportSendResponseStatusEnum = {
+    Queued: 'queued'
+};
+/**
+ * Check if a given object implements the CustomReportSendResponse interface.
+ */
+export function instanceOfCustomReportSendResponse(value) {
+    if ((!('projectId' in value) && !('project_id' in value)) || (value['projectId'] === undefined && value['project_id'] === undefined))
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (value['status'] !== 'queued')
+        return false;
+    if ((!('recipientsCount' in value) && !('recipients_count' in value)) || (value['recipientsCount'] === undefined && value['recipients_count'] === undefined))
+        return false;
+    if ((!('requestId' in value) && !('request_id' in value)) || (value['requestId'] === undefined && value['request_id'] === undefined))
+        return false;
+    return true;
+}
+export function CustomReportSendResponseFromJSON(json) {
+    return CustomReportSendResponseFromJSONTyped(json, false);
+}
+export function CustomReportSendResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'projectId': json['project_id'],
+        'id': json['id'],
+        'status': json['status'],
+        'recipientsCount': json['recipients_count'],
+        'requestId': json['request_id'],
+    };
+}
+export function CustomReportSendResponseToJSON(json) {
+    return CustomReportSendResponseToJSONTyped(json, false);
+}
+export function CustomReportSendResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_id': value['projectId'],
+        'id': value['id'],
+        'status': value['status'],
+        'recipients_count': value['recipientsCount'],
+        'request_id': value['requestId'],
+    };
+}