@zernio/node 0.2.980 → 0.2.982

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3369,6 +3369,10 @@ export type ConversionEvent = {
3369
3369
  *
3370
3370
  */
3371
3371
  li_fat_id?: string;
3372
+ /**
3373
+ * Pinterest click ID (the `epik` URL param or `_epik` cookie). Sent to Pinterest as `click_id`, not hashed.
3374
+ */
3375
+ epik?: string;
3372
3376
  };
3373
3377
  };
3374
3378
  /**
@@ -9768,6 +9772,10 @@ export type TrackingTag = {
9768
9772
  * Unix seconds the tag was created.
9769
9773
  */
9770
9774
  creationTime?: number;
9775
+ /**
9776
+ * Customer data the tag matches automatically, where the platform reports it (Pinterest automatic enhanced match).
9777
+ */
9778
+ automaticMatchingFields?: Array<('em' | 'ph' | 'fn' | 'ln' | 'ge' | 'db' | 'ct' | 'st' | 'zp' | 'country' | 'external_id')>;
9771
9779
  /**
9772
9780
  * Business Manager id that owns the tag, or `null` when the tag lives
9773
9781
  * on a personal (non-BM) ad account. Such tags can't be shared with
@@ -9914,6 +9922,32 @@ export type TrackingTagEventInput = {
9914
9922
  */
9915
9923
  export type TrackingTagInstallBlockedReason = 'insufficient_permissions' | 'scripts_stripped' | 'wordpress_com_plan' | 'no_widget_areas' | 'widgets_api_unavailable';
9916
9924
 
9925
+ /**
9926
+ * Another business a tracking tag is shared with.
9927
+ */
9928
+ export type TrackingTagPartner = {
9929
+ /**
9930
+ * Partner business id.
9931
+ */
9932
+ id: string;
9933
+ name?: string;
9934
+ };
9935
+
9936
+ /**
9937
+ * A person or system user of the owning business with access to a tracking tag.
9938
+ */
9939
+ export type TrackingTagUser = {
9940
+ /**
9941
+ * Business-scoped user id (as listed by GET /v1/ads/businesses/users).
9942
+ */
9943
+ id: string;
9944
+ name?: string;
9945
+ /**
9946
+ * Platform permission names (Meta: `AA_ANALYZE`, `ADVERTISE`, `ANALYZE`, `EDIT`, `UPLOAD`).
9947
+ */
9948
+ tasks: Array<(string)>;
9949
+ };
9950
+
9917
9951
  /**
9918
9952
  * 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.
9919
9953
  *
@@ -47275,11 +47309,11 @@ export type ReplaceAdAudienceCompaniesError = (unknown | {
47275
47309
  export type GetConversionsQualityData = {
47276
47310
  query: {
47277
47311
  /**
47278
- * SocialAccount _id (must be a metaads account).
47312
+ * SocialAccount _id (a metaads or pinterestads account).
47279
47313
  */
47280
47314
  accountId: string;
47281
47315
  /**
47282
- * Meta pixel/dataset ID.
47316
+ * Meta pixel/dataset ID, or the numeric Pinterest ad account id.
47283
47317
  */
47284
47318
  destinationId: string;
47285
47319
  };
