facebookbusiness 0.3.1.0 → 0.14.0.0

data/lib/facebook_ads/ad_objects/video_poll.rb

@@ -0,0 +1,58 @@
+# 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 VideoPoll < AdObject
+    STATUS = [
+      "closed",
+      "results_open",
+      "voting_open",
+    ]
+
+    ACTION = [
+      "ATTACH_TO_VIDEO",
+      "CLOSE",
+      "DELETE_POLL",
+      "SHOW_RESULTS",
+      "SHOW_VOTING",
+    ]
+
+
+    field :close_after_voting, 'bool'
+    field :default_open, 'bool'
+    field :id, 'string'
+    field :question, 'string'
+    field :show_gradient, 'bool'
+    field :show_results, 'bool'
+    field :status, { enum: -> { STATUS }}
+    has_no_delete
+
+    has_edge :poll_options do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/video_upload_limits.rb

@@ -0,0 +1,38 @@
+# 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 VideoUploadLimits < AdObject
+
+    field :length, 'int'
+    field :size, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/whats_app_business_account.rb

@@ -0,0 +1,135 @@
+# 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 WhatsAppBusinessAccount < AdObject
+    TASKS = [
+      "DEVELOP",
+      "MANAGE",
+      "MANAGE_PHONE",
+      "MANAGE_TEMPLATES",
+      "MESSAGING",
+      "VIEW_COST",
+    ]
+
+    CATEGORY = [
+      "MARKETING",
+      "OTP",
+      "TRANSACTIONAL",
+    ]
+
+
+    field :account_review_status, 'string'
+    field :analytics, 'object'
+    field :creation_time, 'int'
+    field :currency, 'string'
+    field :id, 'string'
+    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 :conversation_analytics do |edge|
+      edge.get do |api|
+        api.has_param :conversation_directions, { list: { enum: %w{BUSINESS_INITIATED UNKNOWN USER_INITIATED }} }
+        api.has_param :conversation_types, { list: { enum: %w{FREE_ENTRY_POINT FREE_TIER REGULAR UNKNOWN }} }
+        api.has_param :country_codes, { list: 'string' }
+        api.has_param :dimensions, { list: { enum: %w{CONVERSATION_DIRECTION CONVERSATION_TYPE COUNTRY PHONE UNKNOWN }} }
+        api.has_param :end, 'int'
+        api.has_param :granularity, { enum: %w{DAILY HALF_HOUR MONTHLY }}
+        api.has_param :metric_types, { list: { enum: %w{CONVERSATION COST UNKNOWN }} }
+        api.has_param :phone_numbers, { list: 'string' }
+        api.has_param :start, 'int'
+      end
+    end
+
+    has_edge :message_templates do |edge|
+      edge.delete do |api|
+        api.has_param :name, 'string'
+      end
+      edge.get do |api|
+        api.has_param :category, { list: { enum: -> { WhatsAppBusinessAccount::CATEGORY }} }
+        api.has_param :content, 'string'
+        api.has_param :language, { list: 'string' }
+        api.has_param :name, 'string'
+        api.has_param :name_or_content, 'string'
+        api.has_param :quality_score, { list: { enum: %w{GREEN RED UNKNOWN YELLOW }} }
+        api.has_param :status, { list: { enum: %w{APPROVED DELETED DISABLED IN_APPEAL LOCKED PENDING PENDING_DELETION REJECTED }} }
+      end
+      edge.post 'WhatsAppBusinessAccount' do |api|
+        api.has_param :category, { enum: -> { WhatsAppBusinessAccount::CATEGORY }}
+        api.has_param :components, { list: 'hash' }
+        api.has_param :language, 'string'
+        api.has_param :name, 'string'
+      end
+    end
+
+    has_edge :phone_numbers do |edge|
+      edge.get
+      edge.post do |api|
+        api.has_param :cc, 'string'
+        api.has_param :migrate_phone_number, 'bool'
+        api.has_param :phone_number, 'string'
+      end
+    end
+
+    has_edge :product_catalogs do |edge|
+      edge.delete do |api|
+        api.has_param :catalog_id, 'string'
+      end
+      edge.get 'ProductCatalog'
+      edge.post 'ProductCatalog' do |api|
+        api.has_param :catalog_id, 'string'
+      end
+    end
+
+    has_edge :subscribed_apps do |edge|
+      edge.delete
+      edge.get
+      edge.post 'WhatsAppBusinessAccount'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/{lead_gen_legal_content.rb → whats_app_business_profile.rb}

