facebookbusiness 0.7.0.2 → 0.7.0.3

data/lib/facebook_ads/ad_objects/page_admin_note.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :body, 'string'
     field :from, 'Page'
     field :id, 'string'
+    field :note_label, 'string'
     field :user, 'User'
     has_no_post
     has_no_delete

data/lib/facebook_ads/ad_objects/page_call_to_action.rb

@@ -32,6 +32,7 @@ module FacebookAds
       "EMAIL",
       "FACEBOOK_APP",
       "FOLLOW",
+      "MARKETPLACE_INVENTORY_PAGE",
       "MESSENGER",
       "MINI_SHOP",
       "NONE",
@@ -46,6 +47,7 @@ module FacebookAds
       "EMAIL",
       "FACEBOOK_APP",
       "FOLLOW",
+      "MARKETPLACE_INVENTORY_PAGE",
       "MESSENGER",
       "MINI_SHOP",
       "NONE",
@@ -83,6 +85,7 @@ module FacebookAds
       "SHOP_NOW",
       "SHOP_ON_FACEBOOK",
       "SIGN_UP",
+      "VIEW_INVENTORY",
       "VIEW_SHOP",
       "VISIT_GROUP",
       "WATCH_NOW",

data/lib/facebook_ads/ad_objects/page_change_proposal.rb

@@ -33,6 +33,8 @@ module FacebookAds
     field :id, 'string'
     field :proposed_value, 'string'
     field :upcoming_change_info, 'PageUpcomingChange'
+    has_no_get
+    has_no_post
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/{brand_audience.rb → payment_subscription.rb}

@@ -25,18 +25,32 @@ 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 BrandAudience < AdObject
+  class PaymentSubscription < AdObject
 
-    field :account, 'AdAccount'
-    field :delivery_targeting, 'Targeting'
-    field :description, 'string'
+    field :amount, 'string'
+    field :app_param_data, 'string'
+    field :application, 'Profile'
+    field :billing_period, 'string'
+    field :canceled_reason, 'string'
+    field :created_time, 'datetime'
+    field :currency, 'string'
     field :id, 'string'
-    field :name, 'string'
-    field :sentence_lines, { list: 'string' }
+    field :last_payment, 'string'
+    field :next_bill_time, 'datetime'
+    field :next_period_amount, 'string'
+    field :next_period_currency, 'string'
+    field :next_period_product, 'string'
+    field :payment_status, 'string'
+    field :pending_cancel, 'bool'
+    field :period_start_time, 'datetime'
+    field :product, 'string'
     field :status, 'string'
-    field :targeting, 'Targeting'
-    field :time_created, 'datetime'
-    field :time_updated, 'datetime'
+    field :test, 'int'
+    field :trial_amount, 'string'
+    field :trial_currency, 'string'
+    field :trial_expiry_time, 'datetime'
+    field :updated_time, 'datetime'
+    field :user, 'Profile'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/post.rb

@@ -178,7 +178,7 @@ module FacebookAds
         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 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 :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'

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class ProductCatalog < AdObject
     VERTICAL = [
+      "adoptable_pets",
       "bookable",
       "commerce",
       "destinations",
@@ -295,6 +296,7 @@ module FacebookAds
       end
       edge.post 'ProductSet' do |api|
         api.has_param :filter, 'object'
+        api.has_param :metadata, 'hash'
         api.has_param :name, 'string'
       end
     end

data/lib/facebook_ads/ad_objects/product_feed.rb

@@ -63,6 +63,7 @@ module FacebookAds
       "MEDIA_TITLE",
       "OFFER",
       "PRODUCTS",
+      "TRANSACTABLE_ITEMS",
       "VEHICLES",
       "VEHICLE_OFFER",
     ]

data/lib/facebook_ads/ad_objects/product_set.rb

@@ -30,9 +30,12 @@ module FacebookAds
     field :auto_creation_url, 'string'
     field :filter, 'string'
     field :id, 'string'
+    field :latest_metadata, 'ProductSetMetadata'
+    field :live_metadata, 'ProductSetMetadata'
     field :name, 'string'
     field :product_catalog, 'ProductCatalog'
     field :product_count, 'int'
