facebookbusiness 20.0.0 → 20.0.2

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

@@ -0,0 +1,107 @@
+# 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
+
+      # OriginalEventData contains original event info used for attribution passback event or generalized value optimization(GVO).
+      class OriginalEventData
+
+        # A Facebook pixel Standard Event or Custom Event name.
+        # This is used with event_id to determine if events are identical.
+        attr_accessor :event_name
+
+        # A Unix timestamp in seconds indicating when the original event occurred.
+        attr_accessor :event_time
+
+        # @param [String] event_name
+        # @param [int] event_time
+        def initialize(event_name: nil, event_time: nil)
+          unless event_name.nil?
+            self.event_name = event_name
+          end
+          unless event_time.nil?
+            self.event_time = event_time
+          end
+        end
+
+        # build the object using the input hash
+        # @param [Hash] attributes  attributes in the form of hash
+        def build(attributes = {})
+          return unless attributes.is_a?(Hash)
+
+          # convert string to symbol for hash key
+          attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+          if attributes.has_key?(:'event_name')
+            self.event_name = attributes[:'event_name']
+          end
+
+          if attributes.has_key?(:'event_time')
+            self.event_time = attributes[:'event_time']
+          end
+        end
+
+        # Checks equality by comparing each attribute.
+        def ==(o)
+          return true if self.equal?(o)
+          self.class == o.class &&
+              event_name == o.event_name &&
+              event_time == o.event_time
+        end
+
+        # @see the `==` method
+        def eql?(o)
+          self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Fixnum] Hash code
+        def hash
+          [
+            event_name, event_time,
+          ].hash
+        end
+
+        def to_s
+          hash = {}
+          unless event_name.nil?
+            hash['event_name'] = event_name
+          end
+          unless event_time.nil?
+            hash['event_time'] = event_time
+          end
+          hash.to_s
+        end
+
+
+        # Normalize input fields to server request format.
+        def normalize
+          hash = {}
+          unless event_name.nil?
+            hash['event_name'] = event_name
+          end
+          unless event_time.nil?
+            hash['event_time'] = event_time
+          end
+          hash
+        end
+
+      end
+    end
+  end

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

@@ -203,7 +203,7 @@ module FacebookAds
 					normalized_phone = normalized_phone.gsub(PHONE_NUMBER_DROP_PREFIX_ZEROS, '')
 				end
 
-				if normalized_phone.length < 7 || normalized_phone.length > 15
+				if normalized_phone.length < 7 || normalized_phone.length > 16
 					return nil;
 				end
 

data/lib/facebook_ads/ad_objects/{product_feed_missing_feed_item_replacement.rb → shadow_ig_user_partnership_ads_media_errors.rb}

@@ -13,11 +13,12 @@ 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 ProductFeedMissingFeedItemReplacement < AdObject
+  class ShadowIgUserPartnershipAdsMediaErrors < AdObject
 
-    field :home_listing, 'object'
-    field :product_item, 'object'
-    field :vehicle, 'object'
+    field :ad_code, 'string'
+    field :error_codes, 'string'
+    field :errors, { list: 'string' }
+    field :permalink, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/stories.rb

@@ -26,10 +26,15 @@ module FacebookAds
     field :post_id, 'string'
     field :status, 'string'
     field :url, 'string'
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 
+    has_edge :insights do |edge|
+      edge.get 'InsightsResult' do |api|
+        api.has_param :metric, { list: { enum: -> { InsightsResult::METRIC }} }
+      end
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/third_party_partner_viewability_request.rb

@@ -14,6 +14,18 @@ module FacebookAds
   # pull request for this class.
 
   class ThirdPartyPartnerViewabilityRequest < AdObject