@@ -25,12 +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 LeadGenLegalContent < AdObject
+  class WhatsAppBusinessProfile < AdObject
 
-    field :custom_disclaimer, 'object'
     field :id, 'string'
-    field :privacy_policy, 'object'
-    has_no_post
+    field :name_verification, 'object'
+    field :whatsapp_business_api_data, 'object'
     has_no_delete
 
   end

data/lib/facebook_ads/ad_objects/woodhenge_purchased_payg_receipt.rb

@@ -0,0 +1,38 @@
+# 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 WoodhengePurchasedPaygReceipt < AdObject
+
+    field :id, 'string'
+    field :number_of_subscriptions_purchased, 'int'
+    field :purchase_time, 'datetime'
+    field :user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/work_user_frontline.rb

@@ -0,0 +1,38 @@
+# 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 WorkUserFrontline < AdObject
+
+    field :has_access, 'bool'
+    field :is_frontline, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/api_response.rb

@@ -38,6 +38,10 @@ module FacebookAds
       @body
     end
 
+    def headers
+      @headers
+    end
+
     private
     def is_json_response?
       headers[:content_type] =~ /application\/json/ ||

data/lib/facebook_ads/config.rb

@@ -33,7 +33,7 @@ module FacebookAds
     setting :api_version, FacebookAds::DEFAULT_API_VERSION
     setting :access_token, ENV['FB_ACCESS_TOKEN']
     setting :app_secret, ENV['FB_APP_SECRET']
-
+    setting :crash_logging_enabled, true
     setting :log_api_bodies, false
 
     def logger=(logger)

data/lib/facebook_ads/crash_logger.rb

@@ -0,0 +1,133 @@
+# 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.
+
+require 'facebook_ads/api_request'
+require 'facebook_ads/api_response'
+
+module FacebookAds
+  class CrashLogger
+    class << self
+      private
+      @@enabled = false
+      @@hasRegisteredCrashBlock = false
+
+      def logCrash
+        error = $!
+        if is_facebook_error(error)
+          app_id = get_app_id
+          if app_id.nil?
+            puts "Unable to log the crash: We're missing an app id."
+            return
+          end
+          params = {
+            'bizsdk_crash_report': {
+              'reason': formatted_reason(error),
+              'platform': "ruby #{RUBY_VERSION}",
+              'callstack': error.backtrace
+            }
+          }
+          begin
+            APIRequest.new(
+              :post,
+              "#{app_id}/instruments",
+              session: Session.anonymous_session,
+              params: params,
+              options: {} # batch options, not necessary for now
+            ).execute do |response|
+              if response.result.has_key?('success') && response.result['success'] == true
+                puts 'Successfully sent report'
+                return
+              end
+              puts 'Failed to send report'
+            end
+          rescue
+            puts 'Failed to send report'
+          end
+        end
+      end
+
+      def completion
+        if @@enabled && $! then
+          logCrash()
+        end
+      end
+
+      def is_facebook_error(error)
+        error.backtrace.any? { |frame|
+          frame.match? 'facebook_ads'
+        } if error
+      end
+
+      def formatted_reason(error)
+        if error.kind_of? APIError
+          reason = 'Server Error' if error.kind_of? ServerError
+          reason = 'Client Error' if error.kind_of? ClientError
+          reason += " #{error.message}"
+        else
+          reason = 'SDK Error'
+        end
+        reason
+      end
+
+      def get_app_id
+        params = {
+          'input_token': Session.default_session.access_token,
+          'fields': 'app_id'
+        }
+        begin
+          APIRequest.new(
+            :get,
+            '/debug_token',
+            session: Session.default_session,
+            params: params,
+            options: {} # batch options, not necessary for now
+          ).execute do |response|
+            if (response.result.has_key?('data') &&
+              response.result['data'].has_key?('app_id')
+            )
+              response.result['data']['app_id']
+            else
+              nil
+            end
+          end
+        rescue
+          nil
+        end
+      end
+
+      public
+      # Enable crash reporting
+      def enable
+        if !@@hasRegisteredCrashBlock then
+          at_exit do
+            completion()
+          end
+
+          @@hasRegisteredCrashBlock = true
+        end
+
+        @@enabled = true
+      end
+
+      # Disable crash reporting
+      def disable
+        @@enabled = false
+      end
+    end
+  end
+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)