+    field :metadata, 'hash'
 
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|

data/lib/facebook_ads/ad_objects/{user_influence.rb → product_set_metadata.rb}

@@ -25,11 +25,11 @@ 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 UserInfluence < AdObject
+  class ProductSetMetadata < AdObject
 
-    field :trust, 'string'
-    field :trust_code, 'int'
-    field :version, 'int'
+    field :cover_image_url, 'string'
+    field :description, 'string'
+    field :integrity_review_status, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/profile.rb

@@ -64,6 +64,7 @@ module FacebookAds
 
     has_edge :picture do |edge|
       edge.get 'ProfilePictureSource' do |api|
+        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
         api.has_param :height, 'int'
         api.has_param :redirect, 'bool'
         api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}

data/lib/facebook_ads/ad_objects/profile_picture_source.rb

@@ -32,6 +32,10 @@ module FacebookAds
       "thumbnail",
     ]
 
+    BREAKING_CHANGE = [
+      "PROFILE_PICTURE",
+    ]
+
 
     field :bottom, 'int'
     field :cache_key, 'string'

data/lib/facebook_ads/ad_objects/saved_audience.rb

@@ -40,6 +40,7 @@ module FacebookAds
     field :time_created, 'datetime'
     field :time_updated, 'datetime'
     has_no_post
+    has_no_delete
 
   end
 end

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

@@ -22,20 +22,23 @@ module FacebookAds
     # Content object contains information about the products.
     class Content
 
-      # Product Id
-      attr_accessor :product_id
-
-      # number of product
-      attr_accessor :quantity
-
-      # Item Price.
-      attr_accessor :item_price
+      attr_accessor :product_id,
+                    :quantity,
+                    :item_price,
+                    :title,
+                    :description,
+                    :brand,
+                    :category
 
       # Initializes the object
       # @param [String] product_id
       # @param [Integer] quantity
       # @param [Float] item_price
-      def initialize(product_id: nil, quantity: nil, item_price: nil)
+      # @param [String] title
+      # @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)
         unless product_id.nil?
           self.product_id = String(product_id)
         end
@@ -45,6 +48,18 @@ module FacebookAds
         unless item_price.nil?
           self.item_price = Float(item_price)
         end
+        unless title.nil?
+          self.title = String(title)
+        end
+        unless description.nil?
+          self.description = String(description)
+        end
+        unless brand.nil?
+          self.brand = String(brand)
+        end
+        unless category.nil?
+          self.category = String(category)
+        end
       end
 
       # build the object using the input hash
@@ -66,15 +81,34 @@ module FacebookAds
         if attributes.has_key?(:'item_price')
           self.item_price = attributes[:'item_price']
         end
+
+        if attributes.has_key?(:'title')
+          self.title = attributes[:'title']
+        end
+
+        if attributes.has_key?(:'description')
+          self.description = attributes[:'description']
+        end
+
+        if attributes.has_key?(:'brand')
+          self.brand = attributes[:'brand']
+        end
+
+        if attributes.has_key?(:'category')
+          self.category = attributes[:'category']
+        end
       end
 
       # Checks equality by comparing each attribute.
       def ==(o)
-        return true if self.equal?(o)
-        self.class == o.class &&
+        return self.class == o.class &&
             product_id == o.product_id &&
             quantity == o.quantity &&
-            item_price == o.item_price
+            item_price == o.item_price &&
+            title == o.title &&
+            description == o.description &&
+            brand == o.brand &&
+            category == o.category
       end
 
       # @see the `==` method
@@ -88,7 +122,11 @@ module FacebookAds
         [
             product_id,
             quantity,
-            item_price
+            item_price,
+            title,
+            description,
+            brand,
+            category
         ].hash
       end
 
@@ -106,6 +144,18 @@ module FacebookAds
         unless item_price.nil?
           hash['item_price'] = item_price
         end
