facebookbusiness 0.8.0.2 → 0.9.0.2

data/lib/facebook_ads/ad_objects/{event_tour.rb → payment_engine_payment.rb}

@@ -25,31 +25,48 @@ 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 EventTour < AdObject
+  class PaymentEnginePayment < AdObject
+    REASON = [
+      "BANNED_USER",
+      "DENIED_REFUND",
+      "GRANTED_REPLACEMENT_ITEM",
+    ]
 
-    field :description, 'string'
-    field :dominant_color, 'string'
-    field :end_time, 'string'
+
+    field :actions, { list: 'object' }
+    field :application, 'Application'
+    field :country, 'string'
+    field :created_time, 'datetime'
+    field :disputes, { list: 'object' }
+    field :fraud_status, 'string'
+    field :fulfillment_status, 'string'
     field :id, 'string'
-    field :is_past, 'bool'
-    field :last_event_timestamp, 'int'
-    field :name, 'string'
-    field :num_events, 'int'
-    field :photo, 'Photo'
-    field :publishing_state, 'string'
-    field :scheduled_publish_timestamp, 'int'
-    field :start_time, 'string'
-    field :ticketing_uri, 'string'
-    field :video, 'AdVideo'
+    field :is_from_ad, 'bool'
+    field :is_from_page_post, 'bool'
+    field :items, { list: 'object' }
+    field :payout_foreign_exchange_rate, 'double'
+    field :phone_support_eligible, 'bool'
+    field :refundable_amount, 'CurrencyAmount'
+    field :request_id, 'string'
+    field :tax, 'string'
+    field :tax_country, 'string'
+    field :test, 'int'
+    field :user, 'User'
     has_no_post
     has_no_delete
 
-    has_edge :events do |edge|
-      edge.get 'Event'
+    has_edge :dispute do |edge|
+      edge.post 'PaymentEnginePayment' do |api|
+        api.has_param :reason, { enum: -> { PaymentEnginePayment::REASON }}
+      end
     end
 
-    has_edge :pages do |edge|
-      edge.get 'Page'
+    has_edge :refunds do |edge|
+      edge.post 'PaymentEnginePayment' do |api|
+        api.has_param :amount, 'double'
+        api.has_param :currency, 'string'
+        api.has_param :reason, { enum: -> { PaymentEnginePayment::REASON }}
+      end
     end
 
   end

data/lib/facebook_ads/ad_objects/payment_subscription.rb

@@ -29,13 +29,13 @@ module FacebookAds
 
     field :amount, 'string'
     field :app_param_data, 'string'
-    field :application, 'Profile'
+    field :application, 'Application'
     field :billing_period, 'string'
     field :canceled_reason, 'string'
     field :created_time, 'datetime'
     field :currency, 'string'
     field :id, 'string'
-    field :last_payment, 'string'
+    field :last_payment, 'PaymentEnginePayment'
     field :next_bill_time, 'datetime'
     field :next_period_amount, 'string'
     field :next_period_currency, 'string'
@@ -50,7 +50,7 @@ module FacebookAds
     field :trial_currency, 'string'
     field :trial_expiry_time, 'datetime'
     field :updated_time, 'datetime'
-    field :user, 'Profile'
+    field :user, 'User'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/photo.rb

@@ -125,16 +125,6 @@ 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
-
     has_edge :sponsor_tags do |edge|
       edge.get 'Page'
     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

@@ -35,6 +35,51 @@ module FacebookAds
       "year",
     ]
 
