facebookbusiness 23.0.1 → 23.0.3

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -195,6 +195,12 @@ module FacebookAds
       end
     end
 
+    has_edge :check_marketplace_partner_deals_status do |edge|
+      edge.get 'ProductCatalogCheckMarketplacePartnerDealsStatus' do |api|
+        api.has_param :session_id, 'string'
+      end
+    end
+
     has_edge :check_marketplace_partner_sellers_status do |edge|
       edge.get 'ProductCatalogCheckMarketplacePartnerSellersStatus' do |api|
         api.has_param :session_id, 'string'
@@ -356,6 +362,12 @@ module FacebookAds
       end
     end
 
+    has_edge :marketplace_partner_deals_details do |edge|
+      edge.post 'ProductCatalog' do |api|
+        api.has_param :requests, 'hash'
+      end
+    end
+
     has_edge :marketplace_partner_sellers_details do |edge|
       edge.post 'ProductCatalog' do |api|
         api.has_param :requests, 'hash'
@@ -497,6 +509,7 @@ module FacebookAds
         api.has_param :iphone_app_store_id, 'int'
         api.has_param :iphone_url, 'string'
         api.has_param :launch_date, 'string'
+        api.has_param :live_special_price, 'string'
         api.has_param :manufacturer_info, 'string'
         api.has_param :manufacturer_part_number, 'string'
         api.has_param :marked_for_product_launch, { enum: -> { ProductItem::MARKED_FOR_PRODUCT_LAUNCH }}
@@ -517,6 +530,7 @@ module FacebookAds
         api.has_param :retailer_id, 'string'
         api.has_param :retailer_product_group_id, 'string'
         api.has_param :return_policy_days, 'int'
+        api.has_param :rich_text_description, 'string'
         api.has_param :sale_price, 'int'
         api.has_param :sale_price_end_date, 'datetime'
         api.has_param :sale_price_start_date, 'datetime'

data/lib/facebook_ads/ad_objects/product_catalog_check_marketplace_partner_deals_status.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class ProductCatalogCheckMarketplacePartnerDealsStatus < AdObject
+
+    field :errors, { list: 'object' }
+    field :session_id, 'string'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/product_group.rb

@@ -66,6 +66,7 @@ module FacebookAds
         api.has_param :iphone_app_store_id, 'int'
         api.has_param :iphone_url, 'string'
         api.has_param :launch_date, 'string'
+        api.has_param :live_special_price, 'string'
         api.has_param :manufacturer_part_number, 'string'
         api.has_param :marked_for_product_launch, { enum: -> { ProductItem::MARKED_FOR_PRODUCT_LAUNCH }}
         api.has_param :material, 'string'
@@ -83,6 +84,7 @@ module FacebookAds
         api.has_param :quantity_to_sell_on_facebook, 'int'
         api.has_param :retailer_id, 'string'
         api.has_param :return_policy_days, 'int'
+        api.has_param :rich_text_description, 'string'
         api.has_param :sale_price, 'int'
         api.has_param :sale_price_end_date, 'datetime'
         api.has_param :sale_price_start_date, 'datetime'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -83,6 +83,11 @@ module FacebookAds
       "oz",
     ]
 
