facebookbusiness 21.0.2 → 22.0.1

data/lib/facebook_ads/ad_objects/messenger_business_template.rb

@@ -38,6 +38,8 @@ module FacebookAds
     field :library_template_name, 'string'
     field :name, 'string'
     field :rejected_reason, 'string'
+    field :rejection_reasons, 'object'
+    field :specific_rejection_reasons, 'object'
     field :status, 'string'
     has_no_delete
 

data/lib/facebook_ads/ad_objects/music_work_copyright.rb

@@ -21,7 +21,9 @@ module FacebookAds
     field :displayed_fb_matches_count, 'int'
     field :displayed_ig_matches_count, 'int'
     field :displayed_matches_count, 'int'
+    field :has_rev_share_eligible_isrcs, 'bool'
     field :id, 'string'
+    field :is_linking_required_to_monetize_for_manual_claim, 'bool'
     field :match_rule, 'VideoCopyrightRule'
     field :status, 'string'
     field :tags, { list: 'string' }

data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb

@@ -21,10 +21,8 @@ module FacebookAds
     field :destination_id, 'string'
     field :endpoint, 'string'
     field :fallback_domain, 'string'
-    field :fallback_domain_enabled, 'bool'
     field :first_party_domain, 'string'
     field :host_business_id, 'string'
-    field :host_external_id, 'string'
     field :id, 'string'
     field :instance_id, 'string'
     field :instance_version, 'string'

data/lib/facebook_ads/ad_objects/page.rb

@@ -80,6 +80,17 @@ module FacebookAds
       "Vietnamese",
     ]
 
+    GEN_AI_PROVENANCE_TYPE = [
+      "C2PA",
+      "C2PA_METADATA_EDITED",
+      "EXPLICIT",
+      "EXPLICIT_IMAGINE",
+      "EXPLICIT_IMAGINE_ME",
+      "INVISIBLE_WATERMARK",
+      "IPTC",
+      "IPTC_METADATA_EDITED",
+    ]
+
     PICKUP_OPTIONS = [
       "CURBSIDE",
       "IN_STORE",
@@ -98,6 +109,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
@@ -126,6 +138,7 @@ module FacebookAds
       "ANALYZE",
       "CASHIER_ROLE",
       "CREATE_CONTENT",
+      "GLOBAL_STRUCTURE_MANAGEMENT",
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
@@ -232,6 +245,14 @@ module FacebookAds
       "MESSENGER",
     ]
 
+    ACTIONS = [
+      "BAN_USER",
+      "BLOCK_USER",
+      "MOVE_TO_SPAM",
+      "UNBAN_USER",
+      "UNBLOCK_USER",
+    ]
+
     MODEL = [
       "ARABIC",
       "CHINESE",
@@ -297,6 +318,7 @@ module FacebookAds
       "live_videos",
       "local_delivery",
       "location",
+      "marketing_message_delivery_failed",
       "mcom_invoice_change",
       "members",
       "mention",
@@ -308,6 +330,7 @@ module FacebookAds
       "message_mention",
       "message_reactions",
       "message_reads",
+      "message_template_status_update",
       "messages",
       "messaging_account_linking",
       "messaging_appointments",
@@ -355,14 +378,6 @@ module FacebookAds
       "website",
     ]
 
-    ACTION = [
-      "SPAM",
-    ]
-
-    ACTION_TYPE = [
-      "REPORT_THREAD",
-    ]
-
 
     field :about, 'string'
     field :access_token, 'string'
@@ -1053,7 +1068,6 @@ module FacebookAds
       edge.post 'Page' do |api|
         api.has_param :category, { enum: -> { Page::CATEGORY }}
         api.has_param :components, { list: 'hash' }
-        api.has_param :example, 'hash'
         api.has_param :language, 'string'
         api.has_param :library_template_button_inputs, { list: 'hash' }
         api.has_param :library_template_name, 'string'
@@ -1129,6 +1143,13 @@ module FacebookAds
       end
     end
 
+    has_edge :moderate_conversations do |edge|
+      edge.post 'Page' do |api|
+        api.has_param :actions, { list: { enum: -> { Page::ACTIONS }} }
+        api.has_param :user_ids, { list: 'hash' }
+      end
+    end
+
     has_edge :nlp_configs do |edge|
       edge.post 'Page' do |api|
         api.has_param :api_version, 'object'
