facebookbusiness 0.8.0.3 → 0.9.0.3

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_item.rb

@@ -293,6 +293,7 @@ module FacebookAds
     field :additional_variant_attributes, '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'
@@ -316,12 +317,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'
@@ -342,7 +345,7 @@ module FacebookAds
     field :start_date, 'string'
     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,10 @@ module FacebookAds
     field :windows_phone_app_name, 'string'
     field :windows_phone_url, 'string'
 
+    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/{user_payment_methods_info.rb → product_item_ar_data.rb}

@@ -25,15 +25,30 @@ 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 UserPaymentMethodsInfo < AdObject
+  class ProductItemArData < AdObject
+    SURFACES = [
+      "B2C_MARKETPLACE",
+      "C2C_MARKETPLACE",
+      "DA",
+      "DAILY_DEALS",
+      "DAILY_DEALS_LEGACY",
+      "IG_PRODUCT_TAGGING",
+      "MARKETPLACE",
+      "MARKETPLACE_ADS_DEPRECATED",
+      "MARKETPLACE_SHOPS",
+      "OFFLINE_CONVERSIONS",
+      "SHOPS",
+      "UNIVERSAL_CHECKOUT",
+    ]
 
-    field :account_id, 'string'
-    field :available_card_types, { list: 'string' }
-    field :available_payment_methods, { list: 'string' }
-    field :available_payment_methods_details, { list: 'object' }
-    field :country, 'string'
-    field :currency, 'string'
-    field :existing_payment_methods, { list: 'object' }
+
+    field :container_effect, 'string'
+    field :effect_icon, 'string'
+    field :effect_parameters, 'object'
+    field :picker_icon, 'string'
+    field :product_ar_link, 'object'
+    field :state, 'string'
+    field :surfaces, { list: { enum: -> { SURFACES }} }
     has_no_id
     has_no_get
     has_no_post

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/content.rb

@@ -28,7 +28,8 @@ module FacebookAds
                     :title,
                     :description,
                     :brand,
-                    :category
+                    :category,
+                    :delivery_category
 
       # Initializes the object
       # @param [String] product_id
@@ -38,7 +39,8 @@ module FacebookAds
       # @param [String] description
       # @param [String] brand
       # @param [String] category
-      def initialize(product_id: nil, quantity: nil, item_price: nil, title: nil, description: nil, brand: nil, category: nil)
+      # @param [String] delivery_category
+      def initialize(product_id: nil, quantity: nil, item_price: nil, title: nil, description: nil, brand: nil, category: nil, delivery_category: nil)
         unless product_id.nil?
           self.product_id = String(product_id)
         end
@@ -60,6 +62,9 @@ module FacebookAds
         unless category.nil?
           self.category = String(category)
         end
+        unless delivery_category.nil?
+          self.delivery_category = String(delivery_category)
+        end
       end
 
       # build the object using the input hash
@@ -97,6 +102,10 @@ module FacebookAds
         if attributes.has_key?(:'category')
           self.category = attributes[:'category']
         end
+
+        if attributes.has_key?(:'delivery_category')
+          self.delivery_category = attributes[:'delivery_category']
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -108,7 +117,8 @@ module FacebookAds
             title == o.title &&
             description == o.description &&
             brand == o.brand &&
-            category == o.category
+            category == o.category &&
+            delivery_category == o.delivery_category
       end
 
       # @see the `==` method
@@ -126,7 +136,8 @@ module FacebookAds
             title,
             description,
             brand,
-            category
+            category,
+            delivery_category
         ].hash
       end
 
@@ -156,6 +167,9 @@ module FacebookAds
         unless category.nil?
           hash['category'] = category
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = delivery_category
+        end
         hash.to_s
       end
 
@@ -183,6 +197,11 @@ module FacebookAds
         unless category.nil?
           hash['category'] = category
         end
+        unless delivery_category.nil?
+          hash['delivery_category'] = FacebookAds::ServerSide::Util.normalize_delivery_category(
+            delivery_category
+          )
+        end
         hash
       end
     end

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

@@ -64,6 +64,9 @@ module FacebookAds
       # For more details see https://developers.facebook.com/docs/marketing-apis/data-processing-options
       attr_accessor :data_processing_options_state
 
+      # Where the conversion occurred.
+      attr_accessor :action_source
+
       # @param [String] event_name
       # @param [int] event_time
       # @param [String] event_source_url
@@ -74,6 +77,7 @@ module FacebookAds
       # @param [Array<String>] data_processing_options
       # @param [int] data_processing_options_country
       # @param [int] data_processing_options_state