+    STATUS = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
     VIDEO_FETCH_STATUS = [
       "DIRECT_UPLOAD",
       "FETCHED",
@@ -329,7 +334,6 @@ module FacebookAds
       "COMMERCE_ACCOUNT_NOT_LEGALLY_COMPLIANT",
       "CRAWLED_AVAILABILITY_MISMATCH",
       "DA_DISABLED_BY_USER",
-      "DA_POLICY_UNFIT_FOR_AUDIENCE",
       "DA_POLICY_VIOLATION",
       "DELETED_ITEM",
       "DIGITAL_GOODS_NOT_AVAILABLE_FOR_CHECKOUT",
@@ -393,6 +397,7 @@ module FacebookAds
       "MARKETPLACE_DISABLED_BY_USER",
       "MARKETPLACE_PARTNER_AUCTION_NO_BID_CLOSE_TIME",
       "MARKETPLACE_PARTNER_CURRENCY_NOT_VALID",
+      "MARKETPLACE_PARTNER_DISTRIBUTION_DISABLED",
       "MARKETPLACE_PARTNER_LISTING_COUNTRY_NOT_MATCH_CATALOG",
       "MARKETPLACE_PARTNER_LISTING_LIMIT_EXCEEDED",
       "MARKETPLACE_PARTNER_MISSING_LATLONG",
@@ -451,6 +456,7 @@ module FacebookAds
       "QUALITY_ITEM_LINK_BROKEN",
       "QUALITY_ITEM_LINK_REDIRECTING",
       "RETAILER_ID_NOT_PROVIDED",
+      "RETAILER_ID_USED_BY_GROUP",
       "SHOPIFY_INVALID_RETAILER_ID",
       "SHOPIFY_ITEM_MISSING_SHIPPING_PROFILE",
       "SHOPS_POLICY_VIOLATION",
@@ -786,6 +792,7 @@ module FacebookAds
     field :invalidation_errors, { list: 'ProductItemInvalidationError' }
     field :inventory, 'int'
     field :is_bundle_hero, 'bool'
+    field :live_special_price, 'string'
     field :manufacturer_info, 'string'
     field :manufacturer_part_number, 'string'
     field :marked_for_product_launch, 'string'
@@ -809,6 +816,7 @@ module FacebookAds
     field :retailer_product_group_id, 'string'
     field :review_rejection_reasons, { list: 'string' }
     field :review_status, { enum: -> { REVIEW_STATUS }}
+    field :rich_text_description, 'string'
     field :sale_price, 'string'
     field :sale_price_end_date, 'string'
     field :sale_price_start_date, 'string'
@@ -817,6 +825,7 @@ module FacebookAds
     field :short_description, 'string'
     field :size, 'string'
     field :start_date, 'string'
+    field :status, { enum: -> { STATUS }}
     field :tags, { list: 'string' }
     field :url, 'string'
     field :vendor_id, 'string'

data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb

@@ -136,6 +136,7 @@ module FacebookAds
     field :timezone_id, 'int'
     field :timezone_name, 'string'
     field :topline_id, 'int'
+    field :trending_topics_spec, 'TrendingTopicsSpec'
     field :video_view_length_constraint, 'int'
     field :viewtag, 'string'
     field :action, { enum: -> { ACTION }}
@@ -154,7 +155,6 @@ module FacebookAds
     field :rf_prediction_id_to_release, 'string'
     field :rf_prediction_id_to_share, 'string'
     field :stop_time, 'int'
-    field :trending_topics_spec, 'hash'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb

@@ -25,6 +25,8 @@ module FacebookAds
     field :taiwan_finserv_payer, 'string'
     field :taiwan_universal_beneficiary, 'string'
     field :taiwan_universal_payer, 'string'
+    field :universal_beneficiary, 'string'
+    field :universal_payer, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/server_side/attribution_data.rb

@@ -49,6 +49,15 @@ module FacebookAds
         # The share of value generated by this click-conversion pair that is attributed to Meta.
         attr_accessor :attribution_value
 
+        # The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.
+        attr_accessor :attribution_source
+
+        # The engagement type that caused the original credited conversion.
+        attr_accessor :touchpoint_type
+
+        # The time when the touchpoint event occurred with the ad that the install was credited to.
+        attr_accessor :touchpoint_ts
+
 
 
         # @param [String] scope
@@ -60,7 +69,10 @@ module FacebookAds
         # @param [String] attribution_model
         # @param [String] attr_window
         # @param [Float] attribution_value
-        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil, attribution_value: nil)
+        # @param [String] attribution_source
+        # @param [String] touchpoint_type
+        # @param [Integer] touchpoint_ts
+        def initialize(scope: nil, visit_time: nil, ad_id: nil, adset_id: nil, campaign_id: nil, attribution_share: nil, attribution_model: nil, attr_window: nil, attribution_value: nil, attribution_source: nil, touchpoint_type: nil, touchpoint_ts: nil)
           unless scope.nil?
             self.scope = scope
           end
@@ -88,6 +100,15 @@ module FacebookAds
           unless attribution_value.nil?
             self.attribution_value = attribution_value
           end
+          unless attribution_source.nil?
+            self.attribution_source = attribution_source
+          end
+          unless touchpoint_type.nil?
+            self.touchpoint_type = touchpoint_type
+          end
+          unless touchpoint_ts.nil?
+            self.touchpoint_ts = touchpoint_ts
+          end
         end
 
         # build the object using the input hash