@@ -1172,14 +1193,6 @@ module FacebookAds
       end
     end
 
-    has_edge :pass_thread_metadata do |edge|
-      edge.post 'Page' do |api|
-        api.has_param :metadata, 'string'
-        api.has_param :recipient, 'object'
-        api.has_param :target_app_id, 'int'
-      end
-    end
-
     has_edge :personas do |edge|
       edge.get 'Persona'
       edge.post 'Persona' do |api|
@@ -1239,6 +1252,7 @@ module FacebookAds
         api.has_param :place, 'object'
         api.has_param :privacy, 'string'
         api.has_param :profile_id, 'int'
+        api.has_param :provenance_info, 'hash'
         api.has_param :proxied_app_id, 'string'
         api.has_param :published, 'bool'
         api.has_param :qn, 'string'
@@ -1319,10 +1333,6 @@ module FacebookAds
       end
     end
 
-    has_edge :ratings do |edge|
-      edge.get 'Recommendation'
-    end
-
     has_edge :release_thread_control do |edge|
       edge.post 'Page' do |api|
         api.has_param :recipient, 'object'
@@ -1368,6 +1378,10 @@ module FacebookAds
       edge.get 'CommerceMerchantSettingsSetupStatus'
     end
 
+    has_edge :store_locations do |edge|
+      edge.get 'StoreLocation'
+    end
+
     has_edge :stories do |edge|
       edge.get 'Stories' do |api|
         api.has_param :since, 'datetime'
@@ -1401,14 +1415,6 @@ module FacebookAds
       end
     end
 
-    has_edge :thread_action do |edge|
-      edge.post 'Page' do |api|
-        api.has_param :action, { enum: -> { Page::ACTION }}
-        api.has_param :action_type, { enum: -> { Page::ACTION_TYPE }}
-        api.has_param :user_id, 'hash'
-      end
-    end
-
     has_edge :thread_owner do |edge|
       edge.get 'PageThreadOwner' do |api|
         api.has_param :recipient, 'string'

data/lib/facebook_ads/ad_objects/page_call_to_action.rb

@@ -56,6 +56,7 @@ module FacebookAds
       "CHARITY_DONATE",
       "CHECK_IN",
       "CONTACT_US",
+      "CREATOR_STOREFRONT",
       "DONATE_NOW",
       "EMAIL",
       "FOLLOW_PAGE",

data/lib/facebook_ads/ad_objects/page_change_proposal.rb

@@ -17,9 +17,7 @@ module FacebookAds
 
     field :acceptance_status, 'string'
     field :category, 'string'
-    field :current_value, 'string'
     field :id, 'string'
-    field :proposed_value, 'string'
     field :upcoming_change_info, 'PageUpcomingChange'
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -108,6 +108,7 @@ module FacebookAds
     field :user_access_expire_time, 'datetime'
     field :vertical, 'string'
     field :additional_vertical_option, { enum: -> { ADDITIONAL_VERTICAL_OPTION }}
+    field :business_metadata, 'hash'
     field :catalog_segment_filter, 'object'
     field :catalog_segment_product_set_id, 'string'
     field :destination_catalog_settings, 'hash'
@@ -540,6 +541,10 @@ module FacebookAds
       end
     end
 
+    has_edge :version_configs do |edge|
+      edge.get 'CatalogContentVersionConfig'
+    end
+
     has_edge :version_items_batch do |edge|
       edge.post 'ProductCatalog' do |api|
         api.has_param :allow_upsert, 'bool'

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -390,6 +390,7 @@ module FacebookAds
       "ITEM_PRICE_NOT_POSITIVE",
       "ITEM_STALE_OUT_OF_STOCK",
       "MARKETPLACE_DISABLED_BY_USER",
+      "MARKETPLACE_PARTNER_AUCTION_NO_BID_CLOSE_TIME",
       "MARKETPLACE_PARTNER_LISTING_LIMIT_EXCEEDED",
       "MARKETPLACE_PARTNER_NOT_LOCAL_ITEM",
       "MARKETPLACE_PARTNER_NOT_SHIPPED_ITEM",
@@ -792,6 +793,7 @@ module FacebookAds
     field :product_feed, 'ProductFeed'
     field :product_group, 'ProductGroup'
     field :product_local_info, 'ProductItemLocalInfo'
