facebookbusiness 16.0.2 → 17.0.0

data/lib/facebook_ads/ad_objects/extended_credit_invoice_group.rb

@@ -36,7 +36,6 @@ module FacebookAds
     field :liable_address, 'CrmAddress'
     field :name, 'string'
     field :sold_to_address, 'CrmAddress'
-    has_no_delete
 
     has_edge :ad_accounts do |edge|
       edge.delete do |api|

data/lib/facebook_ads/ad_objects/group.rb

@@ -421,13 +421,6 @@ module FacebookAds
       end
     end
 
-    has_edge :shift_settings do |edge|
-      edge.post do |api|
-        api.has_param :external_id, 'string'
-        api.has_param :shift_feature_setting, { enum: %w{ALL_FEATURES_OFF ALL_FEATURES_ON SHIFT_COVER_ONLY_ON SHIFT_VIEWER_ONLY_ON }}
-      end
-    end
-
     has_edge :videos do |edge|
       edge.get 'AdVideo' do |api|
         api.has_param :type, { enum: -> { AdVideo::TYPE }}

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -88,6 +88,7 @@ module FacebookAds
         api.has_param :until, 'datetime'
       end
       edge.post 'IgMedia' do |api|
+        api.has_param :audio_name, 'string'
         api.has_param :caption, 'string'
         api.has_param :children, { list: 'string' }
         api.has_param :cover_url, 'string'

data/lib/facebook_ads/ad_objects/instant_articles_stats.rb

@@ -28,10 +28,10 @@ module FacebookAds
   class InstantArticlesStats < AdObject
 
     field :error, 'string'
-    field :metadata, 'hash'
+    field :metadata, { list: 'hash' }
     field :metric, 'object'
-    field :totals, 'hash'
-    field :x_axis_breakdown, { list: 'hash' }
+    field :totals, { list: 'hash' }
+    field :x_axis_breakdown, { list: { list: 'hash' } }
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/job_opening.rb

@@ -0,0 +1,91 @@
+# 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.
+
+# 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 JobOpening < AdObject
+    JOB_STATUS = [
+      "CLOSED",
+      "DRAFT",
+      "OPEN",
+      "PROVISIONAL",
+    ]
+
+    PLATFORM_REVIEW_STATUS = [
+      "APPROVED",
+      "PENDING",
+      "REJECTED",
+    ]
+
+    REVIEW_REJECTION_REASONS = [
+      "ADULT_CONTENT",
+      "DISCRIMINATION",
+      "DRUGS",
+      "GENERIC_DEFAULT",
+      "ILLEGAL",
+      "IMPERSONATION",
+      "MISLEADING",
+      "MULTILEVEL_MARKETING",
+      "PERSONAL_INFO",
+      "SEXUAL",
+    ]
+
+    TYPE = [
+      "CONTRACT",
+      "FULL_TIME",
+      "INTERNSHIP",
+      "PART_TIME",
+      "VOLUNTEER",
+    ]
+
+
+    field :address, 'string'
+    field :application_callback_url, 'string'
+    field :created_time, 'datetime'
+    field :description, 'string'
+    field :errors, { list: 'string' }
+    field :external_company_facebook_url, 'string'
+    field :external_company_full_address, 'string'
+    field :external_company_id, 'string'
+    field :external_company_name, 'string'
+    field :external_id, 'string'
+    field :id, 'string'
+    field :job_status, { enum: -> { JOB_STATUS }}
+    field :latitude, 'double'
+    field :longitude, 'double'
+    field :offsite_application_url, 'string'
+    field :page, 'Page'
+    field :photo, 'Photo'
+    field :platform_review_status, { enum: -> { PLATFORM_REVIEW_STATUS }}
+    field :post, 'Post'
+    field :remote_type, 'string'
+    field :review_rejection_reasons, { list: { enum: -> { REVIEW_REJECTION_REASONS }} }
+    field :title, 'string'
+    field :type, { enum: -> { TYPE }}
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/lead.rb

@@ -43,6 +43,7 @@ module FacebookAds
     field :partner_name, 'string'
     field :platform, 'string'
     field :post, 'Link'
