zernio-sdk 0.0.545 → 0.0.546

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587967e7af736a7b24c5db2000683193204c311e50f791c4d473854721ef9e6c
-  data.tar.gz: 3f8edc320c8b43fabfb676c7dbebdae0b1063dff12ffb47c77c5849ac41ffcfa
+  metadata.gz: b0dfe621463e185aa066e3e02e4c937e52942f9396df484507c501d8f211a162
+  data.tar.gz: 94cea2f7abe91b10927eb3ead5923d1995c8e7fadfc44f8fb1482579b1fd02fe
 SHA512:
-  metadata.gz: 55b7d6c3a990b15f9eccdca608024d8000757a5cb1db6c2faa39cec7bd61a230456c16390a15f5c45f068397c43b857a5587acdbc6347970646c9dd8b3153c1d
-  data.tar.gz: e468abd7b33a3db4370e2a17721a139f989e15c0830447f31dcd061c7daf2d96ec66e60fe1c95048d4c81d77d665462efab55a3352a25afb895457ce166d5886
+  metadata.gz: 367afe17a487f866b90d14a3a81540ffce3e60bcd0cb70667442120dbd5b1b5faf5067f59a004f7b06474b1d95b788cdc8a35b2bd1c9f0abb367657a3162e5e9
+  data.tar.gz: 23b0d7fca24b57102459023caf453ed64aef343b2c8fca07919dcfd4c9cf43bc2a8303ea126fcbb9e28760f523ef88298b7d27d3437c6010e52f1ae823142762

data/docs/BoostPostRequest.md

@@ -21,6 +21,7 @@
 | **platform_specific_data** | [**LinkedInAdsPlatformData**](LinkedInAdsPlatformData.md) |  | [optional] |
 | **tracking** | [**BoostPostRequestTracking**](BoostPostRequestTracking.md) |  | [optional] |
 | **special_ad_categories** | **Array<String>** | Meta only. Required for housing, employment, credit, or political ads. | [optional] |
