@zernio/node 0.2.964 → 0.2.966

package/src/generated/types.gen.ts

@@ -7015,6 +7015,28 @@ export type MetaAdsPlatformData = {
     lifetimeMinSpendTarget?: number;
 };
 
+export type MetaAssignedUser = {
+    /**
+     * Business-scoped user id.
+     */
+    id?: string;
+    name?: string;
+    tasks?: Array<(string)>;
+};
+
+export type MetaBusinessUser = {
+    /**
+     * Business-scoped user id.
+     */
+    id?: string;
+    name?: string;
+    email?: string;
+    /**
+     * Meta role in the portfolio, e.g. ADMIN or EMPLOYEE.
+     */
+    role?: string;
+};
+
 export type MetaCatalogProduct = {
     /**
      * Meta product item ID (use in the product endpoints)
@@ -7269,6 +7291,34 @@ export type MetaLeadForm = {
 
 export type style = 'LIST_STYLE' | 'PARAGRAPH_STYLE';
 
+export type MetaPageOwnership = {
+    /**
+     * Facebook Page id.
+     */
+    id?: string;
+    name?: string;
+    /**
+     * Business portfolio that owns the Page; null when the Page is outside any portfolio.
+     */
+    business?: {
+        id?: string;
+        name?: string;
+    } | null;
+    /**
+     * Instagram professional account linked to the Page; null when none is linked.
+     */
+    instagramBusinessAccount?: {
+        id?: string;
+        username?: string;
+    } | null;
+};
+
+export type MetaPagePartner = {
+    businessId?: string;
+    name?: string;
+    permittedTasks?: Array<(string)>;
+};
+
 /**
  * Meta placement asset customization: pin a SPECIFIC asset (image OR video) to each
  * placement group on a SINGLE ad (e.g. a 4:5 image on Feed and a 9:16 image on
@@ -8740,26 +8790,50 @@ export type SocialAccount = {
 export type platform10 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'sms' | 'phone' | 'rcs';
 
 /**
- * A tracking tag's install on a connected store (Shopify web pixel).
+ * A tracking tag's install on a connected store: a Shopify web pixel, or a Custom HTML widget on a WordPress site. Fields marked Shopify or WordPress are present only for that platform.
  */
 export type StorePixelInstall = {
     storeAccountId?: string;
-    platform?: 'shopify';
-    shopDomain?: string;
+    platform?: 'shopify' | 'wordpress';
     /**
-     * True when this tag is the pixel the store fires.
+     * Shopify: this tag is the pixel the store fires. WordPress: the Zernio widget for this tag is in an active widget area with its script intact.
      */
     installed?: boolean;
     /**
-     * The Meta pixel the store fires now (may be a different tag), or null.
+     * Shopify only.
+     */
+    shopDomain?: string;
+    /**
+     * Shopify only: the Meta pixel the store fires now (may be a different tag), or null.
      */
     installedTagId?: (string) | null;
     /**
-     * Shopify web pixel id, or null when nothing is installed.
+     * Shopify only: web pixel id, or null when nothing is installed.
      */
     webPixelId?: (string) | null;
+    /**
+     * WordPress only.
+     */
+    siteUrl?: string;
+    /**
+     * WordPress only.
+     */
+    method?: 'wordpress_widget';
+    /**
+     * WordPress only: widget id, e.g. `custom_html-3`.
+     */
+    widgetId?: (string) | null;
+    /**
+     * WordPress only: widget area holding the widget.
+     */
+    sidebarId?: (string) | null;
 };
 
+/**
+ * WordPress only.
+ */
+export type method = 'wordpress_widget';
+
 /**
  * Normalized, platform-agnostic ad-targeting spec. Every field is optional, an
  * empty object targets the platform's default broadest audience. Field names are
@@ -9315,6 +9389,11 @@ export type platform11 = 'metaads';
  */
 export type kind2 = 'pixel' | 'tag' | 'insight_tag';
 
