facebookbusiness 0.7.0.3 → 0.9.0.0

data/lib/facebook_ads/ad_objects/link.rb

@@ -43,6 +43,12 @@ module FacebookAds
     has_no_delete
 
     has_edge :comments do |edge|
+      edge.get 'Comment' do |api|
+        api.has_param :filter, { enum: -> { Comment::FILTER }}
+        api.has_param :live_filter, { enum: -> { Comment::LIVE_FILTER }}
+        api.has_param :order, { enum: -> { Comment::ORDER }}
+        api.has_param :since, 'datetime'
+      end
       edge.post 'Comment' do |api|
         api.has_param :attachment_id, 'string'
         api.has_param :attachment_share_url, 'string'
@@ -64,12 +70,6 @@ module FacebookAds
       edge.get 'Profile'
     end
 
-    has_edge :reactions do |edge|
-      edge.get 'Profile' do |api|
-        api.has_param :type, { enum: -> { Profile::TYPE }}
-      end
-    end
-
     has_edge :sharedposts do |edge|
       edge.get 'Post'
     end

data/lib/facebook_ads/ad_objects/live_video.rb

@@ -26,6 +26,18 @@ module FacebookAds
   # pull request for this class.
 
   class LiveVideo < AdObject
+    BROADCAST_STATUS = [
+      "live",
+      "live_stopped",
+      "processing",
+      "scheduled_canceled",
+      "scheduled_expired",
+      "scheduled_live",
+      "scheduled_unpublished",
+      "unpublished",
+      "vod",
+    ]
+
     PROJECTION = [
       "CUBEMAP",
       "EQUIRECTANGULAR",
@@ -55,18 +67,6 @@ module FacebookAds
       "REGULAR",
     ]
 
-    BROADCAST_STATUS = [
-      "LIVE",
-      "LIVE_STOPPED",
-      "PROCESSING",
-      "SCHEDULED_CANCELED",
-      "SCHEDULED_EXPIRED",
-      "SCHEDULED_LIVE",
-      "SCHEDULED_UNPUBLISHED",
-      "UNPUBLISHED",
-      "VOD",
-    ]
-
     SOURCE = [
       "owner",
       "target",
@@ -141,10 +141,6 @@ module FacebookAds
       edge.post 'LiveVideoInputStream'
     end
 
-    has_edge :likes do |edge|
-      edge.get 'Profile'
-    end
-
     has_edge :polls do |edge|
       edge.get 'VideoPoll'
       edge.post 'VideoPoll' do |api|

data/lib/facebook_ads/ad_objects/native_offer_view.rb

@@ -33,7 +33,6 @@ module FacebookAds
     has_no_delete
 
     has_edge :photos do |edge|
-      edge.get 'Photo'
       edge.post 'NativeOfferView' do |api|
         api.has_param :ad_account, 'string'
         api.has_param :ad_image_hashes, { list: 'string' }

data/lib/facebook_ads/ad_objects/oracle_transaction.rb

@@ -37,7 +37,6 @@ module FacebookAds
     field :amount_due, 'CurrencyAmount'
     field :billed_amount_details, 'BilledAmountDetails'
     field :billing_period, 'string'
-    field :campaign, 'AtlasCampaign'
     field :cdn_download_uri, 'string'
     field :currency, 'string'
     field :download_uri, 'string'
@@ -58,11 +57,5 @@ module FacebookAds
       edge.get 'InvoiceCampaign'
     end
 
-    has_edge :data do |edge|
-      edge.get 'AtlasUrl' do |api|
-        api.has_param :redirect, 'bool'
-      end
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/page.rb

@@ -92,6 +92,12 @@ module FacebookAds
       "Vietnamese",
     ]
 
+    PICKUP_OPTIONS = [
+      "CURBSIDE",
+      "IN_STORE",
+      "OTHER",
+    ]
+
     TEMPORARY_STATUS = [
       "DIFFERENTLY_OPEN",
       "NO_DATA",
@@ -107,6 +113,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
@@ -129,6 +136,7 @@ module FacebookAds
       "MANAGE",
       "MANAGE_JOBS",
       "MANAGE_LEADS",
+      "MESSAGING",
       "MODERATE",
       "MODERATE_COMMUNITY",
       "PAGES_MESSAGING",
@@ -276,6 +284,7 @@ module FacebookAds
       "leadgen",
       "leadgen_fat",
       "live_videos",
+      "local_delivery",
       "location",
       "mcom_invoice_change",
       "members",
@@ -328,29 +337,6 @@ module FacebookAds
       "website",
     ]
 
