facebookbusiness 19.0.2 → 20.0.0

data/lib/facebook_ads/ad_objects/lead_gen_direct_crm_integration_config.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 LeadGenDirectCrmIntegrationConfig < AdObject
+
+    field :auth_id, 'string'
+    field :creation_time, 'datetime'
+    field :id, 'string'
+    field :lead_gen_data, 'LeadgenForm'
+    field :matched_fields, { list: 'hash' }
+    field :matched_fields_labels, { list: 'hash' }
+    field :resources, { list: 'hash' }
+    field :third_party_app_id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/lead_gen_form_preview_details.rb

@@ -0,0 +1,57 @@
+# 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 LeadGenFormPreviewDetails < AdObject
+
+    field :call_to_action_title, 'string'
+    field :contact_information_text, 'string'
+    field :creatives_overview_default_text, 'string'
+    field :data_privacy_policy_setting_description, 'string'
+    field :default_appointment_scheduling_inline_context, 'string'
+    field :default_disqualified_end_component, 'object'
+    field :default_thank_you_page, 'object'
+    field :disqualified_thank_you_card_transparency_info_text, 'string'
+    field :edit_text, 'string'
+    field :email_inline_context_text, 'string'
+    field :email_messenger_push_opt_in_disclaimer, 'string'
+    field :email_messenger_push_opt_in_transparency_text, 'string'
+    field :form_clarity_description_content, 'string'
+    field :form_clarity_description_title, 'string'
+    field :form_clarity_headline, 'string'
+    field :gated_content_locked_description, 'string'
+    field :gated_content_locked_headline, 'string'
+    field :gated_content_unlocked_description, 'string'
+    field :gated_content_unlocked_headline, 'string'
+    field :how_it_works_section_headers, { list: 'hash' }
+    field :next_button_text, 'string'
+    field :optional_question_text, 'string'
+    field :personal_info_text, 'string'
+    field :phone_number_inline_context_text, 'string'
+    field :privacy_policy_title_section_title_text, 'string'
+    field :privacy_setting_description, 'string'
+    field :products_section_headers, { list: 'hash' }
+    field :qualified_thank_you_card_transparency_info_text, 'string'
+    field :review_your_info_text, 'string'
+    field :secure_sharing_text, 'string'
+    field :slide_to_submit_text, 'string'
+    field :social_proof_section_headers, { list: 'hash' }
+    field :submit_button_text, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page_gated_file.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 LeadGenThankYouPageGatedFile < AdObject
+
+    field :file_cdn_url, 'string'
+    field :file_name, 'string'
+    field :file_size_bytes, 'int'
+    field :id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/lead_gen_thank_you_page_gated_promo.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 LeadGenThankYouPageGatedPromo < AdObject
+
+    field :id, 'string'
+    field :online_offer_url, 'string'
+    field :online_promo_code, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/linked_instagram_account_data.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 LinkedInstagramAccountData < AdObject
+
+    field :access_token, 'string'
+    field :analytics_claim, 'string'
+    field :full_name, 'string'
+    field :profile_picture_url, 'string'
+    field :user_id, 'string'
+    field :user_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/local_service_business.rb

@@ -84,6 +84,7 @@ module FacebookAds
     field :retailer_category, 'string'
     field :sanitized_images, { list: 'string' }
     field :size, 'string'
+    field :tags, { list: 'string' }
     field :title, 'string'
     field :unit_price, 'object'
     field :url, 'string'

data/lib/facebook_ads/ad_objects/location_based_item.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 LocationBasedItem < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+
+    field :applinks, 'CatalogItemAppLinks'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :currency, 'string'
+    field :description, 'string'
+    field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    field :images, { list: 'string' }
+    field :location_based_item_id, 'string'
+    field :name, '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/{dataset.rb → loom_config.rb}

@@ -13,7 +13,7 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class Dataset < AdObject
+  class LoomConfig < AdObject
 
     field :id, 'string'
     has_no_get

data/lib/facebook_ads/ad_objects/marketing_message_targeting.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 MarketingMessageTargeting < AdObject
+
+    field :automation_type, 'string'
+    field :delay_send_time_second, 'int'
+    field :delay_send_time_unit, 'string'
+    field :subscriber_lists, { list: 'RawCustomAudience' }
+    field :targeting_rules, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mc_experience_config_for_api.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 McExperienceConfigForApi < AdObject
+
+    field :is_campaign_enabled, 'bool'
+    field :is_terms_signed, 'bool'
+    field :merchant_type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_bank_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 McomInvoiceBankAccount < AdObject
+
+    field :num_pending_verification_accounts, 'int'
+    field :num_verified_accounts, 'int'
+    field :pending_verification_accounts, { list: 'object' }
+    field :verified_accounts, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_details.rb

