@spyglasshq/sdk 0.1.2 → 0.1.3

package/dist/cjs/Client.js

@@ -44,26 +44,591 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Spyglass = void 0;
+const spyglass = __importStar(require("./api/index.js"));
 const Client_js_1 = require("./api/resources/account/client/Client.js");
-const Client_js_2 = require("./api/resources/indexing/client/Client.js");
-const Client_js_3 = require("./api/resources/search/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
+const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
+const requestBody_js_1 = require("./core/requestBody.js");
+const environments = __importStar(require("./environments.js"));
+const handleNonStatusCodeError_js_1 = require("./errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("./errors/index.js"));
 class Spyglass {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
-    get search() {
-        var _a;
-        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_js_3.SearchClient(this._options)));
-    }
     get account() {
         var _a;
         return ((_a = this._account) !== null && _a !== void 0 ? _a : (this._account = new Client_js_1.AccountClient(this._options)));
     }
-    get indexing() {
-        var _a;
-        return ((_a = this._indexing) !== null && _a !== void 0 ? _a : (this._indexing = new Client_js_2.IndexingClient(this._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 {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 = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__searchBrands(request, requestOptions));
+    }
+    __searchBrands() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SpyglassEnvironment.Default, "brands"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new spyglass.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new spyglass.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new spyglass.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new spyglass.MethodNotAllowedError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new spyglass.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new spyglass.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new spyglass.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SpyglassError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/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 {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 = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__searchCreators(request, requestOptions));
+    }
+    __searchCreators() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SpyglassEnvironment.Default, "creators"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new spyglass.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new spyglass.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new spyglass.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new spyglass.MethodNotAllowedError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new spyglass.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new spyglass.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new spyglass.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SpyglassError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/creators");
+        });
+    }
+    /**
+     * 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, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__searchTaxonomies(request, requestOptions));
+    }
+    __searchTaxonomies(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { query, limit } = request;
+            const _queryParams = {
+                query,
+                limit,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SpyglassEnvironment.Default, "taxonomies"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new spyglass.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new spyglass.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new spyglass.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new spyglass.MethodNotAllowedError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new spyglass.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new spyglass.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SpyglassError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/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.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 = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__searchMedia(request, requestOptions));
+    }
+    __searchMedia() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SpyglassEnvironment.Default, "media"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new spyglass.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new spyglass.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new spyglass.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new spyglass.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new spyglass.MethodNotAllowedError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new spyglass.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new spyglass.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new spyglass.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SpyglassError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/media");
+        });
+    }
+    /**
+     * 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) {
+        return core.HttpResponsePromise.fromPromise(this.__getCreditUsage(requestOptions));
+    }
+    __getCreditUsage(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SpyglassEnvironment.Default, "team/credit-usage"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new spyglass.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new spyglass.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new spyglass.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new spyglass.MethodNotAllowedError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new spyglass.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new spyglass.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SpyglassError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/team/credit-usage");
+        });
+    }
+    /**
+     * 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 = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getComments(request, requestOptions));
+    }
+    __getComments() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SpyglassEnvironment.Default, "comments"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new spyglass.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new spyglass.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new spyglass.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 405:
+                        throw new spyglass.MethodNotAllowedError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new spyglass.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new spyglass.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new spyglass.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SpyglassError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/comments");
+        });
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/cjs/api/{resources/search/client/requests/GetMediaRequest.d.ts → client/requests/SearchMediaRequest.d.ts}

@@ -5,20 +5,20 @@
  *         limit: 20
  *     }
  */
-export interface GetMediaRequest {
+export interface SearchMediaRequest {
     /** Brand id given as a platform string or uuid */
-    brandId?: GetMediaRequest.BrandId;
+    brandId?: SearchMediaRequest.BrandId;
     query?: string;
-    channel?: GetMediaRequest.Channel.Item[];
-    format?: GetMediaRequest.Format.Item[];
-    duration?: GetMediaRequest.Duration.Item[];
-    status?: GetMediaRequest.Status;
-    categories?: GetMediaRequest.Categories.Item[];
+    channel?: SearchMediaRequest.Channel.Item[];
+    format?: SearchMediaRequest.Format.Item[];
+    duration?: SearchMediaRequest.Duration.Item[];
+    status?: SearchMediaRequest.Status;
+    categories?: SearchMediaRequest.Categories.Item[];
     taxonomy?: string[];
-    funnelStage?: GetMediaRequest.FunnelStage.Item[];
-    language?: GetMediaRequest.Language.Item[];
+    funnelStage?: SearchMediaRequest.FunnelStage.Item[];
+    language?: SearchMediaRequest.Language.Item[];
     location?: string[];
-    datePreset?: GetMediaRequest.DatePreset;
+    datePreset?: SearchMediaRequest.DatePreset;
     startDate?: string;
     endDate?: string;
     minDaysRun?: number;
@@ -26,15 +26,15 @@ export interface GetMediaRequest {
     minViewCount?: number;
     maxViewCount?: number;
     landingPage?: string;
-    landingPageMatch?: GetMediaRequest.LandingPageMatch;
+    landingPageMatch?: SearchMediaRequest.LandingPageMatch;
     lowImpressions?: boolean;
     partnershipAd?: boolean;
     crossposted?: boolean;
-    sortBy?: GetMediaRequest.SortBy;
+    sortBy?: SearchMediaRequest.SortBy;
     limit?: number;
     offset?: number;
 }
-export declare namespace GetMediaRequest {
+export declare namespace SearchMediaRequest {
     /**
      * Brand id given as a platform string or uuid
      */