@spyglasshq/sdk 0.1.9 → 0.1.11

package/reference.md

@@ -1,5 +1,4 @@
 # Reference
-
 <details><summary><code>client.<a href="/src/Client.ts">searchBrands</a>({ ...params }) -> spyglass.SearchBrandsResponse</code></summary>
 <dl>
 <dd>
@@ -24,7 +23,7 @@ Send one search field. Each field is its own mode:
   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.
@@ -33,7 +32,7 @@ Send one search field. Each field is its own mode:
 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`
@@ -45,10 +44,9 @@ set, and `query` ranks inside it.
 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.
-
 </dd>
 </dl>
 </dd>
@@ -64,11 +62,11 @@ row even when nothing matches.
 
 ```typescript
 await client.searchBrands({
-  names: ['Nike'],
-  limit: 3,
+    names: ["Nike"],
+    limit: 3
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -82,21 +80,22 @@ await client.searchBrands({
 <dl>
 <dd>
 
-**request:** `spyglass.SearchBrandsRequest`
-
+**request:** `spyglass.SearchBrandsRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Spyglass.RequestOptions`
-
+**requestOptions:** `Spyglass.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -125,7 +124,7 @@ Send one search field. Each field is its own mode:
   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.
@@ -134,7 +133,7 @@ Send one search field. Each field is its own mode:
 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`
@@ -146,10 +145,9 @@ set, and `query` ranks inside it.
 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.
-
 </dd>
 </dl>
 </dd>
@@ -165,12 +163,12 @@ row even when nothing matches.
 
 ```typescript
 await client.searchCreators({
-  igUsername: 'charlidamelio',
-  limit: 3,
-  gender: 'female',
+    igUsername: "charlidamelio",
+    limit: 3,
+    gender: "female"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -184,21 +182,22 @@ await client.searchCreators({
 <dl>
 <dd>
 
-**request:** `spyglass.SearchCreatorsRequest`
-
+**request:** `spyglass.SearchCreatorsRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Spyglass.RequestOptions`
-
+**requestOptions:** `Spyglass.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -221,7 +220,6 @@ such as `Apparel > Footwear > Sneakers`.
 
 Limited to 120 requests per minute per user.
 This call is free and does not use credits.
-
 </dd>
 </dl>
 </dd>
@@ -237,10 +235,10 @@ This call is free and does not use credits.
 
 ```typescript
 await client.searchTaxonomies({
-  query: 'running shoes',
+    query: "running shoes"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -254,21 +252,22 @@ await client.searchTaxonomies({
 <dl>
 <dd>
 
-**request:** `spyglass.SearchTaxonomiesRequest`
-
+**request:** `spyglass.SearchTaxonomiesRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Spyglass.RequestOptions`
-
+**requestOptions:** `Spyglass.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -290,10 +289,9 @@ or omit it to search the whole corpus. Without `accountId`,
 `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.
-
 </dd>
 </dl>
 </dd>
@@ -309,11 +307,11 @@ case `count` is 0 but you are charged for one row.
 
 ```typescript
 await client.searchMedia({
-  query: 'comfort-focused video ads',
-  limit: 20,
+    query: "comfort-focused video ads",
+    limit: 20
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -327,21 +325,22 @@ await client.searchMedia({
 <dl>
 <dd>
 
-**request:** `spyglass.SearchMediaRequest`
-
+**request:** `spyglass.SearchMediaRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Spyglass.RequestOptions`
-
+**requestOptions:** `Spyglass.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -365,7 +364,6 @@ plan, and the current billing period. Granted credits count toward
 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.
-
 </dd>
 </dl>
 </dd>
@@ -381,8 +379,8 @@ the team is out of credits.
 
 ```typescript
 await client.getCreditUsage();
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -396,13 +394,14 @@ await client.getCreditUsage();
 <dl>
 <dd>
 
-**requestOptions:** `Spyglass.RequestOptions`
-
+**requestOptions:** `Spyglass.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -439,10 +438,9 @@ 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.
+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.
-
 </dd>
 </dl>
 </dd>
@@ -458,12 +456,12 @@ unit. Cached posts do not scrape and are not billed.
 
 ```typescript
 await client.getComments({
-  instagramIds: ['https://www.instagram.com/p/C2xY9abcD1e/'],
-  tiktokIds: ['https://www.tiktok.com/@nike/video/7234567890123456789'],
-  limit: 1,
+    instagramIds: ["https://www.instagram.com/p/C2xY9abcD1e/"],
+    tiktokIds: ["https://www.tiktok.com/@nike/video/7234567890123456789"],
+    limit: 1
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -477,27 +475,27 @@ await client.getComments({
 <dl>
 <dd>
 
-**request:** `spyglass.GetCommentsRequest`
-
+**request:** `spyglass.GetCommentsRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Spyglass.RequestOptions`
-
+**requestOptions:** `Spyglass.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Account
-
 <details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">get</a>({ ...params }) -> spyglass.GetAccountResponse</code></summary>
 <dl>
 <dd>
@@ -515,9 +513,8 @@ 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 2,000 microdollars ($0.0020) per account returned, charged against your plan's monthly credits.
+Costs $0.0010 per account returned, charged against your plan's monthly credits.
 An id that matches nothing returns 404 and is free.
-
 </dd>
 </dl>
 </dd>
@@ -533,10 +530,10 @@ An id that matches nothing returns 404 and is free.
 
 ```typescript
 await client.account.get({
-  id: 'id',
+    id: "id"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -550,21 +547,22 @@ await client.account.get({
 <dl>
 <dd>
 
-**request:** `spyglass.GetAccountRequest`
-
+**request:** `spyglass.GetAccountRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `AccountClient.RequestOptions`
-
+**requestOptions:** `AccountClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -589,8 +587,7 @@ ranked totals, highest first.
 `totals` to creatives that started within the requested window.
 
 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.
-
+Costs $0.0005 per cluster returned, charged against your plan's monthly credits. The count field is what you were charged for.
 </dd>
 </dl>
 </dd>
@@ -606,11 +603,82 @@ Costs 1,000 microdollars ($0.0010) per cluster returned, charged against your pl
 
 ```typescript
 await client.account.insights({
-  id: 'id',
-  type: 'HOOK',
+    id: "id",
+    type: "HOOK"
 });
+
 ```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `spyglass.InsightsAccountRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">campaigns</a>({ ...params }) -> spyglass.CampaignsAccountResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Return an account’s campaigns or offers, newest start date first.
+`datePreset`, or `startDate` and `endDate`, filter by campaign
+start date. Omit both for all time.
+
+Limited to 120 requests per minute per user.
+Costs $0.0005 per campaign returned, charged against your plan's monthly credits. The count field is what you were charged for.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.account.campaigns({
+    id: "id",
+    type: "CAMPAIGN"
+});
 
+```
 </dd>
 </dl>
 </dd>
@@ -624,20 +692,92 @@ await client.account.insights({
 <dl>
 <dd>
 
-**request:** `spyglass.InsightsAccountRequest`
+**request:** `spyglass.CampaignsAccountRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">collabs</a>({ ...params }) -> spyglass.CollabsAccountResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Return the creators an account has collaborated with, ordered from
+most media to least. Works for both brands and creators.
+mediaCount is how many of that account’s media items tag the
+creator.
+
+Limited to 120 requests per minute per user.
+Costs $0.0005 per collab returned, charged against your plan's monthly credits. The count field is what you were charged for.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.account.collabs({
+    id: "id"
+});
 
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**requestOptions:** `AccountClient.RequestOptions`
+<dl>
+<dd>
 
+**request:** `spyglass.CollabsAccountRequest` 
+    
 </dd>
 </dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountClient.RequestOptions` 
+    
 </dd>
 </dl>
+</dd>
+</dl>
+
 
 </dd>
 </dl>
@@ -659,8 +799,7 @@ 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.
-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 $0.0025 per landing page returned, charged against your plan's monthly credits. The count field is what you were charged for.
 </dd>
 </dl>
 </dd>
@@ -676,10 +815,10 @@ Costs 5,000 microdollars ($0.0050) per landing page returned, charged against yo
 
 ```typescript
 await client.account.landingPages({
-  id: 'id',
+    id: "id"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -693,21 +832,22 @@ await client.account.landingPages({
 <dl>
 <dd>
 
-**request:** `spyglass.LandingPagesAccountRequest`
-
+**request:** `spyglass.LandingPagesAccountRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `AccountClient.RequestOptions`
-
+**requestOptions:** `AccountClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -734,7 +874,6 @@ queued, returning `status: "indexing"` and the new `brandId`.
 
 Limited to 50 requests per minute per user.
 This call is free.
-
 </dd>
 </dl>
 </dd>
@@ -750,10 +889,10 @@ This call is free.
 
 ```typescript
 await client.account.index({
-  websiteUrl: 'https://www.nike.com',
+    websiteUrl: "https://www.nike.com"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -767,21 +906,22 @@ await client.account.index({
 <dl>
 <dd>
 
-**request:** `spyglass.IndexAccountRequest`
-
+**request:** `spyglass.IndexAccountRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `AccountClient.RequestOptions`
-
+**requestOptions:** `AccountClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -802,7 +942,6 @@ Poll whether a brand finished indexing after POST /account/index.
 
 Limited to 300 requests per minute per user.
 This call is free.
-
 </dd>
 </dl>
 </dd>
@@ -818,10 +957,10 @@ This call is free.
 
 ```typescript
 await client.account.indexStatus({
-  id: 'id',
+    id: "id"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -835,21 +974,23 @@ await client.account.indexStatus({
 <dl>
 <dd>
 
-**request:** `spyglass.IndexStatusAccountRequest`
-
+**request:** `spyglass.IndexStatusAccountRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `AccountClient.RequestOptions`
-
+**requestOptions:** `AccountClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
+