facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/ig_user.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
 
@@ -37,23 +25,83 @@ module FacebookAds
     field :mentioned_comment, 'IgComment'
     field :mentioned_media, 'IgMedia'
     field :name, 'string'
+    field :owner_business, 'Business'
     field :profile_picture_url, 'string'
+    field :shopping_product_tag_eligibility, 'bool'
     field :shopping_review_status, 'string'
     field :username, 'string'
     field :website, 'string'
     has_no_post
     has_no_delete
 
+    has_edge :available_catalogs do |edge|
+      edge.get 'UserAvailableCatalogs'
+    end
+
+    has_edge :branded_content_ad_permissions do |edge|
+      edge.get 'IgbcAdsPermission'
+      edge.post 'IgbcAdsPermission' do |api|
+        api.has_param :creator_instagram_account, 'string'
+        api.has_param :creator_instagram_username, 'string'
+        api.has_param :revoke, 'bool'
+      end
+    end
+
+    has_edge :branded_content_advertisable_medias do |edge|
+      edge.get 'BrandedContentShadowIgMediaId' do |api|
+        api.has_param :ad_code, 'string'
+        api.has_param :creator_username, 'string'
+        api.has_param :only_fetch_allowlisted, 'bool'
+        api.has_param :permalinks, { list: 'string' }
+      end
+    end
+
+    has_edge :branded_content_tag_approval do |edge|
+      edge.delete do |api|
+        api.has_param :user_ids, { list: 'int' }
+      end
+      edge.get 'BrandedContentShadowIgUserId' do |api|
+        api.has_param :user_ids, { list: 'int' }
+      end
+      edge.post 'BrandedContentShadowIgUserId' do |api|
+        api.has_param :user_ids, { list: 'int' }
+      end
+    end
+
+    has_edge :catalog_product_search do |edge|
+      edge.get 'ShadowIgUserCatalogProductSearch' do |api|
+        api.has_param :catalog_id, 'string'
+        api.has_param :q, 'string'
+      end
+    end
+
     has_edge :content_publishing_limit do |edge|
-      edge.get do |api|
+      edge.get 'ContentPublishingLimitResponse' do |api|
         api.has_param :since, 'datetime'
       end
     end
 
+    has_edge :dataset do |edge|
+      edge.get 'Dataset'
+      edge.post 'Dataset' do |api|
+        api.has_param :dataset_name, 'string'
+      end
+    end
+
     has_edge :insights do |edge|
       edge.get 'InstagramInsightsResult' do |api|
+        api.has_param :breakdown, { list: { enum: -> { InstagramInsightsResult::BREAKDOWN }} }
         api.has_param :metric, { list: { enum: -> { InstagramInsightsResult::METRIC }} }
+        api.has_param :metric_type, { enum: -> { InstagramInsightsResult::METRIC_TYPE }}
         api.has_param :period, { list: { enum: -> { InstagramInsightsResult::PERIOD }} }
+        api.has_param :since, 'datetime'
+        api.has_param :timeframe, { enum: -> { InstagramInsightsResult::TIMEFRAME }}
+        api.has_param :until, 'datetime'
+      end
+    end
+
+    has_edge :live_media do |edge|
+      edge.get 'IgMedia' do |api|
         api.has_param :since, 'datetime'
         api.has_param :until, 'datetime'
       end
@@ -65,11 +113,19 @@ 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 :collaborators, { list: 'string' }
+        api.has_param :cover_url, 'string'
         api.has_param :image_url, 'string'
+        api.has_param :is_carousel_item, 'bool'
         api.has_param :location_id, 'string'
         api.has_param :media_type, 'string'
+        api.has_param :product_tags, { list: 'hash' }
+        api.has_param :share_to_feed, 'bool'
         api.has_param :thumb_offset, 'string'
+        api.has_param :upload_type, 'string'
         api.has_param :user_tags, { list: 'hash' }
         api.has_param :video_url, 'string'
       end
@@ -89,8 +145,22 @@ module FacebookAds
       end
     end
 
+    has_edge :notification_message_tokens do |edge|
+      edge.get 'UserPageOneTimeOptInTokenSettings'
+    end
+
+    has_edge :product_appeal do |edge|
+      edge.get 'IgShoppingProductAppeal' do |api|
+        api.has_param :product_id, 'string'
+      end
+      edge.post 'IgShoppingProductAppeal' do |api|
+        api.has_param :appeal_reason, 'string'
+        api.has_param :product_id, 'string'
+      end
+    end
+
     has_edge :recently_searched_hashtags do |edge|
