@spyglasshq/sdk 0.1.9 → 0.1.10

package/dist/esm/api/resources/account/client/requests/CampaignsAccountRequest.d.mts

@@ -0,0 +1,18 @@
+import type * as spyglass from '../../../../index.mjs';
+/**
+ * @example
+ *     {
+ *         id: "id",
+ *         type: "CAMPAIGN"
+ *     }
+ */
+export interface CampaignsAccountRequest {
+    /** Brand id returned by POST /brands/search. */
+    id: string;
+    type: spyglass.CampaignsAccountRequestType;
+    sortBy?: spyglass.CampaignsAccountRequestSortBy;
+    limit?: number;
+    datePreset?: spyglass.CampaignsAccountRequestDatePreset;
+    startDate?: string;
+    endDate?: string;
+}

package/dist/esm/api/resources/account/client/requests/CampaignsAccountRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/account/client/requests/CollabsAccountRequest.d.mts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface CollabsAccountRequest {
+    /** Brand id returned by POST /brands/search. */
+    id: string;
+    limit?: number;
+    offset?: number;
+}

package/dist/esm/api/resources/account/client/requests/CollabsAccountRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/account/client/requests/LandingPagesAccountRequest.d.mts

@@ -10,4 +10,5 @@ export interface LandingPagesAccountRequest {
     id: string;
     showInactive?: spyglass.LandingPagesAccountRequestShowInactive;
     limit?: number;
+    offset?: number;
 }

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

@@ -1,3 +1,5 @@
+export type { CampaignsAccountRequest } from './CampaignsAccountRequest.mjs';
+export type { CollabsAccountRequest } from './CollabsAccountRequest.mjs';
 export type { GetAccountRequest } from './GetAccountRequest.mjs';
 export type { IndexAccountRequest } from './IndexAccountRequest.mjs';
 export type { IndexStatusAccountRequest } from './IndexStatusAccountRequest.mjs';

package/dist/esm/api/resources/account/types/CampaignsAccountRequestDatePreset.d.mts

@@ -0,0 +1,17 @@
+export declare const CampaignsAccountRequestDatePreset: {
+    readonly Today: "today";
+    readonly Yesterday: "yesterday";
+    readonly Last3Days: "last-3-days";
+    readonly Last7Days: "last-7-days";
+    readonly ThisWeek: "this-week";
+    readonly LastWeek: "last-week";
+    readonly Last14Days: "last-14-days";
+    readonly Last30Days: "last-30-days";
+    readonly ThisMonth: "this-month";
+    readonly LastMonth: "last-month";
+    readonly Last3Months: "last-3-months";
+    readonly Last6Months: "last-6-months";
+    readonly YearToDate: "year-to-date";
+    readonly LastYear: "last-year";
+};
+export type CampaignsAccountRequestDatePreset = (typeof CampaignsAccountRequestDatePreset)[keyof typeof CampaignsAccountRequestDatePreset];

package/dist/esm/api/resources/account/types/CampaignsAccountRequestDatePreset.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+export const CampaignsAccountRequestDatePreset = {
+    Today: 'today',
+    Yesterday: 'yesterday',
+    Last3Days: 'last-3-days',
+    Last7Days: 'last-7-days',
+    ThisWeek: 'this-week',
+    LastWeek: 'last-week',
+    Last14Days: 'last-14-days',
+    Last30Days: 'last-30-days',
+    ThisMonth: 'this-month',
+    LastMonth: 'last-month',
+    Last3Months: 'last-3-months',
+    Last6Months: 'last-6-months',
+    YearToDate: 'year-to-date',
+    LastYear: 'last-year',
+};

package/dist/esm/api/resources/account/types/CampaignsAccountRequestSortBy.d.mts

@@ -0,0 +1,5 @@
+export declare const CampaignsAccountRequestSortBy: {
+    readonly MostRecent: "MOST_RECENT";
+    readonly HighestVelocity: "HIGHEST_VELOCITY";
+};
+export type CampaignsAccountRequestSortBy = (typeof CampaignsAccountRequestSortBy)[keyof typeof CampaignsAccountRequestSortBy];

package/dist/esm/api/resources/account/types/CampaignsAccountRequestSortBy.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const CampaignsAccountRequestSortBy = {
+    MostRecent: 'MOST_RECENT',
+    HighestVelocity: 'HIGHEST_VELOCITY',
+};