+      # @param String action_source
       def initialize(event_name: nil,
                      event_time: nil,
                      event_source_url: nil,
@@ -83,7 +87,8 @@ module FacebookAds
                      custom_data: nil,
                      data_processing_options: nil,
                      data_processing_options_country: nil,
-                     data_processing_options_state: nil)
+                     data_processing_options_state: nil,
+                     action_source: nil)
 
         unless event_name.nil?
           self.event_name = event_name
@@ -115,6 +120,9 @@ module FacebookAds
         unless data_processing_options_state.nil?
           self.data_processing_options_state = data_processing_options_state
         end
+        unless action_source.nil?
+          self.action_source = action_source
+        end
       end
 
       # build the object using the input hash
@@ -154,15 +162,19 @@ module FacebookAds
         end
 
         if attributes.has_key?(:'data_processing_options')
-          self.custom_data = attributes[:'data_processing_options']
+          self.data_processing_options = attributes[:'data_processing_options']
         end
 
         if attributes.has_key?(:'data_processing_options_country')
-          self.custom_data = attributes[:'data_processing_options_country']
+          self.data_processing_options_country = attributes[:'data_processing_options_country']
         end
 
         if attributes.has_key?(:'data_processing_options_state')
-          self.custom_data = attributes[:'data_processing_options_state']
+          self.data_processing_options_state = attributes[:'data_processing_options_state']
+        end
+
+        if attributes.has_key?(:'action_source')
+          self.action_source = attributes[:'action_source']
         end
       end
 
@@ -207,7 +219,8 @@ module FacebookAds
             custom_data == o.custom_data &&
             data_processing_options == o.data_processing_options &&
             data_processing_options_country == o.data_processing_options_country &&
-            data_processing_options_state == o.data_processing_options_state
+            data_processing_options_state == o.data_processing_options_state &&
+            action_source == o.action_source
       end
 
       # @see the `==` method
@@ -218,7 +231,11 @@ module FacebookAds
       # Calculates hash code according to all attributes.
       # @return [Fixnum] Hash code
       def hash
-        [event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data, data_processing_options, data_processing_options_country, data_processing_options_state].hash
+        [
+          event_name, event_time, event_source_url, opt_out, event_id, user_data, custom_data,
+          data_processing_options, data_processing_options_country, data_processing_options_state,
+          action_source,
+        ].hash
       end
 
       def to_s
@@ -253,6 +270,9 @@ module FacebookAds
         unless data_processing_options_state.nil?
           hash['data_processing_options_state'] = data_processing_options_state.to_s
         end
+        unless action_source.nil?
+          hash['action_source'] = action_source
+        end
         hash.to_s
       end
 
@@ -290,6 +310,12 @@ module FacebookAds
         unless data_processing_options_state.nil?
           hash['data_processing_options_state'] = data_processing_options_state
         end
+        unless action_source.nil?
+          hash['action_source'] = FacebookAds::ServerSide::Util.normalize(
+            action_source,
+            'action_source'
+          )
+        end
         hash
       end
 

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

@@ -190,7 +190,7 @@ module FacebookAds
           'events',
         ].join('/')
         headers = {
-          'User-Agent' => "fbbizsdk-ruby-v#{FacebookAds::API_VERSION}"
+          'User-Agent' => "fbbizsdk-ruby-v#{FacebookAds::VERSION}"
         }
         params = get_params
         params[:data] = events.map(&:normalize)

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

@@ -52,6 +52,8 @@ module FacebookAds
 				normalized_input = input;
 
 				case field_type
+				when 'action_source'
+					return normalize_action_source input
 				when 'country'
 					normalized_input = normalize_country input
 				when 'ct'
@@ -152,7 +154,7 @@ module FacebookAds
 			def self.normalize_email(email)
 
 				if EMAIL_REGEX.match(email) == nil
-					return ArgumentError, "Invalid email format for the passed email:' + email + '.Please check the passed email format."
+					raise ArgumentError, "Invalid email format for the passed email: '#{email}'. Please check the passed email format."
 				end
 
 				return email
@@ -290,6 +292,17 @@ module FacebookAds
 				delivery_category;
 			end
 
+			# Normalizes the input action_source and returns valid value (or throw exception if invalid).
+			def self.normalize_action_source(action_source)
+				unless FacebookAds::ServerSide::ActionSource.include?(action_source)
+					values = FacebookAds::ServerSide::ActionSource.to_a.join(',')
+					raise ArgumentError.new(
+						"Invalid action_source passed: #{action_source}. Please use one of the defined values: #{values}"
+					)
+				end
+
+				action_source
+			end
 		end
 	end
 end