@@ -131,7 +152,19 @@ module FacebookAds
           end
 
           if attributes.has_key?(:'attribution_value')
-            self.attribution_share = attributes[:'attribution_value']
+            self.attribution_value = attributes[:'attribution_value']
+          end
+
+          if attributes.has_key?(:'attribution_source')
+            self.attribution_source = attributes[:'attribution_source']
+          end
+
+          if attributes.has_key?(:'touchpoint_type')
+            self.touchpoint_type = attributes[:'touchpoint_type']
+          end
+
+          if attributes.has_key?(:'touchpoint_ts')
+            self.touchpoint_ts = attributes[:'touchpoint_ts']
           end
         end
 
@@ -147,7 +180,10 @@ module FacebookAds
               attribution_share == o.attribution_share &&
               attribution_model == o.attribution_model &&
               attr_window == o.attr_window &&
-              attribution_value == o.attribution_value
+              attribution_value == o.attribution_value &&
+              attribution_source == o.attribution_source &&
+              touchpoint_type == o.touchpoint_type &&
+              touchpoint_ts == o.touchpoint_ts
         end
 
         # @see the `==` method
@@ -159,7 +195,7 @@ module FacebookAds
         # @return [Fixnum] Hash code
         def hash
           [
-            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value
+            scope, visit_time, ad_id, adset_id, campaign_id, attribution_share, attribution_model, attr_window, attribution_value, attribution_source, touchpoint_type, touchpoint_ts
           ].hash
         end
 
@@ -192,6 +228,15 @@ module FacebookAds
           unless attribution_value.nil?
             hash['attribution_value'] = attribution_value
           end
+          unless attribution_source.nil?
+            hash['attribution_source'] = attribution_source
+          end
+          unless touchpoint_type.nil?
+            hash['touchpoint_type'] = touchpoint_type
+          end
+          unless touchpoint_ts.nil?
+            hash['touchpoint_ts'] = touchpoint_ts
+          end
           hash.to_s
         end
 
@@ -226,6 +271,15 @@ module FacebookAds
           unless attribution_value.nil?
             hash['attribution_value'] = attribution_value
           end
+          unless attribution_source.nil?
+            hash['attribution_source'] = attribution_source
+          end
+          unless touchpoint_type.nil?
+            hash['touchpoint_type'] = touchpoint_type
+          end
+          unless touchpoint_ts.nil?
+            hash['touchpoint_ts'] = touchpoint_ts
+          end
           hash
         end
 

data/lib/facebook_ads/ad_objects/shadow_ig_user_collaboration_invites.rb

@@ -0,0 +1,28 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class ShadowIgUserCollaborationInvites < AdObject
+
+    field :caption, 'string'
+    field :media_id, 'string'
+    field :media_owner_username, 'string'
+    field :media_url, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/shop.rb

@@ -19,7 +19,6 @@ module FacebookAds
     field :fb_sales_channel, 'object'
     field :id, 'string'
     field :ig_sales_channel, 'object'
-    field :is_onsite_enabled, 'bool'
     field :shop_status, 'string'
     field :workspace, 'object'
     has_no_post

data/lib/facebook_ads/ad_objects/trending_topics_spec.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class TrendingTopicsSpec < AdObject
+
+    field :is_all_trending, 'bool'
+    field :is_special_budget_alloc, 'bool'
+    field :trending_topics, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/unified_thread.rb

@@ -24,6 +24,7 @@ module FacebookAds
     field :folder, 'string'
     field :former_participants, 'object'
     field :id, 'string'
+    field :is_owner, 'bool'
     field :is_subscribed, 'bool'
     field :link, 'string'
     field :linked_group, 'Group'

data/lib/facebook_ads/ad_objects/user.rb

@@ -38,7 +38,6 @@ module FacebookAds
 
     field :about, 'string'
     field :age_range, 'AgeRange'
-    field :avatar_2d_profile_picture, 'AvatarProfilePicture'
     field :birthday, 'string'
     field :client_business_id, 'string'
     field :community, 'Group'
@@ -52,7 +51,6 @@ module FacebookAds
     field :gender, 'string'
     field :hometown, 'Page'
     field :id, 'string'
-    field :id_for_avatars, 'string'
     field :inspirational_people, { list: 'Experience' }
     field :install_type, 'string'
     field :installed, 'bool'