+| **special_ad_category_country** | **Array<String>** | Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise). | [optional] |
 | **link_url** | **String** | TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok Spark Ads have no clickable destination — required for traffic / conversion objectives. Maps to `landing_page_url` on the creative entry of /v2/ad/create/ (TikTok SDK `AdcreateCreatives.landing_page_url`). Ignored on Meta / LinkedIn / Pinterest / X / Google (those infer the destination from the boosted post).  | [optional] |
 | **call_to_action** | **String** | TikTok-only. Call-to-action button label on the Spark Ad creative (e.g. `LEARN_MORE`, `SHOP_NOW`, `DOWNLOAD_NOW`, `SIGN_UP`, `WATCH_NOW`). Maps to `call_to_action` on the creative entry of /v2/ad/create/. Pass-through — the platform validates the value. See TikTok's \"Enumeration - Call-to-Action\" reference for the full list.  | [optional] |
 | **spark_auth_code** | **String** | TikTok-only. Spark Code (creator's `auth_code`) authorizing cross-creator Spark Ads — the advertiser can boost a video owned by a DIFFERENT TikTok account. Without this, boosts are limited to videos owned by the same account running the ads (same-BC creators only). The creator generates the code in their TikTok app's Promote settings and shares it with the advertiser. Maps to `auth_code` on the creative entry of /v2/ad/create/.  | [optional] |
@@ -50,6 +51,7 @@ instance = Zernio::BoostPostRequest.new(
   platform_specific_data: null,
   tracking: null,
   special_ad_categories: null,
+  special_ad_category_country: null,
   link_url: null,
   call_to_action: null,
   spark_auth_code: null,

data/docs/CreateStandaloneAdRequest.md

@@ -57,6 +57,7 @@
 | **saved_targeting_id** | **String** | ID of a `saved_targeting` audience (created via POST /v1/ads/audiences). When set, its stored TargetingSpec is expanded as the base targeting; inline fields on this body merge on top. Lets you reuse a named targeting preset without re-sending every field.  | [optional] |
 | **raw_targeting** | **Hash<String, Object>** | Meta only. A raw Meta-native targeting spec passed to the ad set VERBATIM (snake_case: `geo_locations`, `age_min`, `excluded_custom_audiences`, `flexible_spec`, `targeting_automation`, business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for external ads. Use it to clone a campaign's targeting EXACTLY, preserving advanced fields the camelCase targeting fields can't model. Mutually exclusive with the camelCase targeting fields (countries/regions/cities/interests/ ageMin/...), `audienceId`, and `savedTargetingId` (sending both → 422). Sent as-is; Meta validates and surfaces any errors. If cloning an EU campaign, also pass `dsaBeneficiary` / `dsaPayor` (those are separate fields, not part of targeting).  | [optional] |
 | **special_ad_categories** | **Array<String>** | Meta only. Declares the ad's special category, required for housing, employment, credit, or political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special category disables income/zip targeting on Meta.  | [optional] |
+| **special_ad_category_country** | **Array<String>** | Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via existingCampaignId (the existing campaign's category/country already governs it).  | [optional] |
 | **end_date** | **Time** | Required for lifetime budgets | [optional] |
 | **start_date** | **Time** | Meta only. Ad-set start time (ISO 8601, e.g. \"2026-06-10T09:00:00Z\"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. For lifetime budgets Meta also requires `endDate`. (Same `schedule.startDate` semantics already available on `POST /v1/ads/boost`.)  | [optional] |
 | **instagram_account_id** | **String** | Meta only. Override the Instagram account the ad is delivered as — pass an Instagram Business Account ID (e.g. 17841...), mapped to the creative's `instagram_user_id`. When omitted we auto-resolve the IG account linked to the connected Facebook Page (the existing default). Useful when a Page has more than one eligible IG account.  | [optional] |
@@ -140,6 +141,7 @@ instance = Zernio::CreateStandaloneAdRequest.new(
   saved_targeting_id: null,
   raw_targeting: null,
   special_ad_categories: null,
+  special_ad_category_country: null,
   end_date: null,
   start_date: null,
   instagram_account_id: null,

data/docs/CreateStandaloneAdRequestPromotedObject.md

@@ -12,6 +12,8 @@
 | **custom_conversion_id** | **String** | Custom Conversion ID, when optimising against one instead of a standard event. | [optional] |
 | **product_catalog_id** | **String** | Catalog ID for catalog/Advantage+ Shopping campaigns. | [optional] |
 | **product_set_id** | **String** | Product Set ID inside the catalog. | [optional] |
+| **offline_conversion_data_set_id** | **String** | Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id). | [optional] |
+| **whatsapp_phone_number** | **String** | Meta only. WhatsApp number on messaging-destination ad sets. | [optional] |
 
 ## Example
 
@@ -26,7 +28,9 @@ instance = Zernio::CreateStandaloneAdRequestPromotedObject.new(
   object_store_url: null,
   custom_conversion_id: null,
   product_catalog_id: null,
-  product_set_id: null
+  product_set_id: null,
+  offline_conversion_data_set_id: null,
+  whatsapp_phone_number: null
 )
 ```
 

data/docs/UpdateAdSetRequestPlatformSpecificDataPromotedObject.md

@@ -12,6 +12,8 @@
 | **custom_conversion_id** | **String** |  | [optional] |
 | **product_catalog_id** | **String** |  | [optional] |
 | **product_set_id** | **String** |  | [optional] |
+| **offline_conversion_data_set_id** | **String** |  | [optional] |
+| **whatsapp_phone_number** | **String** |  | [optional] |
 
 ## Example
 
@@ -26,7 +28,9 @@ instance = Zernio::UpdateAdSetRequestPlatformSpecificDataPromotedObject.new(
   object_store_url: null,
   custom_conversion_id: null,
   product_catalog_id: null,
-  product_set_id: null
+  product_set_id: null,
+  offline_conversion_data_set_id: null,
+  whatsapp_phone_number: null
 )
 ```
 

data/docs/UploadedOrDerivedAudience.md

@@ -16,11 +16,14 @@
 | **engagement_sources** | **Array<String>** | Required for engagement audiences. Campaign URNs for the ad source types, organization URNs for pages and events. LinkedIn creates one rule per source, all sharing the same trigger and lookbackDays.  | [optional] |
 | **companies** | [**Array<UploadedOrDerivedAudienceCompaniesInner>**](UploadedOrDerivedAudienceCompaniesInner.md) | Required for company_list audiences (LinkedIn only): plain-text company rows for account targeting. Each row needs at least one identifier. LinkedIn recommends 1,000+ companies for a usable match rate and takes up to 48h to process the list.  | [optional] |
 | **pixel_id** | **String** | Required for website audiences | [optional] |
-| **retention_days** | **Integer** | Required for website audiences | [optional] |
+| **retention_days** | **Integer** | Required for website (max 180) and meta_engagement (max 365) audiences. | [optional] |
+| **engagement_source** | **String** | Required for meta_engagement audiences (Meta only): what people engaged with. `page` = a Facebook Page, `instagram` = an IG professional account, `video` = a video. The source object must be eligible for engagement audiences or Meta rejects with subcode 1713151 (\"Invalid Event Name\"), surfaced verbatim.  | [optional] |
+| **source_id** | **String** | Required for meta_engagement: the Page / IG account / video id. | [optional] |
+| **event** | **String** | meta_engagement only. The engagement event; defaults per source (page → page_engaged, instagram → ig_business_profile_all, video → video_watched). Ignored when `rule` is provided.  | [optional] |
 | **source_audience_id** | **String** | Required for lookalike audiences | [optional] |
 | **country** | **String** | 2-letter code, required for lookalike audiences | [optional] |
 | **ratio** | **Float** | Required for lookalike audiences | [optional] |
-| **rule** | **Object** | Pixel event rule for website audiences (optional) | [optional] |
+| **rule** | **Object** | Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources). | [optional] |
 | **customer_file_source** | **String** | Data source declaration for GDPR compliance (customer_list only) | [optional] |
 
 ## Example
@@ -42,6 +45,9 @@ instance = Zernio::UploadedOrDerivedAudience.new(
   companies: null,
   pixel_id: null,
   retention_days: null,
+  engagement_source: null,
+  source_id: null,
+  event: null,
   source_audience_id: null,
   country: null,
   ratio: null,

data/lib/zernio-sdk/api/ad_audiences_api.rb

@@ -324,7 +324,7 @@ module Zernio
       if @api_client.config.client_side_validation && opts[:'platform'] && !allowable_values.include?(opts[:'platform'])
         fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
       end
-      allowable_values = ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike", "saved_targeting"]
+      allowable_values = ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike", "saved_targeting"]
       if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
         fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
       end

data/lib/zernio-sdk/models/boost_post_request.rb

@@ -59,6 +59,9 @@ module Zernio
     # Meta only. Required for housing, employment, credit, or political ads.
     attr_accessor :special_ad_categories
 
+    # Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).
+    attr_accessor :special_ad_category_country
+
     # TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok Spark Ads have no clickable destination — required for traffic / conversion objectives. Maps to `landing_page_url` on the creative entry of /v2/ad/create/ (TikTok SDK `AdcreateCreatives.landing_page_url`). Ignored on Meta / LinkedIn / Pinterest / X / Google (those infer the destination from the boosted post). 
     attr_accessor :link_url
 
@@ -116,6 +119,7 @@ module Zernio
         :'platform_specific_data' => :'platformSpecificData',
         :'tracking' => :'tracking',
         :'special_ad_categories' => :'specialAdCategories',
+        :'special_ad_category_country' => :'specialAdCategoryCountry',
         :'link_url' => :'linkUrl',
         :'call_to_action' => :'callToAction',
         :'spark_auth_code' => :'sparkAuthCode',
@@ -154,6 +158,7 @@ module Zernio
         :'platform_specific_data' => :'LinkedInAdsPlatformData',
         :'tracking' => :'BoostPostRequestTracking',
         :'special_ad_categories' => :'Array<String>',
+        :'special_ad_category_country' => :'Array<String>',
         :'link_url' => :'String',
         :'call_to_action' => :'String',
         :'spark_auth_code' => :'String',
@@ -266,6 +271,12 @@ module Zernio
         end
       end
 
+      if attributes.key?(:'special_ad_category_country')
+        if (value = attributes[:'special_ad_category_country']).is_a?(Array)
+          self.special_ad_category_country = value
+        end
+      end
+
       if attributes.key?(:'link_url')
         self.link_url = attributes[:'link_url']
       end
@@ -448,6 +459,7 @@ module Zernio
           platform_specific_data == o.platform_specific_data &&
           tracking == o.tracking &&
           special_ad_categories == o.special_ad_categories &&
+          special_ad_category_country == o.special_ad_category_country &&
           link_url == o.link_url &&
           call_to_action == o.call_to_action &&
           spark_auth_code == o.spark_auth_code &&
@@ -464,7 +476,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [post_id, platform_post_id, account_id, ad_account_id, name, goal, budget, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, link_url, call_to_action, spark_auth_code, dsa_beneficiary, dsa_payor].hash
+      [post_id, platform_post_id, account_id, ad_account_id, name, goal, budget, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, link_url, call_to_action, spark_auth_code, dsa_beneficiary, dsa_payor].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/create_standalone_ad_request.rb

@@ -164,6 +164,9 @@ module Zernio
     # Meta only. Declares the ad's special category, required for housing, employment, credit, or political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special category disables income/zip targeting on Meta. 
     attr_accessor :special_ad_categories
 
+    # Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via existingCampaignId (the existing campaign's category/country already governs it). 
+    attr_accessor :special_ad_category_country
+
     # Required for lifetime budgets
     attr_accessor :end_date
 
@@ -306,6 +309,7 @@ module Zernio
         :'saved_targeting_id' => :'savedTargetingId',
         :'raw_targeting' => :'rawTargeting',
         :'special_ad_categories' => :'specialAdCategories',
+        :'special_ad_category_country' => :'specialAdCategoryCountry',
         :'end_date' => :'endDate',
         :'start_date' => :'startDate',
         :'instagram_account_id' => :'instagramAccountId',
@@ -398,6 +402,7 @@ module Zernio
         :'saved_targeting_id' => :'String',
         :'raw_targeting' => :'Hash<String, Object>',
         :'special_ad_categories' => :'Array<String>',
+        :'special_ad_category_country' => :'Array<String>',
         :'end_date' => :'Time',
         :'start_date' => :'Time',
         :'instagram_account_id' => :'String',
@@ -692,6 +697,12 @@ module Zernio
         end
       end
 
+      if attributes.key?(:'special_ad_category_country')
+        if (value = attributes[:'special_ad_category_country']).is_a?(Array)
+          self.special_ad_category_country = value
+        end
+      end
+
       if attributes.key?(:'end_date')
         self.end_date = attributes[:'end_date']
       end
@@ -1341,6 +1352,7 @@ module Zernio
           saved_targeting_id == o.saved_targeting_id &&
           raw_targeting == o.raw_targeting &&
           special_ad_categories == o.special_ad_categories &&
+          special_ad_category_country == o.special_ad_category_country &&
           end_date == o.end_date &&
           start_date == o.start_date &&
           instagram_account_id == o.instagram_account_id &&
@@ -1375,7 +1387,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, ad_account_id, name, campaign_name, ad_set_name, ad_name, tracking, goal, optimization_goal, billing_event, buying_type, rf_prediction_id, creative_features, validate_only, budget_amount, budget_type, status, budget_level, currency, headline, long_headline, body, description, call_to_action, link_url, lead_gen_form_id, image_url, images, video, creatives, ad_set_id, existing_campaign_id, existing_creative_id, business_name, board_id, organization_id, targeting, countries, cities, regions, age_min, age_max, interests, zips, metros, custom_locations, behaviors, income_tier, languages, placements, saved_targeting_id, raw_targeting, special_ad_categories, end_date, start_date, instagram_account_id, dynamic_creative, carousel_cards, placement_assets, audience_id, campaign_type, keywords, additional_headlines, additional_descriptions, advantage_audience, attribution_spec, gender, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, dsa_beneficiary, dsa_payor, brand_identity, identity_type, promoted_object].hash
+      [account_id, ad_account_id, name, campaign_name, ad_set_name, ad_name, tracking, goal, optimization_goal, billing_event, buying_type, rf_prediction_id, creative_features, validate_only, budget_amount, budget_type, status, budget_level, currency, headline, long_headline, body, description, call_to_action, link_url, lead_gen_form_id, image_url, images, video, creatives, ad_set_id, existing_campaign_id, existing_creative_id, business_name, board_id, organization_id, targeting, countries, cities, regions, age_min, age_max, interests, zips, metros, custom_locations, behaviors, income_tier, languages, placements, saved_targeting_id, raw_targeting, special_ad_categories, special_ad_category_country, end_date, start_date, instagram_account_id, dynamic_creative, carousel_cards, placement_assets, audience_id, campaign_type, keywords, additional_headlines, additional_descriptions, advantage_audience, attribution_spec, gender, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, dsa_beneficiary, dsa_payor, brand_identity, identity_type, promoted_object].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb

@@ -40,6 +40,12 @@ module Zernio
     # Product Set ID inside the catalog.
     attr_accessor :product_set_id
 
+    # Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).
+    attr_accessor :offline_conversion_data_set_id
+
+    # Meta only. WhatsApp number on messaging-destination ad sets.
+    attr_accessor :whatsapp_phone_number
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -50,7 +56,9 @@ module Zernio
         :'object_store_url' => :'objectStoreUrl',
         :'custom_conversion_id' => :'customConversionId',
         :'product_catalog_id' => :'productCatalogId',
-        :'product_set_id' => :'productSetId'
+        :'product_set_id' => :'productSetId',
+        :'offline_conversion_data_set_id' => :'offlineConversionDataSetId',
+        :'whatsapp_phone_number' => :'whatsappPhoneNumber'
       }
     end
 
@@ -74,7 +82,9 @@ module Zernio
         :'object_store_url' => :'String',
         :'custom_conversion_id' => :'String',
         :'product_catalog_id' => :'String',
-        :'product_set_id' => :'String'
+        :'product_set_id' => :'String',
+        :'offline_conversion_data_set_id' => :'String',
+        :'whatsapp_phone_number' => :'String'
       }
     end
 
@@ -131,6 +141,14 @@ module Zernio
       if attributes.key?(:'product_set_id')
         self.product_set_id = attributes[:'product_set_id']
       end
+
+      if attributes.key?(:'offline_conversion_data_set_id')
+        self.offline_conversion_data_set_id = attributes[:'offline_conversion_data_set_id']
+      end
+
+      if attributes.key?(:'whatsapp_phone_number')
+        self.whatsapp_phone_number = attributes[:'whatsapp_phone_number']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -160,7 +178,9 @@ module Zernio
           object_store_url == o.object_store_url &&
           custom_conversion_id == o.custom_conversion_id &&
           product_catalog_id == o.product_catalog_id &&
-          product_set_id == o.product_set_id
+          product_set_id == o.product_set_id &&
+          offline_conversion_data_set_id == o.offline_conversion_data_set_id &&
+          whatsapp_phone_number == o.whatsapp_phone_number
     end
 
     # @see the `==` method
@@ -172,7 +192,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pixel_id, custom_event_type, page_id, application_id, object_store_url, custom_conversion_id, product_catalog_id, product_set_id].hash
+      [pixel_id, custom_event_type, page_id, application_id, object_store_url, custom_conversion_id, product_catalog_id, product_set_id, offline_conversion_data_set_id, whatsapp_phone_number].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/list_ad_audiences200_response_audiences_inner.rb

@@ -177,7 +177,7 @@ module Zernio
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike", "saved_targeting"])
+      type_validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike", "saved_targeting"])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -185,7 +185,7 @@ module Zernio
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike", "saved_targeting"])
+      validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike", "saved_targeting"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/zernio-sdk/models/update_ad_set_request_platform_specific_data_promoted_object.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Zernio
-  # Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
+  # Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400.
   class UpdateAdSetRequestPlatformSpecificDataPromotedObject < ApiModelBase
     attr_accessor :pixel_id
 
@@ -32,6 +32,10 @@ module Zernio
 
     attr_accessor :product_set_id
 
+    attr_accessor :offline_conversion_data_set_id
+
+    attr_accessor :whatsapp_phone_number
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -42,7 +46,9 @@ module Zernio
         :'object_store_url' => :'objectStoreUrl',
         :'custom_conversion_id' => :'customConversionId',
         :'product_catalog_id' => :'productCatalogId',
-        :'product_set_id' => :'productSetId'
+        :'product_set_id' => :'productSetId',
+        :'offline_conversion_data_set_id' => :'offlineConversionDataSetId',
+        :'whatsapp_phone_number' => :'whatsappPhoneNumber'
       }
     end
 
@@ -66,7 +72,9 @@ module Zernio
         :'object_store_url' => :'String',
         :'custom_conversion_id' => :'String',
         :'product_catalog_id' => :'String',
-        :'product_set_id' => :'String'
+        :'product_set_id' => :'String',
+        :'offline_conversion_data_set_id' => :'String',
+        :'whatsapp_phone_number' => :'String'
       }
     end
 
