facebookbusiness 19.0.2 → 20.0.0

data/lib/facebook_ads/ad_objects/user_payment_methods_info.rb

@@ -0,0 +1,31 @@
+# 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 UserPaymentMethodsInfo < AdObject
+
+    field :account_id, 'string'
+    field :available_card_types, { list: 'string' }
+    field :available_payment_methods, { list: 'string' }
+    field :available_payment_methods_details, { list: 'object' }
+    field :country, 'string'
+    field :currency, 'string'
+    field :existing_payment_methods, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/user_payment_modules_options.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 UserPaymentModulesOptions < AdObject
+
+    field :account_id, 'string'
+    field :available_payment_options, { list: 'object' }
+    field :country, 'string'
+    field :currency, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/user_set_reporting_root.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 UserSetReportingRoot < AdObject
+
+    field :creation_time, 'datetime'
+    field :id, 'string'
+    field :last_modified_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/vehicle.rb

@@ -168,7 +168,7 @@ module FacebookAds
     has_no_delete
 
     has_edge :augmented_realities_metadata do |edge|
-      edge.get
+      edge.get 'DynamicArMetadata'
     end
 
     has_edge :channels_to_integrity_status do |edge|

data/lib/facebook_ads/ad_objects/vehicle_offer.rb

@@ -78,7 +78,7 @@ module FacebookAds
     has_no_delete
 
     has_edge :augmented_realities_metadata do |edge|
-      edge.get
+      edge.get 'DynamicArMetadata'
     end
 
     has_edge :channels_to_integrity_status do |edge|

data/lib/facebook_ads/ad_objects/video_asset.rb

@@ -0,0 +1,75 @@
+# 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 VideoAsset < AdObject
+
+    field :broadcast_id, 'string'
+    field :broadcast_planned_start_time, 'datetime'
+    field :can_viewer_edit, 'bool'
+    field :copyright_monitoring_status, 'string'
+    field :created_time, 'datetime'
+    field :creator, 'User'
+    field :description, 'string'
+    field :download_hd_url, 'string'
+    field :download_sd_url, 'string'
+    field :embeddable, 'bool'
+    field :expiration, 'object'
+    field :feed_type, 'string'
+    field :id, 'string'
+    field :is_crossposting_eligible, 'bool'
+    field :is_crossposting_within_bm_eligible, 'bool'
+    field :is_crossposting_within_bm_enabled, 'bool'
+    field :is_episode, 'bool'
+    field :is_featured, 'bool'
+    field :is_live_premiere, 'bool'
+    field :is_video_asset, 'bool'
+    field :last_added_time, 'datetime'
+    field :latest_creator, 'User'
+    field :latest_owned_description, 'string'
+    field :latest_owned_title, 'string'
+    field :length, 'double'
+    field :live_status, 'string'
+    field :no_story, 'bool'
+    field :owner_name, 'string'
+    field :owner_picture, 'string'
+    field :owner_post_state, 'string'
+    field :permalink_url, 'string'
+    field :picture, 'string'
+    field :posts_count, 'int'
+    field :posts_ids, { list: 'string' }
+    field :posts_status, 'object'
+    field :premiere_living_room_status, 'string'
+    field :published, 'bool'
+    field :scheduled_publish_time, 'datetime'
+    field :secret, 'bool'
+    field :secure_stream_url, 'string'
+    field :social_actions, 'bool'
+    field :status, 'VideoStatus'
+    field :stream_url, 'string'
+    field :thumbnail_while_encoding, 'string'
+    field :title, 'string'
+    field :views, 'int'
+    has_no_post
+    has_no_delete
+
+    has_edge :insights do |edge|
+      edge.get 'InsightsResult' do |api|
+        api.has_param :metric, { list: { enum: -> { InsightsResult::METRIC }} }
+        api.has_param :period, { enum: -> { InsightsResult::PERIOD }}
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/video_copyright.rb

@@ -46,7 +46,7 @@ module FacebookAds
     has_no_delete
 
     has_edge :update_records do |edge|
-      edge.get
+      edge.get 'MediaCopyrightUpdateRecord'
     end
 
   end

data/lib/facebook_ads/ad_objects/video_copyright_match.rb

