@getlatedev/node 0.2.1411 → 0.2.1413

package/src/generated/types.gen.ts

@@ -4424,6 +4424,10 @@ export type CampaignReport = {
          */
         total: number;
     };
+    /**
+     * The campaign engagement types summed over the same submissions.
+     */
+    engagements: number;
     submissions: CampaignSubmissionCounts;
     /**
      * Top 10 participants by payable, settling and settled cents.
@@ -4451,6 +4455,15 @@ export type CampaignReport = {
     }>;
 };
 
+export type CampaignResultMetric = {
+    key: string;
+    label: string;
+    kind: 'count' | 'money';
+    currency: (string) | null;
+};
+
+export type kind4 = 'count' | 'money';
+
 export type CampaignSettlement = {
     /**
      * The ledger settlement entry.
@@ -4521,6 +4534,10 @@ export type CampaignSubmission = {
      * Views that count toward earnings: every view the platform reports for the post, including those before submission, read at the tracking window end at the latest: once the window completes or is cancelled, the last read at or before its end is final and this value stops moving.
      */
     viewsEligible: (number) | null;
+    /**
+     * The campaign engagement types summed at the latest read (all four on a views campaign), frozen at the tracking window end like `viewsEligible`. An `engagements` campaign earns on this count.
+     */
+    engagementsLatest: (number) | null;
     lastAccruedViews: number;
     accruedCents: number;
     approvedCents: number;