@@ -123,6 +131,14 @@ module Zernio
       if attributes.key?(:'product_set_id')
         self.product_set_id = attributes[:'product_set_id']
       end
+
+      if attributes.key?(:'offline_conversion_data_set_id')
+        self.offline_conversion_data_set_id = attributes[:'offline_conversion_data_set_id']
+      end
+
+      if attributes.key?(:'whatsapp_phone_number')
+        self.whatsapp_phone_number = attributes[:'whatsapp_phone_number']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -152,7 +168,9 @@ module Zernio
           object_store_url == o.object_store_url &&
           custom_conversion_id == o.custom_conversion_id &&
           product_catalog_id == o.product_catalog_id &&
-          product_set_id == o.product_set_id
+          product_set_id == o.product_set_id &&
+          offline_conversion_data_set_id == o.offline_conversion_data_set_id &&
+          whatsapp_phone_number == o.whatsapp_phone_number
     end
 
     # @see the `==` method
@@ -164,7 +182,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pixel_id, custom_event_type, page_id, application_id, object_store_url, custom_conversion_id, product_catalog_id, product_set_id].hash
+      [pixel_id, custom_event_type, page_id, application_id, object_store_url, custom_conversion_id, product_catalog_id, product_set_id, offline_conversion_data_set_id, whatsapp_phone_number].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/uploaded_or_derived_audience.rb

