facebookbusiness 0.7.0.3 → 0.10.0.0

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

@@ -52,12 +52,16 @@ 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'
 					normalized_input = normalize_city input
 				when 'currency'
 					return normalize_currency input
+				when 'delivery_category'
+					return normalize_delivery_category input
 				when 'em'
 					normalized_input = normalize_email input
 				when 'ge'
@@ -150,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
@@ -277,6 +281,28 @@ module FacebookAds
 				end
 				doby
 			end
+
+			# Normalizes the input delivery category and returns valid value (or throw exception if invalid).
+			def self.normalize_delivery_category(delivery_category)
+
+				unless FacebookAds::ServerSide::DeliveryCategory.include?(delivery_category)
+					raise ArgumentError.new("Invalid delivery_category passed: " + delivery_category + ". Please use one of the defined values #{FacebookAds::ServerSide::DeliveryCategory.to_a.join(',')}" )
+				end
+
+				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,10 +29,14 @@ module FacebookAds
     ROLE = [
       "ADMIN",
       "ADS_RIGHTS_REVIEWER",
+      "DEFAULT",
       "DEVELOPER",
       "EMPLOYEE",
       "FINANCE_ANALYST",
+      "FINANCE_EDIT",
       "FINANCE_EDITOR",
+      "FINANCE_VIEW",
+      "MANAGE",
       "PARTNER_CENTER_ADMIN",
       "PARTNER_CENTER_ANALYST",
       "PARTNER_CENTER_EDUCATION",
@@ -70,9 +74,5 @@ module FacebookAds
       edge.get 'ProductCatalog'
     end
 
-    has_edge :updated_by do |edge|
-      edge.get 'User'
-    end
-
   end
 end

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",
     ]
@@ -50,7 +48,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 +70,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 +85,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/user.rb

@@ -49,15 +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 :can_review_measurement_request, 'bool'
     field :cover, 'UserCoverPhoto'
     field :currency, 'Currency'
-    field :devices, { list: 'UserDevice' }
     field :education, { list: 'object' }
     field :email, 'string'
     field :favorite_athletes, { list: 'Experience' }
@@ -70,9 +65,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'
@@ -88,26 +81,21 @@ 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'
-    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 :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
@@ -211,6 +199,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 +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'
@@ -257,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'
@@ -280,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'
@@ -317,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'
@@ -341,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'
@@ -351,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'
@@ -468,6 +465,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'
@@ -479,7 +477,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 }}
@@ -490,11 +487,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'
@@ -514,6 +506,10 @@ module FacebookAds
       end
     end
 
+    has_edge :payment_transactions do |edge|
+      edge.get 'PaymentEnginePayment'
+    end
+
     has_edge :permissions do |edge|
       edge.delete do |api|
         api.has_param :permission, 'string'
@@ -598,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'
@@ -610,10 +617,6 @@ module FacebookAds
       end
     end
 
-    has_edge :taggable_friends do |edge|
-      edge.get 'UserTaggableFriend'
-    end
-
     has_edge :videos do |edge|
       edge.get 'AdVideo' do |api|
         api.has_param :type, { enum: -> { AdVideo::TYPE }}
@@ -623,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'
@@ -678,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'

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/ad_objects/{read_only_analytics_user_property_config.rb → whats_app_business_profile.rb}

@@ -25,11 +25,10 @@ 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 ReadOnlyAnalyticsUserPropertyConfig < AdObject
+  class WhatsAppBusinessProfile < AdObject
 
-    field :active_properties, { list: 'string' }
     field :id, 'string'
-    has_no_post
+    field :name_verification, 'object'
     has_no_delete
 
   end

data/lib/facebook_ads/edge.rb

@@ -53,6 +53,7 @@ module FacebookAds
     def reload!
       @collection = Array.new
       self.has_next_page = true
+      self.next_page_cursor = nil
     end
 
     private
@@ -95,7 +96,7 @@ module FacebookAds
       node.post_edge(name, graph_params.merge(params)) do |response|
         # TODO params check
         # TODO Add new object to collection?
-        
+
         field_type = self.class.return_types[:post]
 
         obj = field_type.deserialize(response, node.session)