facebookbusiness 0.8.0.0 → 0.9.0.1

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

@@ -91,6 +91,9 @@ module FacebookAds
       # The subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
       attr_accessor :subscription_id
 
+      # The lead ID for the user in this transaction. This ID is associated with a lead generated by Facebook's Lead Ads.
+      attr_accessor :lead_id
+
       # The first 5 letters of the first name.
       attr_accessor :f5first
 
@@ -126,6 +129,7 @@ module FacebookAds
       # @param [String] fbc
       # @param [String] fbp
       # @param [String] subscription_id
+      # @param [String] lead_id
       # @param [String] f5first
       # @param [String] f5last
       # @param [String] fi
@@ -135,7 +139,7 @@ module FacebookAds
       def initialize(email: nil, phone: nil, gender: nil, date_of_birth: nil,
                      last_name: nil, first_name: nil, city: nil, state: nil,
                      country_code: nil, zip_code: nil, external_id: nil, client_ip_address: nil,
-                     client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: nil,
+                     client_user_agent: nil, fbc: nil, fbp: nil, subscription_id: nil, lead_id: nil,
                      f5first: nil, f5last: nil, fi: nil, dobd: nil, dobm: nil, doby: nil)
         unless email.nil?
           self.email = email
@@ -185,6 +189,9 @@ module FacebookAds
         unless subscription_id.nil?
           self.subscription_id = subscription_id
         end
+        unless lead_id.nil?
+          self.lead_id = lead_id
+        end
         unless f5first.nil?
           self.f5first = f5first
         end
@@ -273,6 +280,10 @@ module FacebookAds
           self.fbp = attributes[:'fbp']
         end
 
+        if attributes.has_key?(:'lead_id')
+          self.lead_id = attributes[:'lead_id']
+        end
+
         if attributes.has_key?(:'f5first')
           self.f5first = attributes[:'f5first']
         end
@@ -318,6 +329,7 @@ module FacebookAds
             fbc == o.fbc &&
             fbp == o.fbp &&
             subscription_id == o.subscription_id &&
+            lead_id == o.lead_id &&
             f5first == o.f5first &&
             f5last == o.f5last &&
             fi == o.fi &&
@@ -351,6 +363,7 @@ module FacebookAds
             fbc,
             fbp,
             subscription_id,
+            lead_id,
             f5first,
             f5last,
             fi,
@@ -413,6 +426,9 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless lead_id.nil?
+          hash['lead_id'] = lead_id
+        end
         unless f5first.nil?
           hash['f5first'] = f5first
         end
@@ -486,6 +502,9 @@ module FacebookAds
         unless subscription_id.nil?
           hash['subscription_id'] = subscription_id
         end
+        unless lead_id.nil?
+          hash['lead_id'] = lead_id
+        end
         unless f5first.nil?
           hash['f5first'] = FacebookAds::ServerSide::Util.normalize(f5first, 'f5first')
         end

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'
@@ -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

@@ -26,20 +26,6 @@ module FacebookAds
   # pull request for this class.
 
   class SystemUser < AdObject
-    ROLE = [
-      "ADMIN",
-      "ADS_RIGHTS_REVIEWER",
-      "DEVELOPER",
-      "EMPLOYEE",
-      "FINANCE_ANALYST",
-      "FINANCE_EDITOR",
-      "PARTNER_CENTER_ADMIN",
-      "PARTNER_CENTER_ANALYST",
-      "PARTNER_CENTER_EDUCATION",
-      "PARTNER_CENTER_MARKETING",
-      "PARTNER_CENTER_OPERATIONS",
-    ]
-
 
     field :created_by, 'User'
     field :created_time, 'datetime'
@@ -47,8 +33,6 @@ module FacebookAds
     field :id, 'string'
     field :ip_permission, 'string'
     field :name, 'string'
-    field :role, { enum: -> { ROLE }}
-    field :system_user_id, 'int'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/targeting.rb

@@ -50,7 +50,7 @@ module FacebookAds
     field :catalog_based_targeting, 'CatalogBasedTargeting'
     field :cities, { list: 'IdName' }
     field :college_years, { list: 'int' }