@@ -48,9 +48,18 @@ module Zernio
     # Required for website audiences
     attr_accessor :pixel_id
 
-    # Required for website audiences
+    # Required for website (max 180) and meta_engagement (max 365) audiences.
     attr_accessor :retention_days
 
+    # Required for meta_engagement audiences (Meta only): what people engaged with. `page` = a Facebook Page, `instagram` = an IG professional account, `video` = a video. The source object must be eligible for engagement audiences or Meta rejects with subcode 1713151 (\"Invalid Event Name\"), surfaced verbatim. 
+    attr_accessor :engagement_source
+
+    # Required for meta_engagement: the Page / IG account / video id.
+    attr_accessor :source_id
+
+    # meta_engagement only. The engagement event; defaults per source (page → page_engaged, instagram → ig_business_profile_all, video → video_watched). Ignored when `rule` is provided. 
+    attr_accessor :event
+
     # Required for lookalike audiences
     attr_accessor :source_audience_id
 
@@ -60,7 +69,7 @@ module Zernio
     # Required for lookalike audiences
     attr_accessor :ratio
 
-    # Pixel event rule for website audiences (optional)
+    # Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources).
     attr_accessor :rule
 
     # Data source declaration for GDPR compliance (customer_list only)
@@ -104,6 +113,9 @@ module Zernio
         :'companies' => :'companies',
         :'pixel_id' => :'pixelId',
         :'retention_days' => :'retentionDays',
