@spyglasshq/sdk 0.1.0 → 0.1.2

package/dist/esm/api/resources/search/client/requests/{GetMediaV2Request.mjs → GetMediaRequest.mjs}

@@ -1,6 +1,6 @@
 // This file was auto-generated by Fern from our API Definition.
-export var GetMediaV2Request;
-(function (GetMediaV2Request) {
+export var GetMediaRequest;
+(function (GetMediaRequest) {
     let Channel;
     (function (Channel) {
         Channel.Item = {
@@ -8,7 +8,7 @@ export var GetMediaV2Request;
             Instagram: "INSTAGRAM",
             Tiktok: "TIKTOK",
         };
-    })(Channel = GetMediaV2Request.Channel || (GetMediaV2Request.Channel = {}));
+    })(Channel = GetMediaRequest.Channel || (GetMediaRequest.Channel = {}));
     let Format;
     (function (Format) {
         Format.Item = {
@@ -18,7 +18,7 @@ export var GetMediaV2Request;
             Image: "IMAGE",
             Dco: "DCO",
         };
-    })(Format = GetMediaV2Request.Format || (GetMediaV2Request.Format = {}));
+    })(Format = GetMediaRequest.Format || (GetMediaRequest.Format = {}));
     let Duration;
     (function (Duration) {
         Duration.Item = {
@@ -27,8 +27,8 @@ export var GetMediaV2Request;
             Thirty60: "30-60",
             Sixty: "60+",
         };
-    })(Duration = GetMediaV2Request.Duration || (GetMediaV2Request.Duration = {}));
-    GetMediaV2Request.Status = {
+    })(Duration = GetMediaRequest.Duration || (GetMediaRequest.Duration = {}));
+    GetMediaRequest.Status = {
         Active: "ACTIVE",
         Inactive: "INACTIVE",
         All: "ALL",
@@ -64,7 +64,7 @@ export var GetMediaV2Request;
             TextOverlay: "Text Overlay",
             Greenscreen: "Greenscreen",
         };
-    })(Categories = GetMediaV2Request.Categories || (GetMediaV2Request.Categories = {}));
+    })(Categories = GetMediaRequest.Categories || (GetMediaRequest.Categories = {}));
     let FunnelStage;
     (function (FunnelStage) {
         FunnelStage.Item = {
@@ -74,7 +74,7 @@ export var GetMediaV2Request;
             ProductAware: "PRODUCT_AWARE",
             MostAware: "MOST_AWARE",
         };
-    })(FunnelStage = GetMediaV2Request.FunnelStage || (GetMediaV2Request.FunnelStage = {}));
+    })(FunnelStage = GetMediaRequest.FunnelStage || (GetMediaRequest.FunnelStage = {}));
     let Language;
     (function (Language) {
         Language.Item = {
@@ -230,8 +230,8 @@ export var GetMediaV2Request;
             Xhosa: "Xhosa",
             Khasi: "Khasi",
         };
-    })(Language = GetMediaV2Request.Language || (GetMediaV2Request.Language = {}));
-    GetMediaV2Request.DatePreset = {
+    })(Language = GetMediaRequest.Language || (GetMediaRequest.Language = {}));
+    GetMediaRequest.DatePreset = {
         Today: "today",
         Yesterday: "yesterday",
         Last3Days: "last-3-days",
@@ -247,11 +247,11 @@ export var GetMediaV2Request;
         YearToDate: "year-to-date",
         LastYear: "last-year",
     };
-    GetMediaV2Request.LandingPageMatch = {
+    GetMediaRequest.LandingPageMatch = {
         Contains: "contains",
         Equals: "equals",
     };
-    GetMediaV2Request.SortBy = {
+    GetMediaRequest.SortBy = {
         MostRecent: "MOST_RECENT",
         Oldest: "OLDEST",
         LongestRun: "LONGEST_RUN",
@@ -262,4 +262,4 @@ export var GetMediaV2Request;
         HighestEngagement: "HIGHEST_ENGAGEMENT",
         HighestOutlier: "HIGHEST_OUTLIER",
     };
-})(GetMediaV2Request || (GetMediaV2Request = {}));
+})(GetMediaRequest || (GetMediaRequest = {}));

