facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/audience_permission_for_actions.rb

@@ -1,20 +1,8 @@
-# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
-#
-# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
-# copy, modify, and distribute this software in source code or binary form for use
-# in connection with the web services and APIs provided by Facebook.
-#
-# As with any software that integrates with the Facebook platform, your use of
-# this software is subject to the Facebook Platform Policy
-# [http://developers.facebook.com/policy/]. This copyright notice shall be
-# included in all copies or substantial portions of the software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 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
 

data/lib/facebook_ads/ad_objects/audience_sharing_account_valid.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 AudienceSharingAccountValid < AdObject
+
+    field :account_id, 'string'
+    field :account_type, 'string'
+    field :business_id, 'string'
+    field :business_name, 'string'
+    field :can_ad_account_use_lookalike_container, 'bool'
+    field :sharing_agreement_status, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/audience_sharing_recipient_accounts.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 AudienceSharingRecipientAccounts < AdObject
+
+    field :account_id, 'string'
+    field :account_name, 'string'
+    field :account_type, 'string'
+    field :business_id, 'string'
+    field :business_name, 'string'
+    field :can_ad_account_use_lookalike_container, 'bool'
+    field :sharing_agreement_status, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/audio_asset.rb

@@ -0,0 +1,41 @@
+# 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 AudioAsset < AdObject
+
+    field :all_ddex_featured_artists, 'string'
+    field :all_ddex_main_artists, 'string'
+    field :audio_cluster_id, 'string'
+    field :cover_image_source, 'string'
+    field :display_artist, 'string'
+    field :download_hd_url, 'string'
+    field :download_sd_url, 'string'
+    field :duration_in_ms, 'int'
+    field :freeform_genre, 'string'
+    field :grid, 'string'
+    field :id, 'string'
+    field :is_test, 'bool'
+    field :original_release_date, 'datetime'
+    field :owner, 'Page'
+    field :parental_warning_type, 'string'
+    field :subtitle, 'string'
+    field :title, 'string'
+    field :title_with_featured_artists, 'string'
+    field :upc, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/audio_copyright.rb

@@ -1,20 +1,8 @@
-# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
-#
-# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
-# copy, modify, and distribute this software in source code or binary form for use
-# in connection with the web services and APIs provided by Facebook.
-#
-# As with any software that integrates with the Facebook platform, your use of
-# this software is subject to the Facebook Platform Policy
-# [http://developers.facebook.com/policy/]. This copyright notice shall be
-# included in all copies or substantial portions of the software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 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
 
@@ -34,6 +22,7 @@ module FacebookAds
     field :isrc, 'string'
     field :match_rule, 'VideoCopyrightRule'
     field :ownership_countries, { list: 'string' }
+    field :ownership_details, { list: 'hash' }
     field :reference_file_status, 'string'
     field :ridge_monitoring_status, 'string'
     field :tags, { list: 'string' }
@@ -44,7 +33,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/audio_isrc.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 AudioIsrc < AdObject
+
+    field :all_kg_featured_artists, 'string'
+    field :all_kg_main_artists, 'string'
+    field :artist_profile_picture_url, 'string'
+    field :id, 'string'
+    field :isrc, 'string'
+    field :publishing_rights_data, 'object'
+    field :top_searchable_artist_id, 'string'
+    field :top_searchable_artist_name, 'string'
+    field :top_searchable_artist_profile_pic_url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/audio_release.rb

@@ -0,0 +1,38 @@
+# 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 AudioRelease < AdObject
+
+    field :album_title, 'string'
+    field :asset_availability_status, { list: 'hash' }
+    field :audio_availability_status, 'string'
+    field :audio_release_image_uri, 'string'
+    field :created_time, 'datetime'
+    field :displayed_artist, 'string'
+    field :ean, 'string'
+    field :genre, 'string'
+    field :grid, 'string'
+    field :id, 'string'
+    field :isrc, 'string'
+    field :label_name, 'string'
+    field :original_release_date, 'datetime'
+    field :parental_warning_type, 'string'
+    field :proprietary_id, 'string'
+    field :upc, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/audio_visual_reference_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 AudioVisualReferenceMatch < AdObject
+
+    field :audio_conflicting_segments, { list: 'object' }
+    field :audio_current_conflict_resolved_segments, { list: 'object' }
+    field :audio_segment_resolution_history, { list: 'object' }
+    field :conflict_type, 'string'
+    field :conflicting_countries, { list: 'string' }
+    field :country_resolution_history, { list: 'map<string, list<Object>>' }
+    field :creation_time, 'datetime'
+    field :current_conflict_resolved_countries, { list: 'hash' }
+    field :displayed_match_state, 'string'
+    field :dispute_form_data_entries_with_translations, { list: 'object' }
+    field :expiration_time, 'datetime'
+    field :id, 'string'
+    field :is_disputable, 'bool'
+    field :match_state, 'string'
+    field :matched_overlap_percentage, 'double'
+    field :matched_owner_match_duration_in_sec, 'double'
+    field :matched_reference_owner, 'Profile'
+    field :modification_history, { list: 'object' }
+    field :num_matches_on_matched_side, 'int'
+    field :num_matches_on_ref_side, 'int'
+    field :ref_owner_match_duration_in_sec, 'double'
+    field :reference_overlap_percentage, 'double'
+    field :reference_owner, 'Profile'
+    field :rejection_form_data_entries_with_translations, { list: 'object' }
+    field :resolution_details, 'string'
+    field :resolution_reason, 'string'
+    field :update_time, 'datetime'
+    field :views_on_matched_side, 'int'
+    field :visual_conflicting_segments, { list: 'object' }
+    field :visual_current_conflict_resolved_segments, { list: 'object' }
+    field :visual_segment_resolution_history, { list: 'object' }
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/auth_link.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 AuthLink < AdObject
+
+    field :link, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/automotive_model.rb