+        unless title.nil?
+          hash['title'] = title
+        end
+        unless description.nil?
+          hash['description'] = description
+        end
+        unless brand.nil?
+          hash['brand'] = brand
+        end
+        unless category.nil?
+          hash['category'] = category
+        end
         hash.to_s
       end
 
@@ -121,6 +171,18 @@ module FacebookAds
         unless item_price.nil?
           hash['item_price'] = item_price
         end
+        unless title.nil?
+          hash['title'] = title
+        end
+        unless description.nil?
+          hash['description'] = description
+        end
+        unless brand.nil?
+          hash['brand'] = brand
+        end
+        unless category.nil?
+          hash['category'] = category
+        end
         hash
       end
     end

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

@@ -69,7 +69,11 @@ module FacebookAds
       # Use only with Search events. A search query made by a user.
       # Example: 'lettuce'.
       attr_accessor :search_string
-      
+
+      # The item number.
+      # Example: 'item1234'.
+      attr_accessor :item_number
+
       # Custom Properties bag for storing other custom fields
       attr_accessor :custom_properties
 
@@ -86,6 +90,7 @@ module FacebookAds
       # @param [Integer] num_items
       # @param [String] status
       # @param [String] search_string
+      # @param [String] item_number
       # @param [String] custom_properties
       def initialize(value: nil,
                      currency: nil,
@@ -99,6 +104,7 @@ module FacebookAds
                      num_items: nil,
                      status: nil,
                      search_string: nil,
+                     item_number: nil,
                      custom_properties: {})
 
         unless value.nil?
@@ -137,6 +143,9 @@ module FacebookAds
         unless search_string.nil?
           self.search_string = search_string
         end
+        unless item_number.nil?
+          self.item_number = item_number
+        end
         unless custom_properties.nil?
           self.custom_properties = custom_properties
         end
@@ -203,6 +212,10 @@ module FacebookAds
           self.search_string = attributes[:'search_string']
         end
 
+        if attributes.has_key?(:'item_number')
+          self.item_number = attributes[:'item_number']
+        end
+
         if attributes.has_key?(:'custom_properties')
           self.custom_properties = attributes[:'custom_properties']
         end
@@ -224,6 +237,7 @@ module FacebookAds
             num_items == o.num_items &&
             status == o.status &&
             search_string == o.search_string &&
+            item_number == o.item_number &&
             custom_properties == o.custom_properties
       end
 
@@ -248,6 +262,7 @@ module FacebookAds
             num_items,
             status,
             search_string,
+            item_number,
             custom_properties
         ].hash
       end
@@ -294,23 +309,23 @@ module FacebookAds
         end
         unless custom_properties.nil?
           hash['custom_properties'] = custom_properties
-        end        
+        end
         hash.to_s
       end
 
       # Add other custom fields to custom properties.
       def add_custom_property(key, value)
-        custom_properties[key] = value;        
+        custom_properties[key] = value;
       end
 
       # Normalize input fields to server request format.
-      def normalize        
+      def normalize
         hash = {}
         unless value.nil?
           hash['value'] = value
         end
         unless currency.nil?
-          hash['currency'] = FacebookAds::ServerSide::normalize(currency, 'currency')
+          hash['currency'] = FacebookAds::ServerSide::Util.normalize(currency, 'currency')
         end
         unless content_name.nil?
           hash['content_name'] = content_name
@@ -339,6 +354,9 @@ module FacebookAds
         unless search_string.nil?
           hash['search_string'] = search_string
         end
+        unless item_number.nil?
+          hash['item_number'] = item_number
+        end
 
         unless contents.nil?
           content_array = []
@@ -348,7 +366,7 @@ module FacebookAds
           hash['contents'] = content_array
         end
 
-        hash.merge!(custom_properties) unless custom_properties.nil?        
+        hash.merge!(custom_properties) unless custom_properties.nil?
         hash
       end
     end

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

@@ -39,11 +39,28 @@ module FacebookAds
       # Platform from which the event is sent e.g. wordpress
       attr_accessor :partner_agent
 