+    field :product_relationship, 'string'
     field :product_type, 'string'
     field :quantity_to_sell_on_facebook, 'int'
     field :retailer_id, 'string'

data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb

@@ -100,6 +100,7 @@ module FacebookAds
     field :instream_packages, { list: 'string' }
     field :interval_frequency_cap, 'int'
     field :interval_frequency_cap_reset_period, 'int'
+    field :is_balanced_frequency, 'bool'
     field :is_bonus_media, 'int'
     field :is_conversion_goal, 'int'
     field :is_higher_average_frequency, 'bool'
@@ -127,6 +128,8 @@ module FacebookAds
     field :status, 'int'
     field :story_event_type, 'int'
     field :target_cpm, 'int'
+    field :target_frequency, 'int'
+    field :target_frequency_reset_period, 'int'
     field :target_spec, 'Targeting'
     field :time_created, 'datetime'
     field :time_updated, 'datetime'
@@ -143,7 +146,6 @@ module FacebookAds
     field :existing_campaign_id, 'string'
     field :grp_buying, 'bool'
     field :impression, 'int'
-    field :is_balanced_frequency, 'bool'
     field :is_full_view, 'bool'
     field :is_reach_and_frequency_io_buying, 'bool'
     field :num_curve_points, 'int'
@@ -152,8 +154,6 @@ module FacebookAds
     field :rf_prediction_id_to_release, 'string'
     field :rf_prediction_id_to_share, 'string'
     field :stop_time, 'int'
-    field :target_frequency, 'int'
-    field :target_frequency_reset_period, 'int'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/recommended_ig_media.rb

@@ -16,7 +16,6 @@ module FacebookAds
   class RecommendedIgMedia < AdObject
 
     field :intent_score, 'double'
-    field :media, 'InstagramMedia'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/regional_regulation_identities.rb

@@ -17,8 +17,14 @@ module FacebookAds
 
     field :australia_finserv_beneficiary, 'string'
     field :australia_finserv_payer, 'string'
+    field :india_finserv_beneficiary, 'string'
+    field :india_finserv_payer, 'string'
+    field :singapore_universal_beneficiary, 'string'
+    field :singapore_universal_payer, 'string'
     field :taiwan_finserv_beneficiary, 'string'
     field :taiwan_finserv_payer, 'string'
+    field :taiwan_universal_beneficiary, 'string'
+    field :taiwan_universal_payer, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/{private_computation_environment.rb → store_location.rb}

@@ -13,14 +13,16 @@ 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 PrivateComputationEnvironment < AdObject
+  class StoreLocation < AdObject
 
-    field :publisher_account_id, 'string'
-    field :publisher_pce_deployment_status, 'int'
-    field :publisher_pce_id, 'string'
-    field :publisher_region, 'string'
-    field :publisher_vpc_id, 'string'
+    field :full_address, 'string'
+    field :hours, 'object'
     field :id, 'string'
+    field :phone_number, 'string'
+    field :pickup_options, { list: 'string' }
+    field :price_range, 'string'
+    field :store_code, 'string'
+    field :zip_code, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/targeting_subscriber_universe.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 TargetingSubscriberUniverse < AdObject
+
+    field :messenger_subscriber_source, 'IdName'
+    field :whatsapp_subscriber_pool, 'IdName'
+    field :whatsapp_subscriber_source, 'IdName'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/third_party_partner_lift_request.rb

@@ -29,8 +29,11 @@ module FacebookAds
     field :description, 'string'
     field :holdout_size, 'double'
     field :id, 'string'
+    field :legacy_ads_data_partner_id, 'string'
+    field :legacy_ads_data_partner_name, 'string'
     field :modified_time, 'datetime'
     field :owner_instance_id, 'string'
+    field :partner_household_graph_dataset_id, 'string'
     field :region, 'string'
     field :status, { enum: -> { STATUS }}
     field :study_cells, { list: 'string' }

data/lib/facebook_ads/ad_objects/threads_user.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 ThreadsUser < AdObject
+
+    field :threads_user_id, 'string'
+    field :threads_user_profile_pic, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/user.rb

@@ -366,9 +366,9 @@ module FacebookAds
         api.has_param :cover_photo, 'file'
         api.has_param :currency, 'string'
         api.has_param :description, 'string'
-        api.has_param :end_time, 'int'
+        api.has_param :end_time, 'datetime'
         api.has_param :external_event_name, 'string'
