profoundai 0.2.1

package/resources/reports.d.mts

@@ -0,0 +1,256 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Reports extends APIResource {
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.citations({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['count'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    citations(body: ReportCitationsParams, options?: RequestOptions): APIPromise<ReportCitationsResponse>;
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.sentiment({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['positive'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    sentiment(body: ReportSentimentParams, options?: RequestOptions): APIPromise<ReportResponse>;
+    /**
+     * Query visibility report.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.visibility({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['share_of_voice'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    visibility(body: ReportVisibilityParams, options?: RequestOptions): APIPromise<ReportResponse>;
+}
+/**
+ * Base model for report information.
+ */
+export interface ReportInfo {
+    total_rows: number;
+    query?: {
+        [key: string]: unknown;
+    } | null;
+}
+/**
+ * Base response model for reports.
+ */
+export interface ReportResponse {
+    data: Array<ReportResult>;
+    /**
+     * Base model for report information.
+     */
+    info: ReportInfo;
+}
+/**
+ * Base model for report results.
+ */
+export interface ReportResult {
+    dimensions: Array<string>;
+    metrics: Array<number>;
+}
+export interface ReportCitationsResponse {
+    data: Array<ReportResult>;
+    /**
+     * Base model for report information.
+     */
+    info: ReportInfo;
+}
+export interface ReportCitationsParams {
+    category_id: string;
+    /**
+     * End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+     * ISO timestamp.
+     */
+    end_date: string;
+    metrics: Array<'count' | 'share_of_voice'>;
+    /**
+     * Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or
+     * full ISO timestamp.
+     */
+    start_date: string;
+    /**
+     * Date interval for the report. (only used with date dimension)
+     */
+    date_interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Dimensions to group the report by.
+     */
+    dimensions?: Array<'hostname' | 'path' | 'date' | 'region' | 'topic' | 'model' | 'tag' | 'prompt'>;
+    /**
+     * List of filters to apply to the report. Each filter has an operator, field, and
+     * value.
+     */
+    filters?: Array<ReportCitationsParams.Filter>;
+    /**
+     * Custom ordering of the report results.
+     *
+     * The order is a record of key-value pairs where:
+     *
+     * - key is the field to order by, which can be a metric or dimension
+     * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+     *   descending.
+     *
+     * When not specified, the default order is the first metric in the query
+     * descending.
+     */
+    order_by?: {
+        [key: string]: 'asc' | 'desc';
+    };
+    /**
+     * Pagination settings for the report results.
+     */
+    pagination?: Shared.Pagination;
+}
+export declare namespace ReportCitationsParams {
+    interface Filter {
+        field: 'hostname' | 'path' | 'region' | 'topic' | 'model' | 'tag';
+        operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'contains_case_insensitive' | 'not_contains_case_insensitive' | 'matches';
+        /**
+         * Value for the filter. Can be a single value or a list of depending on the
+         * operator.
+         */
+        value: string | Array<string> | number | Array<number>;
+    }
+}
+export interface ReportSentimentParams {
+    category_id: string;
+    /**
+     * End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+     * ISO timestamp.
+     */
+    end_date: string;
+    metrics: Array<'positive' | 'negative'>;
+    /**
+     * Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or
+     * full ISO timestamp.
+     */
+    start_date: string;
+    /**
+     * Date interval for the report. (only used with date dimension)
+     */
+    date_interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Dimensions to group the report by.
+     */
+    dimensions?: Array<'theme' | 'date' | 'region' | 'topic' | 'model' | 'asset_name' | 'tag' | 'prompt'>;
+    /**
+     * List of filters to apply to the report. Each filter has an operator, field, and
+     * value.
+     */
+    filters?: Array<ReportSentimentParams.Filter>;
+    /**
+     * Custom ordering of the report results.
+     *
+     * The order is a record of key-value pairs where:
+     *
+     * - key is the field to order by, which can be a metric or dimension
+     * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+     *   descending.
+     *
+     * When not specified, the default order is the first metric in the query
+     * descending.
+     */
+    order_by?: {
+        [key: string]: 'asc' | 'desc';
+    };
+    /**
+     * Pagination settings for the report results.
+     */
+    pagination?: Shared.Pagination;
+}
+export declare namespace ReportSentimentParams {
+    interface Filter {
+        field: 'asset_name' | 'theme' | 'region' | 'topic' | 'model' | 'tag';
+        operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'contains_case_insensitive' | 'not_contains_case_insensitive' | 'matches';
+        /**
+         * Value for the filter. Can be a single value or a list of depending on the
+         * operator.
+         */
+        value: string | Array<string> | number | Array<number>;
+    }
+}
+export interface ReportVisibilityParams {
+    category_id: string;
+    /**
+     * End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+     * ISO timestamp.
+     */
+    end_date: string;
+    metrics: Array<'share_of_voice' | 'mentions_count' | 'visibility_score'>;
+    /**
+     * Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or
+     * full ISO timestamp.
+     */
+    start_date: string;
+    /**
+     * Date interval for the report. (only used with date dimension)
+     */
+    date_interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Dimensions to group the report by.
+     */
+    dimensions?: Array<'date' | 'region' | 'topic' | 'model' | 'asset_name' | 'prompt' | 'tag'>;
+    /**
+     * List of filters to apply to the report. Each filter has an operator, field, and
+     * value.
+     */
+    filters?: Array<ReportVisibilityParams.Filter>;
+    /**
+     * Custom ordering of the report results.
+     *
+     * The order is a record of key-value pairs where:
+     *
+     * - key is the field to order by, which can be a metric or dimension
+     * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+     *   descending.
+     *
+     * When not specified, the default order is the first metric in the query
+     * descending.
+     */
+    order_by?: {
+        [key: string]: 'asc' | 'desc';
+    };
+    /**
+     * Pagination settings for the report results.
+     */
+    pagination?: Shared.Pagination;
+}
+export declare namespace ReportVisibilityParams {
+    interface Filter {
+        field: 'region' | 'topic' | 'model' | 'asset_name' | 'prompt' | 'tag';
+        operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'contains_case_insensitive' | 'not_contains_case_insensitive' | 'matches';
+        /**
+         * Value for the filter. Can be a single value or a list of depending on the
+         * operator.
+         */
+        value: string | Array<string> | number | Array<number>;
+    }
+}
+export declare namespace Reports {
+    export { type ReportInfo as ReportInfo, type ReportResponse as ReportResponse, type ReportResult as ReportResult, type ReportCitationsResponse as ReportCitationsResponse, type ReportCitationsParams as ReportCitationsParams, type ReportSentimentParams as ReportSentimentParams, type ReportVisibilityParams as ReportVisibilityParams, };
+}
+//# sourceMappingURL=reports.d.mts.map

package/resources/reports.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.d.mts","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI5F;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAG/F;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,gBAAgB,CAAC,CAAC;IAE3C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC;IAEnG;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;QAElE,QAAQ,EACJ,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,2BAA2B,GAC3B,+BAA+B,GAC/B,SAAS,CAAC;QAEd;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KACxD;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC;IAExC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC;IAEtG;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB,KAAK,EAAE,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;QAErE,QAAQ,EACJ,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,2BAA2B,GAC3B,+BAA+B,GAC/B,SAAS,CAAC;QAEd;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KACxD;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC,CAAC;IAEzE;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,GAAG,KAAK,CAAC,CAAC;IAE5F;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB,KAAK,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,GAAG,KAAK,CAAC;QAEtE,QAAQ,EACJ,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,2BAA2B,GAC3B,+BAA+B,GAC/B,SAAS,CAAC;QAEd;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KACxD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/reports.d.ts

@@ -0,0 +1,256 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Reports extends APIResource {
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.citations({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['count'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    citations(body: ReportCitationsParams, options?: RequestOptions): APIPromise<ReportCitationsResponse>;
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.sentiment({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['positive'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    sentiment(body: ReportSentimentParams, options?: RequestOptions): APIPromise<ReportResponse>;
+    /**
+     * Query visibility report.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.visibility({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['share_of_voice'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    visibility(body: ReportVisibilityParams, options?: RequestOptions): APIPromise<ReportResponse>;
+}
+/**
+ * Base model for report information.
+ */
+export interface ReportInfo {
+    total_rows: number;
+    query?: {
+        [key: string]: unknown;
+    } | null;
+}
+/**
+ * Base response model for reports.
+ */
+export interface ReportResponse {
+    data: Array<ReportResult>;
+    /**
+     * Base model for report information.
+     */
+    info: ReportInfo;
+}
+/**
+ * Base model for report results.
+ */
+export interface ReportResult {
+    dimensions: Array<string>;
+    metrics: Array<number>;
+}
+export interface ReportCitationsResponse {
+    data: Array<ReportResult>;
+    /**
+     * Base model for report information.
+     */
+    info: ReportInfo;
+}
+export interface ReportCitationsParams {
+    category_id: string;
+    /**
+     * End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+     * ISO timestamp.
+     */
+    end_date: string;
+    metrics: Array<'count' | 'share_of_voice'>;
+    /**
+     * Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or
+     * full ISO timestamp.
+     */
+    start_date: string;
+    /**
+     * Date interval for the report. (only used with date dimension)
+     */
+    date_interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Dimensions to group the report by.
+     */
+    dimensions?: Array<'hostname' | 'path' | 'date' | 'region' | 'topic' | 'model' | 'tag' | 'prompt'>;
+    /**
+     * List of filters to apply to the report. Each filter has an operator, field, and
+     * value.
+     */
+    filters?: Array<ReportCitationsParams.Filter>;
+    /**
+     * Custom ordering of the report results.
+     *
+     * The order is a record of key-value pairs where:
+     *
+     * - key is the field to order by, which can be a metric or dimension
+     * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+     *   descending.
+     *
+     * When not specified, the default order is the first metric in the query
+     * descending.
+     */
+    order_by?: {
+        [key: string]: 'asc' | 'desc';
+    };
+    /**
+     * Pagination settings for the report results.
+     */
+    pagination?: Shared.Pagination;
+}
+export declare namespace ReportCitationsParams {
+    interface Filter {
+        field: 'hostname' | 'path' | 'region' | 'topic' | 'model' | 'tag';
+        operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'contains_case_insensitive' | 'not_contains_case_insensitive' | 'matches';
+        /**
+         * Value for the filter. Can be a single value or a list of depending on the
+         * operator.
+         */
+        value: string | Array<string> | number | Array<number>;
+    }
+}
+export interface ReportSentimentParams {
+    category_id: string;
+    /**
+     * End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+     * ISO timestamp.
+     */
+    end_date: string;
+    metrics: Array<'positive' | 'negative'>;
+    /**
+     * Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or
+     * full ISO timestamp.
+     */
+    start_date: string;
+    /**
+     * Date interval for the report. (only used with date dimension)
+     */
+    date_interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Dimensions to group the report by.
+     */
+    dimensions?: Array<'theme' | 'date' | 'region' | 'topic' | 'model' | 'asset_name' | 'tag' | 'prompt'>;
+    /**
+     * List of filters to apply to the report. Each filter has an operator, field, and
+     * value.
+     */
+    filters?: Array<ReportSentimentParams.Filter>;
+    /**
+     * Custom ordering of the report results.
+     *
+     * The order is a record of key-value pairs where:
+     *
+     * - key is the field to order by, which can be a metric or dimension
+     * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+     *   descending.
+     *
+     * When not specified, the default order is the first metric in the query
+     * descending.
+     */
+    order_by?: {
+        [key: string]: 'asc' | 'desc';
+    };
+    /**
+     * Pagination settings for the report results.
+     */
+    pagination?: Shared.Pagination;
+}
+export declare namespace ReportSentimentParams {
+    interface Filter {
+        field: 'asset_name' | 'theme' | 'region' | 'topic' | 'model' | 'tag';
+        operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'contains_case_insensitive' | 'not_contains_case_insensitive' | 'matches';
+        /**
+         * Value for the filter. Can be a single value or a list of depending on the
+         * operator.
+         */
+        value: string | Array<string> | number | Array<number>;
+    }
+}
+export interface ReportVisibilityParams {
+    category_id: string;
+    /**
+     * End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full
+     * ISO timestamp.
+     */
+    end_date: string;
+    metrics: Array<'share_of_voice' | 'mentions_count' | 'visibility_score'>;
+    /**
+     * Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or
+     * full ISO timestamp.
+     */
+    start_date: string;
+    /**
+     * Date interval for the report. (only used with date dimension)
+     */
+    date_interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Dimensions to group the report by.
+     */
+    dimensions?: Array<'date' | 'region' | 'topic' | 'model' | 'asset_name' | 'prompt' | 'tag'>;
+    /**
+     * List of filters to apply to the report. Each filter has an operator, field, and
+     * value.
+     */
+    filters?: Array<ReportVisibilityParams.Filter>;
+    /**
+     * Custom ordering of the report results.
+     *
+     * The order is a record of key-value pairs where:
+     *
+     * - key is the field to order by, which can be a metric or dimension
+     * - value is the direction of the order, either 'asc' for ascending or 'desc' for
+     *   descending.
+     *
+     * When not specified, the default order is the first metric in the query
+     * descending.
+     */
+    order_by?: {
+        [key: string]: 'asc' | 'desc';
+    };
+    /**
+     * Pagination settings for the report results.
+     */
+    pagination?: Shared.Pagination;
+}
+export declare namespace ReportVisibilityParams {
+    interface Filter {
+        field: 'region' | 'topic' | 'model' | 'asset_name' | 'prompt' | 'tag';
+        operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'contains_case_insensitive' | 'not_contains_case_insensitive' | 'matches';
+        /**
+         * Value for the filter. Can be a single value or a list of depending on the
+         * operator.
+         */
+        value: string | Array<string> | number | Array<number>;
+    }
+}
+export declare namespace Reports {
+    export { type ReportInfo as ReportInfo, type ReportResponse as ReportResponse, type ReportResult as ReportResult, type ReportCitationsResponse as ReportCitationsResponse, type ReportCitationsParams as ReportCitationsParams, type ReportSentimentParams as ReportSentimentParams, type ReportVisibilityParams as ReportVisibilityParams, };
+}
+//# sourceMappingURL=reports.d.ts.map

package/resources/reports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI5F;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAG/F;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,gBAAgB,CAAC,CAAC;IAE3C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC;IAEnG;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;QAElE,QAAQ,EACJ,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,2BAA2B,GAC3B,+BAA+B,GAC/B,SAAS,CAAC;QAEd;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KACxD;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC;IAExC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAC;IAEtG;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,MAAM;QACrB,KAAK,EAAE,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;QAErE,QAAQ,EACJ,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,2BAA2B,GAC3B,+BAA+B,GAC/B,SAAS,CAAC;QAEd;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KACxD;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC,CAAC;IAEzE;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,GAAG,KAAK,CAAC,CAAC;IAE5F;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAChC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB,KAAK,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,GAAG,KAAK,CAAC;QAEtE,QAAQ,EACJ,IAAI,GACJ,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,2BAA2B,GAC3B,+BAA+B,GAC/B,SAAS,CAAC;QAEd;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;KACxD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/reports.js

@@ -0,0 +1,57 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reports = void 0;
+const resource_1 = require("../core/resource.js");
+class Reports extends resource_1.APIResource {
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.citations({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['count'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    citations(body, options) {
+        return this._client.post('/v1/reports/citations', { body, ...options });
+    }
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.sentiment({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['positive'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    sentiment(body, options) {
+        return this._client.post('/v1/reports/sentiment', { body, ...options });
+    }
+    /**
+     * Query visibility report.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.visibility({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['share_of_voice'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    visibility(body, options) {
+        return this._client.post('/v1/reports/visibility', { body, ...options });
+    }
+}
+exports.Reports = Reports;
+//# sourceMappingURL=reports.js.map

package/resources/reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAA2B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAA2B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAnDD,0BAmDC"}

package/resources/reports.mjs

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class Reports extends APIResource {
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.citations({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['count'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    citations(body, options) {
+        return this._client.post('/v1/reports/citations', { body, ...options });
+    }
+    /**
+     * Get citations for a given category.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.sentiment({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['positive'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    sentiment(body, options) {
+        return this._client.post('/v1/reports/sentiment', { body, ...options });
+    }
+    /**
+     * Query visibility report.
+     *
+     * @example
+     * ```ts
+     * const reportResponse = await client.reports.visibility({
+     *   category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   end_date: '2019-12-27T18:11:19.117Z',
+     *   metrics: ['share_of_voice'],
+     *   start_date: '2019-12-27T18:11:19.117Z',
+     * });
+     * ```
+     */
+    visibility(body, options) {
+        return this._client.post('/v1/reports/visibility', { body, ...options });
+    }
+}
+//# sourceMappingURL=reports.mjs.map

package/resources/reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAA2B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAA2B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/resources/shared.d.mts

@@ -0,0 +1,14 @@
+/**
+ * Report pagination model.
+ */
+export interface Pagination {
+    /**
+     * Maximum number of results to return. Default is 10,000, maximum is 50,000.
+     */
+    limit?: number;
+    /**
+     * Offset for the results. Used for pagination.
+     */
+    offset?: number;
+}
+//# sourceMappingURL=shared.d.mts.map

package/resources/shared.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}