-      edge.get
+      edge.get 'ShadowIgHashtag'
     end
 
     has_edge :stories do |edge|

data/lib/facebook_ads/ad_objects/ig_user_export_for_cam.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 IgUserExportForCam < AdObject
+
+    field :email, 'string'
+    field :id, 'string'
+    field :is_paid_partnership_messages_enabled, 'bool'
+    field :messaging_id, 'string'
+    field :portfolio_url, 'string'
+    field :username, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ig_user_for_ig_only_api.rb

@@ -0,0 +1,148 @@
+# 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 IgUserForIgOnlyApi < AdObject
+
+    field :account_type, 'string'
+    field :biography, 'string'
+    field :followers_count, 'int'
+    field :follows_count, 'int'
+    field :id, 'string'
+    field :media_count, 'int'
+    field :name, 'string'
+    field :profile_picture_url, 'string'
+    field :user_id, 'int'
+    field :username, 'string'
+    field :website, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :content_publishing_limit do |edge|
+      edge.get 'ContentPublishingLimitResponse' do |api|
+        api.has_param :since, 'datetime'
+      end
+    end
+
+    has_edge :conversations do |edge|
+      edge.get 'UnifiedThread' do |api|
+        api.has_param :folder, 'string'
+        api.has_param :platform, { enum: -> { UnifiedThread::PLATFORM }}
+        api.has_param :tags, { list: 'string' }
+        api.has_param :user_id, 'string'
+      end
+    end
+
+    has_edge :live_media do |edge|
+      edge.get
+    end
+
+    has_edge :media do |edge|
+      edge.get do |api|
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+      end
+      edge.post do |api|
+        api.has_param :audio_name, 'string'
+        api.has_param :caption, 'string'
+        api.has_param :children, { list: 'string' }
+        api.has_param :collaborators, { list: 'string' }
+        api.has_param :cover_url, 'string'
+        api.has_param :image_url, 'string'
+        api.has_param :is_carousel_item, 'bool'
+        api.has_param :location_id, 'string'
+        api.has_param :media_type, 'string'
+        api.has_param :product_tags, { list: 'hash' }
+        api.has_param :share_to_feed, 'bool'
+        api.has_param :thumb_offset, 'string'
+        api.has_param :upload_type, 'string'
+        api.has_param :user_tags, { list: 'hash' }
+        api.has_param :video_url, 'string'
+      end
+    end
+
+    has_edge :mediapublish do |edge|
+      edge.post do |api|
+        api.has_param :creation_id, 'int'
+      end
+    end
+
+    has_edge :mentions do |edge|
+      edge.post do |api|
+        api.has_param :comment_id, 'string'
+        api.has_param :media_id, 'string'
+        api.has_param :message, 'string'
+      end
+    end
+
+    has_edge :messageattachments do |edge|
+      edge.post do |api|
+        api.has_param :message, 'object'
+      end
+    end
+
+    has_edge :messages do |edge|
+      edge.post do |api|
+        api.has_param :message, 'object'
+        api.has_param :messaging_type, { enum: %w{MESSAGE_TAG RESPONSE UPDATE UTILITY }}
+        api.has_param :payload, 'string'
+        api.has_param :recipient, 'object'
+        api.has_param :sender_action, { enum: %w{MARK_SEEN REACT TYPING_OFF TYPING_ON UNREACT }}
+        api.has_param :tag, 'object'
+        api.has_param :thread_control, 'object'
+      end
+    end
+
+    has_edge :messenger_profile do |edge|
+      edge.delete do |api|
+        api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL COMMANDS DESCRIPTION GET_STARTED GREETING HOME_URL ICE_BREAKERS PAYMENT_SETTINGS PERSISTENT_MENU PLATFORM SUBJECT_TO_NEW_EU_PRIVACY_RULES TARGET_AUDIENCE TITLE WHITELISTED_DOMAINS }} }
+      end
+      edge.get
+      edge.post do |api|
+        api.has_param :ice_breakers, { list: 'hash' }
+        api.has_param :persistent_menu, { list: 'object' }
+      end
+    end
+
+    has_edge :stories do |edge|
+      edge.get
+    end
+
+    has_edge :subscribed_apps do |edge|
+      edge.delete
+      edge.get
+      edge.post do |api|
+        api.has_param :subscribed_fields, { list: { enum: %w{comments creator_marketplace_invited_creator_onboarding creator_marketplace_projects delta live_comments mentions message_reactions messages messaging_handover messaging_optins messaging_postbacks messaging_referral messaging_seen standby story_insights }} }
+      end
+    end
+
+    has_edge :tags do |edge|
+      edge.get
+    end
+
+    has_edge :welcome_message_flows do |edge|
+      edge.get 'CtxPartnerAppWelcomeMessageFlow' do |api|
+        api.has_param :app_id, 'string'
+        api.has_param :flow_id, 'string'
+      end
+      edge.post do |api|
+        api.has_param :eligible_platforms, { list: { enum: %w{INSTAGRAM MESSENGER WHATSAPP }} }
+        api.has_param :flow_id, 'string'
+        api.has_param :name, 'string'
+        api.has_param :welcome_message_flow, { list: 'object' }
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/ig_video_copyright_check_matches_information.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 IgVideoCopyrightCheckMatchesInformation < AdObject
+
+    field :copyright_matches, { list: 'object' }
+    field :status, 'IgVideoCopyrightCheckStatus'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/ig_video_copyright_check_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 IgVideoCopyrightCheckStatus < AdObject
+
+    field :matches_found, 'bool'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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