-    field :connections, { list: 'IdName' }
+    field :connections, { list: 'ConnectionsTargeting' }
     field :contextual_targeting_categories, { list: 'IdName' }
     field :countries, { list: 'string' }
     field :country, { list: 'string' }
@@ -72,7 +72,7 @@ module FacebookAds
     field :ethnic_affinity, { list: 'IdName' }
     field :exclude_reached_since, { list: 'string' }
     field :excluded_brand_safety_content_types, { list: 'string' }
-    field :excluded_connections, { list: 'IdName' }
+    field :excluded_connections, { list: 'ConnectionsTargeting' }
     field :excluded_custom_audiences, { list: 'RawCustomAudience' }
     field :excluded_dynamic_audience_ids, { list: 'string' }
     field :excluded_engagement_specs, { list: 'TargetingDynamicRule' }
@@ -87,7 +87,7 @@ module FacebookAds
     field :family_statuses, { list: 'IdName' }
     field :fb_deal_id, 'string'
     field :flexible_spec, { list: 'FlexibleTargeting' }
-    field :friends_of_connections, { list: 'IdName' }
+    field :friends_of_connections, { list: 'ConnectionsTargeting' }
     field :genders, { list: 'int' }
     field :generation, { list: 'IdName' }
     field :geo_locations, 'TargetingGeoLocation'

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,6 +32,7 @@ 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

@@ -54,7 +54,6 @@ module FacebookAds
     field :age_range, 'AgeRange'
     field :auth_method, 'string'
     field :birthday, 'string'
-    field :can_review_measurement_request, 'bool'
     field :cover, 'UserCoverPhoto'
     field :currency, 'Currency'
     field :devices, { list: 'UserDevice' }
@@ -70,9 +69,7 @@ module FacebookAds
     field :install_type, 'string'
     field :installed, 'bool'
     field :interested_in, { list: 'string' }
-    field :is_famedeeplinkinguser, 'bool'
     field :is_guest_user, 'bool'
-    field :is_shared_login, 'bool'
     field :is_verified, 'bool'
     field :languages, { list: 'Experience' }
     field :last_name, 'string'
@@ -82,6 +79,7 @@ module FacebookAds
     field :locale, 'string'
     field :location, 'Page'
     field :meeting_for, { list: 'string' }
+    field :messenger_join_notifications_enabled, 'bool'
     field :middle_name, 'string'
     field :name, 'string'
     field :name_format, 'string'
@@ -89,33 +87,28 @@ module FacebookAds
     field :political, 'string'
     field :profile_pic, 'string'
     field :public_key, 'string'
+    field :published_timeline, 'bool'
     field :quotes, 'string'
     field :relationship_status, 'string'
     field :religion, 'string'
-    field :security_settings, 'SecuritySettings'
     field :shared_login_upgrade_required_by, 'datetime'
     field :short_name, 'string'
     field :significant_other, 'User'
     field :sports, { list: 'Experience' }
     field :supports_donate_button_in_live_video, 'bool'
-    field :test_group, 'int'
     field :third_party_id, 'string'
     field :timezone, 'double'
     field :token_for_business, 'string'
     field :updated_time, 'datetime'
+    field :user_storage_key, 'string'
+    field :username, 'string'
     field :verified, 'bool'
     field :video_upload_limits, 'VideoUploadLimits'
-    field :viewer_can_send_gift, 'bool'
     field :website, 'string'
     field :work, { list: 'object' }
 
     has_edge :access_tokens do |edge|
       edge.delete
-      edge.post 'User' do |api|
-        api.has_param :business_app, 'int'
-        api.has_param :page_id, 'string'
-        api.has_param :scope, { list: 'Permission' }
-      end
     end
 
     has_edge :accounts do |edge|
@@ -211,6 +204,7 @@ module FacebookAds
       end
       edge.get 'Business'
       edge.post 'Business' do |api|
+        api.has_param :child_business_external_id, 'string'
         api.has_param :email, 'string'
         api.has_param :name, 'string'
         api.has_param :primary_page, 'string'