+    field :post_submission_check_result, 'LeadGenPostSubmissionCheckResult'
     field :retailer_item_id, 'string'
     field :vehicle, 'Vehicle'
     has_no_post

data/lib/facebook_ads/ad_objects/leadgen_form.rb

@@ -91,7 +91,7 @@ module FacebookAds
     field :questions, { list: 'LeadGenQuestion' }
     field :status, 'string'
     field :thank_you_page, 'object'
-    field :tracking_parameters, 'hash'
+    field :tracking_parameters, { list: 'hash' }
     has_no_delete
 
     has_edge :leads do |edge|

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -109,17 +109,6 @@ module FacebookAds
       end
     end
 
-    has_edge :events do |edge|
-      edge.post do |api|
-        api.has_param :data, { list: 'string' }
-        api.has_param :namespace_id, 'string'
-        api.has_param :progress, 'object'
-        api.has_param :upload_id, 'string'
-        api.has_param :upload_source, 'string'
-        api.has_param :upload_tag, 'string'
-      end
-    end
-
     has_edge :server_events_permitted_business do |edge|
       edge.get 'Business'
     end

data/lib/facebook_ads/ad_objects/open_bridge_configuration.rb

@@ -0,0 +1,39 @@
+# 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.
+
+# 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 OpenBridgeConfiguration < AdObject
+
+    field :access_key, 'string'
+    field :active, 'bool'
+    field :endpoint, 'string'
+    field :host_business_id, 'string'
+    field :host_external_id, 'string'
+    field :id, 'string'
+    field :pixel_id, 'string'
+
+  end
+end

data/lib/facebook_ads/ad_objects/page.rb

@@ -250,11 +250,6 @@ module FacebookAds
       "SCHEDULED_RECURRING",
     ]
 
-    PUBLISH_STATUS = [
-      "DRAFT",
-      "LIVE",
-    ]
-
     MESSAGING_TYPE = [
       "MESSAGE_TAG",
       "RESPONSE",
@@ -275,6 +270,12 @@ module FacebookAds
       "UNREACT",
     ]
 