@@ -0,0 +1,43 @@
+# 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 McomInvoiceDetails < AdObject
+
+    field :additional_amounts, { list: 'object' }
+    field :buyer_notes, 'string'
+    field :currency_amount, 'object'
+    field :external_invoice_id, 'string'
+    field :features, 'object'
+    field :invoice_created, 'int'
+    field :invoice_id, 'string'
+    field :invoice_instructions, 'string'
+    field :invoice_instructions_image_url, 'string'
+    field :invoice_updated, 'int'
+    field :outstanding_amount, 'object'
+    field :paid_amount, 'object'
+    field :payments, { list: 'object' }
+    field :platform_logo_url, 'string'
+    field :platform_name, 'string'
+    field :product_items, { list: 'object' }
+    field :shipping_address, 'object'
+    field :status, 'string'
+    field :tracking_info, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_lists.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 McomInvoiceLists < AdObject
+
+    field :invoice_details, { list: 'McomInvoiceDetails' }
+    field :invoice_ids, { list: 'string' }
+    field :page_id, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_status.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 McomInvoiceStatus < AdObject
+
+    field :bank_account_number, 'string'
+    field :bank_code, 'string'
+    field :invoice_id, 'string'
+    field :invoice_status, 'string'
+    field :page_id, 'string'
+    field :payment_method, 'string'
+    field :payment_type, 'string'
+    field :payout_amount, 'object'
+    field :slip_verification_error, 'string'
+    field :slip_verification_status, 'string'
+    field :transaction_fee, 'object'
+    field :transfer_slip, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_onboarding_status.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 McomOnboardingStatus < AdObject
+
+    field :onboarding_status, 'string'
+    field :page_id, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_payouts.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 McomPayouts < AdObject
+
+    field :number_of_orders, 'int'
+    field :order_ids, { list: 'string' }
+    field :payout_amount, 'object'
+    field :payout_provider_reference_id, 'string'
+    field :payout_status, 'string'
+    field :payout_time, 'int'
+    field :provider, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/measurement_report.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 MeasurementReport < AdObject
+
+    field :download_urls, { list: 'string' }
+    field :id, 'string'
+    field :metadata, 'hash'
+    field :report_type, 'string'
+    field :status, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/media_copyright_attribution.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 MediaCopyrightAttribution < AdObject
+
+    field :attribution_ig_target_id, 'string'
+    field :attribution_target_email_address, 'string'
+    field :attribution_target_id, 'string'
+    field :attribution_target_name, 'string'
+    field :attribution_type, 'string'
+    field :attribution_uri, 'string'
+    field :copyright_count, 'int'
+    field :creation_time, 'datetime'
+    field :creator, 'Profile'
+    field :id, 'string'
+    field :is_enabled, 'bool'
+    field :link_title, 'string'
+    field :match_count, 'int'
+    field :owner, 'Page'
+    field :status, 'string'
+    field :title, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/media_copyright_update_record.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 MediaCopyrightUpdateRecord < AdObject
+
+    field :action_types, { list: 'string' }
+    field :actor, 'User'
+    field :actor_type, 'string'
+    field :creation_time, 'datetime'
+    field :id, 'string'
+    field :ownership_countries, { list: 'object' }
+    field :whitelisted_accounts, { list: 'object' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/media_title.rb

@@ -58,7 +58,7 @@ module FacebookAds
     field :wiki_data_item, 'string'
 
     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/merchant_compliance.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 MerchantCompliance < AdObject
+
+    field :active_campaigns, 'int'
+    field :compliance_status, 'string'
+    field :count_down_start_time, 'int'
+    field :purchase, 'int'
+    field :purchase_conversion_value, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/merchant_report.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 MerchantReport < AdObject
+
+    field :add_to_cart, 'int'
+    field :brand, 'string'
+    field :catalog_segment_id, 'string'
+    field :catalog_segment_purchase_value, 'double'
+    field :category, 'string'
+    field :date, 'string'
+    field :latest_date, 'string'
+    field :link_clicks, 'int'
+    field :merchant_currency, 'string'
+    field :page_id, 'string'
+    field :product_id, 'string'
+    field :product_quantity, 'int'
+    field :product_total_value, 'double'
+    field :purchase, 'int'
+    field :purchase_value, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end