facebookbusiness 19.0.3 → 20.0.1

data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.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 ThirdPartyPartnerViewabilityRequest < AdObject
+    STATUS = [
+      "CREATED",
+      "FAILURE",
+      "IN_PROGRESS",
+      "SCHEDULED",
+      "SUCCESS",
+    ]
+
+
+    field :created_time, 'datetime'
+    field :description, 'string'
+    field :hour, 'datetime'
+    field :id, 'string'
+    field :metric, 'string'
+    field :modified_time, 'datetime'
+    field :owner_instance_id, 'string'
+    field :platform, 'string'
+    field :status, { enum: -> { STATUS }}
+    field :total_file_count, 'int'
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/timezone_offset.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 TimezoneOffset < AdObject
+
+    field :abbr, 'string'
+    field :isdst, 'bool'
+    field :offset, 'int'
+    field :time, 'string'
+    field :ts, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/transactable_item.rb

@@ -0,0 +1,60 @@
+# 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 TransactableItem < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+
+    field :action_title, 'string'
+    field :applinks, 'CatalogItemAppLinks'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :currency, 'string'
+    field :description, 'string'
+    field :duration_time, 'int'
+    field :duration_type, 'string'
+    field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    field :images, { list: 'string' }
+    field :order_index, 'int'
+    field :price, 'string'
+    field :price_type, 'string'
+    field :sanitized_images, { list: 'string' }
+    field :session_type, 'string'
+    field :time_padding_after_end, 'int'
+    field :title, 'string'
+    field :transactable_item_id, '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/transaction.rb

@@ -0,0 +1,53 @@
+# 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 Transaction < AdObject
+    PRODUCT_TYPE = [
+      "cp_return_label",
+      "facebook_ad",
+      "ig_ad",
+      "whatsapp",
+      "workplace",
+    ]
+
+
+    field :account_id, 'string'
+    field :app_amount, 'object'
+    field :billing_end_time, 'int'
+    field :billing_reason, 'string'
+    field :billing_start_time, 'int'
+    field :card_charge_mode, 'int'
+    field :charge_type, 'string'
+    field :checkout_campaign_group_id, 'string'
+    field :credential_id, 'string'
+    field :fatura_id, 'int'
+    field :id, 'string'
+    field :is_business_ec_charge, 'bool'
+    field :is_funding_event, 'bool'
+    field :payment_option, 'string'
+    field :product_type, { enum: -> { PRODUCT_TYPE }}
+    field :provider_amount, 'object'
+    field :status, 'string'
+    field :time, 'int'
+    field :tracking_id, 'string'
+    field :transaction_type, 'string'
+    field :tx_type, 'int'
+    field :vat_invoice_id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/unique_ad_creative.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 UniqueAdCreative < AdObject
+
+    field :sample_creative, 'AdCreative'
+    field :visual_hash, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/user.rb

@@ -43,7 +43,7 @@ module FacebookAds
     field :community, 'Group'
     field :cover, 'UserCoverPhoto'
     field :currency, 'Currency'
-    field :education, { list: 'object' }
+    field :education, { list: 'EducationExperience' }
     field :email, 'string'
     field :favorite_athletes, { list: 'Experience' }
     field :favorite_teams, { list: 'Experience' }
@@ -165,6 +165,10 @@ module FacebookAds
       edge.get 'AdAccount'
     end
 
+    has_edge :assigned_applications do |edge|
+      edge.get 'Application'
+    end
+
     has_edge :assigned_business_asset_groups do |edge|
       edge.get 'BusinessAssetGroup' do |api|
         api.has_param :contained_asset_id, 'string'
@@ -203,7 +207,7 @@ module FacebookAds
         api.has_param :survey_business_type, { enum: -> { Business::SURVEY_BUSINESS_TYPE }}
         api.has_param :survey_num_assets, 'int'
         api.has_param :survey_num_people, 'int'
-        api.has_param :timezone_id, 'int'
+        api.has_param :timezone_id, { enum: -> { Business::TIMEZONE_ID }}
         api.has_param :vertical, { enum: -> { Business::VERTICAL }}
       end
     end
@@ -239,7 +243,6 @@ module FacebookAds
       end
       edge.post 'Post' 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'
@@ -324,7 +327,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'
@@ -378,12 +380,6 @@ module FacebookAds
       end
     end
 
-    has_edge :game_times do |edge|
-      edge.post do |api|
-        api.has_param :action, { enum: %w{END HEARTBEAT START }}
-      end
-    end
-
     has_edge :groups do |edge|
       edge.get 'Group' do |api|
         api.has_param :admin_only, 'bool'
@@ -585,7 +581,6 @@ module FacebookAds
         api.has_param :type, { enum: -> { AdVideo::TYPE }}
       end
       edge.post 'AdVideo' do |api|
-        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'
@@ -636,7 +631,6 @@ module FacebookAds
         api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
         api.has_param :privacy, 'string'
         api.has_param :publish_event_id, 'int'
-        api.has_param :react_mode_metadata, 'string'
         api.has_param :referenced_sticker_id, 'string'
         api.has_param :replace_video_id, 'string'
         api.has_param :slideshow_spec, 'hash'

data/lib/facebook_ads/ad_objects/user_context.rb

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

data/lib/facebook_ads/ad_objects/user_mobile_config.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 UserMobileConfig < AdObject
+
+    field :section_name, 'string'
+    field :value, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/user_notification_seen_state_data.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 UserNotificationSeenStateData < AdObject
+
+    field :id, 'string'
+    field :seen_state, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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