+      # Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID.
+      attr_accessor :namespace_id
+
+      # Unique id used to denote the current set being uploaded.
+      attr_accessor :upload_id
+
+      # Tag string added to track your Offline event uploads.
+      attr_accessor :upload_tag
+
+      # The origin/source of data for the dataset to be uploaded.
+      attr_accessor :upload_source
+
       # @param [String] pixel_id
       # @param [Array(FacebookAds::ServerSide::Event)] events
       # @param [String] test_event_code
       # @param [String] partner_agent
-      def initialize(pixel_id: nil, events: nil, test_event_code: nil, partner_agent: nil)
+      # @param [String] namespace_id
+      # @param [String] upload_id
+      # @param [String] upload_tag
+      # @param [String] upload_source
+      def initialize(pixel_id: nil, events: nil, test_event_code: nil, partner_agent: nil,
+          namespace_id: nil, upload_id: nil, upload_tag: nil, upload_source: nil)
         unless pixel_id.nil?
           self.pixel_id = pixel_id
         end
@@ -56,6 +73,18 @@ module FacebookAds
         unless partner_agent.nil?
           self.partner_agent = partner_agent
         end
+        unless namespace_id.nil?
+          self.namespace_id = namespace_id
+        end
+        unless upload_id.nil?
+          self.upload_id = upload_id
+        end
+        unless upload_tag.nil?
+          self.upload_tag = upload_tag
+        end
+        unless upload_source.nil?
+          self.upload_source = upload_source
+        end
       end
 
       # build the object using the input hash
@@ -83,6 +112,22 @@ module FacebookAds
         if attributes.has_key?(:'partner_agent')
           self.partner_agent = attributes[:'partner_agent']
         end
+
+        if attributes.has_key?(:'namespace_id')
+          self.namespace_id = attributes[:'namespace_id']
+        end
+
+        if attributes.has_key?(:'upload_id')
+          self.upload_id = attributes[:'upload_id']
+        end
+
+        if attributes.has_key?(:'upload_tag')
+          self.upload_tag = attributes[:'upload_tag']
+        end
+
+        if attributes.has_key?(:'upload_source')
+          self.upload_source = attributes[:'upload_source']
+        end
       end
 
       # Execute request
@@ -96,7 +141,11 @@ module FacebookAds
             {
                 data: normalized_events,
                 test_event_code: test_event_code,
-                partner_agent: partner_agent
+                partner_agent: partner_agent,
+                namespace_id: namespace_id,
+                upload_id: upload_id,
+                upload_tag: upload_tag,
+                upload_source: upload_source,
             }
         )
         json_response_object = JSON.parse(JSON.generate(response), object_class: OpenStruct)
@@ -137,9 +186,14 @@ module FacebookAds
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
+            pixel_id == o.pixel_id &&
             events == o.events &&
-            test_event_code == o.test_event_code
-            partner_agent == o.partner_agent
+            test_event_code == o.test_event_code &&
+            partner_agent == o.partner_agent &&
+            namespace_id == o.namespace_id &&
+            upload_id == o.upload_id &&
+            upload_tag == o.upload_tag &&
+            upload_source == o.upload_source
       end
 
       # @see the `==` method
@@ -150,7 +204,16 @@ module FacebookAds
       # Calculates hash code according to all attributes.
       # @return [Fixnum] Hash code
       def hash
-        [events, test_event_code, partner_agent].hash
+        [
+          pixel_id,
+          events,
+          test_event_code,
+          partner_agent,
+          namespace_id,
+          upload_id,
+          upload_tag,
+          upload_source,
+        ].hash
       end
 
       def to_s
@@ -167,9 +230,20 @@ module FacebookAds
         unless partner_agent.nil?
           hash['partner_agent'] = partner_agent
         end
+        unless namespace_id.nil?
+          hash['namespace_id'] = namespace_id
+        end
+        unless upload_id.nil?
+          hash['upload_id'] = upload_id
+        end
+        unless upload_tag.nil?
+          hash['upload_tag'] = upload_tag
+        end
+        unless upload_source.nil?
+          hash['upload_source'] = upload_source
+        end
         hash.to_s
       end
     end
   end
 end
-