@@ -1,20 +1,8 @@
-# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
-#
-# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
-# copy, modify, and distribute this software in source code or binary form for use
-# in connection with the web services and APIs provided by Facebook.
-#
-# As with any software that integrates with the Facebook platform, your use of
-# this software is subject to the Facebook Platform Policy
-# [http://developers.facebook.com/policy/]. This copyright notice shall be
-# included in all copies or substantial portions of the software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 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
 
@@ -35,29 +23,9 @@ module FacebookAds
       "PARTIAL_FETCH",
     ]
 
-    BODY_STYLE = [
-      "CONVERTIBLE",
-      "COUPE",
-      "CROSSOVER",
-      "ESTATE",
-      "GRANDTOURER",
-      "HATCHBACK",
-      "MINIBUS",
-      "MINIVAN",
-      "MPV",
-      "NONE",
-      "OTHER",
-      "PICKUP",
-      "ROADSTER",
-      "SALOON",
-      "SEDAN",
-      "SPORTSCAR",
-      "SUPERCAR",
-      "SUPERMINI",
-      "SUV",
-      "TRUCK",
-      "VAN",
-      "WAGON",
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
     ]
 
 
@@ -89,20 +57,24 @@ module FacebookAds
     field :trim, 'string'
     field :unit_price, 'object'
     field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
     field :year, 'int'
     has_no_post
     has_no_delete
 
-    has_edge :augmented_realities_metadata do |edge|
-      edge.get
-    end
-
     has_edge :channels_to_integrity_status do |edge|
       edge.get 'CatalogItemChannelsToIntegrityStatus'
     end
 
+    has_edge :override_details do |edge|
+      edge.get 'OverrideDetails' do |api|
+        api.has_param :keys, { list: 'string' }
+        api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
+      end
+    end
+
     has_edge :videos_metadata do |edge|
-      edge.get
+      edge.get 'DynamicVideoMetadata'
     end
 
   end

data/lib/facebook_ads/ad_objects/avatar.rb

@@ -0,0 +1,35 @@
+# 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 Avatar < AdObject
+
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :models do |edge|
+      edge.get do |api|
+        api.has_param :client_name, 'string'
+        api.has_param :client_version, 'string'
+        api.has_param :config_id, 'string'
+        api.has_param :force_generate, 'bool'
+        api.has_param :platform, 'string'
+        api.has_param :profile, 'string'
+        api.has_param :sdk_version, 'string'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/avatar_profile_picture.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 AvatarProfilePicture < AdObject
+
+    field :id, 'string'
+    field :url, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/bapi_domain.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 BapiDomain < AdObject
+
+    field :domain, 'string'
+    field :in_cool_down_until, 'int'
+    field :is_eligible_for_vo, 'bool'
+    field :is_in_cool_down, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/bcp_campaign.rb

@@ -0,0 +1,39 @@
+# 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 BcpCampaign < AdObject
+
+    field :ads_permission_required, 'bool'
+    field :application_deadline, 'string'
+    field :campaign_goal, 'string'
+    field :campaign_goal_other, 'string'
+    field :content_delivery_deadline, 'string'
+    field :content_delivery_start_date, 'string'
+    field :content_requirements, { list: 'map<string, unsigned int>' }
+    field :content_requirements_description, 'string'
+    field :currency, 'string'
+    field :deal_negotiation_type, 'string'
+    field :description, 'string'
+    field :has_free_product, 'bool'
+    field :id, 'string'
+    field :name, 'string'
+    field :payment_amount_for_ads, 'int'
+    field :payment_amount_for_content, 'int'
+    field :payment_description, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/bespoke_partner_guidance_laser.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 BespokePartnerGuidanceLaser < AdObject
+
+    field :business, 'Business'
+    field :campaign_group, 'Campaign'
+    field :cpa_improvement, 'double'
+    field :guidance_type, 'string'
+    field :id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/bid_schedule.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 BidSchedule < AdObject
+
+    field :ad_object_id, 'string'
+    field :bid_recurrence_type, 'string'
+    field :bid_timezone, 'string'
+    field :bid_value, 'int'
+    field :id, 'string'
+    field :status, 'string'
+    field :time_end, 'datetime'
+    field :time_start, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/biz_inbox_offsite_email_account.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 BizInboxOffsiteEmailAccount < AdObject
+
+    field :email_address, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :assigned_users do |edge|
+      edge.get 'AssignedUser'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/blind_pig.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 BlindPig < AdObject
+
+    field :id, 'string'
+    field :name, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end