@@ -0,0 +1,54 @@
+# 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 VideoCopyrightMatch < AdObject
+    ACTION = [
+      "BLOCK",
+      "CLAIM_AD_EARNINGS",
+      "MANUAL_REVIEW",
+      "MONITOR",
+      "REQUEST_TAKEDOWN",
+    ]
+
+    ACTION_REASON = [
+      "ARTICLE_17_PREFLAGGING",
+      "ARTIST_OBJECTION",
+      "OBJECTIONABLE_CONTENT",
+      "PREMIUM_MUSIC_VIDEO",
+      "PRERELEASE_CONTENT",
+      "PRODUCT_PARAMETERS",
+      "RESTRICTED_CONTENT",
+      "UNAUTHORIZED_COMMERCIAL_USE",
+    ]
+
+    MATCH_CONTENT_TYPE = [
+      "AUDIO_ONLY",
+      "VIDEO_AND_AUDIO",
+      "VIDEO_ONLY",
+    ]
+
+
+    field :created_date, 'datetime'
+    field :id, 'string'
+    field :last_modified_user, 'User'
+    field :match_data, { list: 'object' }
+    field :match_status, 'string'
+    field :notes, 'string'
+    field :permalink, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/video_group.rb

@@ -0,0 +1,40 @@
+# 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 VideoGroup < AdObject
+
+    field :created_time, 'string'
+    field :description, 'string'
+    field :disable_reason, 'string'
+    field :id, 'string'
+    field :ig_profile_ids, { list: 'string' }
+    field :is_disabled, 'bool'
+    field :is_fb_video_group, 'bool'
+    field :last_used_time, 'string'
+    field :length, 'double'
+    field :name, 'string'
+    field :page_id, 'string'
+    field :page_ids, { list: 'string' }
+    field :picture, 'string'
+    field :placements, { list: 'string' }
+    field :video_group_types, { list: 'string' }
+    field :videos, { list: 'string' }
+    field :views, 'int'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/video_metrics_report.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 VideoMetricsReport < AdObject
+
+    field :checksum, 'string'
+    field :chunks, 'int'
+    field :end_date, 'datetime'
+    field :id, 'string'
+    field :index, 'int'
+    field :name, 'string'
+    field :platform, 'string'
+    field :start_date, 'datetime'
+    field :type, 'string'
+    field :upload_date, 'datetime'
+    field :url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/video_stats.rb

@@ -0,0 +1,30 @@
+# 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 VideoStats < AdObject
+
+    field :aggregate, { list: 'hash' }
+    field :error, 'string'
+    field :metadata, { list: 'hash' }
+    field :time_series, { list: 'map<string, list<Object>>' }
+    field :totals, { list: 'hash' }
+    field :x_axis_breakdown, { list: { list: 'hash' } }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/video_text_question.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 VideoTextQuestion < AdObject
+
+    field :id, 'string'
+    field :question_target_id, 'string'
+    field :question_text, 'string'
+    field :status, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/vidwalla_broadcast.rb

@@ -0,0 +1,24 @@
+# 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 VidwallaBroadcast < AdObject
+
+    field :id, 'string'
+    field :overlay_url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/wearable_device_public_key.rb

@@ -0,0 +1,30 @@
+# 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 WearableDevicePublicKey < AdObject
+
+    field :base64_encoded_public_key, 'string'
+    field :creation_time_on_device, 'datetime'
+    field :device_uuid, 'string'
+    field :id, 'string'
+    field :key_type, 'string'
+    field :owner_id, 'string'
+    field :product_use_case, 'string'
+    field :version, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/web_publisher.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 WebPublisher < AdObject
+
+    field :domain_url, 'string'
+    field :id, 'string'
+    field :publisher_name, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/website_creative_asset_source.rb

@@ -0,0 +1,24 @@
+# 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 WebsiteCreativeAssetSource < AdObject
+
+    field :id, 'string'
+    field :source_url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/website_creative_asset_suggestions.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 WebsiteCreativeAssetSuggestions < AdObject
+
+    field :ad_account_id, 'string'
+    field :extraction_status, 'string'
+    field :id, 'string'
+    field :link_url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -21,6 +21,7 @@ module FacebookAds
       "MANAGE_PHONE",
       "MANAGE_PHONE_ASSETS",
       "MANAGE_TEMPLATES",
+      "MESSAGING",
       "VIEW_COST",
       "VIEW_PHONE_ASSETS",
       "VIEW_TEMPLATES",
@@ -32,8 +33,11 @@ module FacebookAds
       "UTILITY",
     ]
 