+    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",
+    ]
+
     FEED_STORY_VISIBILITY = [
       "hidden",
       "visible",
@@ -59,22 +104,17 @@ module FacebookAds
     field :comments_mirroring_domain, 'string'
     field :coordinates, 'object'
     field :created_time, 'datetime'
-    field :delivery_growth_optimizations, { list: 'string' }
     field :description, 'string'
-    field :entities, 'object'
     field :event, 'Event'
     field :expanded_height, 'int'
     field :expanded_width, 'int'
     field :feed_targeting, 'object'
-    field :formatting, 'string'
     field :from, 'object'
     field :full_picture, 'string'
     field :height, 'int'
     field :icon, 'string'
     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'
@@ -84,8 +124,7 @@ module FacebookAds
     field :is_popular, 'bool'
     field :is_published, 'bool'
     field :is_spherical, 'bool'
-    field :link, 'string'
-    field :live_video_eligibility, { list: 'string' }
+    field :link, 'object'
     field :message, 'string'
     field :message_tags, { list: 'string' }
     field :multi_share_end_card, 'bool'
@@ -96,12 +135,10 @@ 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'
     field :properties, { list: 'string' }
-    field :publishing_stats, 'int'
     field :scheduled_publish_time, 'double'
     field :shares, 'object'
     field :source, 'string'
@@ -112,13 +149,11 @@ module FacebookAds
     field :target, 'Profile'
     field :targeting, 'object'
     field :timeline_visibility, 'string'
-    field :translations, 'hash'
     field :type, 'string'
     field :updated_time, 'datetime'
     field :via, 'object'
     field :video_buying_eligibility, { list: 'string' }
     field :width, 'int'
-    field :will_be_autocropped_when_deliver_to_instagram, 'bool'
 
     has_edge :attachments do |edge|
       edge.get
@@ -172,24 +207,6 @@ module FacebookAds
       end
     end
 
-    has_edge :promotions do |edge|
-      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 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 :currency, 'string'
-        api.has_param :flow_id, 'string'
-        api.has_param :placement, 'string'
-        api.has_param :start_time, 'int'
-        api.has_param :stop_time, 'int'
-        api.has_param :targeting, 'Targeting'
-      end
-    end
-
     has_edge :reactions do |edge|
       edge.get 'Profile' do |api|
         api.has_param :type, { enum: -> { Profile::TYPE }}

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "home_listings",
       "hotels",
       "jobs",
+      "local_delivery_shipping_profiles",
       "local_service_businesses",
       "offer_items",
       "offline_commerce",
@@ -110,7 +111,6 @@ module FacebookAds
     field :catalog_segment_product_set_id, 'string'
     field :destination_catalog_settings, 'hash'
     field :flight_catalog_settings, 'hash'
-    field :onsite_commerce_merchant, 'object'
     field :parent_catalog_id, 'string'
 
     has_edge :agencies do |edge|
@@ -274,12 +274,6 @@ module FacebookAds
       end
     end
 
-    has_edge :onsite_commerce_merchant do |edge|
-      edge.post 'ProductCatalog' do |api|
-        api.has_param :onsite_commerce_merchant, 'object'
-      end
-    end
-
     has_edge :pricing_variables_batch do |edge|
       edge.get 'ProductCatalogPricingVariablesBatch' do |api|
         api.has_param :handle, 'string'
@@ -305,6 +299,7 @@ module FacebookAds
         api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
         api.has_param :file_name, 'string'
         api.has_param :item_sub_type, { enum: -> { ProductFeed::ITEM_SUB_TYPE }}
+        api.has_param :migrated_from_feed_id, 'string'
         api.has_param :name, 'string'
         api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
         api.has_param :override_value, 'string'
@@ -354,6 +349,7 @@ module FacebookAds
       edge.post 'ProductItem' do |api|
         api.has_param :additional_image_files, { list: 'file' }
         api.has_param :additional_image_urls, { list: 'string' }
+        api.has_param :additional_uploaded_image_ids, { list: 'string' }
         api.has_param :additional_variant_attributes, 'hash'
         api.has_param :android_app_name, 'string'
         api.has_param :android_class, 'string'

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -116,6 +116,7 @@ module FacebookAds
     field :id, 'string'
     field :item_sub_type, 'string'
     field :latest_upload, 'ProductFeedUpload'
+    field :migrated_from_feed_id, 'string'
     field :name, 'string'
     field :override_type, 'string'
     field :product_count, 'int'

data/lib/facebook_ads/ad_objects/product_feed_schedule.rb

@@ -54,6 +54,8 @@ module FacebookAds
     field :timezone, 'string'
     field :url, 'string'
     field :username, 'string'
+    has_no_post
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/product_group.rb

@@ -32,6 +32,14 @@ module FacebookAds
     field :retailer_id, 'string'
     field :variants, { list: 'ProductVariant' }
 
+    has_edge :ar_data do |edge|
+      edge.post do |api|
+        api.has_param :effect_icon, 'file'
+        api.has_param :state, { enum: %w{DISABLED ENABLED TEST }}
+        api.has_param :surfaces, { list: { enum: %w{SHOPS TEST_CAPABILITY UNIVERSAL_CHECKOUT US_MARKETPLACE }} }
+      end
+    end
+
     has_edge :products do |edge|
       edge.get 'ProductItem'
       edge.post 'ProductItem' do |api|

data/lib/facebook_ads/ad_objects/product_item.rb

@@ -316,12 +316,14 @@ module FacebookAds
     field :id, 'string'
     field :image_cdn_urls, 'hash'
     field :image_url, 'string'
+    field :images, { list: 'string' }
     field :inventory, 'int'
     field :manufacturer_part_number, 'string'
     field :material, 'string'
     field :mobile_link, 'string'
     field :name, 'string'
     field :ordering_index, 'int'
+    field :parent_product_id, 'string'
     field :pattern, 'string'
     field :price, 'string'
     field :product_catalog, 'ProductCatalog'
@@ -343,6 +345,7 @@ module FacebookAds
     field :url, 'string'
     field :visibility, { enum: -> { VISIBILITY }}
     field :additional_image_files, { list: 'file' }
+    field :additional_uploaded_image_ids, { list: 'string' }
     field :android_app_name, 'string'
     field :android_class, 'string'
     field :android_package, 'string'
@@ -367,6 +370,18 @@ module FacebookAds
     field :windows_phone_app_name, 'string'
     field :windows_phone_url, 'string'
 
+    has_edge :ar_data do |edge|
+      edge.post do |api|
+        api.has_param :container_effect, { enum: %w{MAKEUP }}
+        api.has_param :effect_parameters, 'hash'
+        api.has_param :picker_icon, 'file'
+      end
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
     has_edge :product_sets do |edge|
       edge.get 'ProductSet'
     end

data/lib/facebook_ads/ad_objects/referral.rb

@@ -34,10 +34,12 @@ module FacebookAds
     field :namespace, 'string'
     field :need_promo_code, 'bool'
     field :offer_origin, 'string'
+    field :privacy_policy_link, 'string'
     field :promotion_text, 'string'
     field :receiver_benefits_text, 'string'
     field :referral_link_uri, 'string'
     field :sender_benefits_text, 'string'
+    field :terms_and_condition_link, 'string'
 
   end
 end

data/lib/facebook_ads/ad_objects/server_side/action_source.rb

@@ -0,0 +1,48 @@
+# 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.
+
+module FacebookAds
+	module ServerSide
+		ActionSource = Set[
+
+			# Conversion happened over email.
+			'email',
+
+			# Conversion was made on your website.
+			'website',
+
+			# Conversion was made using your app.
+			'app',
+
+			# Conversion was made over the phone.
+			'phone_call',
+
+			# Conversion was made via a messaging app, SMS, or online messaging feature.
+			'chat',
+
+			# Conversion was made in person at your physical store.
+			'physical_store',
+
+			# Conversion happened automatically, for example, a subscription renewal that's set on auto-pay each month.
+			'system_generated',
+
+			# Conversion happened in a way that is not listed.
+			'other'
+		]
+	end
+end

data/lib/facebook_ads/ad_objects/server_side/batch_processor.rb

@@ -0,0 +1,73 @@
+# 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.
+
+module FacebookAds::ServerSide
+  class BatchProcessor
+    attr_accessor :batch_size
+    attr_accessor :concurrent_requests
+
+    # Initializes the object
+    # @param [Integer] batch_size  The number of events to send in each request
+    # @param [Integer] concurrent_requests  The number of threads to use when making requests concurrently
+    def initialize(batch_size=50, concurrent_requests=4)
+      self.batch_size = batch_size
+      self.concurrent_requests = concurrent_requests
+    end
+
+    def process_event_requests(event_requests_async)
+      generator = self.process_event_requests_generator(event_requests_async)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_events(event_request_async_to_clone, events)
+      generator = self.process_events_generator(event_request_async_to_clone, events)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_event_requests_generator(event_requests_async)
+      index = 0
+      Enumerator.new do |generator|
+        while index < event_requests_async.size do
+          batch = event_requests_async[index, concurrent_requests].map(&:execute)
+          generator.yield *[batch]
+          index += concurrent_requests
+        end
+      end
+    end
+
+    def process_events_generator(event_request_async_to_clone, events)
+      index = 0
+      Enumerator.new do |generator|
+        while index < events.size do
+          batch = []
+          while index < events.size && batch.size < concurrent_requests do
+            event_request_async = event_request_async_to_clone.clone_without_events
+            event_request_async.events = events[index, batch_size]
+            batch << event_request_async
+            index += batch_size
+          end
+          generator.yield *[batch.map(&:execute)]
+        end
+      end
+    end
+  end
+end