bonio-facebookbusiness 0.13.0.0

data/lib/facebook_ads/ad_objects/security_settings.rb

@@ -0,0 +1,36 @@
+# 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.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class SecuritySettings < AdObject
+
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  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/batch_processor.rb

@@ -0,0 +1,73 @@
+# 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::ServerSide
+  class BatchProcessor
+    attr_accessor :batch_size
+    attr_accessor :concurrent_requests
+
+    # Initializes the object
+    # @param [Integer] batch_size  The number of events to send in each request
+    # @param [Integer] concurrent_requests  The number of threads to use when making requests concurrently
+    def initialize(batch_size=50, concurrent_requests=4)
+      self.batch_size = batch_size
+      self.concurrent_requests = concurrent_requests
+    end
+
+    def process_event_requests(event_requests_async)
+      generator = self.process_event_requests_generator(event_requests_async)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_events(event_request_async_to_clone, events)
+      generator = self.process_events_generator(event_request_async_to_clone, events)
+      generator.each do |batch|
+        Concurrent::Promise.zip(*batch).execute.value!
+      end
+    end
+
+    def process_event_requests_generator(event_requests_async)
+      index = 0
+      Enumerator.new do |generator|
+        while index < event_requests_async.size do
+          batch = event_requests_async[index, concurrent_requests].map(&:execute)
+          generator.yield *[batch]
+          index += concurrent_requests
+        end
+      end
+    end
+
+    def process_events_generator(event_request_async_to_clone, events)
+      index = 0
+      Enumerator.new do |generator|
+        while index < events.size do
+          batch = []
+          while index < events.size && batch.size < concurrent_requests do
+            event_request_async = event_request_async_to_clone.clone_without_events
+            event_request_async.events = events[index, batch_size]
+            batch << event_request_async
+            index += batch_size
+          end
+          generator.yield *[batch.map(&:execute)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,209 @@
+# 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
+    # Content object contains information about the products.
+    class Content
+
+      attr_accessor :product_id,
+                    :quantity,
+                    :item_price,
+                    :title,
+                    :description,
+                    :brand,
+                    :category,
+                    :delivery_category
+
+      # Initializes the object
+      # @param [String] product_id
+      # @param [Integer] quantity
+      # @param [Float] item_price
+      # @param [String] title
+      # @param [String] description
+      # @param [String] brand
+      # @param [String] category
+      # @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
+        unless quantity.nil?
+          self.quantity = Integer(quantity)
+        end
+        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
+        unless delivery_category.nil?
+          self.delivery_category = String(delivery_category)
+        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?(:'product_id')
+          self.product_id = attributes[:'product_id']
+        end
+
+        if attributes.has_key?(:'quantity')
+          self.quantity = attributes[:'quantity']
+        end
+
+        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
+
+        if attributes.has_key?(:'delivery_category')
+          self.delivery_category = attributes[:'delivery_category']
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      def ==(o)
+        return self.class == o.class &&
+            product_id == o.product_id &&
+            quantity == o.quantity &&
+            item_price == o.item_price &&
+            title == o.title &&
+            description == o.description &&
+            brand == o.brand &&
+            category == o.category &&
+            delivery_category == o.delivery_category
+      end
+
+      # @see the `==` method
+      def eql?(o)
+        self == o
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Fixnum] Hash code
+      def hash
+        [
+            product_id,
+            quantity,
+            item_price,
+            title,
+            description,
+            brand,
+            category,
+            delivery_category
+        ].hash
+      end
+
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        hash = {}
+        unless product_id.nil?
+          hash['product_id'] = product_id
+        end
+        unless quantity.nil?
+          hash['quantity'] = quantity
+        end
+        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
+        unless delivery_category.nil?
+          hash['delivery_category'] = delivery_category
+        end
+        hash.to_s
+      end
+
+      # Normalize input fields to server request format.
+      def normalize
+        hash = {}
+        unless product_id.nil?
+          hash['id'] = product_id
+        end
+        unless quantity.nil?
+          hash['quantity'] = quantity
+        end
+        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
+        unless delivery_category.nil?
+          hash['delivery_category'] = FacebookAds::ServerSide::Util.normalize_delivery_category(
+            delivery_category
+          )
+        end
+        hash
+      end
+    end
+  end
+end