@@ -47311,7 +47345,7 @@ export type GetConversionsQualityError = (ErrorResponse | {
47311
47345
  export type SendConversionsData = {
47312
47346
  body: {
47313
47347
  /**
47314
- * SocialAccount ID (metaads, googleads, linkedinads, tiktokads, or openaiads).
47348
+ * SocialAccount ID (metaads, googleads, linkedinads, tiktokads, openaiads, or pinterestads).
47315
47349
  */
47316
47350
  accountId: string;
47317
47351
  /**
@@ -47319,13 +47353,13 @@ export type SendConversionsData = {
47319
47353
  * ID. For Google, the conversion action resource name. For
47320
47354
  * LinkedIn, the conversion rule ID or full
47321
47355
  * `urn:lla:llaPartnerConversion:{id}` URN. For OpenAI Ads, the
47322
- * pixel wire id.
47356
+ * pixel wire id. For Pinterest, the numeric ad account id.
47323
47357
  *
47324
47358
  */
47325
47359
  destinationId: string;
47326
47360
  events: Array<ConversionEvent>;
47327
47361
  /**
47328
- * Meta `test_event_code` passthrough. Ignored by Google, LinkedIn, and OpenAI Ads.
47362
+ * Meta `test_event_code` passthrough. On Pinterest any value sends the batch with `test=true` (validated, not recorded). Ignored by Google, LinkedIn, and OpenAI Ads.
47329
47363
  */
47330
47364
  testCode?: string;
47331
47365
  /**
@@ -47346,7 +47380,7 @@ export type SendConversionsData = {
47346
47380
  };
47347
47381
 
47348
47382
  export type SendConversionsResponse = ({
47349
- platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads' | 'openaiads';
47383
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads' | 'openaiads' | 'pinterestads';
47350
47384
  /**
47351
47385
  * Events accepted by the platform.
47352
47386
  */
@@ -47816,14 +47850,14 @@ export type UpdateCampaignConversionGoalsError = (ErrorResponse | {
47816
47850
  export type ListConversionDestinationsData = {
47817
47851
  path: {
47818
47852
  /**
47819
- * SocialAccount ID (metaads, googleads, linkedinads, tiktokads, or openaiads).
47853
+ * SocialAccount ID (metaads, googleads, linkedinads, tiktokads, openaiads, or pinterestads).
47820
47854
  */
47821
47855
  accountId: string;
47822
47856
  };
47823
47857
  };
47824
47858
 
47825
47859
  export type ListConversionDestinationsResponse = ({
47826
- platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads' | 'openaiads';
47860
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads' | 'openaiads' | 'pinterestads';
47827
47861
  destinations?: Array<{
47828
47862
  /**
47829
47863
  * Destination identifier. Meta: pixel ID. Google:
@@ -49620,6 +49654,10 @@ export type CreateTrackingTagData = {
49620
49654
  * OpenAI Ads only (ignored by Meta). When set, also provisions a standard conversion event setting wired to the new pixel, so `goal: conversions` ad creates on `POST /v1/ads/create` have an event to reference immediately.
49621
49655
  */
49622
49656
  defaultEventType?: 'order_created' | 'lead_created' | 'items_added' | 'contents_viewed' | 'checkout_started' | 'registration_completed' | 'subscription_created' | 'trial_started' | 'appointment_scheduled' | 'page_viewed' | 'app_installed' | 'app_opened';
49657
+ /**
49658
+ * Pinterest only (400 elsewhere). Customer data the new tag matches automatically (automatic enhanced match): `em` email, `ph` phone, `fn`/`ln` name, `ge` gender, `db` date of birth, `ct`/`st`/`zp`/`country` location, `external_id`. Pinterest has one switch for the name and one for the location, so `fn` turns on `ln` too and any location code turns on all four.
49659
+ */
49660
+ automaticMatchingFields?: Array<('em' | 'ph' | 'fn' | 'ln' | 'ge' | 'db' | 'ct' | 'st' | 'zp' | 'country' | 'external_id')>;
49623
49661
  };
49624
49662
  path: {
49625
49663
  /**
@@ -50015,6 +50053,89 @@ export type DeleteTrackingTagEventError = (ErrorResponse | {
50015
50053
  error?: string;
50016
50054
  } | unknown);
50017
50055
 
50056
+ export type ListTrackingTagUsersData = {
50057
+ path: {
50058
+ accountId: string;
50059
+ /**
50060
+ * Tag id (`TrackingTag.id`).
50061
+ */
50062
+ tagId: string;
50063
+ };
50064
+ };
50065
+
50066
+ export type ListTrackingTagUsersResponse = ({
50067
+ platform?: string;
50068
+ users?: Array<TrackingTagUser>;
50069
+ });
50070
+
50071
+ export type ListTrackingTagUsersError = (ErrorResponse | {
50072
+ error?: string;
50073
+ } | unknown);
50074
+
50075
+ export type AssignTrackingTagUserData = {
50076
+ body: {
50077
+ userId: string;
50078
+ tasks: Array<(string)>;
50079
+ };
50080
+ path: {
50081
+ accountId: string;
50082
+ /**
50083
+ * Tag id (`TrackingTag.id`).
50084
+ */
50085
+ tagId: string;
50086
+ };
50087
+ };
50088
+
50089
+ export type AssignTrackingTagUserResponse = ({
50090
+ platform?: string;
50091
+ userId?: string;
50092
+ tasks?: Array<(string)>;
50093
+ });
50094
+
50095
+ export type AssignTrackingTagUserError = (ErrorResponse | {
50096
+ error?: string;
50097
+ } | unknown);
50098
+
50099
+ export type RemoveTrackingTagUserData = {
50100
+ path: {
50101
+ accountId: string;
50102
+ tagId: string;
50103
+ /**
50104
+ * User id (`TrackingTagUser.id`).
50105
+ */
50106
+ userId: string;
50107
+ };
50108
+ };
50109
+
50110
+ export type RemoveTrackingTagUserResponse = ({
50111
+ platform?: string;
50112
+ userId?: string;
50113
+ removed?: boolean;
50114
+ });
50115
+
50116
+ export type RemoveTrackingTagUserError = (ErrorResponse | {
50117
+ error?: string;
50118
+ } | unknown);
50119
+
50120
+ export type ListTrackingTagPartnersData = {
50121
+ path: {
50122
+ accountId: string;
50123
+ /**
50124
+ * Tag id (`TrackingTag.id`).
50125
+ */
50126
+ tagId: string;
50127
+ };
50128
+ };
50129
+
50130
+ export type ListTrackingTagPartnersResponse = ({
50131
+ platform?: string;
50132
+ partners?: Array<TrackingTagPartner>;
50133
+ });
50134
+
50135
+ export type ListTrackingTagPartnersError = (ErrorResponse | {
50136
+ error?: string;
50137
+ } | unknown);
50138
+
50018
50139
  export type GetTrackingTagDiagnosticsData = {
50019
50140
  path: {
50020
50141
  accountId: string;