@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/esm/apis/OwnedMediaCommunitiesApi.d.ts

@@ -0,0 +1,348 @@
+/**
+ * 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 ListOwnedMediaRequest {
+    projectId: number;
+    provider: ListOwnedMediaProviderEnum;
+    page?: number;
+    perPage?: number;
+    view?: ListOwnedMediaViewEnum;
+    store?: ListOwnedMediaStoreEnum;
+    owned?: boolean;
+    model?: ListOwnedMediaModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    brandKind?: ListOwnedMediaBrandKindEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListOwnedMediaOutputEnum;
+}
+export interface ListRedditCitationsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    view?: ListRedditCitationsViewEnum;
+    subreddit?: string;
+    author?: string;
+    status?: ListRedditCitationsStatusEnum;
+    owned?: boolean;
+    brand?: string;
+    order?: ListRedditCitationsOrderEnum;
+    direction?: ListRedditCitationsDirectionEnum;
+    model?: ListRedditCitationsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    brandKind?: ListRedditCitationsBrandKindEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListRedditCitationsOutputEnum;
+}
+/**
+ * OwnedMediaCommunitiesApi - interface
+ *
+ * @export
+ * @interface OwnedMediaCommunitiesApiInterface
+ */
+export interface OwnedMediaCommunitiesApiInterface {
+    /**
+     * Creates request options for listOwnedMedia without sending the request
+     * @param {number} projectId Project ID
+     * @param {'youtube' | 'instagram' | 'facebook' | 'tiktok' | 'linkedin' | 'mobile_apps'} provider The platform to report on
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'videos' | 'channels' | 'posts' | 'profiles' | 'own_citations' | 'apps'} [view] Row shape; the allowed set depends on provider
+     * @param {'google_play' | 'app_store'} [store] provider=mobile_apps only
+     * @param {boolean} [owned] Return only rows belonging to the account\'s own connected profile
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\'s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 OwnedMediaCommunitiesApiInterface
+     */
+    listOwnedMediaRequestOpts(requestParameters: ListOwnedMediaRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. Requires the Growth plan or above.
+     * @summary List owned-media citations
+     * @param {number} projectId Project ID
+     * @param {'youtube' | 'instagram' | 'facebook' | 'tiktok' | 'linkedin' | 'mobile_apps'} provider The platform to report on
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'videos' | 'channels' | 'posts' | 'profiles' | 'own_citations' | 'apps'} [view] Row shape; the allowed set depends on provider
+     * @param {'google_play' | 'app_store'} [store] provider&#x3D;mobile_apps only
+     * @param {boolean} [owned] Return only rows belonging to the account\&#39;s own connected profile
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 OwnedMediaCommunitiesApiInterface
+     */
+    listOwnedMediaRaw(requestParameters: ListOwnedMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. Requires the Growth plan or above.
+     * List owned-media citations
+     */
+    listOwnedMedia(requestParameters: ListOwnedMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listRedditCitations without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'subreddits' | 'authors' | 'threads'} [view]
+     * @param {string} [subreddit] Filter to one subreddit (name without the r/ prefix)
+     * @param {string} [author] Filter to one Reddit author
+     * @param {'open' | 'archived'} [status] view&#x3D;threads only
+     * @param {boolean} [owned] Return only subreddits/authors the account has claimed as its own
+     * @param {string} [brand] Filter to citations whose scraped Reddit content mentions a brand: \&#39;brand\&#39; for the tracked brand, or a competitor id. Reads the page content, not the AI answer.
+     * @param {'citations' | 'subreddit' | 'unique_authors' | 'positive_pct' | 'negative_pct' | 'author' | 'avg_position' | 'upvotes' | 'comments' | 'sentiment'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 OwnedMediaCommunitiesApiInterface
+     */
+    listRedditCitationsRequestOpts(requestParameters: ListRedditCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Which Reddit content AI answers cite for your tracked prompts. view=subreddits (default) returns one row per subreddit with its citation count, unique authors and positive/negative sentiment split; view=authors returns one row per author; view=threads returns the individual cited threads with upvotes, comments, average position and dominant sentiment. Requires the Growth plan or above.
+     * @summary List cited Reddit content
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'subreddits' | 'authors' | 'threads'} [view]
+     * @param {string} [subreddit] Filter to one subreddit (name without the r/ prefix)
+     * @param {string} [author] Filter to one Reddit author
+     * @param {'open' | 'archived'} [status] view&#x3D;threads only
+     * @param {boolean} [owned] Return only subreddits/authors the account has claimed as its own
+     * @param {string} [brand] Filter to citations whose scraped Reddit content mentions a brand: \&#39;brand\&#39; for the tracked brand, or a competitor id. Reads the page content, not the AI answer.
+     * @param {'citations' | 'subreddit' | 'unique_authors' | 'positive_pct' | 'negative_pct' | 'author' | 'avg_position' | 'upvotes' | 'comments' | 'sentiment'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 OwnedMediaCommunitiesApiInterface
+     */
+    listRedditCitationsRaw(requestParameters: ListRedditCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Which Reddit content AI answers cite for your tracked prompts. view=subreddits (default) returns one row per subreddit with its citation count, unique authors and positive/negative sentiment split; view=authors returns one row per author; view=threads returns the individual cited threads with upvotes, comments, average position and dominant sentiment. Requires the Growth plan or above.
+     * List cited Reddit content
+     */
+    listRedditCitations(requestParameters: ListRedditCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class OwnedMediaCommunitiesApi extends runtime.BaseAPI implements OwnedMediaCommunitiesApiInterface {
+    /**
+     * Creates request options for listOwnedMedia without sending the request
+     */
+    listOwnedMediaRequestOpts(requestParameters: ListOwnedMediaRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. Requires the Growth plan or above.
+     * List owned-media citations
+     */
+    listOwnedMediaRaw(requestParameters: ListOwnedMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Which owned-media content AI answers cite, by platform. `provider` is required. Each row carries a `yours` flag so you can compare your own presence against everyone else cited on the same platform. view=own_citations returns the raw citations of the connected profile only and stays empty until a profile is connected. For Reddit use /dimensions/reddit. Requires the Growth plan or above.
+     * List owned-media citations
+     */
+    listOwnedMedia(requestParameters: ListOwnedMediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listRedditCitations without sending the request
+     */
+    listRedditCitationsRequestOpts(requestParameters: ListRedditCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Which Reddit content AI answers cite for your tracked prompts. view=subreddits (default) returns one row per subreddit with its citation count, unique authors and positive/negative sentiment split; view=authors returns one row per author; view=threads returns the individual cited threads with upvotes, comments, average position and dominant sentiment. Requires the Growth plan or above.
+     * List cited Reddit content
+     */
+    listRedditCitationsRaw(requestParameters: ListRedditCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Which Reddit content AI answers cite for your tracked prompts. view=subreddits (default) returns one row per subreddit with its citation count, unique authors and positive/negative sentiment split; view=authors returns one row per author; view=threads returns the individual cited threads with upvotes, comments, average position and dominant sentiment. Requires the Growth plan or above.
+     * List cited Reddit content
+     */
+    listRedditCitations(requestParameters: ListRedditCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const ListOwnedMediaProviderEnum: {
+    readonly Youtube: "youtube";
+    readonly Instagram: "instagram";
+    readonly Facebook: "facebook";
+    readonly Tiktok: "tiktok";
+    readonly Linkedin: "linkedin";
+    readonly MobileApps: "mobile_apps";
+};
+export type ListOwnedMediaProviderEnum = typeof ListOwnedMediaProviderEnum[keyof typeof ListOwnedMediaProviderEnum];
+/**
+ * @export
+ */
+export declare const ListOwnedMediaViewEnum: {
+    readonly Videos: "videos";
+    readonly Channels: "channels";
+    readonly Posts: "posts";
+    readonly Profiles: "profiles";
+    readonly OwnCitations: "own_citations";
+    readonly Apps: "apps";
+};
+export type ListOwnedMediaViewEnum = typeof ListOwnedMediaViewEnum[keyof typeof ListOwnedMediaViewEnum];
+/**
+ * @export
+ */
+export declare const ListOwnedMediaStoreEnum: {
+    readonly GooglePlay: "google_play";
+    readonly AppStore: "app_store";
+};
+export type ListOwnedMediaStoreEnum = typeof ListOwnedMediaStoreEnum[keyof typeof ListOwnedMediaStoreEnum];
+/**
+ * @export
+ */
+export declare const ListOwnedMediaModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListOwnedMediaModelEnum = typeof ListOwnedMediaModelEnum[keyof typeof ListOwnedMediaModelEnum];
+/**
+ * @export
+ */
+export declare const ListOwnedMediaBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListOwnedMediaBrandKindEnum = typeof ListOwnedMediaBrandKindEnum[keyof typeof ListOwnedMediaBrandKindEnum];
+/**
+ * @export
+ */
+export declare const ListOwnedMediaOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListOwnedMediaOutputEnum = typeof ListOwnedMediaOutputEnum[keyof typeof ListOwnedMediaOutputEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsViewEnum: {
+    readonly Subreddits: "subreddits";
+    readonly Authors: "authors";
+    readonly Threads: "threads";
+};
+export type ListRedditCitationsViewEnum = typeof ListRedditCitationsViewEnum[keyof typeof ListRedditCitationsViewEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsStatusEnum: {
+    readonly Open: "open";
+    readonly Archived: "archived";
+};
+export type ListRedditCitationsStatusEnum = typeof ListRedditCitationsStatusEnum[keyof typeof ListRedditCitationsStatusEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsOrderEnum: {
+    readonly Citations: "citations";
+    readonly Subreddit: "subreddit";
+    readonly UniqueAuthors: "unique_authors";
+    readonly PositivePct: "positive_pct";
+    readonly NegativePct: "negative_pct";
+    readonly Author: "author";
+    readonly AvgPosition: "avg_position";
+    readonly Upvotes: "upvotes";
+    readonly Comments: "comments";
+    readonly Sentiment: "sentiment";
+};
+export type ListRedditCitationsOrderEnum = typeof ListRedditCitationsOrderEnum[keyof typeof ListRedditCitationsOrderEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListRedditCitationsDirectionEnum = typeof ListRedditCitationsDirectionEnum[keyof typeof ListRedditCitationsDirectionEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListRedditCitationsModelEnum = typeof ListRedditCitationsModelEnum[keyof typeof ListRedditCitationsModelEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListRedditCitationsBrandKindEnum = typeof ListRedditCitationsBrandKindEnum[keyof typeof ListRedditCitationsBrandKindEnum];
+/**
+ * @export
+ */
+export declare const ListRedditCitationsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListRedditCitationsOutputEnum = typeof ListRedditCitationsOutputEnum[keyof typeof ListRedditCitationsOutputEnum];