@spyglasshq/sdk 0.1.2 → 0.1.3

package/dist/cjs/api/resources/index.js

@@ -15,6 +15,9 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importStar = (this && this.__importStar) || (function () {
     var ownKeys = function(o) {
         ownKeys = Object.getOwnPropertyNames || function (o) {
@@ -32,16 +35,8 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.search = exports.indexing = exports.account = void 0;
+exports.account = void 0;
+__exportStar(require("./account/client/requests/index.js"), exports);
 exports.account = __importStar(require("./account/index.js"));
 __exportStar(require("./account/types/index.js"), exports);
-__exportStar(require("./indexing/client/requests/index.js"), exports);
-exports.indexing = __importStar(require("./indexing/index.js"));
-__exportStar(require("./indexing/types/index.js"), exports);
-__exportStar(require("./search/client/requests/index.js"), exports);
-exports.search = __importStar(require("./search/index.js"));
-__exportStar(require("./search/types/index.js"), exports);

package/dist/{esm/api/resources/search/types/GetMediaResponse.d.mts → cjs/api/types/SearchMediaResponse.d.ts}

@@ -1,8 +1,8 @@
-export interface GetMediaResponse {
+export interface SearchMediaResponse {
     count: number;
-    media: GetMediaResponse.Media.Item[];
+    media: SearchMediaResponse.Media.Item[];
 }
-export declare namespace GetMediaResponse {
+export declare namespace SearchMediaResponse {
     type Media = Media.Item[];
     namespace Media {
         interface Item {

package/dist/cjs/api/{resources/search/types/GetMediaResponse.js → types/SearchMediaResponse.js}

@@ -1,9 +1,9 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetMediaResponse = void 0;
-var GetMediaResponse;
-(function (GetMediaResponse) {
+exports.SearchMediaResponse = void 0;
+var SearchMediaResponse;
+(function (SearchMediaResponse) {
     let Media;
     (function (Media) {
         let Item;
@@ -53,5 +53,5 @@ var GetMediaResponse;
                 };
             })(UgcCharacter = Item.UgcCharacter || (Item.UgcCharacter = {}));
         })(Item = Media.Item || (Media.Item = {}));
-    })(Media = GetMediaResponse.Media || (GetMediaResponse.Media = {}));
-})(GetMediaResponse || (exports.GetMediaResponse = GetMediaResponse = {}));
+    })(Media = SearchMediaResponse.Media || (SearchMediaResponse.Media = {}));
+})(SearchMediaResponse || (exports.SearchMediaResponse = SearchMediaResponse = {}));

package/dist/cjs/api/types/index.d.ts

@@ -1 +1,7 @@
 export * from "./Error_.js";
+export * from "./GetCommentsResponse.js";
+export * from "./GetCreditUsageResponse.js";
+export * from "./SearchBrandsResponse.js";
+export * from "./SearchCreatorsResponse.js";
+export * from "./SearchMediaResponse.js";
+export * from "./SearchTaxonomiesResponse.js";

package/dist/cjs/api/types/index.js

@@ -15,3 +15,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Error_.js"), exports);
+__exportStar(require("./GetCommentsResponse.js"), exports);
+__exportStar(require("./GetCreditUsageResponse.js"), exports);
+__exportStar(require("./SearchBrandsResponse.js"), exports);
+__exportStar(require("./SearchCreatorsResponse.js"), exports);
+__exportStar(require("./SearchMediaResponse.js"), exports);
+__exportStar(require("./SearchTaxonomiesResponse.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.2";
+export declare const SDK_VERSION = "0.1.3";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.1.2";
+exports.SDK_VERSION = "0.1.3";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@spyglasshq/sdk",
-        "X-Fern-SDK-Version": "0.1.2",
-        "User-Agent": "@spyglasshq/sdk/0.1.2",
+        "X-Fern-SDK-Version": "0.1.3",
+        "User-Agent": "@spyglasshq/sdk/0.1.3",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/Client.d.mts

@@ -1,6 +1,5 @@
+import * as spyglass from "./api/index.mjs";
 import { AccountClient } from "./api/resources/account/client/Client.mjs";
-import { IndexingClient } from "./api/resources/indexing/client/Client.mjs";
-import { SearchClient } from "./api/resources/search/client/Client.mjs";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient.mjs";
 import * as core from "./core/index.mjs";
@@ -11,13 +10,265 @@ export declare namespace Spyglass {
 }
 export declare class Spyglass {
     protected readonly _options: NormalizedClientOptionsWithAuth<Spyglass.Options>;
-    protected _search: SearchClient | undefined;
     protected _account: AccountClient | undefined;
-    protected _indexing: IndexingClient | undefined;
     constructor(options: Spyglass.Options);
-    get search(): SearchClient;
     get account(): AccountClient;
-    get indexing(): IndexingClient;
+    /**
+     * 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 {Spyglass.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.searchBrands({
+     *         names: ["Nike"],
+     *         limit: 3
+     *     })
+     */
+    searchBrands(request?: spyglass.SearchBrandsRequest, requestOptions?: Spyglass.RequestOptions): core.HttpResponsePromise<spyglass.SearchBrandsResponse>;
+    private __searchBrands;
+    /**
+     * 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 {Spyglass.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.searchCreators({
+     *         igUsername: "charlidamelio",
+     *         limit: 3,
+     *         gender: "female"
+     *     })
+     */
+    searchCreators(request?: spyglass.SearchCreatorsRequest, requestOptions?: Spyglass.RequestOptions): core.HttpResponsePromise<spyglass.SearchCreatorsResponse>;
+    private __searchCreators;
+    /**
+     * 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 {Spyglass.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.searchTaxonomies({
+     *         query: "running shoes"
+     *     })
+     */
+    searchTaxonomies(request: spyglass.SearchTaxonomiesRequest, requestOptions?: Spyglass.RequestOptions): core.HttpResponsePromise<spyglass.SearchTaxonomiesResponse>;
+    private __searchTaxonomies;
+    /**
+     * 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.SearchMediaRequest} request
+     * @param {Spyglass.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.searchMedia({
+     *         query: "comfort-focused video ads",
+     *         limit: 20
+     *     })
+     */
+    searchMedia(request?: spyglass.SearchMediaRequest, requestOptions?: Spyglass.RequestOptions): core.HttpResponsePromise<spyglass.SearchMediaResponse>;
+    private __searchMedia;
+    /**
+     * Credits left on the API key's team, the credits included in the
+     * plan, and the current billing period. Granted credits count toward
+     * `remainingCredits` and not `planCredits`.
+     *
+     * Limited to 120 requests per minute per user.
+     * This call is free and does not use credits. It still responds when
+     * the team is out of credits.
+     *
+     * @param {Spyglass.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.getCreditUsage()
+     */
+    getCreditUsage(requestOptions?: Spyglass.RequestOptions): core.HttpResponsePromise<spyglass.GetCreditUsageResponse>;
+    private __getCreditUsage;
+    /**
+     * 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 {Spyglass.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.getComments({
+     *         instagramIds: ["https://www.instagram.com/p/C2xY9abcD1e/"],
+     *         tiktokIds: ["https://www.tiktok.com/@nike/video/7234567890123456789"],
+     *         limit: 1
+     *     })
+     */
+    getComments(request?: spyglass.GetCommentsRequest, requestOptions?: Spyglass.RequestOptions): core.HttpResponsePromise<spyglass.GetCommentsResponse>;
+    private __getComments;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.