+        :'engagement_source' => :'engagementSource',
+        :'source_id' => :'sourceId',
+        :'event' => :'event',
         :'source_audience_id' => :'sourceAudienceId',
         :'country' => :'country',
         :'ratio' => :'ratio',
@@ -138,6 +150,9 @@ module Zernio
         :'companies' => :'Array<UploadedOrDerivedAudienceCompaniesInner>',
         :'pixel_id' => :'String',
         :'retention_days' => :'Integer',
+        :'engagement_source' => :'String',
+        :'source_id' => :'String',
+        :'event' => :'String',
         :'source_audience_id' => :'String',
         :'country' => :'String',
         :'ratio' => :'Float',
@@ -234,6 +249,18 @@ module Zernio
         self.retention_days = attributes[:'retention_days']
       end
 
+      if attributes.key?(:'engagement_source')
+        self.engagement_source = attributes[:'engagement_source']
+      end
+
+      if attributes.key?(:'source_id')
+        self.source_id = attributes[:'source_id']
+      end
+
+      if attributes.key?(:'event')
+        self.event = attributes[:'event']
+      end
+
       if attributes.key?(:'source_audience_id')
         self.source_audience_id = attributes[:'source_audience_id']
       end
@@ -304,8 +331,8 @@ module Zernio
         invalid_properties.push('invalid value for "companies", number of items must be greater than or equal to 1.')
       end
 