package/dist/{cjs/api/resources/search/client/requests/SearchBrandsV2Request.d.ts → esm/api/resources/search/client/requests/SearchBrandsRequest.d.mts}

@@ -5,8 +5,8 @@
  *         limit: 3
  *     }
  */
-export interface SearchBrandsV2Request {
-    brandIds?: SearchBrandsV2Request.BrandIds.Item[];
+export interface SearchBrandsRequest {
+    brandIds?: SearchBrandsRequest.BrandIds.Item[];
     names?: string[];
     igUsername?: string;
     tiktokUsername?: string;
@@ -14,12 +14,12 @@ export interface SearchBrandsV2Request {
     location?: string;
     minFollowers?: number;
     maxFollowers?: number;
-    sortBy?: SearchBrandsV2Request.SortBy;
+    sortBy?: SearchBrandsRequest.SortBy;
     offset?: number;
     limit?: number;
     taxonomy?: string[];
 }
-export declare namespace SearchBrandsV2Request {
+export declare namespace SearchBrandsRequest {
     type BrandIds = BrandIds.Item[];
     namespace BrandIds {
         /**

package/dist/esm/api/resources/search/client/requests/{SearchBrandsV2Request.mjs → SearchBrandsRequest.mjs}

@@ -1,7 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
-export var SearchBrandsV2Request;
-(function (SearchBrandsV2Request) {
-    SearchBrandsV2Request.SortBy = {
+export var SearchBrandsRequest;
+(function (SearchBrandsRequest) {
+    SearchBrandsRequest.SortBy = {
         Name: "NAME",
         MostFollowers: "MOST_FOLLOWERS",
         LeastFollowers: "LEAST_FOLLOWERS",
@@ -9,4 +9,4 @@ export var SearchBrandsV2Request;
         HighestEngagement: "HIGHEST_ENGAGEMENT",
         MostActiveAds: "MOST_ACTIVE_ADS",
     };
-})(SearchBrandsV2Request || (SearchBrandsV2Request = {}));
+})(SearchBrandsRequest || (SearchBrandsRequest = {}));

package/dist/esm/api/resources/search/client/requests/index.d.mts

@@ -2,7 +2,7 @@ export type { GetAccountRequest } from "./GetAccountRequest.mjs";
 export type { GetBrandLandingPagesRequest } from "./GetBrandLandingPagesRequest.mjs";
 export type { GetBrandMediaInsightsRequest } from "./GetBrandMediaInsightsRequest.mjs";
 export type { GetCommentsRequest } from "./GetCommentsRequest.mjs";
-export { GetMediaV2Request } from "./GetMediaV2Request.mjs";
-export { SearchBrandsV2Request } from "./SearchBrandsV2Request.mjs";
+export { GetMediaRequest } from "./GetMediaRequest.mjs";
+export { SearchBrandsRequest } from "./SearchBrandsRequest.mjs";
 export { SearchCreatorsRequest } from "./SearchCreatorsRequest.mjs";
 export type { SearchTaxonomiesRequest } from "./SearchTaxonomiesRequest.mjs";

package/dist/esm/api/resources/search/client/requests/index.mjs

@@ -1,3 +1,3 @@
-export { GetMediaV2Request } from "./GetMediaV2Request.mjs";
-export { SearchBrandsV2Request } from "./SearchBrandsV2Request.mjs";
+export { GetMediaRequest } from "./GetMediaRequest.mjs";
+export { SearchBrandsRequest } from "./SearchBrandsRequest.mjs";
 export { SearchCreatorsRequest } from "./SearchCreatorsRequest.mjs";

package/dist/esm/api/resources/search/types/GetAccountResponse.d.mts

@@ -1,5 +1,5 @@
-import type * as Spyglass from "../../../index.mjs";
-export type GetAccountResponse = Spyglass.GetAccountResponse.Brand | Spyglass.GetAccountResponse.Creator;
+import type * as spyglass from "../../../index.mjs";
+export type GetAccountResponse = spyglass.GetAccountResponse.Brand | spyglass.GetAccountResponse.Creator;
 export declare namespace GetAccountResponse {
     interface Brand {
         type: "BRAND";

package/dist/esm/api/resources/search/types/{GetMediaV2Response.d.mts → GetMediaResponse.d.mts}

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

package/dist/esm/api/resources/search/types/{GetMediaV2Response.mjs → GetMediaResponse.mjs}

@@ -1,6 +1,6 @@
 // This file was auto-generated by Fern from our API Definition.
-export var GetMediaV2Response;
-(function (GetMediaV2Response) {
+export var GetMediaResponse;
+(function (GetMediaResponse) {
     let Media;
     (function (Media) {
         let Item;
@@ -50,5 +50,5 @@ export var GetMediaV2Response;
                 };
             })(UgcCharacter = Item.UgcCharacter || (Item.UgcCharacter = {}));
         })(Item = Media.Item || (Media.Item = {}));
-    })(Media = GetMediaV2Response.Media || (GetMediaV2Response.Media = {}));
-})(GetMediaV2Response || (GetMediaV2Response = {}));
+    })(Media = GetMediaResponse.Media || (GetMediaResponse.Media = {}));
+})(GetMediaResponse || (GetMediaResponse = {}));

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

@@ -1,9 +1,9 @@
-export interface SearchBrandsV2Response {
+export interface SearchBrandsResponse {
     count: number;
-    brands: SearchBrandsV2Response.Brands.Item[];
+    brands: SearchBrandsResponse.Brands.Item[];
     unmatchedIds?: string[] | undefined;
 }
-export declare namespace SearchBrandsV2Response {
+export declare namespace SearchBrandsResponse {
     type Brands = Brands.Item[];
     namespace Brands {
         interface Item {

package/dist/esm/api/resources/search/types/{SearchBrandsV2Response.mjs → SearchBrandsResponse.mjs}

@@ -1,6 +1,6 @@
 // This file was auto-generated by Fern from our API Definition.
-export var SearchBrandsV2Response;
-(function (SearchBrandsV2Response) {
+export var SearchBrandsResponse;
+(function (SearchBrandsResponse) {
     let Brands;
     (function (Brands) {
         let Item;
@@ -9,5 +9,5 @@ export var SearchBrandsV2Response;
                 Brand: "BRAND",
             };
         })(Item = Brands.Item || (Brands.Item = {}));
-    })(Brands = SearchBrandsV2Response.Brands || (SearchBrandsV2Response.Brands = {}));
-})(SearchBrandsV2Response || (SearchBrandsV2Response = {}));
+    })(Brands = SearchBrandsResponse.Brands || (SearchBrandsResponse.Brands = {}));
+})(SearchBrandsResponse || (SearchBrandsResponse = {}));

package/dist/esm/api/resources/search/types/index.d.mts

@@ -4,7 +4,7 @@ export * from "./GetBrandLandingPagesResponse.mjs";
 export * from "./GetBrandMediaInsightsRequestType.mjs";
 export * from "./GetBrandMediaInsightsResponse.mjs";
 export * from "./GetCommentsResponse.mjs";
-export * from "./GetMediaV2Response.mjs";
-export * from "./SearchBrandsV2Response.mjs";
+export * from "./GetMediaResponse.mjs";
+export * from "./SearchBrandsResponse.mjs";
 export * from "./SearchCreatorsResponse.mjs";
 export * from "./SearchTaxonomiesResponse.mjs";

package/dist/esm/api/resources/search/types/index.mjs

@@ -4,7 +4,7 @@ export * from "./GetBrandLandingPagesResponse.mjs";
 export * from "./GetBrandMediaInsightsRequestType.mjs";
 export * from "./GetBrandMediaInsightsResponse.mjs";
 export * from "./GetCommentsResponse.mjs";
-export * from "./GetMediaV2Response.mjs";
-export * from "./SearchBrandsV2Response.mjs";
+export * from "./GetMediaResponse.mjs";
+export * from "./SearchBrandsResponse.mjs";
 export * from "./SearchCreatorsResponse.mjs";
 export * from "./SearchTaxonomiesResponse.mjs";

package/dist/esm/index.d.mts

@@ -1,6 +1,6 @@
-export * as Spyglass from "./api/index.mjs";
+export * as spyglass from "./api/index.mjs";
 export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
-export { SpyglassClient } from "./Client.mjs";
+export { Spyglass } from "./Client.mjs";
 export { SpyglassEnvironment } from "./environments.mjs";
 export { SpyglassError, SpyglassTimeoutError } from "./errors/index.mjs";
 export * from "./exports.mjs";

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
-export * as Spyglass from "./api/index.mjs";
-export { SpyglassClient } from "./Client.mjs";
+export * as spyglass from "./api/index.mjs";
+export { Spyglass } from "./Client.mjs";
 export { SpyglassEnvironment } from "./environments.mjs";
 export { SpyglassError, SpyglassTimeoutError } from "./errors/index.mjs";
 export * from "./exports.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.1.0";
+export const SDK_VERSION = "0.1.2";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spyglasshq/sdk",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "private": false,
     "repository": {
         "type": "git",
@@ -98,5 +98,20 @@
     "engines": {
         "node": ">=18.0.0"
     },
-    "sideEffects": false
+    "sideEffects": false,
+    "description": "Official TypeScript & Node.js SDK for the Spyglass API — search brands, creators, and the ads they run.",
+    "license": "MIT",
+    "homepage": "https://docs.spyglass.so",
+    "keywords": [
+        "spyglass",
+        "ads",
+        "ad-intelligence",
+        "social-media",
+        "creators",
+        "brands",
+        "marketing",
+        "tiktok",
+        "instagram",
+        "meta-ads"
+    ]
 }

package/reference.md

@@ -1,6 +1,6 @@
 # Reference
 ## Search
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">searchBrandsV2</a>({ ...params }) -> Spyglass.SearchBrandsV2Response</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">brands</a>({ ...params }) -> spyglass.SearchBrandsResponse</code></summary>
 <dl>
 <dd>
 
@@ -12,7 +12,10 @@
 <dl>
 <dd>
 
-Find brands (advertisers) only.
+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:
 
@@ -59,7 +62,7 @@ row even when nothing matches.
 <dd>
 
 ```typescript
-await client.search.searchBrandsV2({
+await client.search.brands({
     names: ["Nike"],
     limit: 3
 });
@@ -78,7 +81,7 @@ await client.search.searchBrandsV2({
 <dl>
 <dd>
 
-**request:** `Spyglass.SearchBrandsV2Request` 
+**request:** `spyglass.SearchBrandsRequest` 
     
 </dd>
 </dl>
@@ -98,7 +101,7 @@ await client.search.searchBrandsV2({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">creators</a>({ ...params }) -> Spyglass.SearchCreatorsResponse</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">creators</a>({ ...params }) -> spyglass.SearchCreatorsResponse</code></summary>
 <dl>
 <dd>
 
@@ -110,9 +113,10 @@ await client.search.searchBrandsV2({
 <dl>
 <dd>
 
-Find creators only.
-
-They also accept profile filters: `gender`, `ageRange`, `ethnicity`, `location` and `language`.
+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:
 
@@ -179,7 +183,7 @@ await client.search.creators({
 <dl>
 <dd>
 
-**request:** `Spyglass.SearchCreatorsRequest` 
+**request:** `spyglass.SearchCreatorsRequest` 
     
 </dd>
 </dl>
@@ -199,7 +203,7 @@ await client.search.creators({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getAccount</a>({ ...params }) -> Spyglass.GetAccountResponse</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getAccount</a>({ ...params }) -> spyglass.GetAccountResponse</code></summary>
 <dl>
 <dd>
 
@@ -250,7 +254,7 @@ await client.search.getAccount({
 <dl>
 <dd>
 
-**request:** `Spyglass.GetAccountRequest` 
+**request:** `spyglass.GetAccountRequest` 
     
 </dd>
 </dl>
@@ -270,7 +274,7 @@ await client.search.getAccount({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">taxonomies</a>({ ...params }) -> Spyglass.SearchTaxonomiesResponse</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">taxonomies</a>({ ...params }) -> spyglass.SearchTaxonomiesResponse</code></summary>
 <dl>
 <dd>
 
@@ -320,7 +324,7 @@ await client.search.taxonomies({
 <dl>
 <dd>
 
-**request:** `Spyglass.SearchTaxonomiesRequest` 
+**request:** `spyglass.SearchTaxonomiesRequest` 
     
 </dd>
 </dl>
@@ -340,7 +344,7 @@ await client.search.taxonomies({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getMediaV2</a>({ ...params }) -> Spyglass.GetMediaV2Response</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getMedia</a>({ ...params }) -> spyglass.GetMediaResponse</code></summary>
 <dl>
 <dd>
 
@@ -374,7 +378,7 @@ case `count` is 0 but you are charged for one row.
 <dd>
 
 ```typescript
-await client.search.getMediaV2({
+await client.search.getMedia({
     query: "comfort-focused video ads",
     limit: 20
 });
@@ -393,7 +397,7 @@ await client.search.getMediaV2({
 <dl>
 <dd>
 
-**request:** `Spyglass.GetMediaV2Request` 
+**request:** `spyglass.GetMediaRequest` 
     
 </dd>
 </dl>
@@ -413,7 +417,7 @@ await client.search.getMediaV2({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getBrandMediaInsights</a>({ ...params }) -> Spyglass.GetBrandMediaInsightsResponse</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getBrandMediaInsights</a>({ ...params }) -> spyglass.GetBrandMediaInsightsResponse</code></summary>
 <dl>
 <dd>
 
@@ -467,7 +471,7 @@ await client.search.getBrandMediaInsights({
 <dl>
 <dd>
 
-**request:** `Spyglass.GetBrandMediaInsightsRequest` 
+**request:** `spyglass.GetBrandMediaInsightsRequest` 
     
 </dd>
 </dl>
@@ -487,7 +491,7 @@ await client.search.getBrandMediaInsights({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getBrandLandingPages</a>({ ...params }) -> Spyglass.GetBrandLandingPagesResponse</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getBrandLandingPages</a>({ ...params }) -> spyglass.GetBrandLandingPagesResponse</code></summary>
 <dl>
 <dd>
 
@@ -536,7 +540,7 @@ await client.search.getBrandLandingPages({
 <dl>
 <dd>
 
-**request:** `Spyglass.GetBrandLandingPagesRequest` 
+**request:** `spyglass.GetBrandLandingPagesRequest` 
     
 </dd>
 </dl>
@@ -556,7 +560,7 @@ await client.search.getBrandLandingPages({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getComments</a>({ ...params }) -> Spyglass.GetCommentsResponse</code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getComments</a>({ ...params }) -> spyglass.GetCommentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -625,7 +629,7 @@ await client.search.getComments({
 <dl>
 <dd>
 
-**request:** `Spyglass.GetCommentsRequest` 
+**request:** `spyglass.GetCommentsRequest` 
     
 </dd>
 </dl>
@@ -646,7 +650,7 @@ await client.search.getComments({
 </details>
 
 ## Account
-<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">getCreditUsage</a>() -> Spyglass.GetCreditUsageResponse</code></summary>
+<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">getCreditUsage</a>() -> spyglass.GetCreditUsageResponse</code></summary>
 <dl>
 <dd>
 
@@ -708,7 +712,7 @@ await client.account.getCreditUsage();
 </details>
 
 ## Indexing
-<details><summary><code>client.indexing.<a href="/src/api/resources/indexing/client/Client.ts">indexBrand</a>({ ...params }) -> Spyglass.IndexBrandResponse</code></summary>
+<details><summary><code>client.indexing.<a href="/src/api/resources/indexing/client/Client.ts">indexBrand</a>({ ...params }) -> spyglass.IndexBrandResponse</code></summary>
 <dl>
 <dd>
 
@@ -762,7 +766,7 @@ await client.indexing.indexBrand({
 <dl>
 <dd>
 
-**request:** `Spyglass.IndexBrandRequest` 
+**request:** `spyglass.IndexBrandRequest` 
     
 </dd>
 </dl>
@@ -782,7 +786,7 @@ await client.indexing.indexBrand({
 </dl>
 </details>
 
-<details><summary><code>client.indexing.<a href="/src/api/resources/indexing/client/Client.ts">indexBrandStatus</a>({ ...params }) -> Spyglass.IndexBrandStatusResponse</code></summary>
+<details><summary><code>client.indexing.<a href="/src/api/resources/indexing/client/Client.ts">indexBrandStatus</a>({ ...params }) -> spyglass.IndexBrandStatusResponse</code></summary>
 <dl>
 <dd>
 
@@ -830,7 +834,7 @@ await client.indexing.indexBrandStatus({
 <dl>
 <dd>
 
-**request:** `Spyglass.IndexBrandStatusRequest` 
+**request:** `spyglass.IndexBrandStatusRequest` 
     
 </dd>
 </dl>