package/dist/esm/api/resources/account/types/CampaignsAccountRequestType.d.mts

@@ -0,0 +1,5 @@
+export declare const CampaignsAccountRequestType: {
+    readonly Campaign: "CAMPAIGN";
+    readonly Offer: "OFFER";
+};
+export type CampaignsAccountRequestType = (typeof CampaignsAccountRequestType)[keyof typeof CampaignsAccountRequestType];

package/dist/esm/api/resources/account/types/CampaignsAccountRequestType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const CampaignsAccountRequestType = {
+    Campaign: 'CAMPAIGN',
+    Offer: 'OFFER',
+};

package/dist/esm/api/resources/account/types/CampaignsAccountResponse.d.mts

@@ -0,0 +1,20 @@
+export interface CampaignsAccountResponse {
+    count: number;
+    campaigns: CampaignsAccountResponse.Campaigns.Item[];
+}
+export declare namespace CampaignsAccountResponse {
+    type Campaigns = Campaigns.Item[];
+    namespace Campaigns {
+        interface Item {
+            id: string;
+            type: string;
+            category: string | null;
+            title: string;
+            summary: string | null;
+            velocityScore: number | null;
+            startAt: string;
+            mediaCount?: number | undefined;
+            launches7d: number;
+        }
+    }
+}

package/dist/esm/api/resources/account/types/CampaignsAccountResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/account/types/CollabsAccountResponse.d.mts

@@ -0,0 +1,14 @@
+export interface CollabsAccountResponse {
+    count: number;
+    collabs: CollabsAccountResponse.Collabs.Item[];
+}
+export declare namespace CollabsAccountResponse {
+    type Collabs = Collabs.Item[];
+    namespace Collabs {
+        interface Item {
+            name: string;
+            profileUrl: string;
+            mediaCount: number;
+        }
+    }
+}

package/dist/esm/api/resources/account/types/CollabsAccountResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/account/types/InsightsAccountResponse.d.mts

@@ -8,16 +8,6 @@ export type InsightsAccountResponse = {
 } | {
     type: 'HOOK' | 'TARGET_PERSONA' | 'AD_ANGLE';
     count: number;
-    buckets: {
-        year: number;
-        week: number;
-        clusters: {
-            id: string;
-            label: string;
-            rawDelta: number;
-            percentDelta: number | null;
-        }[];
-    }[];
     totals: {
         id: string;
         label: string;

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

@@ -1,3 +1,8 @@
+export * from './CampaignsAccountRequestDatePreset.mjs';
+export * from './CampaignsAccountRequestSortBy.mjs';
+export * from './CampaignsAccountRequestType.mjs';
+export * from './CampaignsAccountResponse.mjs';
+export * from './CollabsAccountResponse.mjs';
 export * from './GetAccountResponse.mjs';
 export * from './IndexAccountResponse.mjs';
 export * from './IndexStatusAccountResponse.mjs';

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

@@ -1,3 +1,8 @@
+export * from './CampaignsAccountRequestDatePreset.mjs';
+export * from './CampaignsAccountRequestSortBy.mjs';
+export * from './CampaignsAccountRequestType.mjs';
+export * from './CampaignsAccountResponse.mjs';
+export * from './CollabsAccountResponse.mjs';
 export * from './GetAccountResponse.mjs';
 export * from './IndexAccountResponse.mjs';
 export * from './IndexStatusAccountResponse.mjs';

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.9";
+export declare const SDK_VERSION = "0.1.10";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = '0.1.9';
+export const SDK_VERSION = '0.1.10';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglasshq/sdk",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "private": false,
   "repository": {
     "type": "git",

package/reference.md

@@ -24,7 +24,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 +33,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,7 +45,7 @@ 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.
 
@@ -125,7 +125,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 +134,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,7 +146,7 @@ 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.
 
@@ -290,7 +290,7 @@ 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.
 
@@ -439,7 +439,7 @@ 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.
 
@@ -515,7 +515,7 @@ 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>
@@ -589,7 +589,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>
@@ -643,6 +643,148 @@ await client.account.insights({
 </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>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**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>
+
+<dl>
+<dd>
+
+**request:** `spyglass.CollabsAccountRequest`
+
+</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">landingPages</a>({ ...params }) -> spyglass.LandingPagesAccountResponse</code></summary>
 <dl>
 <dd>
@@ -659,7 +801,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>