-      if !@retention_days.nil? && @retention_days > 180
-        invalid_properties.push('invalid value for "retention_days", must be smaller than or equal to 180.')
+      if !@retention_days.nil? && @retention_days > 365
+        invalid_properties.push('invalid value for "retention_days", must be smaller than or equal to 365.')
       end
 
       if !@retention_days.nil? && @retention_days < 1
@@ -332,7 +359,7 @@ module Zernio
       return false if @name.nil?
       return false if @name.to_s.length > 255
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike"])
+      type_validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike"])
       return false unless type_validator.valid?(@type)
       return false if !@match_rules.nil? && @match_rules.length > 50
       return false if !@match_rules.nil? && @match_rules.length < 1
@@ -344,8 +371,10 @@ module Zernio
       return false if !@engagement_sources.nil? && @engagement_sources.length < 1
       return false if !@companies.nil? && @companies.length > 300000
       return false if !@companies.nil? && @companies.length < 1
-      return false if !@retention_days.nil? && @retention_days > 180
+      return false if !@retention_days.nil? && @retention_days > 365
       return false if !@retention_days.nil? && @retention_days < 1
+      engagement_source_validator = EnumAttributeValidator.new('String', ["page", "instagram", "video"])
+      return false unless engagement_source_validator.valid?(@engagement_source)
       return false if !@ratio.nil? && @ratio > 0.2
       return false if !@ratio.nil? && @ratio < 0.01
       true
@@ -388,7 +417,7 @@ module Zernio
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike"])
+      validator = EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -476,8 +505,8 @@ module Zernio
         fail ArgumentError, 'retention_days cannot be nil'
       end
 
-      if retention_days > 180
-        fail ArgumentError, 'invalid value for "retention_days", must be smaller than or equal to 180.'
+      if retention_days > 365
+        fail ArgumentError, 'invalid value for "retention_days", must be smaller than or equal to 365.'
       end
 
       if retention_days < 1
@@ -487,6 +516,16 @@ module Zernio
       @retention_days = retention_days
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] engagement_source Object to be assigned
+    def engagement_source=(engagement_source)
+      validator = EnumAttributeValidator.new('String', ["page", "instagram", "video"])
+      unless validator.valid?(engagement_source)
+        fail ArgumentError, "invalid value for \"engagement_source\", must be one of #{validator.allowable_values}."
+      end
+      @engagement_source = engagement_source
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] ratio Value to be assigned
     def ratio=(ratio)