-        api.has_param :external_event_start_time, 'int'
+        api.has_param :external_event_start_time, 'datetime'
         api.has_param :external_event_uri, 'string'
         api.has_param :external_fundraiser_uri, 'string'
         api.has_param :external_id, 'string'
@@ -443,6 +443,12 @@ module FacebookAds
       edge.post 'User'
     end
 
+    has_edge :messenger_kids_accounts_unread_badge do |edge|
+      edge.post 'User' do |api|
+        api.has_param :proxied_app_id, 'int'
+      end
+    end
+
     has_edge :music do |edge|
       edge.get 'Page' do |api|
         api.has_param :target_id, 'string'
@@ -525,6 +531,7 @@ module FacebookAds
         api.has_param :place, 'object'
         api.has_param :privacy, 'string'
         api.has_param :profile_id, 'int'
+        api.has_param :provenance_info, 'hash'
         api.has_param :proxied_app_id, 'string'
         api.has_param :published, 'bool'
         api.has_param :qn, 'string'

data/lib/facebook_ads/ad_objects/vehicle.rb

@@ -125,6 +125,15 @@ module FacebookAds
     field :condition, 'string'
     field :currency, 'string'
     field :custom_label_0, 'string'
+    field :custom_label_1, 'string'
+    field :custom_label_2, 'string'
+    field :custom_label_3, 'string'
+    field :custom_label_4, 'string'
+    field :custom_number_0, 'int'
+    field :custom_number_1, 'int'
+    field :custom_number_2, 'int'
+    field :custom_number_3, 'int'
+    field :custom_number_4, 'int'
     field :date_first_on_lot, 'string'
     field :dealer_communication_channel, 'string'
     field :dealer_email, 'string'
@@ -158,6 +167,7 @@ module FacebookAds
     field :sale_price, 'string'
     field :sanitized_images, { list: 'string' }
     field :state_of_vehicle, 'string'
+    field :tags, { list: 'string' }
     field :title, 'string'
     field :transmission, 'string'
     field :trim, 'string'

data/lib/facebook_ads/ad_objects/vehicle_offer.rb

@@ -40,6 +40,16 @@ module FacebookAds
     field :cashback_price, 'string'
     field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
+    field :custom_label_0, 'string'
+    field :custom_label_1, 'string'
+    field :custom_label_2, 'string'
+    field :custom_label_3, 'string'
+    field :custom_label_4, 'string'
+    field :custom_number_0, 'int'
+    field :custom_number_1, 'int'
+    field :custom_number_2, 'int'
+    field :custom_number_3, 'int'
+    field :custom_number_4, 'int'
     field :dma_codes, { list: 'string' }
     field :downpayment_currency, 'string'
     field :downpayment_price, 'string'
@@ -69,6 +79,7 @@ module FacebookAds
     field :sanitized_images, { list: 'string' }
     field :start_date, 'string'
     field :start_time, 'int'
+    field :tags, { list: 'string' }
     field :term_length, 'int'
     field :term_qualifier, 'string'
     field :title, 'string'

data/lib/facebook_ads/ad_objects/video_copyright_match.rb

@@ -47,6 +47,7 @@ module FacebookAds
     field :match_status, 'string'
     field :notes, 'string'
     field :permalink, 'string'
+    field :ugc_content_format, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -80,6 +80,7 @@ module FacebookAds
     field :id, 'string'
     field :is_enabled_for_insights, 'bool'
     field :linked_commerce_account, 'CommerceMerchantSettings'
+    field :marketing_messages_lite_api_status, 'string'
     field :message_template_namespace, 'string'
     field :name, 'string'
     field :on_behalf_of_business_info, 'object'
@@ -149,17 +150,15 @@ module FacebookAds
       end
     end
 
-    has_edge :dcc_config do |edge|
-      edge.get
-    end
-
     has_edge :flows do |edge|
       edge.get
       edge.post do |api|
         api.has_param :categories, { list: { enum: %w{APPOINTMENT_BOOKING CONTACT_US CUSTOMER_SUPPORT LEAD_GENERATION OTHER SHOPPING SIGN_IN SIGN_UP SURVEY }} }
         api.has_param :clone_flow_id, 'string'
         api.has_param :endpoint_uri, 'string'
+        api.has_param :flow_json, 'string'
         api.has_param :name, 'string'
+        api.has_param :publish, 'bool'
       end
     end
 