+    SUGGESTION_ACTION = [
+      "ACCEPT",
+      "DISMISS",
+      "IMPRESSION",
+    ]
+
     PLATFORM = [
       "INSTAGRAM",
       "MESSENGER",
@@ -330,9 +331,12 @@ module FacebookAds
       "founded",
       "general_info",
       "general_manager",
+      "group_feed",
       "hometown",
       "hours",
+      "in_thread_lead_form_submit",
       "inbox_labels",
+      "invoice_access_bank_slip_events",
       "invoice_access_invoice_change",
       "invoice_access_invoice_draft_change",
       "invoice_access_onboarding_status_active",
@@ -345,6 +349,7 @@ module FacebookAds
       "members",
       "mention",
       "merchant_review",
+      "message_context",
       "message_deliveries",
       "message_echoes",
       "message_mention",
@@ -385,6 +390,7 @@ module FacebookAds
       "publisher_subscriptions",
       "ratings",
       "registration",
+      "send_cart",
       "standby",
       "user_action",
       "video_text_question_responses",
@@ -426,7 +432,7 @@ module FacebookAds
     field :delivery_and_pickup_option_info, { list: 'string' }
     field :description, 'string'
     field :description_html, 'string'
-    field :differently_open_offerings, 'hash'
+    field :differently_open_offerings, { list: 'hash' }
     field :directed_by, 'string'
     field :display_subtext, 'string'
     field :displayed_message_response_time, 'string'
@@ -453,7 +459,6 @@ module FacebookAds
     field :impressum, 'string'
     field :influences, 'string'
     field :instagram_business_account, 'IgUser'
-    field :instant_articles_review_status, 'string'
     field :is_always_open, 'bool'
     field :is_chain, 'bool'
     field :is_community_page, 'bool'
@@ -527,7 +532,6 @@ module FacebookAds
     field :store_number, 'int'
     field :studio, 'string'
     field :supports_donate_button_in_live_video, 'bool'
-    field :supports_instant_articles, 'bool'
     field :talking_about_count, 'int'
     field :temporary_status, 'string'
     field :unread_message_count, 'int'
@@ -639,6 +643,7 @@ module FacebookAds
         api.has_param :canvas_product_list, 'object'
         api.has_param :canvas_product_set, 'object'
         api.has_param :canvas_store_locator, 'object'
+        api.has_param :canvas_template_video, 'object'
         api.has_param :canvas_text, 'object'
         api.has_param :canvas_video, 'object'
       end
@@ -678,10 +683,6 @@ module FacebookAds
       end
     end
 
-    has_edge :claimed_urls do |edge|
-      edge.get 'Url'
-    end
-
     has_edge :commerce_eligibility do |edge|
       edge.get 'PageCommerceEligibility'
     end
@@ -949,35 +950,6 @@ module FacebookAds
       edge.get 'InstagramUser'
     end
 
-    has_edge :instant_articles do |edge|
-      edge.get 'InstantArticle' do |api|
-        api.has_param :development_mode, 'bool'
-      end
-      edge.post 'InstantArticle' do |api|
-        api.has_param :development_mode, 'bool'
-        api.has_param :html_source, 'string'
-        api.has_param :published, 'bool'
-        api.has_param :take_live, 'bool'
-      end
-    end
-
-    has_edge :instant_articles_insights do |edge|
-      edge.get 'InstantArticleInsightsQueryResult' do |api|
-        api.has_param :breakdown, { enum: -> { InstantArticleInsightsQueryResult::BREAKDOWN }}
-        api.has_param :metric, { list: 'object' }
-        api.has_param :period, { enum: -> { InstantArticleInsightsQueryResult::PERIOD }}
-        api.has_param :since, 'datetime'
-        api.has_param :until, 'datetime'
-      end
-    end
-
-    has_edge :instant_articles_publish do |edge|
-      edge.post 'Page' do |api|
-        api.has_param :canonical_url, 'string'
-        api.has_param :publish_status, { enum: -> { Page::PUBLISH_STATUS }}
-      end
-    end
-
     has_edge :instant_articles_stats do |edge|
       edge.get 'InstantArticlesStats' do |api|
         api.has_param :metrics_list, { list: 'hash' }
@@ -1110,6 +1082,7 @@ module FacebookAds
         api.has_param :persona_id, 'string'
         api.has_param :recipient, 'object'
         api.has_param :sender_action, { enum: -> { Page::SENDER_ACTION }}
+        api.has_param :suggestion_action, { enum: -> { Page::SUGGESTION_ACTION }}
         api.has_param :tag, 'object'
         api.has_param :thread_control, 'object'
       end
@@ -1453,7 +1426,10 @@ module FacebookAds
     end
 
     has_edge :video_reels do |edge|
-      edge.get 'AdVideo'
+      edge.get 'AdVideo' do |api|
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+      end
       edge.post 'AdVideo' do |api|
         api.has_param :description, 'string'
         api.has_param :feed_targeting, 'object'
@@ -1577,5 +1553,11 @@ module FacebookAds
       end
     end
 
+    has_edge :welcome_message_flows do |edge|
+      edge.get do |api|
+        api.has_param :flow_id, 'string'
+      end
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/page_post_experiment.rb

@@ -33,7 +33,7 @@ module FacebookAds
     field :declared_winning_time, 'datetime'
     field :description, 'string'
     field :id, 'string'
-    field :insight_snapshots, 'map<datetime, map<int, Object>>'
+    field :insight_snapshots, { list: 'map<datetime, list<map<int, Object>>>' }
     field :name, 'string'
     field :optimization_goal, 'string'
     field :publish_status, 'string'

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -163,6 +163,7 @@ module FacebookAds
         api.has_param :allow_upsert, 'bool'
         api.has_param :fbe_external_business_id, 'string'
         api.has_param :requests, { list: 'hash' }
+        api.has_param :version, 'int'
       end
     end
 
@@ -322,6 +323,7 @@ module FacebookAds
         api.has_param :item_sub_type, { enum: -> { ProductCatalog::ITEM_SUB_TYPE }}
         api.has_param :item_type, 'string'
         api.has_param :requests, 'hash'
+        api.has_param :version, 'int'
       end
     end
 
@@ -330,28 +332,7 @@ module FacebookAds
         api.has_param :allow_upsert, 'bool'
         api.has_param :item_type, 'string'
         api.has_param :requests, 'hash'
-      end
-    end
-
-    has_edge :media_titles do |edge|
-      edge.get 'MediaTitle' do |api|
-        api.has_param :bulk_pagination, 'bool'
-        api.has_param :filter, 'object'
-      end
-      edge.post 'MediaTitle' do |api|
-        api.has_param :applinks, 'object'
-        api.has_param :content_category, { enum: -> { MediaTitle::CONTENT_CATEGORY }}
-        api.has_param :currency, 'string'
-        api.has_param :description, 'string'
-        api.has_param :fb_page_id, 'string'
-        api.has_param :genres, { list: 'string' }
-        api.has_param :images, { list: 'object' }
-        api.has_param :kg_fb_id, 'string'
-        api.has_param :media_title_id, 'string'
-        api.has_param :price, 'int'
-        api.has_param :title, 'string'
-        api.has_param :title_display_name, 'string'
-        api.has_param :url, 'string'
+        api.has_param :version, 'int'
       end
     end
 

data/lib/facebook_ads/ad_objects/product_catalog_category.rb

@@ -39,7 +39,7 @@ module FacebookAds
     field :image_url, 'string'
     field :name, 'string'
     field :num_items, 'int'
-    field :tokens, 'hash'
+    field :tokens, { list: 'hash' }
     field :data, { list: 'hash' }
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/product_feed_rule.rb

@@ -37,7 +37,7 @@ module FacebookAds
 
     field :attribute, 'string'
     field :id, 'string'
-    field :params, 'hash'
+    field :params, { list: 'hash' }
     field :rule_type, 'string'
 
   end

data/lib/facebook_ads/ad_objects/product_feed_rule_suggestion.rb

@@ -28,7 +28,7 @@ module FacebookAds
   class ProductFeedRuleSuggestion < AdObject
 
     field :attribute, 'string'
-    field :params, 'hash'
+    field :params, { list: 'hash' }
     field :type, 'string'
     has_no_id
     has_no_get

data/lib/facebook_ads/ad_objects/product_feed_schedule.rb

@@ -26,16 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class ProductFeedSchedule < AdObject
-    DAY_OF_WEEK = [
-      "FRIDAY",
-      "MONDAY",
-      "SATURDAY",
-      "SUNDAY",
-      "THURSDAY",
-      "TUESDAY",
-      "WEDNESDAY",
-    ]
-
     INTERVAL = [
       "DAILY",
       "HOURLY",
@@ -45,7 +35,7 @@ module FacebookAds
 
 
     field :day_of_month, 'int'
-    field :day_of_week, { enum: -> { DAY_OF_WEEK }}
+    field :day_of_week, 'string'
     field :hour, 'int'
     field :id, 'string'
     field :interval, { enum: -> { INTERVAL }}

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -315,6 +315,7 @@ module FacebookAds
       "DIGITAL_GOODS_NOT_AVAILABLE_FOR_CHECKOUT",
       "DUPLICATE_IMAGES",
       "DUPLICATE_TITLE_AND_DESCRIPTION",
+      "EMPTY_DESCRIPTION",
       "GENERIC_INVALID_FIELD",
       "HIDDEN_UNTIL_PRODUCT_LAUNCH",
       "IMAGE_FETCH_FAILED",
@@ -648,22 +649,22 @@ module FacebookAds
     ]
 
 
-    field :additional_image_cdn_urls, { list: 'hash' }
+    field :additional_image_cdn_urls, { list: { list: 'hash' } }
     field :additional_image_urls, { list: 'string' }
-    field :additional_variant_attributes, 'hash'
+    field :additional_variant_attributes, { list: 'hash' }
     field :age_group, { enum: -> { AGE_GROUP }}
     field :applinks, 'CatalogItemAppLinks'
     field :ar_data, 'ProductItemArData'
     field :availability, { enum: -> { AVAILABILITY }}
     field :brand, 'string'
-    field :capability_to_review_status, 'hash'
+    field :capability_to_review_status, { list: 'hash' }
     field :category, 'string'
     field :category_specific_fields, 'CatalogSubVerticalList'
     field :color, 'string'
     field :commerce_insights, 'ProductItemCommerceInsights'
     field :condition, { enum: -> { CONDITION }}
     field :currency, 'string'
-    field :custom_data, 'hash'
+    field :custom_data, { list: 'hash' }
     field :custom_label_0, 'string'
     field :custom_label_1, 'string'
     field :custom_label_2, 'string'
@@ -681,7 +682,7 @@ module FacebookAds
     field :gender, { enum: -> { GENDER }}
     field :gtin, 'string'
     field :id, 'string'
-    field :image_cdn_urls, 'hash'
+    field :image_cdn_urls, { list: 'hash' }
     field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :image_url, 'string'
     field :images, { list: 'string' }
@@ -754,5 +755,9 @@ module FacebookAds
       edge.get 'ProductSet'
     end
 
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/reach_frequency_estimates_placement_breakdown.rb

@@ -30,6 +30,9 @@ module FacebookAds
     field :android, { list: 'double' }
     field :audience_network, { list: 'double' }
     field :desktop, { list: 'double' }
+    field :facebook_search, { list: 'double' }
+    field :fb_reels, { list: 'double' }
+    field :fb_reels_overlay, { list: 'double' }
     field :ig_android, { list: 'double' }
     field :ig_ios, { list: 'double' }
     field :ig_other, { list: 'double' }

data/lib/facebook_ads/ad_objects/reach_frequency_prediction.rb

@@ -77,7 +77,7 @@ module FacebookAds
     field :curve_reach, { list: 'int' }
     field :daily_grp_curve, { list: 'double' }
     field :daily_impression_curve, { list: 'double' }
-    field :daily_impression_curve_map, 'map<unsigned int, list<float>>'
+    field :daily_impression_curve_map, { list: 'map<unsigned int, list<float>>' }
     field :day_parting_schedule, { list: 'ReachFrequencyDayPart' }
     field :destination_id, 'string'
     field :end_time, 'datetime'
@@ -93,8 +93,8 @@ module FacebookAds
     field :external_reach, 'int'
     field :feed_ratio_0000, 'int'
     field :frequency_cap, 'int'
-    field :frequency_distribution_map, 'map<unsigned int, list<float>>'
-    field :frequency_distribution_map_agg, 'map<unsigned int, list<unsigned int>>'
+    field :frequency_distribution_map, { list: 'map<unsigned int, list<float>>' }
+    field :frequency_distribution_map_agg, { list: 'map<unsigned int, list<unsigned int>>' }
     field :grp_audience_size, 'double'
     field :grp_avg_probability_map, 'string'
     field :grp_country_audience_size, 'double'
@@ -127,7 +127,7 @@ module FacebookAds
     field :optimization_goal_name, 'string'
     field :pause_periods, { list: 'object' }
     field :placement_breakdown, 'ReachFrequencyEstimatesPlacementBreakdown'
-    field :placement_breakdown_map, 'map<unsigned int, ReachFrequencyEstimatesPlacementBreakdown>'
+    field :placement_breakdown_map, { list: 'map<unsigned int, ReachFrequencyEstimatesPlacementBreakdown>' }
     field :plan_name, 'string'
     field :plan_type, 'string'
     field :prediction_mode, 'int'

data/lib/facebook_ads/ad_objects/saved_audience.rb

@@ -32,7 +32,6 @@ module FacebookAds
     field :approximate_count_upper_bound, 'int'
     field :delete_time, 'int'
     field :description, 'string'
-    field :extra_info, 'string'
     field :id, 'string'
     field :name, 'string'
     field :operation_status, 'CustomAudienceStatus'