facebookbusiness 19.0.3 → 20.0.1

data/lib/facebook_ads/ad_objects/messenger_call_settings.rb

@@ -0,0 +1,25 @@
+# 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 MessengerCallSettings < AdObject
+
+    field :audio_enabled, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/messenger_destination_page_welcome_message.rb

@@ -0,0 +1,29 @@
+# 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 MessengerDestinationPageWelcomeMessage < AdObject
+
+    field :id, 'string'
+    field :page_welcome_message_body, 'string'
+    field :page_welcome_message_type, 'string'
+    field :template_name, 'string'
+    field :time_created, 'datetime'
+    field :time_last_used, 'datetime'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mix_insights_result.rb

@@ -0,0 +1,45 @@
+# 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 MixInsightsResult < AdObject
+
+    field :daily_age_gender_breakdown, { list: 'map<string, list<map<string, int>>>' }
+    field :daily_audio_library_values, { list: 'hash' }
+    field :daily_ugc_values, { list: 'hash' }
+    field :daily_values, { list: 'hash' }
+    field :metric, 'string'
+    field :monthly_audio_library_values, { list: 'hash' }
+    field :monthly_ugc_values, { list: 'hash' }
+    field :monthly_values, { list: 'hash' }
+    field :percent_growth, 'double'
+    field :shielded_fields, { list: 'map<string, list<map<string, bool>>>' }
+    field :total_age_gender_breakdown, { list: 'hash' }
+    field :total_audio_library_value, 'int'
+    field :total_country_breakdown, { list: 'hash' }
+    field :total_locale_breakdown, { list: 'hash' }
+    field :total_product_breakdown, { list: 'hash' }
+    field :total_ugc_value, 'int'
+    field :total_value, 'int'
+    field :trending_age, { list: 'map<string, list<map<string, float>>>' }
+    field :trending_gender, { list: 'map<string, list<map<string, float>>>' }
+    field :trending_interest, { list: 'map<string, list<map<string, float>>>' }
+    field :trending_territory, { list: 'map<string, list<map<string, float>>>' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/music_work_copyright.rb

@@ -0,0 +1,33 @@
+# 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 MusicWorkCopyright < AdObject
+
+    field :available_ui_actions, { list: 'string' }
+    field :claim_status, 'string'
+    field :creation_time, 'datetime'
+    field :displayed_fb_matches_count, 'int'
+    field :displayed_ig_matches_count, 'int'
+    field :displayed_matches_count, 'int'
+    field :id, 'string'
+    field :match_rule, 'VideoCopyrightRule'
+    field :status, 'string'
+    field :tags, { list: 'string' }
+    field :update_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/negative_keyword_list.rb

@@ -0,0 +1,33 @@
+# 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 NegativeKeywordList < AdObject
+
+    field :applied_active_ad_campaign_groups, { list: 'hash' }
+    field :applied_inactive_ad_campaign_groups, { list: 'hash' }
+    field :creator_id, 'string'
+    field :id, 'string'
+    field :is_fully_reviewed, 'bool'
+    field :last_update_time, 'datetime'
+    field :last_update_user_id, 'string'
+    field :list_name, 'string'
+    field :total_approved_keyword_count, 'int'
+    field :total_declined_keyword_count, 'int'
+    field :total_negative_keyword_count, 'int'
+    field :total_validated_keyword_count, 'int'
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -14,20 +14,6 @@ module FacebookAds
   # pull request for this class.
 
   class OfflineConversionDataSet < AdObject
-    PERMITTED_ROLES = [
-      "ADMIN",
-      "ADVERTISER",
-      "UPLOADER",
-    ]
-
-    RELATIONSHIP_TYPE = [
-      "AD_MANAGER",
-      "AGENCY",
-      "AGGREGATOR",
-      "AUDIENCE_MANAGER",
-      "OTHER",
-    ]
-
 
     field :automatic_matching_fields, { list: 'string' }
     field :business, 'Business'
@@ -61,27 +47,17 @@ module FacebookAds
     field :owner_business, 'Business'
     field :usage, 'OfflineConversionDataSetUsage'
     field :valid_entries, 'int'
-    field :auto_assign_to_new_accounts_only, 'bool'
+    has_no_post
+    has_no_delete
 
     has_edge :adaccounts do |edge|
       edge.get 'AdAccount' do |api|
         api.has_param :business, 'string'
       end
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :account_id, 'string'
-        api.has_param :auto_track_for_ads, 'bool'
-        api.has_param :business, 'string'
-      end
     end
 
     has_edge :agencies do |edge|
       edge.get 'Business'
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :business, 'string'
-        api.has_param :other_relationship, 'string'
-        api.has_param :permitted_roles, { list: { enum: -> { OfflineConversionDataSet::PERMITTED_ROLES }} }
-        api.has_param :relationship_type, { list: { enum: -> { OfflineConversionDataSet::RELATIONSHIP_TYPE }} }
-      end
     end
 
     has_edge :audiences do |edge|
@@ -133,16 +109,6 @@ module FacebookAds
         api.has_param :start_time, 'datetime'
         api.has_param :upload_tag, 'string'
       end
-      edge.post 'OfflineConversionDataSetUpload' do |api|
-        api.has_param :upload_tag, 'string'
-      end
-    end
-
-    has_edge :validate do |edge|
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :data, { list: 'string' }
-        api.has_param :namespace_id, 'string'
-      end
     end
 
   end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_activities.rb

@@ -0,0 +1,33 @@
+# 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 OfflineConversionDataSetActivities < AdObject
+
+    field :actor_id, 'int'
+    field :actor_name, 'string'
+    field :adaccount_id, 'int'
+    field :adaccount_name, 'string'
+    field :event_time, 'datetime'
+    field :event_type, 'string'
+    field :extra_data, 'string'
+    field :object_id, 'int'
+    field :object_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_optimization_status.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 OfflineConversionDataSetOptimizationStatus < AdObject
+
+    field :event, 'string'
+    field :last_changed_time, 'int'
+    field :last_detected_time, 'int'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_product_item.rb

@@ -0,0 +1,56 @@
+# 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 OfflineProductItem < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+
+    field :applinks, 'CatalogItemAppLinks'
+    field :brand, 'string'
+    field :category, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :currency, 'string'
+    field :description, 'string'
+    field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    field :image_url, 'string'
+    field :images, { list: 'string' }
+    field :name, 'string'
+    field :offline_product_item_id, 'string'
+    field :price, 'string'
+    field :sanitized_images, { list: 'string' }
+    field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
+    has_no_post
+    has_no_delete
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_terms_of_service.rb

@@ -0,0 +1,25 @@
+# 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 OfflineTermsOfService < AdObject
+
+    field :accept_time, 'int'
+    field :id, 'string'
+    field :signed_by_user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offsite_signal_container_business_object.rb

@@ -0,0 +1,37 @@
+# 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 OffsiteSignalContainerBusinessObject < AdObject
+
+    field :business, 'Business'
+    field :id, 'string'
+    field :is_eligible_for_sharing_to_ad_account, 'bool'
+    field :is_eligible_for_sharing_to_business, 'bool'
+    field :is_unavailable, 'bool'
+    field :name, 'string'
+    field :primary_container_id, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :linked_application do |edge|
+      edge.get 'AdsDataset'
+    end
+
+    has_edge :linked_page do |edge|
+      edge.get 'Page'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb

@@ -15,7 +15,6 @@ module FacebookAds
 
   class OpenBridgeConfiguration < AdObject
 
-    field :access_key, 'string'
     field :active, 'bool'
     field :endpoint, 'string'
     field :fallback_domain, 'string'
@@ -23,6 +22,7 @@ module FacebookAds
     field :host_business_id, 'string'
     field :host_external_id, 'string'
     field :id, 'string'
+    field :instance_id, 'string'
     field :pixel_id, 'string'
 
   end

data/lib/facebook_ads/ad_objects/order_id_attributions.rb

@@ -0,0 +1,33 @@
+# 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 OrderIdAttributions < AdObject
+
+    field :app_id, 'string'
+    field :attribution_type, 'string'
+    field :attributions, { list: 'object' }
+    field :conversion_device, 'string'
+    field :dataset_id, 'string'
+    field :holdout_status, { list: 'object' }
+    field :order_id, 'string'
+    field :order_timestamp, 'datetime'
+    field :pixel_id, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/organization.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 Organization < AdObject
+
+    field :hq_country, 'string'
+    field :id, 'string'
+    field :legal_entity_name, 'string'
+    field :master_bm_id, 'string'
+    field :owner_business, 'Business'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/owned_domain.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 OwnedDomain < AdObject
+
+    field :domain_name, 'string'
+    field :id, 'string'
+    field :owner_business, 'Business'
+    field :status, 'string'
+    field :verification_code, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/p2m_invoice_payments.rb

@@ -0,0 +1,26 @@
+# 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 P2mInvoicePayments < AdObject
+
+    field :page_id, 'string'
+    field :payments, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/page.rb

@@ -458,11 +458,11 @@ module FacebookAds
     field :influences, 'string'
     field :instagram_business_account, 'IgUser'
     field :is_always_open, 'bool'
+    field :is_calling_eligible, 'bool'
     field :is_chain, 'bool'
     field :is_community_page, 'bool'
     field :is_eligible_for_branded_content, 'bool'
     field :is_eligible_for_disable_connect_ig_btn_for_non_page_admin_am_web, 'bool'
-    field :is_eligible_for_live_boosting_expansion, 'bool'
     field :is_messenger_bot_get_started_enabled, 'bool'
     field :is_messenger_platform_bot, 'bool'
     field :is_owned, 'bool'
@@ -591,7 +591,7 @@ module FacebookAds
     end
 
     has_edge :ar_experience do |edge|
-      edge.get
+      edge.get 'ArAdsDataContainer'
     end
 
     has_edge :assigned_users do |edge|
@@ -635,7 +635,7 @@ module FacebookAds
     end
 
     has_edge :businessprojects do |edge|
-      edge.get do |api|
+      edge.get 'BusinessProject' do |api|
         api.has_param :business, 'string'
       end
     end
@@ -644,6 +644,16 @@ module FacebookAds
       edge.get 'PageCallToAction'
     end
 
+    has_edge :calls do |edge|
+      edge.post do |api|
+        api.has_param :action, { enum: %w{ACCEPT REJECT TERMINATE }}
+        api.has_param :call_id, 'string'
+        api.has_param :platform, { enum: %w{INSTAGRAM MESSENGER }}
+        api.has_param :session, 'hash'
+        api.has_param :to, 'string'
+      end
+    end
+
     has_edge :canvas_elements do |edge|
       edge.get 'CanvasBodyElement'
       edge.post 'CanvasBodyElement' do |api|
@@ -734,11 +744,11 @@ module FacebookAds
     end
 
     has_edge :copyright_manual_claims do |edge|
-      edge.post do |api|
-        api.has_param :action, { enum: %w{BLOCK CLAIM_AD_EARNINGS MANUAL_REVIEW MONITOR REQUEST_TAKEDOWN }}
-        api.has_param :action_reason, { enum: %w{ARTICLE_17_PREFLAGGING ARTIST_OBJECTION OBJECTIONABLE_CONTENT PREMIUM_MUSIC_VIDEO PRERELEASE_CONTENT PRODUCT_PARAMETERS RESTRICTED_CONTENT UNAUTHORIZED_COMMERCIAL_USE }}
+      edge.post 'VideoCopyrightMatch' do |api|
+        api.has_param :action, { enum: -> { VideoCopyrightMatch::ACTION }}
+        api.has_param :action_reason, { enum: -> { VideoCopyrightMatch::ACTION_REASON }}
         api.has_param :countries, 'object'
-        api.has_param :match_content_type, { enum: %w{AUDIO_ONLY VIDEO_AND_AUDIO VIDEO_ONLY }}
+        api.has_param :match_content_type, { enum: -> { VideoCopyrightMatch::MATCH_CONTENT_TYPE }}
         api.has_param :matched_asset_id, 'string'
         api.has_param :reference_asset_id, 'string'
         api.has_param :selected_segments, { list: 'hash' }
@@ -772,7 +782,8 @@ module FacebookAds
     end
 
     has_edge :dataset do |edge|
-      edge.get 'Dataset'
+      edge.get 'AdsPixel'
+      edge.post 'AdsPixel'
     end
 
     has_edge :events do |edge|
@@ -792,7 +803,7 @@ module FacebookAds
     end
 
     has_edge :fantasy_games do |edge|
-      edge.get
+      edge.get 'FantasyGame'
     end
 
     has_edge :feed do |edge|
@@ -804,7 +815,6 @@ module FacebookAds
       end
       edge.post 'Page' do |api|
         api.has_param :actions, 'object'
-        api.has_param :adaptive_type, 'string'
         api.has_param :album_id, 'string'
         api.has_param :android_key_hash, 'string'
         api.has_param :animated_effect_id, 'int'
@@ -890,7 +900,6 @@ module FacebookAds
         api.has_param :publish_event_id, 'int'
         api.has_param :published, 'bool'
         api.has_param :quote, 'string'
-        api.has_param :react_mode_metadata, 'string'
         api.has_param :ref, { list: 'string' }
         api.has_param :referenceable_image_ids, { list: 'string' }
         api.has_param :referral_id, 'string'
@@ -1094,6 +1103,13 @@ module FacebookAds
       edge.get 'MessagingFeatureReview'
     end
 
+    has_edge :messenger_call_settings do |edge|
+      edge.get 'MessengerCallSettings'
+      edge.post 'Page' do |api|
+        api.has_param :audio_enabled, 'bool'
+      end
+    end
+
     has_edge :messenger_lead_forms do |edge|
       edge.get 'MessengerAdsPartialAutomatedStepList'
       edge.post 'Page' do |api|
@@ -1507,7 +1523,6 @@ module FacebookAds
       end
       edge.post 'AdVideo' do |api|
         api.has_param :ad_breaks, { list: 'string' }
-        api.has_param :adaptive_type, 'string'
         api.has_param :animated_effect_id, 'int'
         api.has_param :application_id, 'string'
         api.has_param :asked_fun_fact_prompt_id, 'int'
@@ -1566,7 +1581,6 @@ module FacebookAds
         api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
         api.has_param :publish_event_id, 'int'
         api.has_param :published, 'bool'
-        api.has_param :react_mode_metadata, 'string'
         api.has_param :reference_only, 'bool'
         api.has_param :referenced_sticker_id, 'string'
         api.has_param :replace_video_id, 'string'