data/lib/facebook_ads/errors.rb

@@ -24,14 +24,15 @@ module FacebookAds
 
   class APIError < Error
     ERROR_ATTRS = [
-      :fb_message, :type, :code,
+      :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
 
     def initialize(api_response)
+      send("headers=", api_response.headers)
       error_obj = api_response.result
       @api_response = api_response
 
@@ -47,6 +48,10 @@ module FacebookAds
         super(error_obj)
       end
     end
+
+    def getHeaders
+      self.headers
+    end
   end
 
   class ServerError < APIError; end

data/lib/facebook_ads/session.rb

@@ -39,8 +39,8 @@ 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.params[:access_token] = access_token
+            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
         else
@@ -75,6 +75,10 @@ module FacebookAds
     end
 
     class << self
+      def anonymous_session
+        new()
+      end
+
       def default_session
         # TODO
         @default_session ||= new( access_token: FacebookAds.config.access_token,

data/lib/facebook_ads/version.rb

@@ -19,6 +19,6 @@
 # FB:AUTOGEN
 
 module FacebookAds
-  VERSION = '0.3.1.0'
-  API_VERSION = '3.1'
+  VERSION = '0.14.0.0'
+  API_VERSION = '14.0'
 end

data/lib/facebook_ads.rb

@@ -18,6 +18,7 @@
 
 require 'facebook_ads/version'
 require 'facebook_ads/helpers/shortcuts'
+require 'facebook_ads/crash_logger'
 
 module FacebookAds
   DEFAULT_API_VERSION = 'v' + API_VERSION
@@ -36,6 +37,7 @@ module FacebookAds
   def configure
     @config ||= Config.new
     yield @config if block_given?
+    CrashLogger.enable if @config.crash_logging_enabled
     @config
   end
 
@@ -58,7 +60,7 @@ module FacebookAds
   require 'facebook_ads/batch_api/batch'
   require 'facebook_ads/batch_api/batch_proxy'
 
-  # Autoload Ab Objects Helpers
+  # Autoload Ad Objects Helpers
   Dir.glob(File.expand_path(File.join(__FILE__, '..', 'facebook_ads', 'ad_objects', 'helpers', '*.rb'))).each do |file|
     class_name = File.basename(file, '.rb').split('_').map(&:capitalize).join.to_sym
     autoload class_name, file
@@ -69,4 +71,12 @@ module FacebookAds
     class_name = File.basename(file, '.rb').split('_').map(&:capitalize).join.to_sym
     autoload class_name, file
   end
+
+  module ServerSide
+    # Autoload Server-Side API
+    Dir.glob(File.expand_path(File.join(__FILE__, '..', 'facebook_ads', 'ad_objects', 'server_side', '*.rb'))).each do |file|
+      class_name = File.basename(file, '.rb').split('_').map(&:capitalize).join.to_sym
+      autoload class_name, file
+    end
+  end
 end

data/lib/facebookbusiness.rb

@@ -1 +1,19 @@
+# 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.
+
 require "facebook_ads"