+    METRIC = [
+      "DISPLAY_EVENT",
+      "IMPRESSION",
+      "VIDEO_EVENT",
+    ]
+
+    PLATFORM = [
+      "AUDIENCE_NETWORK",
+      "FACEBOOK",
+      "INSTAGRAM",
+    ]
+
     STATUS = [
       "CREATED",
       "FAILURE",
@@ -27,10 +39,10 @@ module FacebookAds
     field :description, 'string'
     field :hour, 'datetime'
     field :id, 'string'
-    field :metric, 'string'
+    field :metric, { enum: -> { METRIC }}
     field :modified_time, 'datetime'
     field :owner_instance_id, 'string'
-    field :platform, 'string'
+    field :platform, { enum: -> { PLATFORM }}
     field :status, { enum: -> { STATUS }}
     field :total_file_count, 'int'
     has_no_post

data/lib/facebook_ads/ad_objects/transactable_item.rb

@@ -56,5 +56,12 @@ module FacebookAds
       edge.get 'CatalogItemChannelsToIntegrityStatus'
     end
 
+    has_edge :override_details do |edge|
+      edge.get 'OverrideDetails' do |api|
+        api.has_param :keys, { list: 'string' }
+        api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
+      end
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/user.rb

@@ -98,6 +98,7 @@ module FacebookAds
 
     has_edge :accounts do |edge|
       edge.get 'Page' do |api|
+        api.has_param :ad_id, 'string'
         api.has_param :is_place, 'bool'
         api.has_param :is_promotable, 'bool'
       end
@@ -245,7 +246,6 @@ module FacebookAds
         api.has_param :actions, 'object'
         api.has_param :album_id, 'string'
         api.has_param :android_key_hash, 'string'
-        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 :asset3d_id, 'int'
@@ -581,7 +581,6 @@ module FacebookAds
         api.has_param :type, { enum: -> { AdVideo::TYPE }}
       end
       edge.post 'AdVideo' do |api|
-        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 :audio_story_wave_animation_handle, 'string'

data/lib/facebook_ads/ad_objects/vehicle.rb

@@ -167,14 +167,17 @@ module FacebookAds
     field :year, 'int'
     has_no_delete
 
-    has_edge :augmented_realities_metadata do |edge|
-      edge.get 'DynamicArMetadata'
-    end
-
     has_edge :channels_to_integrity_status do |edge|
       edge.get 'CatalogItemChannelsToIntegrityStatus'
     end
 
+    has_edge :override_details do |edge|
+      edge.get 'OverrideDetails' do |api|
+        api.has_param :keys, { list: 'string' }
+        api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
+      end
+    end
+
     has_edge :videos_metadata do |edge|
       edge.get 'DynamicVideoMetadata'
     end

data/lib/facebook_ads/ad_objects/vehicle_offer.rb

@@ -77,14 +77,17 @@ module FacebookAds
     has_no_post
     has_no_delete
 
-    has_edge :augmented_realities_metadata do |edge|
-      edge.get 'DynamicArMetadata'
-    end
-
     has_edge :channels_to_integrity_status do |edge|
       edge.get 'CatalogItemChannelsToIntegrityStatus'
     end
 
+    has_edge :override_details do |edge|
+      edge.get 'OverrideDetails' do |api|
+        api.has_param :keys, { list: 'string' }
+        api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
+      end
+    end
+
     has_edge :videos_metadata do |edge|
       edge.get 'DynamicVideoMetadata'
     end

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -42,6 +42,13 @@ module FacebookAds
       "ORDER_STATUS",
     ]
 
+    PROVIDER_NAME = [
+      "PAYU",
+      "RAZORPAY",
+      "UPI_VPA",
+      "ZAAKPAY",
+    ]
+
 
     field :account_review_status, 'string'
     field :analytics, 'object'
@@ -67,6 +74,10 @@ module FacebookAds
     field :timezone_id, 'string'
     has_no_delete
 
+    has_edge :activities do |edge|
+      edge.get
+    end
+
     has_edge :assigned_users do |edge|
       edge.delete do |api|
         api.has_param :user, 'int'
@@ -99,6 +110,13 @@ module FacebookAds
       end
     end
 
+    has_edge :dataset do |edge|
+      edge.get 'Dataset'
+      edge.post 'Dataset' do |api|
+        api.has_param :dataset_name, 'string'
+      end
+    end
+
     has_edge :dcc_config do |edge|
       edge.get
     end
@@ -106,13 +124,20 @@ module FacebookAds
     has_edge :flows do |edge|
       edge.get
       edge.post do |api|