@@ -243,7 +237,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'
@@ -257,10 +259,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'
@@ -280,7 +282,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'
@@ -317,11 +319,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'
@@ -341,7 +343,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'
@@ -351,7 +353,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'
@@ -468,6 +470,7 @@ module FacebookAds
       edge.post 'LiveVideo' do |api|
         api.has_param :content_tags, { 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'
@@ -489,11 +492,6 @@ module FacebookAds
       end
     end
 
-    has_edge :meeting_link do |edge|
-      edge.get 'WorkMeetingLink'
-      edge.post 'WorkMeetingLink'
-    end
-
     has_edge :music do |edge|
       edge.get 'Page' do |api|
         api.has_param :target_id, 'string'
@@ -513,6 +511,10 @@ module FacebookAds
       end
     end
 
+    has_edge :owned_product_catalogs do |edge|
+      edge.get 'ProductCatalog'
+    end
+
     has_edge :permissions do |edge|
       edge.delete do |api|
         api.has_param :permission, 'string'
@@ -673,6 +675,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'

data/lib/facebook_ads/ad_objects/vehicle.rb

@@ -29,6 +29,7 @@ module FacebookAds
     AVAILABILITY = [
       "AVAILABLE",
       "NOT_AVAILABLE",
+      "PENDING",
     ]
 
     BODY_STYLE = [
@@ -108,6 +109,7 @@ module FacebookAds
     field :applinks, 'CatalogItemAppLinks'
     field :availability, 'string'
     field :body_style, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
     field :condition, 'string'
     field :currency, 'string'
     field :custom_label_0, 'string'

data/lib/facebook_ads/ad_objects/vehicle_offer.rb

@@ -35,6 +35,7 @@ module FacebookAds
     field :body_style, 'string'
     field :cashback_currency, 'string'
     field :cashback_price, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
     field :currency, 'string'
     field :dma_codes, { list: 'string' }
     field :downpayment_currency, 'string'

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -26,6 +26,14 @@ module FacebookAds
   # pull request for this class.
 
   class WhatsAppBusinessAccount < AdObject
+    TASKS = [
+      "DEVELOP",
+      "MANAGE",
+      "MANAGE_PHONE",
+      "MANAGE_TEMPLATES",
+      "VIEW_COST",
+    ]
+
     CATEGORY = [
       "ACCOUNT_UPDATE",
       "ALERT_UPDATE",
@@ -47,12 +55,27 @@ module FacebookAds
     field :message_template_namespace, 'string'
     field :name, 'string'
     field :on_behalf_of_business_info, 'object'
+    field :owner_business_info, 'object'
+    field :primary_funding_id, 'string'
     field :purchase_order_number, 'string'
     field :status, 'string'
     field :timezone_id, 'string'
     has_no_post
     has_no_delete
 
+    has_edge :assigned_users do |edge|
+      edge.delete do |api|
+        api.has_param :user, 'int'
+      end
+      edge.get 'AssignedUser' do |api|
+        api.has_param :business, 'string'
+      end
+      edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :tasks, { list: { enum: -> { WhatsAppBusinessAccount::TASKS }} }
+        api.has_param :user, 'int'
+      end
+    end
+
     has_edge :message_templates do |edge|
       edge.delete do |api|
         api.has_param :name, 'string'
@@ -78,6 +101,8 @@ module FacebookAds
     end
 
     has_edge :subscribed_apps do |edge|
+      edge.delete
+      edge.get
       edge.post 'WhatsAppBusinessAccount'
     end
 

data/lib/facebook_ads/errors.rb

@@ -26,7 +26,7 @@ module FacebookAds
     ERROR_ATTRS = [
       :headers, :fb_message, :type, :code,
       :error_subcode, :is_transient, :error_user_title,
-      :error_user_msg, :fbtrace_id,
+      :error_user_msg, :error_data, :fbtrace_id,
     ]
 
     attr_accessor *ERROR_ATTRS

data/lib/facebook_ads/session.rb

@@ -39,7 +39,7 @@ module FacebookAds
       case method
         when :get, :post, :delete
           api_conn.send(method, path.gsub(/^\//,''), params) do |req|
-            req.headers[:user_agent] = "fbbizsdk-ruby-v#{API_VERSION}".freeze
+            req.headers[:user_agent] = "fbbizsdk-ruby-v#{VERSION}".freeze
             req.params[:access_token] = access_token if access_token
             req.params[:appsecret_proof] = appsecret_proof if app_secret
           end