-    DOMAIN_ACTION_TYPE = [
-      "ADD",
-      "REMOVE",
-    ]
-
-    PAYMENT_DEV_MODE_ACTION = [
-      "ADD",
-      "REMOVE",
-    ]
-
-    SETTING_TYPE = [
-      "ACCOUNT_LINKING",
-      "CALL_TO_ACTIONS",
-      "DOMAIN_WHITELISTING",
-      "GREETING",
-      "PAYMENT",
-    ]
-
-    THREAD_STATE = [
-      "EXISTING_THREAD",
-      "NEW_THREAD",
-    ]
-
 
     field :about, 'string'
     field :access_token, 'string'
@@ -375,6 +361,7 @@ module FacebookAds
     field :checkins, 'int'
     field :company_overview, 'string'
     field :connected_instagram_account, 'IgUser'
+    field :connected_page_backed_instagram_account, 'IgUser'
     field :contact_address, 'MailingAddress'
     field :copyright_whitelisted_ig_partners, { list: 'string' }
     field :country_page_likes, 'int'
@@ -443,7 +430,6 @@ module FacebookAds
     field :new_like_count, 'int'
     field :offer_eligible, 'bool'
     field :overall_star_rating, 'double'
-    field :page_about_story, 'PageAboutStory'
     field :page_token, 'string'
     field :parent_page, 'Page'
     field :parking, 'PageParking'
@@ -452,6 +438,7 @@ module FacebookAds
     field :personal_interests, 'string'
     field :pharma_safety_info, 'string'
     field :phone, 'string'
+    field :pickup_options, { list: 'string' }
     field :place_type, 'string'
     field :plot_outline, 'string'
     field :preferred_audience, 'Targeting'
@@ -558,6 +545,13 @@ module FacebookAds
       end
     end
 
+    has_edge :business_data do |edge|
+      edge.post 'Page' do |api|
+        api.has_param :data, { list: 'string' }
+        api.has_param :partner_agent, 'string'
+      end
+    end
+
     has_edge :call_to_actions do |edge|
       edge.get 'PageCallToAction'
     end
@@ -599,9 +593,6 @@ module FacebookAds
         api.has_param :url, 'string'
       end
       edge.get 'Url'
-      edge.post 'Page' do |api|
-        api.has_param :url, 'string'
-      end
     end
 
     has_edge :commerce_merchant_settings do |edge|
@@ -689,6 +680,13 @@ module FacebookAds
       end
     end
 
+    has_edge :extend_thread_control do |edge|
+      edge.post 'Page' do |api|
+        api.has_param :duration, 'int'
+        api.has_param :recipient, 'object'
+      end
+    end
+
     has_edge :feed do |edge|
       edge.get 'PagePost' do |api|
         api.has_param :include_hidden, 'bool'
@@ -913,6 +911,7 @@ module FacebookAds
         api.has_param :crossposting_actions, { list: 'hash' }
         api.has_param :custom_labels, { list: 'string' }
         api.has_param :description, 'string'
+        api.has_param :enable_backup_ingest, 'bool'
         api.has_param :encoding_settings, 'string'
         api.has_param :fisheye_video_cropped, 'bool'
         api.has_param :front_z_rotation, 'double'
@@ -925,7 +924,6 @@ module FacebookAds
         api.has_param :privacy, 'string'
         api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
         api.has_param :published, 'bool'
-        api.has_param :save_vod, 'bool'
         api.has_param :schedule_custom_profile_image, 'file'
         api.has_param :spatial_audio_format, { enum: -> { LiveVideo::SPATIAL_AUDIO_FORMAT }}
         api.has_param :status, { enum: -> { LiveVideo::STATUS }}
@@ -955,6 +953,7 @@ module FacebookAds
         api.has_param :page_username, 'string'
         api.has_param :permanently_closed, 'bool'
         api.has_param :phone, 'string'
+        api.has_param :pickup_options, { list: { enum: -> { Page::PICKUP_OPTIONS }} }
         api.has_param :place_topics, { list: 'string' }
         api.has_param :price_range, 'string'
         api.has_param :store_code, 'string'
@@ -1001,13 +1000,9 @@ module FacebookAds
       edge.get 'MessagingFeatureReview'
     end
 
-    has_edge :messenger_ads_page_welcome_messages do |edge|
-      edge.get 'MessengerDestinationPageWelcomeMessage'
-    end
-
     has_edge :messenger_profile do |edge|
       edge.delete do |api|