@@ -192,10 +190,6 @@ module FacebookAds
       edge.get 'WhatsAppBusinessAccount'
     end
 
-    has_edge :avatars do |edge|
-      edge.get 'Avatar'
-    end
-
     has_edge :business_users do |edge|
       edge.get 'BusinessUser'
     end
@@ -222,6 +216,7 @@ module FacebookAds
     has_edge :conversations do |edge|
       edge.get 'UnifiedThread' do |api|
         api.has_param :folder, 'string'
+        api.has_param :is_owner, 'bool'
         api.has_param :platform, { enum: -> { UnifiedThread::PLATFORM }}
         api.has_param :tags, { list: 'string' }
         api.has_param :user_id, 'string'

data/lib/facebook_ads/ad_objects/user_page_one_time_opt_in_token_settings.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class UserPageOneTimeOptInTokenSettings < AdObject
 
     field :creation_timestamp, 'int'
+    field :custom_audience_ids, { list: 'string' }
     field :next_eligible_time, 'int'
     field :next_eligible_time_for_paid_messaging, 'int'
     field :notification_messages_frequency, 'string'

data/lib/facebook_ads/ad_objects/video_copyright.rb

@@ -28,8 +28,10 @@ module FacebookAds
 
 
     field :content_category, 'string'
+    field :content_protect_protection_disabled_reason, 'string'
     field :copyright_content_id, 'string'
     field :creator, 'User'
+    field :disable_protection_by_content_protect_status, 'bool'
     field :excluded_ownership_segments, { list: 'VideoCopyrightSegment' }
     field :id, 'string'
     field :in_conflict, 'bool'

data/lib/facebook_ads/ad_objects/video_copyright_match.rb

@@ -47,6 +47,7 @@ module FacebookAds
     field :match_status, 'string'
     field :notes, 'string'
     field :permalink, 'string'
+    field :policy_eval_modify_reasons, { list: 'object' }
     field :ugc_content_format, 'string'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -40,6 +40,11 @@ module FacebookAds
       "VIEW_TEMPLATES",
     ]
 
+    TYPE = [
+      "INTERACTIVE",
+      "TEXT",
+    ]
+
     CATEGORY = [
       "AUTHENTICATION",
       "MARKETING",
@@ -55,9 +60,15 @@ module FacebookAds
       "POSITIONAL",
     ]
 