@@ -523,6 +562,9 @@ module Zernio
           companies == o.companies &&
           pixel_id == o.pixel_id &&
           retention_days == o.retention_days &&
+          engagement_source == o.engagement_source &&
+          source_id == o.source_id &&
+          event == o.event &&
           source_audience_id == o.source_audience_id &&
           country == o.country &&
           ratio == o.ratio &&
@@ -539,7 +581,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, ad_account_id, name, description, type, match_rules, source_type, trigger, lookback_days, engagement_sources, companies, pixel_id, retention_days, source_audience_id, country, ratio, rule, customer_file_source].hash
+      [account_id, ad_account_id, name, description, type, match_rules, source_type, trigger, lookback_days, engagement_sources, companies, pixel_id, retention_days, engagement_source, source_id, event, source_audience_id, country, ratio, rule, customer_file_source].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.545'
+  VERSION = '0.0.546'
 end

data/openapi.yaml

@@ -33787,7 +33787,7 @@ paths:
                     endDate: { type: string, description: "Ad set end_time (ISO 8601)." }
                     promotedObject:
                       type: object
-                      description: "Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create)."
+                      description: "Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400."
                       properties:
                         pixelId: { type: string }
                         customEventType: { type: string }
@@ -33797,6 +33797,9 @@ paths:
                         customConversionId: { type: string }
                         productCatalogId: { type: string }
                         productSetId: { type: string }
+                        offlineConversionDataSetId: { type: string }
+                        whatsappPhoneNumber: { type: string }
+                      additionalProperties: false
       responses:
         '200':
           description: Ad set updated
@@ -35662,6 +35665,10 @@ paths:
                   type: array
                   description: "Meta only. Required for housing, employment, credit, or political ads."
                   items: { type: string, enum: [HOUSING, EMPLOYMENT, CREDIT, FINANCIAL_PRODUCTS_SERVICES, ISSUES_ELECTIONS_POLITICS, ONLINE_GAMBLING_AND_GAMING] }
+                specialAdCategoryCountry:
+                  type: array
+                  description: 'Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).'
+                  items: { type: string }
                 linkUrl:
                   type: string
                   format: uri
@@ -36107,6 +36114,13 @@ paths:
                     political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special
                     category disables income/zip targeting on Meta.
                   items: { type: string, enum: [HOUSING, EMPLOYMENT, CREDIT, FINANCIAL_PRODUCTS_SERVICES, ISSUES_ELECTIONS_POLITICS, ONLINE_GAMBLING_AND_GAMING] }