-        api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL GET_STARTED GREETING HOME_URL ICE_BREAKERS PAYMENT_SETTINGS PERSISTENT_MENU TARGET_AUDIENCE WHITELISTED_DOMAINS }} }
+        api.has_param :fields, { list: { enum: %w{ACCOUNT_LINKING_URL GET_STARTED GREETING HOME_URL ICE_BREAKERS PAYMENT_SETTINGS PERSISTENT_MENU PLATFORM TARGET_AUDIENCE WHITELISTED_DOMAINS }} }
       end
       edge.get 'MessengerProfile'
       edge.post 'Page' do |api|
@@ -1061,16 +1056,6 @@ module FacebookAds
       end
     end
 
-    has_edge :page_about_story do |edge|
-      edge.post 'Page' do |api|
-        api.has_param :composed_text, { list: 'hash' }
-        api.has_param :cover_photo, 'hash'
-        api.has_param :entity_map, { list: 'hash' }
-        api.has_param :is_published, 'bool'
-        api.has_param :title, 'string'
-      end
-    end
-
     has_edge :page_backed_instagram_accounts do |edge|
       edge.get 'InstagramUser'
       edge.post 'InstagramUser'
@@ -1091,6 +1076,14 @@ 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|
@@ -1175,6 +1168,7 @@ module FacebookAds
       end
       edge.post 'ProfilePictureSource' do |api|
         api.has_param :android_key_hash, 'string'
+        api.has_param :burn_media_effect, 'bool'
         api.has_param :caption, 'string'
         api.has_param :composer_session_id, 'string'
         api.has_param :has_umg, 'bool'
@@ -1201,10 +1195,6 @@ module FacebookAds
       end
     end
 
-    has_edge :place_topics do |edge|
-      edge.get 'PlaceTopic'
-    end
-
     has_edge :posts do |edge|
       edge.get 'PagePost' do |api|
         api.has_param :include_hidden, 'bool'
@@ -1230,6 +1220,12 @@ module FacebookAds
       edge.get 'Recommendation'
     end
 
+    has_edge :release_thread_control do |edge|
+      edge.post 'Page' do |api|
+        api.has_param :recipient, 'object'
+      end
+    end
+
     has_edge :request_thread_control do |edge|
       edge.post 'Page' do |api|
         api.has_param :metadata, 'string'
@@ -1276,9 +1272,6 @@ module FacebookAds
     end
 
     has_edge :tabs do |edge|
-      edge.delete do |api|
-        api.has_param :tab, 'string'
-      end
       edge.get 'Tab' do |api|
         api.has_param :tab, { list: 'string' }
       end
@@ -1309,26 +1302,6 @@ module FacebookAds
       end
     end
 
-    has_edge :thread_settings do |edge|
-      edge.delete do |api|
-        api.has_param :setting_type, { enum: -> { Page::SETTING_TYPE }}
-        api.has_param :thread_state, { enum: -> { Page::THREAD_STATE }}
-      end
-      edge.post 'Page' do |api|
-        api.has_param :account_linking_url, 'string'
-        api.has_param :call_to_actions, { list: 'object' }
-        api.has_param :domain_action_type, { enum: -> { Page::DOMAIN_ACTION_TYPE }}
-        api.has_param :greeting, 'object'
-        api.has_param :payment_dev_mode_action, { enum: -> { Page::PAYMENT_DEV_MODE_ACTION }}
-        api.has_param :payment_privacy_url, 'string'
-        api.has_param :payment_public_key, 'string'
-        api.has_param :payment_testers, { list: 'string' }
-        api.has_param :setting_type, { enum: -> { Page::SETTING_TYPE }}
-        api.has_param :thread_state, { enum: -> { Page::THREAD_STATE }}
-        api.has_param :whitelisted_domains, { list: 'string' }
-      end
-    end
-
     has_edge :threads do |edge|
       edge.get 'UnifiedThread' do |api|
         api.has_param :folder, 'string'
@@ -1352,6 +1325,10 @@ module FacebookAds
         api.has_param :selected_rule_id, 'string'
         api.has_param :source, { enum: -> { VideoCopyrightRule::SOURCE }}
       end
+      edge.post 'VideoCopyrightRule' do |api|
+        api.has_param :condition_groups, { list: 'object' }
+        api.has_param :name, 'string'
+      end
     end
 
     has_edge :video_copyrights do |edge|
@@ -1453,6 +1430,7 @@ module FacebookAds
         api.has_param :slideshow_spec, 'hash'
         api.has_param :social_actions, 'bool'
         api.has_param :source, 'string'