data/lib/facebook_ads/ad_objects/image_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
 
@@ -297,6 +285,7 @@ module FacebookAds
     field :tags, { list: 'string' }
     field :title, 'string'
     field :update_time, 'datetime'
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/image_copyright_dispute.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 ImageCopyrightDispute < AdObject
+
+    field :appeal_form_data, 'string'
+    field :dispute_form_data, 'string'
+    field :expiration_time, 'datetime'
+    field :id, 'string'
+    field :match_id, 'string'
+    field :status, 'string'
+    field :time_appealed, 'datetime'
+    field :time_created, 'datetime'
+    field :time_updated, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/image_reference_match.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 ImageReferenceMatch < AdObject
+
+    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 :match_state, 'string'
+    field :matched_reference_copyright, 'ImageCopyright'
+    field :matched_reference_owner, 'Profile'
+    field :modification_history, { list: 'object' }
+    field :reference_copyright, 'ImageCopyright'
+    field :reference_owner, 'Profile'
+    field :rejection_form_data_entries_with_translations, { list: 'object' }
+    field :resolution_reason, 'string'
+    field :update_time, 'datetime'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/insights_result.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
 
@@ -26,7 +14,51 @@ module FacebookAds
   # pull request for this class.
 
   class InsightsResult < AdObject
+    BREAKDOWN = [
+      "action_type",
+      "follow_type",
+      "story_navigation_action_type",
+      "surface_type",
+    ]
+
+    METRIC = [
+      "clips_replays_count",
+      "comments",
+      "follows",
+      "ig_reels_aggregated_all_plays_count",
+      "ig_reels_avg_watch_time",
+      "ig_reels_video_view_total_time",
+      "impressions",
+      "likes",
+      "navigation",
+      "peak_concurrent_viewers",
+      "plays",
+      "profile_activity",
+      "profile_visits",
+      "quotes",
+      "reach",
+      "replies",
+      "reposts",
+      "saved",
+      "shares",
+      "thread_replies",
+      "thread_shares",
+      "total_interactions",
+      "video_views",
+      "views",
+    ]
+
+    PERIOD = [
+      "day",
+      "days_28",
+      "lifetime",
+      "month",
+      "total_over_range",
+      "week",
+    ]
+
     DATE_PRESET = [
+      "data_maximum",
       "last_14d",
       "last_28d",
       "last_30d",
@@ -48,14 +80,6 @@ module FacebookAds
       "yesterday",
     ]
 
-    PERIOD = [
-      "day",
-      "days_28",
-      "lifetime",
-      "month",
-      "week",
-    ]
-
 
     field :description, 'string'
     field :description_from_api_doc, 'string'
@@ -63,7 +87,7 @@ module FacebookAds
     field :name, 'string'
     field :period, 'string'
     field :title, 'string'
-    field :values, { list: 'object' }
+    field :values, { list: 'InsightsValue' }
     has_no_get
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/insights_value.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 InsightsValue < AdObject
+
+    field :campaign_id, 'string'
+    field :end_time, 'datetime'
+    field :engagement_source, 'string'
+    field :message_type, 'string'
+    field :messaging_channel, 'string'
+    field :recurring_notifications_entry_point, 'string'
+    field :recurring_notifications_frequency, 'string'
+    field :recurring_notifications_topic, 'string'
+    field :start_time, 'datetime'
+    field :value, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/instagram_boostable_media_for_access_token.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 InstagramBoostableMediaForAccessToken < AdObject
+
+    field :has_product_tags, 'bool'
+    field :media, 'IgMedia'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end