+/**
+ * Why a pixel cannot be installed on a WordPress site.
+ */
+export type TrackingTagInstallBlockedReason = 'insufficient_permissions' | 'scripts_stripped' | 'wordpress_com_plan' | 'no_widget_areas' | 'widgets_api_unavailable';
+
 /**
  * X-specific post options. The article field creates a long-form X Article and is mutually exclusive with tweet media and tweet-only options. Geo-restriction applies at the media level: media is hidden outside the specified countries while tweet text remains visible.
  *
@@ -20954,6 +21033,80 @@ export type ResyncPageWebhookSubscriptionError = (ErrorResponse | {
     error?: string;
 } | unknown);
 
+export type ListBusinessPartnersData = {
+    path: {
+        /**
+         * Zernio SocialAccount id of the Facebook or Instagram account.
+         */
+        accountId: string;
+    };
+};
+
+export type ListBusinessPartnersResponse = ({
+    page?: MetaPageOwnership;
+    partners?: Array<MetaPagePartner>;
+});
+
+export type ListBusinessPartnersError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
+export type GrantBusinessPartnerData = {
+    body: {
+        /**
+         * Meta business portfolio id of the partner (numeric string).
+         */
+        businessId: string;
+        /**
+         * Tasks granted on the Page. Defaults to ADVERTISE and ANALYZE.
+         */
+        permittedTasks?: Array<('MANAGE' | 'CREATE_CONTENT' | 'MODERATE' | 'MESSAGING' | 'ADVERTISE' | 'ANALYZE')>;
+    };
+    path: {
+        /**
+         * Zernio SocialAccount id of the Facebook or Instagram account.
+         */
+        accountId: string;
+    };
+};
+
+export type GrantBusinessPartnerResponse = ({
+    page?: MetaPageOwnership;
+    partner?: {
+        businessId?: string;
+        permittedTasks?: Array<(string)>;
+    };
+});
+
+export type GrantBusinessPartnerError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
+export type RevokeBusinessPartnerData = {
+    path: {
+        /**
+         * Zernio SocialAccount id of the Facebook or Instagram account.
+         */
+        accountId: string;
+    };
+    query: {
+        /**
+         * Meta business portfolio id of the partner (numeric string).
+         */
+        businessId: string;
+    };
+};
+
+export type RevokeBusinessPartnerResponse = ({
+    pageId?: string;
+    businessId?: string;
+    revoked?: boolean;
+});
+
+export type RevokeBusinessPartnerError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
 export type GetFacebookPagesData = {
     path: {
         accountId: string;
@@ -40529,6 +40682,118 @@ export type ListMetaBusinessesError = (unknown | {
     error?: string;
 } | ErrorResponse);
 
+export type ListMetaBusinessUsersData = {
+    query: {
+        /**
+         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Meta business portfolio id.
+         */
+        businessId: string;
+    };
+};
+
+export type ListMetaBusinessUsersResponse = ({
+    businessId?: string;
+    users?: Array<MetaBusinessUser>;
+    systemUsers?: Array<MetaBusinessUser>;
+});
+
+export type ListMetaBusinessUsersError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
+export type ListPageUsersData = {
+    query: {
+        /**
+         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Business portfolio whose people to list.
+         */
+        businessId: string;
+        /**
+         * Facebook Page id.
+         */
+        pageId: string;
+    };
+};
+
+export type ListPageUsersResponse = ({
+    pageId?: string;
+    businessId?: string;
+    users?: Array<MetaAssignedUser>;
+});
+
+export type ListPageUsersError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
+export type AssignPageUserData = {
+    body: {
+        /**
+         * Zernio SocialAccount id used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Facebook Page id.
+         */
+        pageId: string;
+        /**
+         * Business portfolio the user belongs to.
+         */
+        businessId: string;
+        /**
+         * Business-scoped user id from GET /v1/ads/businesses/users.
+         */
+        userId: string;
+        tasks: Array<('MANAGE' | 'CREATE_CONTENT' | 'MODERATE' | 'MESSAGING' | 'ADVERTISE' | 'ANALYZE')>;
+    };
+};
+
+export type AssignPageUserResponse = ({
+    pageId?: string;
+    businessId?: string;
+    user?: {
+        id?: string;
+        tasks?: Array<(string)>;
+    };
+});
+
+export type AssignPageUserError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
+export type RemovePageUserData = {
+    query: {
+        /**
+         * Zernio SocialAccount id used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Facebook Page id.
+         */
+        pageId: string;
+        /**
+         * Business-scoped user id.
+         */
+        userId: string;
+    };
+};
+
+export type RemovePageUserResponse = ({
+    pageId?: string;
+    userId?: string;
+    removed?: boolean;
+});
+
+export type RemovePageUserError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
 export type ListAdLabelsData = {
     query: {
         /**
@@ -42035,6 +42300,90 @@ export type UpdateAdAccountManagerLinkError = (ErrorResponse | {
     error?: string;
 } | unknown);
 
+export type ListAdAccountUsersData = {
+    query: {
+        /**
+         * Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Meta ad account id (act_<n>).
+         */
+        adAccountId: string;
+        /**
+         * Business portfolio whose people to list.
+         */
+        businessId: string;
+    };
+};
+
+export type ListAdAccountUsersResponse = ({
+    adAccountId?: string;
+    businessId?: string;
+    users?: Array<MetaAssignedUser>;
+});
+
+export type ListAdAccountUsersError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
+export type AssignAdAccountUserData = {
+    body: {
+        /**
+         * Zernio SocialAccount id used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Meta ad account id (act_<n>).
+         */
+        adAccountId: string;
+        /**
+         * Business-scoped user id from GET /v1/ads/businesses/users.
+         */
+        userId: string;
+        tasks: Array<('MANAGE' | 'ADVERTISE' | 'ANALYZE' | 'DRAFT')>;
+    };
+};
+
+export type AssignAdAccountUserResponse = ({
+    adAccountId?: string;
+    user?: {
+        id?: string;
+        tasks?: Array<(string)>;
+    };
+});
+
+export type AssignAdAccountUserError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
+export type RemoveAdAccountUserData = {
+    query: {
+        /**
+         * Zernio SocialAccount id used to resolve the Meta token.
+         */
+        accountId: string;
+        /**
+         * Meta ad account id (act_<n>).
+         */
+        adAccountId: string;
+        /**
+         * Business-scoped user id.
+         */
+        userId: string;
+    };
+};
+
+export type RemoveAdAccountUserResponse = ({
+    adAccountId?: string;
+    userId?: string;
+    removed?: boolean;
+});
+
+export type RemoveAdAccountUserError = (unknown | {
+    error?: string;
+} | ErrorResponse);
+
 export type GetAdAccountFinanceData = {
     query: {
         /**
@@ -42337,12 +42686,24 @@ export type UpdateAdAccountData = {
          * Meta ad account ID (act_...)
          */
         adAccountId: string;
+        /**
+         * New ad account name.
+         */
+        name?: string;
+        /**
+         * Account spend cap in whole currency units; null removes it.
+         */
+        spendCap?: (number) | null;
+        /**
+         * Restart the amount counted against the cap from zero. Cannot be combined with spendCap null.
+         */
+        resetAmountSpent?: boolean;
         /**
          * Legal entity benefiting from ads on this ad account
          */
-        defaultDsaBeneficiary: string;
+        defaultDsaBeneficiary?: string;
         /**
-         * Legal entity paying for ads on this ad account. Defaults to defaultDsaBeneficiary when omitted.
+         * Legal entity paying for ads on this ad account. Defaults to defaultDsaBeneficiary when omitted. Requires defaultDsaBeneficiary.
          */
         defaultDsaPayor?: string;
     };
@@ -42350,10 +42711,27 @@ export type UpdateAdAccountData = {
 
 export type UpdateAdAccountResponse = ({
     adAccountId?: string;
+    /**
+     * Present when defaultDsaBeneficiary was passed.
+     */
     dsaDefaults?: {
         beneficiary?: string;
         payor?: string;
     };
+    /**
+     * Present when name, spendCap or resetAmountSpent was passed.
+     */
+    settings?: {
+        name?: string;
+        currency?: string;
+        balance?: number;
+        amountSpent?: number;
+        spendCap?: (number) | null;
+        fundingSource?: {
+            displayString?: string;
+            type?: number;
+        } | null;
+    };
 });
 
 export type UpdateAdAccountError = (unknown | {
@@ -48609,9 +48987,17 @@ export type RemoveTrackingTagSharedAccountError = (unknown | {
 export type InstallTrackingTagOnStoreData = {
     body: {
         /**
-         * The connected Shopify account id (platform `shopify`).
+         * The connected Shopify (`shopify`) or WordPress (`wordpress`) account id.
          */
         storeAccountId: string;
+        /**
+         * WordPress only: widget area to use (see `install.preflight.sidebars` from GET). Defaults to a footer area.
+         */
+        sidebarId?: string;
+        /**
+         * WordPress only: fetch the homepage afterwards and report `homepageCheck`.
+         */
+        verifyHomepage?: boolean;
     };
     path: {
         accountId: string;
@@ -48626,15 +49012,36 @@ export type InstallTrackingTagOnStoreResponse = ({
     platform?: 'metaads';
     install?: (StorePixelInstall & {
     /**
-     * The pixel this install replaced on the store, if any.
+     * Shopify only: the pixel this install replaced on the store, if any.
      */
     replacedTagId?: (string) | null;
+    /**
+     * WordPress only: name of the widget area used.
+     */
+    sidebarName?: string;
+    /**
+     * WordPress only: false when an existing Zernio widget was updated.
+     */
+    created?: boolean;
+    /**
+     * WordPress only: whether the pixel appeared in the homepage HTML. `not_found` can be a stale page cache.
+     */
+    homepageCheck?: 'found' | 'not_found' | 'unreachable' | 'skipped';
 });
 });
 
 export type InstallTrackingTagOnStoreError = (ErrorResponse | {
     error?: string;
-} | unknown);
+} | unknown | {
+    /**
+     * What blocked the install and the manual alternative.
+     */
+    error?: string;
+    code?: 'tracking_tag_install_blocked';
+    details?: {
+        reason?: TrackingTagInstallBlockedReason;
+    };
+});
 
 export type GetTrackingTagStoreInstallData = {
     path: {
@@ -48646,7 +49053,7 @@ export type GetTrackingTagStoreInstallData = {
     };
     query: {
         /**
-         * The connected Shopify account id.
+         * The connected Shopify or WordPress account id.
          */
         storeAccountId: string;
     };
@@ -48654,7 +49061,28 @@ export type GetTrackingTagStoreInstallData = {
 
 export type GetTrackingTagStoreInstallResponse = ({
     platform?: 'metaads';
-    install?: StorePixelInstall;
+    install?: (StorePixelInstall & {
+    /**
+     * WordPress only.
+     */
+    preflight?: {
+        /**
+         * True when POST should be able to install.
+         */
+        ready?: boolean;
+        /**
+         * A TrackingTagInstallBlockedReason when an install would be blocked, else null.
+         */
+        reason?: (string) | null;
+        /**
+         * Active widget areas of the theme.
+         */
+        sidebars?: Array<{
+            id?: string;
+            name?: string;
+        }>;
+    };
+});
 });
 
 export type GetTrackingTagStoreInstallError = (ErrorResponse | {
@@ -48671,7 +49099,7 @@ export type RemoveTrackingTagFromStoreData = {
     };
     query: {
         /**
-         * The connected Shopify account id.
+         * The connected Shopify or WordPress account id.
          */
         storeAccountId: string;
     };
@@ -48679,7 +49107,12 @@ export type RemoveTrackingTagFromStoreData = {
 
 export type RemoveTrackingTagFromStoreResponse = ({
     platform?: 'metaads';
-    install?: StorePixelInstall;
+    install?: (StorePixelInstall & {
+    /**
+     * WordPress only: number of Zernio widgets deleted.
+     */
+    removed?: number;
+});
 });
 
 export type RemoveTrackingTagFromStoreError = (ErrorResponse | {