@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/apis/ReputationStudiesApi.d.ts

@@ -0,0 +1,342 @@
+/**
+ * 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';
+export interface GetReputationReportRequest {
+    id: string;
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    model?: GetReputationReportModelEnum;
+    brand?: string;
+    dimension?: string;
+    output?: GetReputationReportOutputEnum;
+}
+export interface GetStudyRequest {
+    id: number;
+}
+export interface GetStudyReportRequest {
+    id: number;
+    reportId: string;
+    page?: number;
+    perPage?: number;
+    model?: GetStudyReportModelEnum;
+    subject?: string;
+    dimension?: string;
+    output?: GetStudyReportOutputEnum;
+}
+export interface ListReputationReportsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    output?: ListReputationReportsOutputEnum;
+}
+export interface ListStudiesRequest {
+    projectId?: number;
+    status?: ListStudiesStatusEnum;
+    page?: number;
+    perPage?: number;
+    output?: ListStudiesOutputEnum;
+}
+/**
+ * ReputationStudiesApi - interface
+ *
+ * @export
+ * @interface ReputationStudiesApiInterface
+ */
+export interface ReputationStudiesApiInterface {
+    /**
+     * Creates request options for getReputationReport without sending the request
+     * @param {string} id The report id from GET /reputation/reports
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'gemini' | 'deepseek' | 'grok' | 'claude'} [model] Restrict to one analyst model
+     * @param {string} [brand] Restrict to one brand name, or a comma-separated list
+     * @param {string} [dimension] Restrict to one reputation dimension key
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    getReputationReportRequestOpts(requestParameters: GetReputationReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * One reputation report\'s scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. Scores come from several analyst models independently, so compare models rather than averaging them blindly.
+     * @summary Get reputation report scores
+     * @param {string} id The report id from GET /reputation/reports
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'gemini' | 'deepseek' | 'grok' | 'claude'} [model] Restrict to one analyst model
+     * @param {string} [brand] Restrict to one brand name, or a comma-separated list
+     * @param {string} [dimension] Restrict to one reputation dimension key
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    getReputationReportRaw(requestParameters: GetReputationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * One reputation report\'s scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. Scores come from several analyst models independently, so compare models rather than averaging them blindly.
+     * Get reputation report scores
+     */
+    getReputationReport(requestParameters: GetReputationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getStudy without sending the request
+     * @param {number} id
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    getStudyRequestOpts(requestParameters: GetStudyRequest): Promise<runtime.RequestOpts>;
+    /**
+     * One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in `reports` with GET /studies/{id}/reports/{report_id}.
+     * @summary Get a custom AI study
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    getStudyRaw(requestParameters: GetStudyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in `reports` with GET /studies/{id}/reports/{report_id}.
+     * Get a custom AI study
+     */
+    getStudy(requestParameters: GetStudyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getStudyReport without sending the request
+     * @param {number} id
+     * @param {string} reportId The report id from GET /studies/{id}
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'gemini' | 'deepseek' | 'grok' | 'claude'} [model] Restrict to one analyst model
+     * @param {string} [subject] Restrict to one subject name, or a comma-separated list
+     * @param {string} [dimension] Restrict to one dimension key
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    getStudyReportRequestOpts(requestParameters: GetStudyReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * One custom-study report\'s scores as flat rows: one row per analyst model, subject, dimension and attribute, with its 0-100 score and the reasoning the model gave.
+     * @summary Get custom study report scores
+     * @param {number} id
+     * @param {string} reportId The report id from GET /studies/{id}
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'gemini' | 'deepseek' | 'grok' | 'claude'} [model] Restrict to one analyst model
+     * @param {string} [subject] Restrict to one subject name, or a comma-separated list
+     * @param {string} [dimension] Restrict to one dimension key
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    getStudyReportRaw(requestParameters: GetStudyReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * One custom-study report\'s scores as flat rows: one row per analyst model, subject, dimension and attribute, with its 0-100 score and the reasoning the model gave.
+     * Get custom study report scores
+     */
+    getStudyReport(requestParameters: GetStudyReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listReputationReports without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    listReputationReportsRequestOpts(requestParameters: ListReputationReportsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The monthly multi-model analyst reports scoring the tracked brand and its competitors, newest first. Pending and failed reports are included on purpose: whether this month ran at all is often the question. Each row carries the report id, its status, and which analyst models produced data. Requires reputation monitoring to be enabled on the account.
+     * @summary List reputation reports
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    listReputationReportsRaw(requestParameters: ListReputationReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The monthly multi-model analyst reports scoring the tracked brand and its competitors, newest first. Pending and failed reports are included on purpose: whether this month ran at all is often the question. Each row carries the report id, its status, and which analyst models produced data. Requires reputation monitoring to be enabled on the account.
+     * List reputation reports
+     */
+    listReputationReports(requestParameters: ListReputationReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listStudies without sending the request
+     * @param {number} [projectId] Restrict to studies attached to this project (plus account-level ones)
+     * @param {'active' | 'archived'} [status]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    listStudiesRequestOpts(requestParameters: ListStudiesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The custom AI studies defined on the account: analyst reports over any set of subjects (brands, sectors, topics) and any set of dimensions. Studies belong to the ACCOUNT, not to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by. A team member whose project access is restricted sees only the studies of the projects they can reach. Requires reputation monitoring to be enabled on the account.
+     * @summary List custom AI studies
+     * @param {number} [projectId] Restrict to studies attached to this project (plus account-level ones)
+     * @param {'active' | 'archived'} [status]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReputationStudiesApiInterface
+     */
+    listStudiesRaw(requestParameters: ListStudiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The custom AI studies defined on the account: analyst reports over any set of subjects (brands, sectors, topics) and any set of dimensions. Studies belong to the ACCOUNT, not to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by. A team member whose project access is restricted sees only the studies of the projects they can reach. Requires reputation monitoring to be enabled on the account.
+     * List custom AI studies
+     */
+    listStudies(requestParameters: ListStudiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class ReputationStudiesApi extends runtime.BaseAPI implements ReputationStudiesApiInterface {
+    /**
+     * Creates request options for getReputationReport without sending the request
+     */
+    getReputationReportRequestOpts(requestParameters: GetReputationReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * One reputation report\'s scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. Scores come from several analyst models independently, so compare models rather than averaging them blindly.
+     * Get reputation report scores
+     */
+    getReputationReportRaw(requestParameters: GetReputationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * One reputation report\'s scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. Scores come from several analyst models independently, so compare models rather than averaging them blindly.
+     * Get reputation report scores
+     */
+    getReputationReport(requestParameters: GetReputationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getStudy without sending the request
+     */
+    getStudyRequestOpts(requestParameters: GetStudyRequest): Promise<runtime.RequestOpts>;
+    /**
+     * One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in `reports` with GET /studies/{id}/reports/{report_id}.
+     * Get a custom AI study
+     */
+    getStudyRaw(requestParameters: GetStudyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in `reports` with GET /studies/{id}/reports/{report_id}.
+     * Get a custom AI study
+     */
+    getStudy(requestParameters: GetStudyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getStudyReport without sending the request
+     */
+    getStudyReportRequestOpts(requestParameters: GetStudyReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * One custom-study report\'s scores as flat rows: one row per analyst model, subject, dimension and attribute, with its 0-100 score and the reasoning the model gave.
+     * Get custom study report scores
+     */
+    getStudyReportRaw(requestParameters: GetStudyReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * One custom-study report\'s scores as flat rows: one row per analyst model, subject, dimension and attribute, with its 0-100 score and the reasoning the model gave.
+     * Get custom study report scores
+     */
+    getStudyReport(requestParameters: GetStudyReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listReputationReports without sending the request
+     */
+    listReputationReportsRequestOpts(requestParameters: ListReputationReportsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The monthly multi-model analyst reports scoring the tracked brand and its competitors, newest first. Pending and failed reports are included on purpose: whether this month ran at all is often the question. Each row carries the report id, its status, and which analyst models produced data. Requires reputation monitoring to be enabled on the account.
+     * List reputation reports
+     */
+    listReputationReportsRaw(requestParameters: ListReputationReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The monthly multi-model analyst reports scoring the tracked brand and its competitors, newest first. Pending and failed reports are included on purpose: whether this month ran at all is often the question. Each row carries the report id, its status, and which analyst models produced data. Requires reputation monitoring to be enabled on the account.
+     * List reputation reports
+     */
+    listReputationReports(requestParameters: ListReputationReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listStudies without sending the request
+     */
+    listStudiesRequestOpts(requestParameters: ListStudiesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The custom AI studies defined on the account: analyst reports over any set of subjects (brands, sectors, topics) and any set of dimensions. Studies belong to the ACCOUNT, not to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by. A team member whose project access is restricted sees only the studies of the projects they can reach. Requires reputation monitoring to be enabled on the account.
+     * List custom AI studies
+     */
+    listStudiesRaw(requestParameters: ListStudiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The custom AI studies defined on the account: analyst reports over any set of subjects (brands, sectors, topics) and any set of dimensions. Studies belong to the ACCOUNT, not to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by. A team member whose project access is restricted sees only the studies of the projects they can reach. Requires reputation monitoring to be enabled on the account.
+     * List custom AI studies
+     */
+    listStudies(requestParameters?: ListStudiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const GetReputationReportModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly Gemini: "gemini";
+    readonly Deepseek: "deepseek";
+    readonly Grok: "grok";
+    readonly Claude: "claude";
+};
+export type GetReputationReportModelEnum = typeof GetReputationReportModelEnum[keyof typeof GetReputationReportModelEnum];
+/**
+ * @export
+ */
+export declare const GetReputationReportOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetReputationReportOutputEnum = typeof GetReputationReportOutputEnum[keyof typeof GetReputationReportOutputEnum];
+/**
+ * @export
+ */
+export declare const GetStudyReportModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly Gemini: "gemini";
+    readonly Deepseek: "deepseek";
+    readonly Grok: "grok";
+    readonly Claude: "claude";
+};
+export type GetStudyReportModelEnum = typeof GetStudyReportModelEnum[keyof typeof GetStudyReportModelEnum];
+/**
+ * @export
+ */
+export declare const GetStudyReportOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetStudyReportOutputEnum = typeof GetStudyReportOutputEnum[keyof typeof GetStudyReportOutputEnum];
+/**
+ * @export
+ */
+export declare const ListReputationReportsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListReputationReportsOutputEnum = typeof ListReputationReportsOutputEnum[keyof typeof ListReputationReportsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListStudiesStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+};
+export type ListStudiesStatusEnum = typeof ListStudiesStatusEnum[keyof typeof ListStudiesStatusEnum];
+/**
+ * @export
+ */
+export declare const ListStudiesOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListStudiesOutputEnum = typeof ListStudiesOutputEnum[keyof typeof ListStudiesOutputEnum];