@spyglasshq/sdk 0.1.2 → 0.1.4

package/dist/cjs/api/resources/search/client/Client.d.ts

@@ -1,337 +0,0 @@
-import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
-import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
-import * as core from "../../../../core/index.js";
-import * as spyglass from "../../../index.js";
-export declare namespace SearchClient {
-    type Options = BaseClientOptions;
-    interface RequestOptions extends BaseRequestOptions {
-    }
-}
-/**
- * Search accounts, ads, and related data.
- */
-export declare class SearchClient {
-    protected readonly _options: NormalizedClientOptionsWithAuth<SearchClient.Options>;
-    constructor(options: SearchClient.Options);
-    /**
-     * Find brands.
-     * Search semantically with `query`, or look them up by name, id, or
-     * social handle. Either way, you can also narrow the results with
-     * filters such as product taxonomy, location, and follower count.
-     *
-     * Send one search field. Each field is its own mode:
-     *
-     * - **Query** (`query`). A natural-language brief. Runs a language model and
-     *   ranks by relevance, so `sortBy` is ignored. Bills at least one row even
-     *   when nothing matches.
-     * - **Name** (`names`). Fuzzy-matches account names (a case-insensitive contains
-     *   match). Pass every name in one array.
-     * - **ID** (`brandIds`). Looks up known ids. Missing ids are omitted and listed
-     *   in `unmatchedIds`. `limit` and `offset` are ignored.
-     * - **Instagram** (`igUsername`). Case-insensitive contains match on the
-     *   handle. A leading `@` is ignored.
-     * - **TikTok** (`tiktokUsername`). Same match on the TikTok handle.
-     *
-     * If a request includes more than one of these fields, only the highest
-     * priority field is used. The rest are ignored:
-     *
-     * 1. `brandIds`
-     * 2. `igUsername` or `tiktokUsername` (if both are set, either handle can match)
-     * 3. `names`
-     * 4. `query`
-     *
-     * One exception: `query` together with `names` uses both. `names` narrows the
-     * set, and `query` ranks inside it.
-     *
-     * `limit` (default 20, max 100) caps the rows returned, and the cost, for
-     * every mode except ID.
-     *
-     * Limited to 120 requests per minute per user.
-     * Costs 2,000 microdollars ($0.0020) per brand returned, charged against your plan's monthly credits. The count field is what you were charged for.
-     * A `query` search runs a language model, so it bills a minimum of one
-     * row even when nothing matches.
-     *
-     * @param {spyglass.SearchBrandsRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.ContentTooLargeError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.brands({
-     *         names: ["Nike"],
-     *         limit: 3
-     *     })
-     */
-    brands(request?: spyglass.SearchBrandsRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.SearchBrandsResponse>;
-    private __brands;
-    /**
-     * Find creators.
-     * Search semantically with `query`, or look them up by name, id, or
-     * social handle. Either way, you can also narrow the results with
-     * filters such as audience profile, location, and follower count.
-     *
-     * Send one search field. Each field is its own mode:
-     *
-     * - **Query** (`query`). A natural-language brief. Runs a language model and
-     *   ranks by relevance, so `sortBy` is ignored. Bills at least one row even
-     *   when nothing matches.
-     * - **Name** (`names`). Fuzzy-matches account names (a case-insensitive contains
-     *   match). Pass every name in one array.
-     * - **ID** (`brandIds`). Looks up known ids. Missing ids are omitted and listed
-     *   in `unmatchedIds`. `limit` and `offset` are ignored.
-     * - **Instagram** (`igUsername`). Case-insensitive contains match on the
-     *   handle. A leading `@` is ignored.
-     * - **TikTok** (`tiktokUsername`). Same match on the TikTok handle.
-     *
-     * If a request includes more than one of these fields, only the highest
-     * priority field is used. The rest are ignored:
-     *
-     * 1. `brandIds`
-     * 2. `igUsername` or `tiktokUsername` (if both are set, either handle can match)
-     * 3. `names`
-     * 4. `query`
-     *
-     * One exception: `query` together with `names` uses both. `names` narrows the
-     * set, and `query` ranks inside it.
-     *
-     * `limit` (default 20, max 100) caps the rows returned, and the cost, for
-     * every mode except ID.
-     *
-     * Limited to 120 requests per minute per user.
-     * Costs 2,000 microdollars ($0.0020) per creator returned, charged against your plan's monthly credits. The count field is what you were charged for.
-     * A `query` search runs a language model, so it bills a minimum of one
-     * row even when nothing matches.
-     *
-     * @param {spyglass.SearchCreatorsRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.ContentTooLargeError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.creators({
-     *         igUsername: "charlidamelio",
-     *         limit: 3,
-     *         gender: "female"
-     *     })
-     */
-    creators(request?: spyglass.SearchCreatorsRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.SearchCreatorsResponse>;
-    private __creators;
-    /**
-     * Fetch a single brand or creator by id. The `type` field tells you
-     * which one you got: `BRAND` or `CREATOR`, and the creator-only fields
-     * (`gender`, `ageRange`, ...) are present only on `CREATOR`.
-     *
-     * Limited to 120 requests per minute per user.
-     * Costs 2,000 microdollars ($0.0020) per account returned, charged against your plan's monthly credits.
-     * An id that matches nothing returns 404 and is free.
-     *
-     * @param {spyglass.GetAccountRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.NotFoundError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.getAccount({
-     *         id: "id"
-     *     })
-     */
-    getAccount(request: spyglass.GetAccountRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.GetAccountResponse>;
-    private __getAccount;
-    /**
-     * Find taxonomy paths you can pass to POST /media as `taxonomy`.
-     * `query` is a product or category phrase. Each path is a string
-     * such as `Apparel > Footwear > Sneakers`.
-     *
-     * Limited to 120 requests per minute per user.
-     * This call is free and does not use credits.
-     *
-     * @param {spyglass.SearchTaxonomiesRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.taxonomies({
-     *         query: "running shoes"
-     *     })
-     */
-    taxonomies(request: spyglass.SearchTaxonomiesRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.SearchTaxonomiesResponse>;
-    private __taxonomies;
-    /**
-     * Return creatives. Pass `brandId` to scope to one brand or creator,
-     * or omit it to search the whole corpus. Without `brandId`,
-     * `query` is required.
-     *
-     * Limited to 120 requests per minute per user.
-     * Costs 1,000 microdollars ($0.0010) per creative returned, charged against your plan's monthly credits. The count field is what you were charged for.
-     * The call bills a minimum of one row even when nothing matches. In that
-     * case `count` is 0 but you are charged for one row.
-     *
-     * @param {spyglass.GetMediaRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.NotFoundError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.ContentTooLargeError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.getMedia({
-     *         query: "comfort-focused video ads",
-     *         limit: 20
-     *     })
-     */
-    getMedia(request?: spyglass.GetMediaRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.GetMediaResponse>;
-    private __getMedia;
-    /**
-     * Return clustered creative themes for an account. `MEDIA_MIX` returns a
-     * breakdown by media type; the other types return weekly buckets plus
-     * ranked totals, highest first.
-     *
-     * `maxDaysBack` filters both the weekly bucket series and ranked
-     * `totals` to creatives that started within the requested window.
-     *
-     * Limited to 120 requests per minute per user.
-     * Costs 1,000 microdollars ($0.0010) per cluster returned, charged against your plan's monthly credits. The count field is what you were charged for.
-     *
-     * @param {spyglass.GetBrandMediaInsightsRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.NotFoundError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.getBrandMediaInsights({
-     *         id: "id",
-     *         type: "HOOK"
-     *     })
-     */
-    getBrandMediaInsights(request: spyglass.GetBrandMediaInsightsRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.GetBrandMediaInsightsResponse>;
-    private __getBrandMediaInsights;
-    /**
-     * Return the landing-page URLs a brand sends ad traffic to, ranked by
-     * how often they appear across its ads.
-     *
-     * Limited to 120 requests per minute per user.
-     * Costs 5,000 microdollars ($0.0050) per landing page returned, charged against your plan's monthly credits. The count field is what you were charged for.
-     *
-     * @param {spyglass.GetBrandLandingPagesRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.NotFoundError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.getBrandLandingPages({
-     *         id: "id"
-     *     })
-     */
-    getBrandLandingPages(request: spyglass.GetBrandLandingPagesRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.GetBrandLandingPagesResponse>;
-    private __getBrandLandingPages;
-    /**
-     * Return public comments for specific Instagram or TikTok posts.
-     * Pass post URLs or the platform id. At least one of `instagramIds` or
-     * `tiktokIds` is required (max 20 each). `limit` is comment pages
-     * per post (default 1, max 20).
-     *
-     * Instagram accepts a shortcode or a post URL:
-     *
-     * - `C2xY9abcD1e`
-     * - `https://www.instagram.com/p/C2xY9abcD1e/`
-     * - `https://www.instagram.com/reel/C2xY9abcD1e/`
-     *
-     * TikTok accepts a video id or a post URL:
-     *
-     * - `7234567890123456789`
-     * - `https://www.tiktok.com/@nike/video/7234567890123456789`
-     *
-     * Recent posts may be scraped live; older posts with stored comments
-     * are served from cache.
-     *
-     * Limited to 20 requests per minute per user.
-     * Costs 10,000 microdollars ($0.0100) per successful page of comments returned, charged against your plan's monthly credits.
-     * Each comment page fetched live (`limit`, default 1) is one billed
-     * unit. Cached posts do not scrape and are not billed.
-     *
-     * @param {spyglass.GetCommentsRequest} request
-     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link spyglass.BadRequestError}
-     * @throws {@link spyglass.UnauthorizedError}
-     * @throws {@link spyglass.PaymentRequiredError}
-     * @throws {@link spyglass.ForbiddenError}
-     * @throws {@link spyglass.MethodNotAllowedError}
-     * @throws {@link spyglass.ContentTooLargeError}
-     * @throws {@link spyglass.TooManyRequestsError}
-     * @throws {@link spyglass.InternalServerError}
-     * @throws {@link errors.SpyglassError}
-     * @throws {@link errors.SpyglassTimeoutError}
-     *
-     * @example
-     *     await client.search.getComments({
-     *         instagramIds: ["https://www.instagram.com/p/C2xY9abcD1e/"],
-     *         tiktokIds: ["https://www.tiktok.com/@nike/video/7234567890123456789"],
-     *         limit: 1
-     *     })
-     */
-    getComments(request?: spyglass.GetCommentsRequest, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<spyglass.GetCommentsResponse>;
-    private __getComments;
-}