+        api.has_param :source_instagram_media_id, 'string'
         api.has_param :specified_dialect, 'string'
         api.has_param :spherical, 'bool'
         api.has_param :sponsor_id, 'string'

data/lib/facebook_ads/ad_objects/page_post.rb

@@ -76,6 +76,7 @@ module FacebookAds
     field :id, 'string'
     field :implicit_place, 'Place'
     field :instagram_eligibility, 'string'
+    field :instream_eligibility, 'string'
     field :is_app_share, 'bool'
     field :is_eligible_for_promotion, 'bool'
     field :is_expired, 'bool'
@@ -94,6 +95,7 @@ module FacebookAds
     field :permalink_url, 'object'
     field :picture, 'string'
     field :place, 'Place'
+    field :poll, 'object'
     field :privacy, 'Privacy'
     field :promotable_id, 'string'
     field :promotion_status, 'string'

data/lib/facebook_ads/ad_objects/photo.rb

@@ -125,6 +125,12 @@ module FacebookAds
       end
     end
 
+    has_edge :reactions do |edge|
+      edge.get 'Profile' do |api|
+        api.has_param :type, { enum: -> { Profile::TYPE }}
+      end
+    end
+
     has_edge :sharedposts do |edge|
       edge.get 'Post'
     end

data/lib/facebook_ads/ad_objects/playable_content.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :name, 'string'
     field :owner, 'Profile'
     field :app_id, 'string'
+    field :session_id, 'string'
     field :source, 'file'
     field :source_url, 'string'
     field :source_zip, 'file'

data/lib/facebook_ads/ad_objects/post.rb

@@ -46,6 +46,51 @@ module FacebookAds
       "normal",
     ]
 
+    CHECKIN_ENTRY_POINT = [
+      "BRANDING_CHECKIN",
+      "BRANDING_OTHER",
+      "BRANDING_PHOTO",
+      "BRANDING_STATUS",
+    ]
+
+    FORMATTING = [
+      "MARKDOWN",
+      "PLAINTEXT",
+    ]
+
+    PLACE_ATTACHMENT_SETTING = [
+      "1",
+      "2",
+    ]
+
+    POST_SURFACES_BLACKLIST = [
+      "1",
+      "2",
+      "3",
+      "4",
+      "5",
+    ]
+
+    POSTING_TO_REDSPACE = [
+      "disabled",
+      "enabled",
+    ]
+
+    TARGET_SURFACE = [
+      "STORY",
+      "TIMELINE",
+    ]
+
+    UNPUBLISHED_CONTENT_TYPE = [
+      "ADS_POST",
+      "DRAFT",
+      "INLINE_CREATED",
+      "PUBLISHED",
+      "REVIEWABLE_BRANDED_CONTENT",
+      "SCHEDULED",
+      "SCHEDULED_RECURRING",
+    ]
+
 
     field :actions, { list: 'string' }
     field :admin_creator, 'object'
@@ -74,6 +119,7 @@ module FacebookAds
     field :id, 'string'
     field :implicit_place, 'Place'
     field :instagram_eligibility, 'string'
+    field :instream_eligibility, 'string'
     field :is_app_share, 'bool'
     field :is_eligible_for_promotion, 'bool'
     field :is_expired, 'bool'
@@ -95,6 +141,7 @@ module FacebookAds
     field :permalink_url, 'object'
     field :picture, 'string'
     field :place, 'Place'
+    field :poll, 'object'
     field :privacy, 'Privacy'
     field :promotable_id, 'string'
     field :promotion_status, 'string'
@@ -174,11 +221,11 @@ module FacebookAds
       edge.post do |api|
         api.has_param :ad_account_id, 'string'
         api.has_param :ad_conversion_pixel_id, 'int'
-        api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
+        api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MARKETPLACE_NATIONWIDE_AUDIENCE MARKETPLACE_SAVED_AUDIENCE MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
         api.has_param :audience_id, 'string'
         api.has_param :bid_amount, 'int'
         api.has_param :budget, 'int'
-        api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_PAGE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SEND_A_GIFT SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE SUBSCRIBE UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
+        api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_PAGE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REFER_FRIENDS REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SEND_A_GIFT SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE START_ORDER SUBSCRIBE SWIPE_UP_PRODUCT SWIPE_UP_SHOP UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
         api.has_param :currency, 'string'
         api.has_param :flow_id, 'string'
         api.has_param :placement, 'string'