+    SEND_TYPE = [
+      "CAMPAIGN",
+      "DIRECT",
+    ]
+
     SUB_CATEGORY = [
       "ORDER_DETAILS",
       "ORDER_STATUS",
+      "RICH_ORDER_STATUS",
     ]
 
     PROVIDER_NAME = [
@@ -127,6 +138,7 @@ module FacebookAds
         api.has_param :metric_types, { list: { enum: %w{AVERAGE_DURATION COST COUNT UNKNOWN }} }
         api.has_param :phone_numbers, { list: 'string' }
         api.has_param :start, 'int'
+        api.has_param :tiers, { list: 'string' }
       end
     end
 
@@ -171,13 +183,36 @@ module FacebookAds
       end
     end
 
+    has_edge :group_analytics do |edge|
+      edge.get do |api|
+        api.has_param :end, 'datetime'
+        api.has_param :granularity, { enum: %w{DAILY }}
+        api.has_param :group_ids, { list: 'string' }
+        api.has_param :metric_types, { list: { enum: %w{CLICKS COST DELIVERED PARTICIPANTS_JOINED PARTICIPANTS_LEFT READ REPLIES SENT }} }
+        api.has_param :start, 'datetime'
+      end
+    end
+
+    has_edge :marketing_campaigns do |edge|
+      edge.get
+    end
+
     has_edge :message_campaigns do |edge|
       edge.get
     end
 
+    has_edge :message_samples do |edge|
+      edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :interactive, 'hash'
+        api.has_param :text, 'hash'
+        api.has_param :type, { enum: -> { WhatsAppBusinessAccount::TYPE }}
+      end
+    end
+
     has_edge :message_template_previews do |edge|
       edge.get do |api|
         api.has_param :add_security_recommendation, 'bool'
+        api.has_param :business_name, 'string'
         api.has_param :button_types, { list: { enum: %w{OTP }} }
         api.has_param :category, { enum: %w{AUTHENTICATION }}
         api.has_param :code_expiration_minutes, 'int'
@@ -197,10 +232,12 @@ module FacebookAds
         api.has_param :name, 'string'
         api.has_param :name_or_content, 'string'
         api.has_param :quality_score, { list: { enum: %w{GREEN RED UNKNOWN YELLOW }} }
+        api.has_param :source, { enum: %w{AUTO_GENERATED MANUAL }}
         api.has_param :status, { list: { enum: %w{APPROVED ARCHIVED DELETED DISABLED IN_APPEAL LIMIT_EXCEEDED PAUSED PENDING PENDING_DELETION REJECTED }} }
       end
       edge.post 'WhatsAppBusinessAccount' do |api|
         api.has_param :allow_category_change, 'bool'
+        api.has_param :bid_spec, 'hash'
         api.has_param :category, { enum: -> { WhatsAppBusinessAccount::CATEGORY }}
         api.has_param :components, { list: 'hash' }
         api.has_param :cta_url_link_tracking_opted_out, 'bool'
@@ -213,6 +250,7 @@ module FacebookAds
         api.has_param :message_send_ttl_seconds, 'int'
         api.has_param :name, 'string'
         api.has_param :parameter_format, { enum: -> { WhatsAppBusinessAccount::PARAMETER_FORMAT }}
+        api.has_param :send_type, { enum: -> { WhatsAppBusinessAccount::SEND_TYPE }}
         api.has_param :sub_category, { enum: -> { WhatsAppBusinessAccount::SUB_CATEGORY }}
       end
     end
@@ -226,8 +264,10 @@ module FacebookAds
 
     has_edge :migrate_message_templates do |edge|
       edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :count, 'int'
         api.has_param :page_number, 'int'
         api.has_param :source_waba_id, 'string'
+        api.has_param :template_ids, { list: 'string' }
       end
     end
 
@@ -272,7 +312,7 @@ module FacebookAds
         api.has_param :granularity, { enum: %w{DAILY HALF_HOUR MONTHLY }}
         api.has_param :metric_types, { list: { enum: %w{COST VOLUME }} }
         api.has_param :phone_numbers, { list: 'string' }
-        api.has_param :pricing_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL GROUP_MARKETING GROUP_SERVICE GROUP_UTILITY MARKETING MARKETING_LITE SERVICE UTILITY }} }
+        api.has_param :pricing_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL GROUP_MARKETING GROUP_MARKETING_LITE GROUP_SERVICE GROUP_UTILITY MARKETING MARKETING_LITE MARKETING_LITE_DYNAMIC SERVICE UTILITY }} }
         api.has_param :pricing_types, { list: { enum: %w{FREE_CUSTOMER_SERVICE FREE_ENTRY_POINT FREE_GROUP_CUSTOMER_SERVICE REGULAR }} }
         api.has_param :start, 'int'
         api.has_param :tiers, { list: 'string' }
@@ -327,6 +367,7 @@ module FacebookAds
         api.has_param :product_type, { enum: %w{CLOUD_API MARKETING_MESSAGES_LITE_API }}
         api.has_param :start, 'datetime'
         api.has_param :template_ids, { list: 'string' }
+        api.has_param :use_waba_timezone, 'bool'
       end
     end
 
@@ -367,10 +408,18 @@ module FacebookAds
     end
 
     has_edge :welcome_message_sequences do |edge|
+      edge.delete do |api|
+        api.has_param :sequence_id, 'string'
+      end
       edge.get 'CtxPartnerAppWelcomeMessageFlow' do |api|
         api.has_param :app_id, 'string'
         api.has_param :sequence_id, 'string'
       end
+      edge.post do |api|
+        api.has_param :name, 'string'
+        api.has_param :sequence_id, 'string'
+        api.has_param :welcome_message_sequence, 'object'
+      end
     end
 
   end

data/lib/facebook_ads/ad_objects/whats_app_business_health_status.rb

@@ -16,6 +16,7 @@ module FacebookAds
   class WhatsAppBusinessHealthStatus < AdObject
 
     field :additional_info, { list: 'string' }
+    field :can_receive_call_sip, 'string'
     field :can_send_message, 'string'
     field :entity_type, 'string'
     field :errors, { list: 'object' }

data/lib/facebook_ads/version.rb

@@ -7,6 +7,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '23.0.1'
+  VERSION = '23.0.3'
   API_VERSION = '23.0'
 end