+                specialAdCategoryCountry:
+                  type: array
+                  description: |
+                    Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires
+                    specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via
+                    existingCampaignId (the existing campaign's category/country already governs it).
+                  items: { type: string }
                 endDate: { type: string, format: date-time, description: Required for lifetime budgets }
                 startDate:
                   type: string
@@ -36454,6 +36468,13 @@ paths:
                     productSetId:
                       type: string
                       description: Product Set ID inside the catalog.
+                    offlineConversionDataSetId:
+                      type: string
+                      description: 'Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).'
+                    whatsappPhoneNumber:
+                      type: string
+                      description: 'Meta only. WhatsApp number on messaging-destination ad sets.'
+                  additionalProperties: false
       responses:
         '200':
           description: 'validateOnly dry-run passed — nothing was created'
@@ -37189,7 +37210,7 @@ paths:
         - { name: accountId, in: query, required: true, schema: { type: string }, description: Social account ID }
         - { name: adAccountId, in: query, required: true, schema: { type: string }, description: Platform ad account ID }
         - { name: platform, in: query, schema: { type: string, enum: [facebook, instagram, googleads, tiktok, tiktokads, pinterest, linkedin, linkedinads, twitter, xads] } }
-        - { name: type, in: query, required: false, schema: { type: string, enum: [customer_list, company_list, engagement, website, website_retargeting, lookalike, saved_targeting] }, description: "Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences." }
+        - { name: type, in: query, required: false, schema: { type: string, enum: [customer_list, company_list, engagement, meta_engagement, website, website_retargeting, lookalike, saved_targeting] }, description: "Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences." }
       responses:
         '200':
           description: Audiences
@@ -37208,7 +37229,7 @@ paths:
                         platformAudienceId: { type: string }
                         name: { type: string }
                         description: { type: string }
-                        type: { type: string, enum: [customer_list, company_list, engagement, website, website_retargeting, lookalike, saved_targeting] }
+                        type: { type: string, enum: [customer_list, company_list, engagement, meta_engagement, website, website_retargeting, lookalike, saved_targeting] }
                         spec:
                           anyOf:
                             - $ref: '#/components/schemas/TargetingSpec'
@@ -37248,7 +37269,7 @@ paths:
                     adAccountId: { type: string, description: "Platform ad account ID. Must start with act_ for Meta; bare platform id for others (Google customer id, X/TikTok/LinkedIn/Pinterest account id)." }
                     name: { type: string, maxLength: 255 }
                     description: { type: string }
-                    type: { type: string, enum: [customer_list, company_list, engagement, website, website_retargeting, lookalike] }
+                    type: { type: string, enum: [customer_list, company_list, engagement, meta_engagement, website, website_retargeting, lookalike] }
                     matchRules:
                       type: array
                       minItems: 1
@@ -37319,11 +37340,27 @@ paths:
                           website: { type: string, maxLength: 100 }
                           linkedinPageUrl: { type: string }
                     pixelId: { type: string, description: Required for website audiences }
-                    retentionDays: { type: integer, minimum: 1, maximum: 180, description: Required for website audiences }
+                    retentionDays: { type: integer, minimum: 1, maximum: 365, description: "Required for website (max 180) and meta_engagement (max 365) audiences." }
+                    engagementSource:
+                      type: string
+                      enum: [page, instagram, video]
+                      description: |
+                        Required for meta_engagement audiences (Meta only): what people
+                        engaged with. `page` = a Facebook Page, `instagram` = an IG
+                        professional account, `video` = a video. The source object must be
+                        eligible for engagement audiences or Meta rejects with subcode
+                        1713151 ("Invalid Event Name"), surfaced verbatim.
+                    sourceId: { type: string, description: "Required for meta_engagement: the Page / IG account / video id." }
+                    event:
+                      type: string
+                      description: |
+                        meta_engagement only. The engagement event; defaults per source
+                        (page → page_engaged, instagram → ig_business_profile_all,
+                        video → video_watched). Ignored when `rule` is provided.
                     sourceAudienceId: { type: string, description: Required for lookalike audiences }
                     country: { type: string, description: "2-letter code, required for lookalike audiences" }
                     ratio: { type: number, minimum: 0.01, maximum: 0.20, description: Required for lookalike audiences }
-                    rule: { type: object, description: "Pixel event rule for website audiences (optional)" }
+                    rule: { type: object, description: "Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources)." }
                     customerFileSource: { type: string, description: "Data source declaration for GDPR compliance (customer_list only)" }
                 - type: object
                   title: SavedTargetingAudience

data/spec/models/boost_post_request_spec.rb

@@ -137,6 +137,12 @@ describe Zernio::BoostPostRequest do
     end
   end
 
+  describe 'test attribute "special_ad_category_country"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "link_url"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/create_standalone_ad_request_promoted_object_spec.rb

@@ -75,4 +75,16 @@ describe Zernio::CreateStandaloneAdRequestPromotedObject do
     end
   end
 
+  describe 'test attribute "offline_conversion_data_set_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "whatsapp_phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/create_standalone_ad_request_spec.rb

@@ -381,6 +381,12 @@ describe Zernio::CreateStandaloneAdRequest do
     end
   end
 
+  describe 'test attribute "special_ad_category_country"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "end_date"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/list_ad_audiences200_response_audiences_inner_spec.rb

@@ -60,7 +60,7 @@ describe Zernio::ListAdAudiences200ResponseAudiencesInner do
   describe 'test attribute "type"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike", "saved_targeting"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike", "saved_targeting"])
       # validator.allowable_values.each do |value|
       #   expect { instance.type = value }.not_to raise_error
       # end

data/spec/models/update_ad_set_request_platform_specific_data_promoted_object_spec.rb

@@ -75,4 +75,16 @@ describe Zernio::UpdateAdSetRequestPlatformSpecificDataPromotedObject do
     end
   end
 
+  describe 'test attribute "offline_conversion_data_set_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "whatsapp_phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/uploaded_or_derived_audience_spec.rb

@@ -54,7 +54,7 @@ describe Zernio::UploadedOrDerivedAudience do
   describe 'test attribute "type"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "website", "website_retargeting", "lookalike"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["customer_list", "company_list", "engagement", "meta_engagement", "website", "website_retargeting", "lookalike"])
       # validator.allowable_values.each do |value|
       #   expect { instance.type = value }.not_to raise_error
       # end
@@ -117,6 +117,28 @@ describe Zernio::UploadedOrDerivedAudience do
     end
   end
 
+  describe 'test attribute "engagement_source"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["page", "instagram", "video"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.engagement_source = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "source_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "event"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "source_audience_id"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zernio-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.545
+  version: 0.0.546
 platform: ruby
 authors:
 - OpenAPI-Generator