data/lib/facebook_ads/ad_objects/system_user.rb

@@ -29,14 +29,14 @@ module FacebookAds
     ROLE = [
       "ADMIN",
       "ADS_RIGHTS_REVIEWER",
+      "DEFAULT",
       "DEVELOPER",
       "EMPLOYEE",
       "FINANCE_ANALYST",
+      "FINANCE_EDIT",
       "FINANCE_EDITOR",
-      "FINANCE_EDIT_TASK",
-      "FINANCE_VIEW_TASK",
-      "MODERATE_TASK",
-      "OPERATE_TASK",
+      "FINANCE_VIEW",
+      "MANAGE",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",

data/lib/facebook_ads/ad_objects/targeting.rb

@@ -27,13 +27,11 @@ module FacebookAds
 
   class Targeting < AdObject
     DEVICE_PLATFORMS = [
-      "connected_tv",
       "desktop",
       "mobile",
     ]
 
     EFFECTIVE_DEVICE_PLATFORMS = [
-      "connected_tv",
       "desktop",
       "mobile",
     ]

data/lib/facebook_ads/ad_objects/third_party_measurement_report_dataset.rb

@@ -32,7 +32,6 @@ module FacebookAds
     field :partner, 'Business'
     field :product, 'string'
     field :schema, { list: 'object' }
-    has_no_post
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/unified_thread.rb

@@ -32,7 +32,6 @@ module FacebookAds
     field :id, 'string'
     field :is_subscribed, 'bool'
     field :link, 'string'
-    field :linked_group, 'Group'
     field :message_count, 'int'
     field :name, 'string'
     field :participants, 'object'

data/lib/facebook_ads/ad_objects/user.rb

@@ -49,14 +49,10 @@ module FacebookAds
 
 
     field :about, 'string'
-    field :address, 'Location'
-    field :admin_notes, { list: 'PageAdminNote' }
     field :age_range, 'AgeRange'
-    field :auth_method, 'string'
     field :birthday, 'string'
     field :cover, 'UserCoverPhoto'
     field :currency, 'Currency'
-    field :devices, { list: 'UserDevice' }
     field :education, { list: 'object' }
     field :email, 'string'
     field :favorite_athletes, { list: 'Experience' }
@@ -85,7 +81,6 @@ module FacebookAds
     field :payment_pricepoints, 'PaymentPricepoints'
     field :political, 'string'
     field :profile_pic, 'string'
-    field :public_key, 'string'
     field :quotes, 'string'
     field :relationship_status, 'string'
     field :religion, 'string'
@@ -101,7 +96,6 @@ module FacebookAds
     field :verified, 'bool'
     field :video_upload_limits, 'VideoUploadLimits'
     field :website, 'string'
-    field :work, { list: 'object' }
 
     has_edge :access_tokens do |edge|
       edge.delete
@@ -238,7 +232,15 @@ module FacebookAds
     end
 
     has_edge :feed do |edge|
-      edge.post do |api|
+      edge.get 'Post' do |api|
+        api.has_param :include_hidden, 'bool'
+        api.has_param :q, 'string'
+        api.has_param :show_expired, 'bool'
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+        api.has_param :with, 'string'
+      end
+      edge.post 'Post' do |api|
         api.has_param :actions, 'object'
         api.has_param :adaptive_type, 'string'
         api.has_param :album_id, 'string'
@@ -252,10 +254,10 @@ module FacebookAds
         api.has_param :attached_media, { list: 'object' }
         api.has_param :audience_exp, 'bool'
         api.has_param :backdated_time, 'datetime'
-        api.has_param :backdated_time_granularity, { enum: %w{day hour min month none year }}
+        api.has_param :backdated_time_granularity, { enum: -> { Post::BACKDATED_TIME_GRANULARITY }}
         api.has_param :call_to_action, 'object'
         api.has_param :caption, 'string'
-        api.has_param :checkin_entry_point, { enum: %w{BRANDING_CHECKIN BRANDING_OTHER BRANDING_PHOTO BRANDING_STATUS }}
+        api.has_param :checkin_entry_point, { enum: -> { Post::CHECKIN_ENTRY_POINT }}
         api.has_param :child_attachments, { list: 'object' }
         api.has_param :client_mutation_id, 'string'
         api.has_param :composer_entry_picker, 'string'
@@ -275,7 +277,7 @@ module FacebookAds
         api.has_param :expanded_height, 'int'
         api.has_param :expanded_width, 'int'
         api.has_param :feed_targeting, 'object'
-        api.has_param :formatting, { enum: %w{MARKDOWN PLAINTEXT }}
+        api.has_param :formatting, { enum: -> { Post::FORMATTING }}
         api.has_param :fun_fact_prompt_id, 'int'
         api.has_param :fun_fact_toastee_id, 'int'
         api.has_param :has_nickname, 'bool'
@@ -312,11 +314,11 @@ module FacebookAds
         api.has_param :page_recommendation, 'string'
         api.has_param :picture, 'string'
         api.has_param :place, 'object'
-        api.has_param :place_attachment_setting, { enum: %w{1 2 }}
+        api.has_param :place_attachment_setting, { enum: -> { Post::PLACE_ATTACHMENT_SETTING }}
         api.has_param :place_list, 'string'
         api.has_param :place_list_data, { list: 'string' }
-        api.has_param :post_surfaces_blacklist, { list: { enum: %w{1 2 3 4 5 }} }
-        api.has_param :posting_to_redspace, { enum: %w{disabled enabled }}
+        api.has_param :post_surfaces_blacklist, { list: { enum: -> { Post::POST_SURFACES_BLACKLIST }} }
+        api.has_param :posting_to_redspace, { enum: -> { Post::POSTING_TO_REDSPACE }}
         api.has_param :privacy, 'string'
         api.has_param :prompt_id, 'string'
         api.has_param :prompt_tracking_string, 'string'
@@ -336,7 +338,7 @@ module FacebookAds
         api.has_param :sponsor_relationship, 'int'
         api.has_param :suggested_place_id, 'object'
         api.has_param :tags, { list: 'int' }
-        api.has_param :target_surface, { enum: %w{STORY TIMELINE }}
+        api.has_param :target_surface, { enum: -> { Post::TARGET_SURFACE }}
         api.has_param :targeting, 'object'
         api.has_param :text_format_metadata, 'string'
         api.has_param :text_format_preset_id, 'string'
@@ -346,7 +348,7 @@ module FacebookAds
         api.has_param :time_since_original_post, 'int'
         api.has_param :title, 'string'
         api.has_param :tracking_info, 'string'
-        api.has_param :unpublished_content_type, { enum: %w{ADS_POST DRAFT INLINE_CREATED PUBLISHED REVIEWABLE_BRANDED_CONTENT SCHEDULED SCHEDULED_RECURRING }}
+        api.has_param :unpublished_content_type, { enum: -> { Post::UNPUBLISHED_CONTENT_TYPE }}
         api.has_param :user_selected_tags, 'bool'
         api.has_param :video_start_time_ms, 'int'
         api.has_param :viewer_coordinates, 'object'
@@ -504,8 +506,8 @@ module FacebookAds
       end
     end
 
-    has_edge :owned_product_catalogs do |edge|
-      edge.get 'ProductCatalog'
+    has_edge :payment_transactions do |edge|
+      edge.get 'PaymentEnginePayment'
     end
 
     has_edge :permissions do |edge|
@@ -592,6 +594,17 @@ module FacebookAds
       end
     end
 
+    has_edge :posts do |edge|
+      edge.get 'Post' do |api|
+        api.has_param :include_hidden, 'bool'
+        api.has_param :q, 'string'
+        api.has_param :show_expired, 'bool'
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+        api.has_param :with, 'string'
+      end
+    end
+
     has_edge :rich_media_documents do |edge|
       edge.get 'Canvas' do |api|
         api.has_param :query, 'string'
@@ -613,7 +626,6 @@ module FacebookAds
         api.has_param :animated_effect_id, 'int'
         api.has_param :application_id, 'string'
         api.has_param :asked_fun_fact_prompt_id, 'int'
-        api.has_param :attribution_app_id, 'string'
         api.has_param :audio_story_wave_animation_handle, 'string'
         api.has_param :composer_entry_picker, 'string'
         api.has_param :composer_entry_point, 'string'
@@ -668,6 +680,7 @@ module FacebookAds
         api.has_param :sales_promo_id, 'int'
         api.has_param :slideshow_spec, 'hash'
         api.has_param :source, 'string'
+        api.has_param :source_instagram_media_id, 'string'
         api.has_param :spherical, 'bool'
         api.has_param :sponsor_id, 'string'
         api.has_param :start_offset, 'int'