@@ -217,8 +216,7 @@ module FacebookAds
 
     has_edge :migrate_flows do |edge|
       edge.post 'WhatsAppBusinessAccount' do |api|
-        api.has_param :page_number, 'int'
-        api.has_param :source_flow_ids, { list: 'string' }
+        api.has_param :source_flow_names, { list: 'string' }
         api.has_param :source_waba_id, 'string'
       end
     end
@@ -239,6 +237,7 @@ module FacebookAds
       end
       edge.post 'WhatsAppBusinessAccount' do |api|
         api.has_param :configuration_name, 'string'
+        api.has_param :data_endpoint_url, 'string'
         api.has_param :merchant_category_code, 'string'
         api.has_param :merchant_vpa, 'string'
         api.has_param :provider_name, { enum: -> { WhatsAppBusinessAccount::PROVIDER_NAME }}
@@ -262,6 +261,20 @@ module FacebookAds
       end
     end
 
+    has_edge :pricing_analytics do |edge|
+      edge.get do |api|
+        api.has_param :country_codes, { list: 'string' }
+        api.has_param :dimensions, { list: { enum: %w{COUNTRY PHONE PRICING_CATEGORY PRICING_TYPE }} }
+        api.has_param :end, 'int'
+        api.has_param :granularity, { enum: %w{DAILY HALF_HOUR MONTHLY }}
+        api.has_param :metric_types, { list: { enum: %w{COST VOLUME }} }
+        api.has_param :phone_numbers, { list: 'string' }
+        api.has_param :pricing_categories, { list: { enum: %w{AUTHENTICATION AUTHENTICATION_INTERNATIONAL MARKETING MARKETING_LITE SERVICE UTILITY }} }
+        api.has_param :pricing_types, { list: { enum: %w{FREE_CUSTOMER_SERVICE FREE_ENTRY_POINT REGULAR }} }
+        api.has_param :start, 'int'
+      end
+    end
+
     has_edge :product_catalogs do |edge|
       edge.delete do |api|
         api.has_param :catalog_id, 'string'
@@ -284,6 +297,7 @@ module FacebookAds
 
     has_edge :set_solution_migration_intent do |edge|
       edge.post do |api|
+        api.has_param :app_id, 'string'
         api.has_param :solution_id, 'string'
       end
     end
@@ -305,13 +319,32 @@ 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 COST DELIVERED READ SENT }} }
+        api.has_param :metric_types, { list: { enum: %w{CLICKED COST DELIVERED READ REPLIED SENT }} }
         api.has_param :product_type, { enum: %w{CLOUD_API MARKETING_MESSAGES_LITE_API }}
         api.has_param :start, 'datetime'
         api.has_param :template_ids, { list: 'string' }
       end
     end
 
+    has_edge :template_group_analytics do |edge|
+      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 COST DELIVERED READ REPLIED SENT }} }
+        api.has_param :start, 'datetime'
+        api.has_param :template_group_ids, { list: 'string' }
+      end
+    end
+
+    has_edge :template_groups do |edge|
+      edge.get
+      edge.post do |api|
+        api.has_param :description, 'string'
+        api.has_param :name, 'string'
+        api.has_param :whatsapp_business_templates, { list: 'string' }
+      end
+    end
+
     has_edge :template_performance_metrics do |edge|
       edge.get do |api|
         api.has_param :name, 'string'

data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb

@@ -26,6 +26,7 @@ module FacebookAds
 
     VERIFICATION_STATUS = [
       "APPROVED",
+      "DISCARDED",
       "FAILED",
       "PENDING",
       "REVOKED",

data/lib/facebook_ads/version.rb

@@ -7,6 +7,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '21.0.2'
-  API_VERSION = '21.0'
+  VERSION = '22.0.1'
+  API_VERSION = '22.0'
 end

data/lib/facebook_ads.rb

@@ -15,9 +15,9 @@ module FacebookAds
   extend self
   extend Shortcuts
 
-  def with_session(access_token, secret = nil, api_version = DEFAULT_API_VERSION)
+  def with_session(access_token, app_secret = nil, api_version = DEFAULT_API_VERSION)
     original_session = Session.current_session
-    Session.current_session = Session.new(access_token, secret, api_version)
+    Session.current_session = Session.new(access_token: access_token, app_secret: app_secret, api_version: api_version)
     yield
     Session.current_session = original_session
   end