@spyglasshq/sdk 0.1.1 → 0.1.3

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

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

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

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

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

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

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.1.1";
+export const SDK_VERSION = "0.1.3";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spyglasshq/sdk",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "private": false,
     "repository": {
         "type": "git",
@@ -22,17 +22,6 @@
             },
             "default": "./dist/cjs/index.js"
         },
-        "./search": {
-            "import": {
-                "types": "./dist/esm/api/resources/search/exports.d.mts",
-                "default": "./dist/esm/api/resources/search/exports.mjs"
-            },
-            "require": {
-                "types": "./dist/cjs/api/resources/search/exports.d.ts",
-                "default": "./dist/cjs/api/resources/search/exports.js"
-            },
-            "default": "./dist/cjs/api/resources/search/exports.js"
-        },
         "./account": {
             "import": {
                 "types": "./dist/esm/api/resources/account/exports.d.mts",
@@ -44,17 +33,6 @@
             },
             "default": "./dist/cjs/api/resources/account/exports.js"
         },
-        "./indexing": {
-            "import": {
-                "types": "./dist/esm/api/resources/indexing/exports.d.mts",
-                "default": "./dist/esm/api/resources/indexing/exports.mjs"
-            },
-            "require": {
-                "types": "./dist/cjs/api/resources/indexing/exports.d.ts",
-                "default": "./dist/cjs/api/resources/indexing/exports.js"
-            },
-            "default": "./dist/cjs/api/resources/indexing/exports.js"
-        },
         "./package.json": "./package.json"
     },
     "files": [

package/reference.md

@@ -1,6 +1,5 @@
 # Reference
-## Search
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">brands</a>({ ...params }) -> spyglass.SearchBrandsResponse</code></summary>
+<details><summary><code>client.<a href="/src/Client.ts">searchBrands</a>({ ...params }) -> spyglass.SearchBrandsResponse</code></summary>
 <dl>
 <dd>
 
@@ -12,7 +11,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 +61,7 @@ row even when nothing matches.
 <dd>
 
 ```typescript
-await client.search.brands({
+await client.searchBrands({
     names: ["Nike"],
     limit: 3
 });
@@ -86,7 +88,7 @@ await client.search.brands({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `Spyglass.RequestOptions` 
     
 </dd>
 </dl>
@@ -98,7 +100,7 @@ await client.search.brands({
 </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.<a href="/src/Client.ts">searchCreators</a>({ ...params }) -> spyglass.SearchCreatorsResponse</code></summary>
 <dl>
 <dd>
 
@@ -110,9 +112,10 @@ await client.search.brands({
 <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:
 
@@ -159,7 +162,7 @@ row even when nothing matches.
 <dd>
 
 ```typescript
-await client.search.creators({
+await client.searchCreators({
     igUsername: "charlidamelio",
     limit: 3,
     gender: "female"
@@ -187,7 +190,7 @@ await client.search.creators({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `Spyglass.RequestOptions` 
     
 </dd>
 </dl>
@@ -199,7 +202,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.<a href="/src/Client.ts">searchTaxonomies</a>({ ...params }) -> spyglass.SearchTaxonomiesResponse</code></summary>
 <dl>
 <dd>
 
@@ -211,13 +214,12 @@ await client.search.creators({
 <dl>
 <dd>
 
-Fetch a single brand or creator by id. The `type` field tells you
-which one you got: `BRAND` or `CREATOR`, and the creator-only fields
-(`gender`, `ageRange`, ...) are present only on `CREATOR`.
+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.
-Costs 2,000 microdollars ($0.0020) per account returned, charged against your plan's monthly credits.
-An id that matches nothing returns 404 and is free.
+This call is free and does not use credits.
 </dd>
 </dl>
 </dd>
@@ -232,8 +234,8 @@ An id that matches nothing returns 404 and is free.
 <dd>
 
 ```typescript
-await client.search.getAccount({
-    id: "id"
+await client.searchTaxonomies({
+    query: "running shoes"
 });
 
 ```
@@ -250,7 +252,7 @@ await client.search.getAccount({
 <dl>
 <dd>
 
-**request:** `spyglass.GetAccountRequest` 
+**request:** `spyglass.SearchTaxonomiesRequest` 
     
 </dd>
 </dl>
@@ -258,7 +260,7 @@ await client.search.getAccount({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `Spyglass.RequestOptions` 
     
 </dd>
 </dl>
@@ -270,7 +272,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.<a href="/src/Client.ts">searchMedia</a>({ ...params }) -> spyglass.SearchMediaResponse</code></summary>
 <dl>
 <dd>
 
@@ -282,12 +284,14 @@ await client.search.getAccount({
 <dl>
 <dd>
 
-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`.
+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.
-This call is free and does not use credits.
+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.
 </dd>
 </dl>
 </dd>
@@ -302,8 +306,9 @@ This call is free and does not use credits.
 <dd>
 
 ```typescript
-await client.search.taxonomies({
-    query: "running shoes"
+await client.searchMedia({
+    query: "comfort-focused video ads",
+    limit: 20
 });
 
 ```
@@ -320,7 +325,7 @@ await client.search.taxonomies({
 <dl>
 <dd>
 
-**request:** `spyglass.SearchTaxonomiesRequest` 
+**request:** `spyglass.SearchMediaRequest` 
     
 </dd>
 </dl>
@@ -328,7 +333,7 @@ await client.search.taxonomies({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `Spyglass.RequestOptions` 
     
 </dd>
 </dl>
@@ -340,7 +345,7 @@ await client.search.taxonomies({
 </dl>
 </details>
 
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">getMedia</a>({ ...params }) -> spyglass.GetMediaResponse</code></summary>
+<details><summary><code>client.<a href="/src/Client.ts">getCreditUsage</a>() -> spyglass.GetCreditUsageResponse</code></summary>
 <dl>
 <dd>
 
@@ -352,14 +357,13 @@ await client.search.taxonomies({
 <dl>
 <dd>
 
-Return creatives. Pass `brandId` to scope to one brand or creator,
-or omit it to search the whole corpus. Without `brandId`,
-`query` is required.
+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.
-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.
+This call is free and does not use credits. It still responds when
+the team is out of credits.
 </dd>
 </dl>
 </dd>
@@ -374,10 +378,7 @@ case `count` is 0 but you are charged for one row.
 <dd>
 
 ```typescript
-await client.search.getMedia({
-    query: "comfort-focused video ads",
-    limit: 20
-});
+await client.getCreditUsage();
 
 ```
 </dd>
@@ -393,15 +394,7 @@ await client.search.getMedia({
 <dl>
 <dd>
 
-**request:** `spyglass.GetMediaRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `Spyglass.RequestOptions` 
     
 </dd>
 </dl>
@@ -413,7 +406,7 @@ await client.search.getMedia({
 </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.<a href="/src/Client.ts">getComments</a>({ ...params }) -> spyglass.GetCommentsResponse</code></summary>
 <dl>
 <dd>
 
@@ -425,15 +418,29 @@ await client.search.getMedia({
 <dl>
 <dd>
 
-Return clustered creative themes for an account. `MEDIA_MIX` returns a
-breakdown by media type; the other types return weekly buckets plus
-ranked totals, highest first.
+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).
 
-`maxDaysBack` filters both the weekly bucket series and ranked
-`totals` to creatives that started within the requested window.
+Instagram accepts a shortcode or a post URL:
 
-Limited to 120 requests per minute per user.
-Costs 1,000 microdollars ($0.0010) per cluster returned, charged against your plan's monthly credits. The count field is what you were charged for.
+- `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.
 </dd>
 </dl>
 </dd>
@@ -448,9 +455,10 @@ Costs 1,000 microdollars ($0.0010) per cluster returned, charged against your pl
 <dd>
 
 ```typescript
-await client.search.getBrandMediaInsights({
-    id: "id",
-    type: "HOOK"
+await client.getComments({
+    instagramIds: ["https://www.instagram.com/p/C2xY9abcD1e/"],
+    tiktokIds: ["https://www.tiktok.com/@nike/video/7234567890123456789"],
+    limit: 1
 });
 
 ```
@@ -467,7 +475,7 @@ await client.search.getBrandMediaInsights({
 <dl>
 <dd>
 
-**request:** `spyglass.GetBrandMediaInsightsRequest` 
+**request:** `spyglass.GetCommentsRequest` 
     
 </dd>
 </dl>
@@ -475,7 +483,7 @@ await client.search.getBrandMediaInsights({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `Spyglass.RequestOptions` 
     
 </dd>
 </dl>
@@ -487,7 +495,8 @@ 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>
+## Account
+<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">get</a>({ ...params }) -> spyglass.GetAccountResponse</code></summary>
 <dl>
 <dd>
 
@@ -499,11 +508,13 @@ await client.search.getBrandMediaInsights({
 <dl>
 <dd>
 
-Return the landing-page URLs a brand sends ad traffic to, ranked by
-how often they appear across its ads.
+Fetch a single brand or creator by id. The `type` field tells you
+which one you got: `BRAND` or `CREATOR`, and the creator-only fields
+(`gender`, `ageRange`, ...) are present only on `CREATOR`.
 
 Limited to 120 requests per minute per user.
-Costs 5,000 microdollars ($0.0050) per landing page returned, charged against your plan's monthly credits. The count field is what you were charged for.
+Costs 2,000 microdollars ($0.0020) per account returned, charged against your plan's monthly credits.
+An id that matches nothing returns 404 and is free.
 </dd>
 </dl>
 </dd>
@@ -518,7 +529,7 @@ Costs 5,000 microdollars ($0.0050) per landing page returned, charged against yo
 <dd>
 
 ```typescript
-await client.search.getBrandLandingPages({
+await client.account.get({
     id: "id"
 });
 
@@ -536,7 +547,7 @@ await client.search.getBrandLandingPages({
 <dl>
 <dd>
 
-**request:** `spyglass.GetBrandLandingPagesRequest` 
+**request:** `spyglass.GetAccountRequest` 
     
 </dd>
 </dl>
@@ -544,7 +555,7 @@ await client.search.getBrandLandingPages({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `AccountClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -556,7 +567,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.account.<a href="/src/api/resources/account/client/Client.ts">insights</a>({ ...params }) -> spyglass.InsightsAccountResponse</code></summary>
 <dl>
 <dd>
 
@@ -568,29 +579,15 @@ await client.search.getBrandLandingPages({
 <dl>
 <dd>
 
-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`
+Return clustered creative themes for an account. `MEDIA_MIX` returns a
+breakdown by media type; the other types return weekly buckets plus
+ranked totals, highest first.
 
-Recent posts may be scraped live; older posts with stored comments
-are served from cache.
+`maxDaysBack` filters both the weekly bucket series and ranked
+`totals` to creatives that started within the requested window.
 
-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.
+Limited to 120 requests per minute per user.
+Costs 1,000 microdollars ($0.0010) per cluster returned, charged against your plan's monthly credits. The count field is what you were charged for.
 </dd>
 </dl>
 </dd>
@@ -605,10 +602,9 @@ unit. Cached posts do not scrape and are not billed.
 <dd>
 
 ```typescript
-await client.search.getComments({
-    instagramIds: ["https://www.instagram.com/p/C2xY9abcD1e/"],
-    tiktokIds: ["https://www.tiktok.com/@nike/video/7234567890123456789"],
-    limit: 1
+await client.account.insights({
+    id: "id",
+    type: "HOOK"
 });
 
 ```
@@ -625,7 +621,7 @@ await client.search.getComments({
 <dl>
 <dd>
 
-**request:** `spyglass.GetCommentsRequest` 
+**request:** `spyglass.InsightsAccountRequest` 
     
 </dd>
 </dl>
@@ -633,7 +629,7 @@ await client.search.getComments({
 <dl>
 <dd>
 
-**requestOptions:** `SearchClient.RequestOptions` 
+**requestOptions:** `AccountClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -645,8 +641,7 @@ await client.search.getComments({
 </dl>
 </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">landingPages</a>({ ...params }) -> spyglass.LandingPagesAccountResponse</code></summary>
 <dl>
 <dd>
 
@@ -658,13 +653,11 @@ await client.search.getComments({
 <dl>
 <dd>
 
-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`.
+Return the landing-page URLs an account sends ad traffic to, ranked by
+how often they appear across its ads.
 
 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.
+Costs 5,000 microdollars ($0.0050) per landing page returned, charged against your plan's monthly credits. The count field is what you were charged for.
 </dd>
 </dl>
 </dd>
@@ -679,7 +672,9 @@ the team is out of credits.
 <dd>
 
 ```typescript
-await client.account.getCreditUsage();
+await client.account.landingPages({
+    id: "id"
+});
 
 ```
 </dd>
@@ -695,6 +690,14 @@ await client.account.getCreditUsage();
 <dl>
 <dd>
 
+**request:** `spyglass.LandingPagesAccountRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `AccountClient.RequestOptions` 
     
 </dd>
@@ -707,8 +710,7 @@ await client.account.getCreditUsage();
 </dl>
 </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.account.<a href="/src/api/resources/account/client/Client.ts">index</a>({ ...params }) -> spyglass.IndexAccountResponse</code></summary>
 <dl>
 <dd>
 
@@ -744,7 +746,7 @@ This call is free.
 <dd>
 
 ```typescript
-await client.indexing.indexBrand({
+await client.account.index({
     websiteUrl: "https://www.nike.com"
 });
 
@@ -762,7 +764,7 @@ await client.indexing.indexBrand({
 <dl>
 <dd>
 
-**request:** `spyglass.IndexBrandRequest` 
+**request:** `spyglass.IndexAccountRequest` 
     
 </dd>
 </dl>
@@ -770,7 +772,7 @@ await client.indexing.indexBrand({
 <dl>
 <dd>
 
-**requestOptions:** `IndexingClient.RequestOptions` 
+**requestOptions:** `AccountClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -782,7 +784,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.account.<a href="/src/api/resources/account/client/Client.ts">indexStatus</a>({ ...params }) -> spyglass.IndexStatusAccountResponse</code></summary>
 <dl>
 <dd>
 
@@ -812,7 +814,7 @@ This call is free.
 <dd>
 
 ```typescript
-await client.indexing.indexBrandStatus({
+await client.account.indexStatus({
     id: "id"
 });
 
@@ -830,7 +832,7 @@ await client.indexing.indexBrandStatus({
 <dl>
 <dd>
 
-**request:** `spyglass.IndexBrandStatusRequest` 
+**request:** `spyglass.IndexStatusAccountRequest` 
     
 </dd>
 </dl>
@@ -838,7 +840,7 @@ await client.indexing.indexBrandStatus({
 <dl>
 <dd>
 
-**requestOptions:** `IndexingClient.RequestOptions` 
+**requestOptions:** `AccountClient.RequestOptions` 
     
 </dd>
 </dl>