facebookbusiness 19.0.3 → 20.0.1

data/lib/facebook_ads/ad_objects/canvas_template.rb

@@ -0,0 +1,36 @@
+# 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 CanvasTemplate < AdObject
+
+    field :channels, { list: 'map<string, list<map<string, string>>>' }
+    field :description, 'string'
+    field :document, 'Canvas'
+    field :id, 'string'
+    field :is_multi_tab_supportable, 'bool'
+    field :is_new, 'bool'
+    field :name, 'string'
+    field :objectives, { list: 'hash' }
+    field :owner_id, 'User'
+    field :required_capabilities, { list: 'string' }
+    field :snapshot_photo, 'Photo'
+    field :status, 'string'
+    field :sub_verticals, { list: 'string' }
+    field :verticals, { list: 'hash' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/cass_setup_offline_event_set_progress.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 CassSetupOfflineEventSetProgress < AdObject
+
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/catalog_item_override.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 CatalogItemOverride < AdObject
+
+    field :id, 'string'
+    field :local_info, 'ProductItemLocalInfo'
+    field :override_type, 'string'
+    field :override_value, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/catalog_item_rejection_reasons.rb

@@ -0,0 +1,34 @@
+# 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 CatalogItemRejectionReasons < AdObject
+    CAPABILITY = [
+      "business_inbox_in_messenger",
+      "shops",
+      "test_capability",
+      "universal_checkout",
+      "us_marketplace",
+    ]
+
+
+    field :capability, { enum: -> { CAPABILITY }}
+    field :rejection_information, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/catalog_item_validation_error_list.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 CatalogItemValidationErrorList < AdObject
+
+    field :errors, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/catalog_smart_pixel_settings.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 CatalogSmartPixelSettings < AdObject
+
+    field :allowed_domains, { list: 'string' }
+    field :available_property_filters, { list: 'string' }
+    field :catalog, 'ProductCatalog'
+    field :cbb_custom_override_filters, { list: 'object' }
+    field :cbb_default_filter, { list: 'map<string, list<string>>' }
+    field :cbb_default_filter_crawl_params, 'string'
+    field :cbb_override_type_field_mapping, { list: 'map<string, list<string>>' }
+    field :defaults, { list: 'hash' }
+    field :filters, { list: 'map<string, list<string>>' }
+    field :id, 'string'
+    field :is_cbb_enabled, 'bool'
+    field :is_create_enabled, 'bool'
+    field :is_delete_enabled, 'bool'
+    field :is_update_enabled, 'bool'
+    field :microdata_format_precedence, { list: 'string' }
+    field :pixel, 'AdsPixel'
+    field :property_filter, { list: 'string' }
+    field :retention_time_sec, 'int'
+    field :trusted_domains, { list: 'string' }
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/catalog_website_settings.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 CatalogWebsiteSettings < AdObject
+
+    field :id, 'string'
+    field :is_allowed_to_crawl, 'bool'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/china_business_onboarding_vetting_request.rb

@@ -0,0 +1,64 @@
+# 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 ChinaBusinessOnboardingVettingRequest < AdObject
+
+    field :ad_account_creation_request_status, 'string'
+    field :ad_account_limit, 'int'
+    field :ad_account_number, 'string'
+    field :ad_accounts_info, { list: 'object' }
+    field :business_manager_id, 'string'
+    field :business_registration, 'string'
+    field :business_registration_id, 'string'
+    field :chinese_address, 'string'
+    field :chinese_legal_entity_name, 'string'
+    field :city, 'string'
+    field :contact, 'string'
+    field :coupon_code, 'string'
+    field :disapprove_reason, 'string'
+    field :english_business_name, 'string'
+    field :id, 'string'
+    field :official_website_url, 'string'
+    field :org_ad_account_count, 'int'
+    field :payment_type, 'string'
+    field :planning_agency_id, 'string'
+    field :planning_agency_name, 'string'
+    field :promotable_app_ids, { list: 'string' }
+    field :promotable_page_ids, { list: 'string' }
+    field :promotable_pages, { list: 'object' }
+    field :promotable_urls, { list: 'string' }
+    field :request_changes_reason, 'string'
+    field :reviewed_user, 'string'
+    field :spend_limit, 'int'
+    field :status, 'string'
+    field :subvertical, 'string'
+    field :subvertical_v2, 'string'
+    field :supporting_document, 'string'
+    field :time_changes_requested, 'datetime'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    field :time_zone, 'string'
+    field :used_reseller_link, 'bool'
+    field :user_id, 'string'
+    field :user_name, 'string'
+    field :vertical, 'string'
+    field :vertical_v2, 'string'
+    field :viewed_by_reseller, 'bool'
+    field :zip_code, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/cloudbridge_dataset_status.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 CloudbridgeDatasetStatus < AdObject
+
+    field :app_redacted_event, { list: 'string' }
+    field :app_sensitive_params, { list: 'map<string, list<string>>' }
+    field :app_unverified_event, { list: 'string' }
+    field :has_app_associated, 'bool'
+    field :is_app_prohibited, 'bool'
+    field :is_dataset, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/collaborative_ads_partner_businesses.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 CollaborativeAdsPartnerBusinesses < AdObject
+
+    field :collaborative_ads_partner_businesses_info, { list: 'Business' }
+    field :dedicated_partner_business_info, 'Business'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/column_suggestions.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 ColumnSuggestions < AdObject
+
+    field :explanations, 'object'
+    field :format, { list: 'string' }
+    field :objective, { list: 'string' }
+    field :optimization_goals, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/comment.rb

@@ -14,6 +14,11 @@ module FacebookAds
   # pull request for this class.
 
   class Comment < AdObject
+    ORDER = [
+      "chronological",
+      "reverse_chronological",
+    ]
+
     COMMENT_PRIVACY_VALUE = [
       "DECLINED_BY_ADMIN_ASSISTANT",
       "DEFAULT_PRIVACY",
@@ -38,11 +43,6 @@ module FacebookAds
       "no_filter",
     ]
 
-    ORDER = [
-      "chronological",
-      "reverse_chronological",
-    ]
-
 
     field :admin_creator, 'User'
     field :application, 'Application'

data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb

@@ -15,30 +15,20 @@ module FacebookAds
 
   class CommerceMerchantSettings < AdObject
 
-    field :braintree_merchant_id, 'string'
     field :checkout_message, 'string'
     field :contact_email, 'string'
     field :cta, 'string'
-    field :disable_checkout_urls, 'bool'
     field :display_name, 'string'
-    field :external_merchant_id, 'string'
     field :facebook_channel, 'object'
-    field :feature_eligibility, 'object'
-    field :has_discount_code, 'bool'
-    field :has_onsite_intent, 'bool'
     field :id, 'string'
     field :instagram_channel, 'object'
-    field :merchant_alert_email, 'string'
     field :merchant_page, 'Profile'
     field :merchant_status, 'string'
     field :onsite_commerce_merchant, 'object'
     field :payment_provider, 'string'
-    field :privacy_url_by_locale, { list: 'hash' }
     field :review_rejection_messages, { list: 'string' }
     field :review_rejection_reasons, { list: 'string' }
-    field :supported_card_types, { list: 'string' }
     field :terms, 'string'
-    field :terms_url_by_locale, { list: 'hash' }
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/commerce_order.rb

@@ -47,6 +47,7 @@ module FacebookAds
 
     field :buyer_details, 'object'
     field :channel, 'string'
+    field :contains_bopis_items, 'bool'
     field :created, 'string'
     field :estimated_payment_details, 'object'
     field :id, 'string'
@@ -65,7 +66,6 @@ module FacebookAds
       edge.post 'CommerceOrder' do |api|
         api.has_param :idempotency_key, 'string'
         api.has_param :merchant_order_reference, 'string'
-        api.has_param :return_error_response, 'bool'
       end
     end
 

data/lib/facebook_ads/ad_objects/contacts_messenger_sync_config.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 ContactsMessengerSyncConfig < AdObject
+
+    field :enabled, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/content_delivery_report.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 ContentDeliveryReport < AdObject
+
+    field :content_name, 'string'
+    field :content_url, 'string'
+    field :creator_name, 'string'
+    field :creator_url, 'string'
+    field :estimated_impressions, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/conversion_health_kpi.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 ConversionHealthKpi < AdObject
+
+    field :health_indicator, 'string'
+    field :impacted_browsers_match_rate, 'double'
+    field :impacted_browsers_match_rate_mom_trend, 'double'
+    field :impacted_browsers_traffic_share, 'double'
+    field :impacted_browsers_traffic_share_mom_trend, 'double'
+    field :match_rate, 'double'
+    field :match_rate_mom_trend, 'double'
+    field :match_rate_vertical_benchmark, 'double'
+    field :match_rate_vs_benchmark_mom_trend, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/copyright_attribution_insights.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 CopyrightAttributionInsights < AdObject
+
+    field :l7_attribution_page_view, 'int'
+    field :l7_attribution_page_view_delta, 'double'
+    field :l7_attribution_video_view, 'int'
+    field :l7_attribution_video_view_delta, 'double'
+    field :metrics_ending_date, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/copyright_audio_asset.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 CopyrightAudioAsset < AdObject
+
+    field :audio_availability_status, 'string'
+    field :audio_library_policy, { list: 'map<string, list<map<string, Object>>>' }
+    field :creation_time, 'datetime'
+    field :id, 'string'
+    field :reference_files, { list: 'object' }
+    field :title, 'string'
+    field :update_time, 'datetime'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/copyright_media_misuse.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 CopyrightMediaMisuse < AdObject
+
+    field :audio_segments, { list: 'object' }
+    field :creation_time, 'datetime'
+    field :disabled_audio_segments, { list: 'object' }
+    field :disabled_video_segments, { list: 'object' }
+    field :entire_file_issue, 'bool'
+    field :entire_file_issue_reasons, { list: 'string' }
+    field :expiration_time, 'datetime'
+    field :id, 'string'
+    field :media_asset_id, 'string'
+    field :reasons, { list: 'string' }
+    field :requested_audio_segments, { list: 'object' }
+    field :requested_video_segments, { list: 'object' }
+    field :resolution_type, 'string'
+    field :status, 'string'
+    field :update_time, 'datetime'
+    field :video_copyright, 'VideoCopyright'
+    field :video_segments, { list: 'object' }
+    has_no_post
+    has_no_delete
+
+  end
+end