@spyglasshq/sdk 0.1.2 → 0.1.4

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

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

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

@@ -0,0 +1,5 @@
+export type { GetCommentsRequest } from "./GetCommentsRequest.mjs";
+export { SearchBrandsRequest } from "./SearchBrandsRequest.mjs";
+export { SearchCreatorsRequest } from "./SearchCreatorsRequest.mjs";
+export { SearchMediaRequest } from "./SearchMediaRequest.mjs";
+export type { SearchTaxonomiesRequest } from "./SearchTaxonomiesRequest.mjs";

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

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

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

@@ -1,3 +1,4 @@
+export * from "./client/index.mjs";
 export * from "./errors/index.mjs";
 export * from "./resources/index.mjs";
 export * from "./types/index.mjs";

package/dist/esm/api/index.mjs

@@ -1,3 +1,4 @@
+export * from "./client/index.mjs";
 export * from "./errors/index.mjs";
 export * from "./resources/index.mjs";
 export * from "./types/index.mjs";

package/dist/esm/api/resources/account/client/Client.d.mts

@@ -7,27 +7,26 @@ export declare namespace AccountClient {
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-/**
- * The API key's team: credits and the billing period.
- */
 export declare class AccountClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AccountClient.Options>;
     constructor(options: AccountClient.Options);
     /**
-     * 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`.
+     * 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.
-     * This call is free and does not use credits. It still responds when
-     * the team is out of credits.
+     * 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.
      *
+     * @param {spyglass.GetAccountRequest} request
      * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link spyglass.BadRequestError}
      * @throws {@link spyglass.UnauthorizedError}
      * @throws {@link spyglass.PaymentRequiredError}
      * @throws {@link spyglass.ForbiddenError}
+     * @throws {@link spyglass.NotFoundError}
      * @throws {@link spyglass.MethodNotAllowedError}
      * @throws {@link spyglass.TooManyRequestsError}
      * @throws {@link spyglass.InternalServerError}
@@ -35,8 +34,129 @@ export declare class AccountClient {
      * @throws {@link errors.SpyglassTimeoutError}
      *
      * @example
-     *     await client.account.getCreditUsage()
+     *     await client.account.get({
+     *         id: "id"
+     *     })
      */
-    getCreditUsage(requestOptions?: AccountClient.RequestOptions): core.HttpResponsePromise<spyglass.GetCreditUsageResponse>;
-    private __getCreditUsage;
+    get(request: spyglass.GetAccountRequest, requestOptions?: AccountClient.RequestOptions): core.HttpResponsePromise<spyglass.GetAccountResponse>;
+    private __get;
+    /**
+     * 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.
+     *
+     * `maxDaysBack` filters both the weekly bucket series and ranked
+     * `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.
+     *
+     * @param {spyglass.InsightsAccountRequest} request
+     * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link spyglass.BadRequestError}
+     * @throws {@link spyglass.UnauthorizedError}
+     * @throws {@link spyglass.PaymentRequiredError}
+     * @throws {@link spyglass.ForbiddenError}
+     * @throws {@link spyglass.NotFoundError}
+     * @throws {@link spyglass.MethodNotAllowedError}
+     * @throws {@link spyglass.TooManyRequestsError}
+     * @throws {@link spyglass.InternalServerError}
+     * @throws {@link errors.SpyglassError}
+     * @throws {@link errors.SpyglassTimeoutError}
+     *
+     * @example
+     *     await client.account.insights({
+     *         id: "id",
+     *         type: "HOOK"
+     *     })
+     */
+    insights(request: spyglass.InsightsAccountRequest, requestOptions?: AccountClient.RequestOptions): core.HttpResponsePromise<spyglass.InsightsAccountResponse>;
+    private __insights;
+    /**
+     * 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.
+     *
+     * @param {spyglass.LandingPagesAccountRequest} request
+     * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link spyglass.BadRequestError}
+     * @throws {@link spyglass.UnauthorizedError}
+     * @throws {@link spyglass.PaymentRequiredError}
+     * @throws {@link spyglass.ForbiddenError}
+     * @throws {@link spyglass.NotFoundError}
+     * @throws {@link spyglass.MethodNotAllowedError}
+     * @throws {@link spyglass.TooManyRequestsError}
+     * @throws {@link spyglass.InternalServerError}
+     * @throws {@link errors.SpyglassError}
+     * @throws {@link errors.SpyglassTimeoutError}
+     *
+     * @example
+     *     await client.account.landingPages({
+     *         id: "id"
+     *     })
+     */
+    landingPages(request: spyglass.LandingPagesAccountRequest, requestOptions?: AccountClient.RequestOptions): core.HttpResponsePromise<spyglass.LandingPagesAccountResponse>;
+    private __landingPages;
+    /**
+     * Look up a brand by website URL, or start indexing it if we do not
+     * have it yet. Pass a single `websiteUrl`. Instagram and TikTok
+     * profile URLs are accepted and resolved as creators.
+     *
+     * This endpoint does not consume credits. An existing brand returns
+     * `status: "already_exists"`. A new brand is created and sync is
+     * queued, returning `status: "indexing"` and the new `brandId`.
+     *
+     * Limited to 50 requests per minute per user.
+     * This call is free.
+     *
+     * @param {spyglass.IndexAccountRequest} request
+     * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link spyglass.BadRequestError}
+     * @throws {@link spyglass.UnauthorizedError}
+     * @throws {@link spyglass.ForbiddenError}
+     * @throws {@link spyglass.MethodNotAllowedError}
+     * @throws {@link spyglass.ContentTooLargeError}
+     * @throws {@link spyglass.TooManyRequestsError}
+     * @throws {@link spyglass.InternalServerError}
+     * @throws {@link errors.SpyglassError}
+     * @throws {@link errors.SpyglassTimeoutError}
+     *
+     * @example
+     *     await client.account.index({
+     *         websiteUrl: "https://www.nike.com"
+     *     })
+     */
+    index(request: spyglass.IndexAccountRequest, requestOptions?: AccountClient.RequestOptions): core.HttpResponsePromise<spyglass.IndexAccountResponse>;
+    private __index;
+    /**
+     * Poll whether a brand finished indexing after POST /account/index.
+     *
+     * Limited to 300 requests per minute per user.
+     * This call is free.
+     *
+     * @param {spyglass.IndexStatusAccountRequest} request
+     * @param {AccountClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link spyglass.BadRequestError}
+     * @throws {@link spyglass.UnauthorizedError}
+     * @throws {@link spyglass.ForbiddenError}
+     * @throws {@link spyglass.NotFoundError}
+     * @throws {@link spyglass.MethodNotAllowedError}
+     * @throws {@link spyglass.TooManyRequestsError}
+     * @throws {@link spyglass.InternalServerError}
+     * @throws {@link errors.SpyglassError}
+     * @throws {@link errors.SpyglassTimeoutError}
+     *
+     * @example
+     *     await client.account.indexStatus({
+     *         id: "id"
+     *     })
+     */
+    indexStatus(request: spyglass.IndexStatusAccountRequest, requestOptions?: AccountClient.RequestOptions): core.HttpResponsePromise<spyglass.IndexStatusAccountResponse>;
+    private __indexStatus;
 }