@getlatedev/node 0.2.1412 → 0.2.1414

package/src/generated/types.gen.ts

@@ -4423,6 +4423,10 @@ export type CampaignReport = {
          * Latest view counts.
          */
         total: number;
+        /**
+         * Views from ads, on YouTube and X posts.
+         */
+        paid: number;
     };
     /**
      * The campaign engagement types summed over the same submissions.
@@ -4455,6 +4459,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.
@@ -4529,6 +4542,14 @@ export type CampaignSubmission = {
      * 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;
+    /**
+     * Views from ads the creator ran: YouTube views from the advertising traffic source, X impressions beyond the organic ones. Null on other platforms and before the first read. On an organic-only campaign `viewsEligible` is the latest views minus these.
+     */
+    viewsPaid: (number) | null;
+    /**
+     * When `viewsPaid` was last read. YouTube refreshes every 6 hours and reports ad views up to 2 days late; X about once a day while the post is under 30 days old.
+     */
+    paidViewsReadAt: (string) | null;
     lastAccruedViews: number;
     accruedCents: number;
     approvedCents: number;
@@ -4618,12 +4639,12 @@ export type CampaignSubmissionDetail = CampaignSubmission & {
 };
 
 export type CampaignSubmissionFlag = {
-    code: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap';
+    code: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap' | 'paid_views' | 'organic_unverified';
     detail: string;
     raisedAt: string;
 };
 
-export type code = 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap';
+export type code = 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap' | 'paid_views' | 'organic_unverified';
 
 /**
  * Actions taken on the matched comment itself (comment trigger only; ignored on the
@@ -6496,6 +6517,10 @@ export type CreatorCampaignEconomicsCpm = {
      * 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')>;
+    /**
+     * Count only organic views: views from ads the creator ran do not earn. Every campaign platform must be YouTube or X, which report ad views per post, or the request answers 400. A post earns nothing until its ad views were first read.
+     */
+    organicViewsOnly?: boolean;
     ratePer1kCents: number;
     /**
      * The count a post must reach before it earns, in the campaign metric (views or engagements).
@@ -6521,6 +6546,10 @@ export type CreatorCampaignEconomicsPool = {
     type: 'pool';
     budgetCents: number;
     minViewsToQualify: number;
+    /**
+     * Count only organic views: views from ads the creator ran do not earn. Every campaign platform must be YouTube or X, which report ad views per post, or the request answers 400. A post earns nothing until its ad views were first read.
+     */
+    organicViewsOnly?: boolean;
 };
 
 /**
@@ -6574,6 +6603,10 @@ export type CreatorPortalEconomics = {
      * The engagements that count. Missing means all four.
      */
     engagementTypes?: Array<('likes' | 'comments' | 'shares' | 'saves')>;
+    /**
+     * Only organic views count; views from ads do not.
+     */
+    organicViewsOnly?: boolean;
     ratePer1kCents: number;
     minViewsToEarn: number;
     maxPayoutPerClipCents?: number;
@@ -6585,6 +6618,10 @@ export type CreatorPortalEconomics = {
     type: 'pool';
     poolCents: number;
     minViewsToQualify: number;
+    /**
+     * Only organic views count; views from ads do not.
+     */
+    organicViewsOnly?: boolean;
 };
 
 export type type10 = 'cpm';
@@ -6594,7 +6631,7 @@ export type CreatorPortalInvite = {
     campaign: CreatorPortalCampaign;
 };
 
-export type kind4 = 'invite';
+export type kind5 = 'invite';
 
 export type CreatorPortalParticipant = {
     kind: 'participant';
@@ -6640,7 +6677,7 @@ export type CreatorPortalParticipant = {
     payouts: CreatorPortalPayoutSetup;
 };
 
-export type kind5 = 'participant';
+export type kind6 = 'participant';
 
 export type CreatorPortalPayoutEntry = {
     id: string;
@@ -6698,6 +6735,10 @@ export type CreatorPortalSubmission = {
      * The campaign engagement types summed at the latest read. Null until the post is read.
      */
     engagements: (number) | null;
+    /**
+     * Views that came from ads the creator ran, on YouTube and X. Null where the platform does not report them or before the first read.
+     */
+    viewsFromAds: (number) | null;
     earnedCents: number;
     rejectReason: (string) | null;
     /**
@@ -8665,7 +8706,7 @@ export type FileItem = {
     trashed: boolean;
 };
 
-export type kind6 = 'file' | 'folder';
+export type kind7 = 'file' | 'folder';
 
 export type FilePickerSession = {
     /**
@@ -10015,7 +10056,7 @@ export type ImessageSenderLifecycle = {
     createdAt?: string;
 };
 
-export type kind7 = 'phone' | 'email';
+export type kind8 = 'phone' | 'email';
 
 export type region = 'US' | 'GB';
 
@@ -10969,7 +11010,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.
@@ -15477,7 +15518,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.
@@ -18084,6 +18125,10 @@ export type WebhookPayloadCampaignSubmission = {
          * The campaign engagement types summed at the latest read. An engagements campaign earns on this count.
          */
         engagementsLatest: (number) | null;
+        /**
+         * Views from ads, on YouTube and X. Null elsewhere or before the first read.
+         */
+        viewsPaid: (number) | null;
         flags: Array<{
             code: string;
             detail: string;
@@ -50652,6 +50697,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?: {
         /**
@@ -68260,7 +68448,7 @@ export type ListCampaignSubmissionsData = {
         campaignId: string;
     };
     query?: {
-        flag?: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap';
+        flag?: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap' | 'paid_views' | 'organic_unverified';
         limit?: number;
         maxScore?: number;
         minScore?: number;