-        api.has_param :categories, { list: { enum: %w{APPOINTMENT_BOOKING CONTACT_US CUSTOMER_SUPPORT LEAD_GENERATION OTHER SIGN_IN SIGN_UP SURVEY }} }
+        api.has_param :categories, { list: { enum: %w{APPOINTMENT_BOOKING CONTACT_US CUSTOMER_SUPPORT LEAD_GENERATION OTHER SHOPPING SIGN_IN SIGN_UP SURVEY }} }
         api.has_param :clone_flow_id, 'string'
         api.has_param :endpoint_uri, 'string'
         api.has_param :name, 'string'
       end
     end
 
+    has_edge :generate_payment_configuration_oauth_link do |edge|
+      edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :configuration_name, 'string'
+        api.has_param :redirect_url, 'string'
+      end
+    end
+
     has_edge :message_campaigns do |edge|
       edge.get
     end
@@ -156,6 +181,14 @@ module FacebookAds
       end
     end
 
+    has_edge :migrate_flows do |edge|
+      edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :page_number, 'int'
+        api.has_param :source_flow_ids, { list: 'string' }
+        api.has_param :source_waba_id, 'string'
+      end
+    end
+
     has_edge :migrate_message_templates do |edge|
       edge.post 'WhatsAppBusinessAccount' do |api|
         api.has_param :page_number, 'int'
@@ -163,6 +196,27 @@ module FacebookAds
       end
     end
 
+    has_edge :payment_configuration do |edge|
+      edge.delete do |api|
+        api.has_param :configuration_name, 'string'
+      end
+      edge.get do |api|
+        api.has_param :configuration_name, 'string'
+      end
+      edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :configuration_name, 'string'
+        api.has_param :merchant_category_code, 'string'
+        api.has_param :merchant_vpa, 'string'
+        api.has_param :provider_name, { enum: -> { WhatsAppBusinessAccount::PROVIDER_NAME }}
+        api.has_param :purpose_code, 'string'
+        api.has_param :redirect_url, 'string'
+      end
+    end
+
+    has_edge :payment_configurations do |edge|
+      edge.get
+    end
+
     has_edge :phone_numbers do |edge|
       edge.get
       edge.post do |api|
@@ -194,6 +248,12 @@ module FacebookAds
       end
     end
 
+    has_edge :set_solution_migration_intent do |edge|
+      edge.post do |api|
+        api.has_param :solution_id, 'string'
+      end
+    end
+
     has_edge :solutions do |edge|
       edge.get
     end
@@ -212,6 +272,7 @@ module FacebookAds
         api.has_param :end, 'datetime'
         api.has_param :granularity, { enum: %w{DAILY }}
         api.has_param :metric_types, { list: { enum: %w{CLICKED COST DELIVERED READ SENT }} }
+        api.has_param :product_type, { enum: %w{CLOUD_API MARKETING_MESSAGES_LITE_API }}
         api.has_param :start, 'datetime'
         api.has_param :template_ids, { list: 'string' }
       end
@@ -234,5 +295,12 @@ module FacebookAds
       end
     end
 
+    has_edge :welcome_message_sequences do |edge|
+      edge.get 'CtxPartnerAppWelcomeMessageFlow' do |api|
+        api.has_param :app_id, 'string'
+        api.has_param :sequence_id, 'string'
+      end
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/whats_app_business_partner_client_verification_submission.rb

@@ -16,6 +16,8 @@ module FacebookAds
   class WhatsAppBusinessPartnerClientVerificationSubmission < AdObject
     REJECTION_REASONS = [
       "ADDRESS_NOT_MATCHING",
+      "BUSINESS_NOT_ELIGIBLE",
+      "LEGAL_NAME_NOT_FOUND_IN_DOCUMENTS",
       "LEGAL_NAME_NOT_MATCHING",
       "NONE",
       "WEBSITE_NOT_MATCHING",

data/lib/facebook_ads/ad_objects/{with_asset3_d.rb → with_asset_3d.rb}

@@ -13,7 +13,7 @@ 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 WithAsset3D < AdObject
+  class WithAsset3d < AdObject
 
     field :id, 'string'
     has_no_post

data/lib/facebook_ads/version.rb

@@ -7,6 +7,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '20.0.0'
+  VERSION = '20.0.2'
   API_VERSION = '20.0'
 end