@@ -6471,7 +6488,7 @@ export type CreatorCampaignCaps = {
  *
  * Every type carries `budgetCents`, the most the campaign can pay out in total. Once earnings reach it, the campaign stops accruing and `creator_campaign.budget_exhausted` fires.
  *
- * - `cpm`: `ratePer1kCents` per 1,000 eligible views, earned from `minViewsToEarn` views on, capped per post by `maxPayoutPerClipCents`.
+ * - `cpm`: `ratePer1kCents` per 1,000 of the counted `metric` (views by default), earned once a post reaches `minViewsToEarn` of it, capped per post by `maxPayoutPerClipCents`.
  * - `per_post`: `perApprovedPostCents` for each approved post, at most `maxPostsPerParticipant` per participant.
  * - `pool`: `budgetCents` is split at close among approved posts by eligible views; a post needs `minViewsToQualify` views to share.
  *
@@ -6480,12 +6497,28 @@ export type CreatorCampaignEconomics = CreatorCampaignEconomicsCpm | CreatorCamp
 
 export type CreatorCampaignEconomicsCpm = {
     type: 'cpm';
+    /**
+     * What the rate pays on. `engagements` counts the `engagementTypes` as each platform reports them, and `minViewsToEarn` then applies to engagements. Fixed once the campaign leaves draft.
+     */
+    metric?: 'views' | 'engagements';
+    /**
+     * With `metric: engagements`, the engagements that count. Missing means all four, and sending it on a views campaign answers 400. YouTube reports likes and comments only, Facebook and Threads have no saves, and Pinterest reports saves only.
+     */
+    engagementTypes?: Array<('likes' | 'comments' | 'shares' | 'saves')>;
     ratePer1kCents: number;
+    /**
+     * The count a post must reach before it earns, in the campaign metric (views or engagements).
+     */
     minViewsToEarn: number;
     maxPayoutPerClipCents?: number;
     budgetCents: number;
 };
 
+/**
+ * What the rate pays on. `engagements` counts the `engagementTypes` as each platform reports them, and `minViewsToEarn` then applies to engagements. Fixed once the campaign leaves draft.
+ */
+export type metric2 = 'views' | 'engagements';
+
 export type CreatorCampaignEconomicsPerPost = {
     type: 'per_post';
     perApprovedPostCents: number;
@@ -6542,6 +6575,14 @@ export type CreatorPortalCampaign = {
  */
 export type CreatorPortalEconomics = {
     type: 'cpm';
+    /**
+     * What the rate pays on. Missing means views.
+     */
+    metric?: 'views' | 'engagements';
+    /**
+     * The engagements that count. Missing means all four.
+     */
+    engagementTypes?: Array<('likes' | 'comments' | 'shares' | 'saves')>;
     ratePer1kCents: number;
     minViewsToEarn: number;
     maxPayoutPerClipCents?: number;
@@ -6562,7 +6603,7 @@ export type CreatorPortalInvite = {
     campaign: CreatorPortalCampaign;
 };
 
-export type kind4 = 'invite';
+export type kind5 = 'invite';
 
 export type CreatorPortalParticipant = {
     kind: 'participant';
@@ -6608,7 +6649,7 @@ export type CreatorPortalParticipant = {
     payouts: CreatorPortalPayoutSetup;
 };
 
-export type kind5 = 'participant';
+export type kind6 = 'participant';
 
 export type CreatorPortalPayoutEntry = {
     id: string;
@@ -6662,6 +6703,10 @@ export type CreatorPortalSubmission = {
      * Latest view count read for the post.
      */
     views: number;
+    /**
+     * The campaign engagement types summed at the latest read. Null until the post is read.
+     */
+    engagements: (number) | null;
     earnedCents: number;
     rejectReason: (string) | null;
     /**
@@ -8629,7 +8674,7 @@ export type FileItem = {
     trashed: boolean;
 };
 
-export type kind6 = 'file' | 'folder';
+export type kind7 = 'file' | 'folder';
 
 export type FilePickerSession = {
     /**
@@ -9979,7 +10024,7 @@ export type ImessageSenderLifecycle = {
     createdAt?: string;
 };
 
-export type kind7 = 'phone' | 'email';
+export type kind8 = 'phone' | 'email';
 
 export type region = 'US' | 'GB';
 
@@ -10596,7 +10641,7 @@ export type InstagramDemographicsResponse = {
     note?: string;
 };
 
-export type metric2 = 'follower_demographics' | 'engaged_audience_demographics';
+export type metric3 = 'follower_demographics' | 'engaged_audience_demographics';
 
 /**
  * The timeframe used for demographic data
@@ -10933,7 +10978,7 @@ export type InstagramVideoFallback = {
     };
 };
 
-export type kind8 = 'instagram_video_reuploaded' | 'instagram_video_rehosted_copy';
+export type kind9 = 'instagram_video_reuploaded' | 'instagram_video_rehosted_copy';
 
 /**
  * A Google Search keyword: a bare string (BROAD match), or an object naming the match type.
@@ -15441,7 +15486,7 @@ export type platform15 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | '
 /**
  * Platform-native flavor of the tag (Meta: `pixel`).
  */
-export type kind9 = 'pixel' | 'tag' | 'insight_tag';
+export type kind10 = 'pixel' | 'tag' | 'insight_tag';
 
 /**
  * One health check the platform runs on a tracking tag.
@@ -18040,6 +18085,14 @@ export type WebhookPayloadCampaignSubmission = {
         platformPostUrl: (string) | null;
         status: string;
         viewsAtSubmission: (number) | null;
+        /**
+         * Views that count toward earnings at the latest read.
+         */
+        viewsEligible: (number) | null;
+        /**
+         * The campaign engagement types summed at the latest read. An engagements campaign earns on this count.
+         */
+        engagementsLatest: (number) | null;
         flags: Array<{
             code: string;
             detail: string;
@@ -50608,6 +50661,149 @@ export type ListAdRuleRunsError = (ErrorResponse | {
     error?: string;
 });
 
+export type UploadCampaignResultsData = {
+    body: {
+        rows: Array<{
+            /**
+             * The day, at most 400 days ago.
+             */
+            date: string;
+            /**
+             * The platform campaign id.
+             */
+            campaignId?: string;
+            /**
+             * The `utm_campaign` value on the campaign's ads.
+             */
+            utmCampaign?: string;
+            /**
+             * The campaign's name, matched case-insensitively.
+             */
+            campaignName?: string;
+            /**
+             * Platform ad account id. Narrows matching to one ad account.
+             */
+            adAccountId?: string;
+            /**
+             * Metric key (snake_case, up to 40 characters) to a non-negative number. 1 to 20 per row.
+             */
+            values: {
+                [key: string]: (number);
+            };
+        }>;
+    };
+    headers?: {
+        /**
+         * A retry with the same key and body replays the first response instead of uploading twice.
+         */
+        'Idempotency-Key'?: string;
+    };
+};
+
+export type UploadCampaignResultsResponse = ({
+    uploadId: string;
+    rows: number;
+    status: 'queued';
+});
+
+export type UploadCampaignResultsError = (ErrorResponse | unknown);
+
+export type ListCampaignResultsData = {
+    query: {
+        /**
+         * Comma-separated platform campaign ids, at most 500. Omit for all campaigns.
+         */
+        campaignIds?: string;
+        /**
+         * `nextCursor` from the previous page.
+         */
+        cursor?: string;
+        fromDate: string;
+        /**
+         * Campaigns per page.
+         */
+        limit?: number;
+        /**
+         * Inclusive. At most 400 days after `fromDate`.
+         */
+        toDate: string;
+    };
+};
+
+export type ListCampaignResultsResponse = ({
+    fromDate: string;
+    toDate: string;
+    campaigns: Array<{
+        platform: string;
+        adAccountId: string;
+        campaignId: string;
+        values: {
+            [key: string]: (number);
+        };
+    }>;
+    nextCursor: (string) | null;
+});
+
+export type ListCampaignResultsError = (ErrorResponse);
+
+export type GetCampaignResultsUploadData = {
+    path: {
+        uploadId: string;
+    };
+};
+
+export type GetCampaignResultsUploadResponse = ({
+    uploadId: string;
+    status: 'queued' | 'done' | 'failed';
+    source: 'api' | 'csv' | 'hubspot';
+    rowsReceived: number;
+    rowsMatched: number;
+    rowsUnmatched: number;
+    unmatched: Array<{
+        /**
+         * The row's position in the request.
+         */
+        index?: number;
+        /**
+         * The campaign id, UTM or name the row gave.
+         */
+        campaign?: string;
+        reason?: 'no_campaign' | 'ambiguous';
+    }>;
+    createdAt: string;
+    completedAt: (string) | null;
+});
+
+export type GetCampaignResultsUploadError = (ErrorResponse | {
+    error?: string;
+});
+
+export type ListCampaignResultMetricsResponse = ({
+    metrics: Array<CampaignResultMetric>;
+});
+
+export type ListCampaignResultMetricsError = (ErrorResponse);
+
+export type SetCampaignResultMetricData = {
+    body: {
+        label: string;
+        kind: 'count' | 'money';
+        /**
+         * ISO 4217, money metrics only.
+         */
+        currency?: (string) | null;
+    };
+    path: {
+        key: string;
+    };
+};
+
+export type SetCampaignResultMetricResponse = ({
+    metric: CampaignResultMetric;
+});
+
+export type SetCampaignResultMetricError = (ErrorResponse);
+
 export type ListAdCampaignsData = {
     query?: {
         /**
@@ -68231,7 +68427,7 @@ export type ListCampaignSubmissionsData = {
         /**
          * What to sort by. Posts with no value to sort by (not read yet, not scored) come last in either direction.
          */
-        sort?: 'submittedAt' | 'viewsEligible' | 'earnedCents' | 'authenticityScore';
+        sort?: 'submittedAt' | 'viewsEligible' | 'engagementsLatest' | 'earnedCents' | 'authenticityScore';
         status?: 'received' | 'tracking' | 'pending_review' | 'approved' | 'rejected' | 'expired' | 'withdrawn';
     };
 };