@spyglasshq/sdk 0.1.9 → 0.1.11

package/dist/esm/Client.mjs

@@ -8,15 +8,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as spyglass from './api/index.mjs';
-import { AccountClient } from './api/resources/account/client/Client.mjs';
-import { normalizeClientOptionsWithAuth, } from './BaseClient.mjs';
-import { mergeHeaders } from './core/headers.mjs';
-import * as core from './core/index.mjs';
-import { mergeAdditionalBodyParameters } from './core/requestBody.mjs';
-import * as environments from './environments.mjs';
-import { handleNonStatusCodeError } from './errors/handleNonStatusCodeError.mjs';
-import * as errors from './errors/index.mjs';
+import * as spyglass from "./api/index.mjs";
+import { AccountClient } from "./api/resources/account/client/Client.mjs";
+import { normalizeClientOptionsWithAuth } from "./BaseClient.mjs";
+import { mergeHeaders } from "./core/headers.mjs";
+import * as core from "./core/index.mjs";
+import { mergeAdditionalBodyParameters } from "./core/requestBody.mjs";
+import * as environments from "./environments.mjs";
+import { handleNonStatusCodeError } from "./errors/handleNonStatusCodeError.mjs";
+import * as errors from "./errors/index.mjs";
 export class Spyglass {
     constructor(options) {
         this._options = normalizeClientOptionsWithAuth(options);
@@ -38,7 +38,7 @@ export class Spyglass {
      *   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
+     * - **ID** (`ids`). 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.
@@ -47,7 +47,7 @@ export class Spyglass {
      * If a request includes more than one of these fields, only the highest
      * priority field is used. The rest are ignored:
      *
-     * 1. `brandIds`
+     * 1. `ids`
      * 2. `igUsername` or `tiktokUsername` (if both are set, either handle can match)
      * 3. `names`
      * 4. `query`
@@ -59,7 +59,7 @@ export class Spyglass {
      * 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.
+     * Costs $0.0010 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.
      *
@@ -92,12 +92,12 @@ export class Spyglass {
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = 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',
+                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',
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
-                requestType: 'json',
+                requestType: "json",
                 body: 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,
@@ -106,12 +106,9 @@ export class Spyglass {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
-            if (_response.error.reason === 'status-code') {
+            if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
@@ -137,7 +134,7 @@ export class Spyglass {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, 'POST', '/brands');
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/brands");
         });
     }
     /**
@@ -153,7 +150,7 @@ export class Spyglass {
      *   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
+     * - **ID** (`ids`). 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.
@@ -162,7 +159,7 @@ export class Spyglass {
      * If a request includes more than one of these fields, only the highest
      * priority field is used. The rest are ignored:
      *
-     * 1. `brandIds`
+     * 1. `ids`
      * 2. `igUsername` or `tiktokUsername` (if both are set, either handle can match)
      * 3. `names`
      * 4. `query`
@@ -174,7 +171,7 @@ export class Spyglass {
      * 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.
+     * Costs $0.0010 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.
      *
@@ -208,12 +205,12 @@ export class Spyglass {
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = 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',
+                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',
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
-                requestType: 'json',
+                requestType: "json",
                 body: 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,
@@ -222,12 +219,9 @@ export class Spyglass {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
-            if (_response.error.reason === 'status-code') {
+            if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
@@ -253,7 +247,7 @@ export class Spyglass {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, 'POST', '/creators');
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/creators");
         });
     }
     /**
@@ -296,8 +290,8 @@ export class Spyglass {
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = 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',
+                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()
@@ -311,12 +305,9 @@ export class Spyglass {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
-            if (_response.error.reason === 'status-code') {
+            if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
@@ -340,7 +331,7 @@ export class Spyglass {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, 'GET', '/taxonomies');
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/taxonomies");
         });
     }
     /**
@@ -349,7 +340,7 @@ export class Spyglass {
      * `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.
+     * Costs $0.0005 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.
      *
@@ -383,12 +374,12 @@ export class Spyglass {
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = 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',
+                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',
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
-                requestType: 'json',
+                requestType: "json",
                 body: 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,
@@ -397,12 +388,9 @@ export class Spyglass {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
-            if (_response.error.reason === 'status-code') {
+            if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
@@ -430,7 +418,7 @@ export class Spyglass {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, 'POST', '/media');
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/media");
         });
     }
     /**
@@ -466,8 +454,8 @@ export class Spyglass {
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = 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',
+                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,
@@ -477,12 +465,9 @@ export class Spyglass {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
-            if (_response.error.reason === 'status-code') {
+            if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
@@ -506,7 +491,7 @@ export class Spyglass {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, 'GET', '/team/credit-usage');
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/team/credit-usage");
         });
     }
     /**
@@ -530,7 +515,7 @@ export class Spyglass {
      * 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.
+     * Costs $0.0050 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.
      *
@@ -564,12 +549,12 @@ export class Spyglass {
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = 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',
+                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',
+                contentType: "application/json",
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
-                requestType: 'json',
+                requestType: "json",
                 body: 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,
@@ -578,12 +563,9 @@ export class Spyglass {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
-            if (_response.error.reason === 'status-code') {
+            if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new spyglass.BadRequestError(_response.error.body, _response.rawResponse);
@@ -609,7 +591,7 @@ export class Spyglass {
                         });
                 }
             }
-            return handleNonStatusCodeError(_response.error, _response.rawResponse, 'POST', '/comments');
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/comments");
         });
     }
     /**

package/dist/esm/api/client/index.d.mts

@@ -1 +1 @@
-export * from './requests/index.mjs';
+export * from "./requests/index.mjs";

package/dist/esm/api/client/index.mjs

@@ -1 +1 @@
-export * from './requests/index.mjs';
+export * from "./requests/index.mjs";

package/dist/esm/api/client/requests/SearchBrandsRequest.d.mts

@@ -6,7 +6,7 @@
  *     }
  */
 export interface SearchBrandsRequest {
-    brandIds?: SearchBrandsRequest.BrandIds.Item[];
+    ids?: SearchBrandsRequest.Ids.Item[];
     names?: string[];
     igUsername?: string;
     tiktokUsername?: string;
@@ -20,10 +20,10 @@ export interface SearchBrandsRequest {
     taxonomy?: string[];
 }
 export declare namespace SearchBrandsRequest {
-    type BrandIds = BrandIds.Item[];
-    namespace BrandIds {
+    type Ids = Ids.Item[];
+    namespace Ids {
         /**
-         * Brand id given as a platform string or uuid
+         * Account id given as a platform string or uuid
          */
         type Item = string | number;
     }

package/dist/esm/api/client/requests/SearchBrandsRequest.mjs

@@ -2,11 +2,11 @@
 export var SearchBrandsRequest;
 (function (SearchBrandsRequest) {
     SearchBrandsRequest.SortBy = {
-        Name: 'NAME',
-        MostFollowers: 'MOST_FOLLOWERS',
-        LeastFollowers: 'LEAST_FOLLOWERS',
-        MostViews: 'MOST_VIEWS',
-        HighestEngagement: 'HIGHEST_ENGAGEMENT',
-        MostActiveAds: 'MOST_ACTIVE_ADS',
+        Name: "NAME",
+        MostFollowers: "MOST_FOLLOWERS",
+        LeastFollowers: "LEAST_FOLLOWERS",
+        MostViews: "MOST_VIEWS",
+        HighestEngagement: "HIGHEST_ENGAGEMENT",
+        MostActiveAds: "MOST_ACTIVE_ADS",
     };
 })(SearchBrandsRequest || (SearchBrandsRequest = {}));

package/dist/esm/api/client/requests/SearchCreatorsRequest.d.mts

@@ -7,7 +7,7 @@
  *     }
  */
 export interface SearchCreatorsRequest {
-    brandIds?: SearchCreatorsRequest.BrandIds.Item[];
+    ids?: SearchCreatorsRequest.Ids.Item[];
     names?: string[];
     igUsername?: string;
     tiktokUsername?: string;
@@ -24,10 +24,10 @@ export interface SearchCreatorsRequest {
     language?: SearchCreatorsRequest.Language;
 }
 export declare namespace SearchCreatorsRequest {
-    type BrandIds = BrandIds.Item[];
-    namespace BrandIds {
+    type Ids = Ids.Item[];
+    namespace Ids {
         /**
-         * Brand id given as a platform string or uuid
+         * Account id given as a platform string or uuid
          */
         type Item = string | number;
     }