+    DISPLAY_FORMAT = [
+      "ORDER_DETAILS",
+    ]
+
     SUB_CATEGORY = [
-      "CUSTOM",
       "ORDER_DETAILS",
       "ORDER_STATUS",
     ]
@@ -41,6 +45,7 @@ module FacebookAds
 
     field :account_review_status, 'string'
     field :analytics, 'object'
+    field :auth_international_rate_eligibility, 'object'
     field :business_verification_status, 'string'
     field :country, 'string'
     field :creation_time, 'int'
@@ -55,6 +60,7 @@ module FacebookAds
     field :owner_business, 'Business'
     field :owner_business_info, 'object'
     field :ownership_type, 'string'
+    field :primary_business_location, 'string'
     field :primary_funding_id, 'string'
     field :purchase_order_number, 'string'
     field :status, 'string'
@@ -80,7 +86,7 @@ module FacebookAds
 
     has_edge :conversation_analytics do |edge|
       edge.get do |api|
-        api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION MARKETING MARKETING_OPTIMIZED_DELIVERY SERVICE UNKNOWN UTILITY }} }
+        api.has_param :conversation_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING MARKETING_OPTIMIZED_DELIVERY SERVICE UNKNOWN UTILITY UTILITY_FIXED_TEMPLATE }} }
         api.has_param :conversation_directions, { list: { enum: %w{BUSINESS_INITIATED UNKNOWN USER_INITIATED }} }
         api.has_param :conversation_types, { list: { enum: %w{FREE_ENTRY_POINT FREE_TIER REGULAR UNKNOWN }} }
         api.has_param :country_codes, { list: 'string' }
@@ -133,13 +139,14 @@ 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 :status, { list: { enum: %w{APPROVED DELETED DISABLED IN_APPEAL LIMIT_EXCEEDED PAUSED PENDING PENDING_DELETION REJECTED }} }
+        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 :category, { enum: -> { WhatsAppBusinessAccount::CATEGORY }}
         api.has_param :components, { list: 'hash' }
         api.has_param :cta_url_link_tracking_opted_out, 'bool'
+        api.has_param :display_format, { enum: -> { WhatsAppBusinessAccount::DISPLAY_FORMAT }}
         api.has_param :language, 'string'
         api.has_param :library_template_button_inputs, { list: 'hash' }
         api.has_param :library_template_name, 'string'
@@ -181,6 +188,16 @@ module FacebookAds
       edge.get
     end
 
+    has_edge :set_obo_mobility_intent do |edge|
+      edge.post do |api|
+        api.has_param :solution_id, 'string'
+      end
+    end
+
+    has_edge :solutions do |edge|
+      edge.get
+    end
+
     has_edge :subscribed_apps do |edge|
       edge.delete
       edge.get
@@ -194,7 +211,7 @@ module FacebookAds
       edge.get do |api|
         api.has_param :end, 'datetime'
         api.has_param :granularity, { enum: %w{DAILY }}
-        api.has_param :metric_types, { list: { enum: %w{CLICKED DELIVERED READ SENT }} }
+        api.has_param :metric_types, { list: { enum: %w{CLICKED COST DELIVERED READ SENT }} }
         api.has_param :start, 'datetime'
         api.has_param :template_ids, { list: 'string' }
       end

data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb

@@ -14,14 +14,28 @@ module FacebookAds
   # pull request for this class.
 
   class WhatsAppBusinessPartnerClientVerificationSubmission < AdObject
+    REJECTION_REASONS = [
+      "ADDRESS_NOT_MATCHING",
+      "LEGAL_NAME_NOT_MATCHING",
+      "NONE",
+      "WEBSITE_NOT_MATCHING",
+    ]
+
+    VERIFICATION_STATUS = [
+      "APPROVED",
+      "FAILED",
+      "PENDING",
+      "REVOKED",
+    ]
+
 
     field :client_business_id, 'string'
     field :id, 'string'
-    field :rejection_reasons, { list: 'string' }
+    field :rejection_reasons, { list: { enum: -> { REJECTION_REASONS }} }
     field :submitted_info, 'object'
     field :submitted_time, 'datetime'
     field :update_time, 'datetime'
-    field :verification_status, 'string'
+    field :verification_status, { enum: -> { VERIFICATION_STATUS }}
     has_no_get
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/whats_app_payment_capabilities.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 WhatsAppPaymentCapabilities < AdObject
+
+    field :is_enabled, 'bool'
+    field :payment_capability_details, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end