reward_sciences 0.1.0

data/lib/reward_sciences/controllers/reward_categories.rb

@@ -0,0 +1,61 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class RewardCategories < BaseController
+    @@instance = RewardCategories.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # List all the available reward categories.
+    # @param [Integer] limit Optional parameter: The number of reward categories you want to be retrieved.
+    # @param [Integer] offset Optional parameter: The number of reward categories you want to skip before starting the retrieval.
+    # @return Mixed response from the API call
+    def list(limit = 25, 
+             offset = 0)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/reward_categories'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'limit' => limit,
+        'offset' => offset
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+  end
+end

data/lib/reward_sciences/controllers/rewards.rb

@@ -0,0 +1,246 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class Rewards < BaseController
+    @@instance = Rewards.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Bid on a reward auction.
+    # @param [Integer] user_id Required parameter: The ID of the user who is bidding on the reward auction.
+    # @param [Integer] reward_id Required parameter: The ID of the reward auction to be bid on.
+    # @param [String] amount Required parameter: Can be either 'max' (when max bidding) or the number of points the user wants to bid.
+    # @return Mixed response from the API call
+    def bid(user_id, 
+            reward_id, 
+            amount)
+
+      # Validate required parameters
+      if user_id == nil
+        raise ArgumentError.new "Required parameter 'user_id' cannot be nil."
+      elsif reward_id == nil
+        raise ArgumentError.new "Required parameter 'reward_id' cannot be nil."
+      elsif amount == nil
+        raise ArgumentError.new "Required parameter 'amount' cannot be nil."
+      end
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/rewards/{reward_id}/bids'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'reward_id' => reward_id
+      }
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'user_id' => user_id,
+        'amount' => amount
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+
+    # List all the available rewards.
+    # @param [Integer] category_id Optional parameter: The id of the category to filter rewards by
+    # @param [Integer] limit Optional parameter: The number of rewards you want to be retrieved.
+    # @param [Integer] offset Optional parameter: The number of rewards you want to skip before starting the retrieval.
+    # @return Mixed response from the API call
+    def list(category_id = nil, 
+             limit = 25, 
+             offset = 0)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/rewards'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'category_id' => category_id,
+        'limit' => limit,
+        'offset' => offset
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+
+    # Redeem a reward.
+    # @param [Integer] user_id Required parameter: The ID of the user who is redeeming the reward.
+    # @param [Integer] reward_id Required parameter: The ID of the reward to be redeemed.
+    # @return Mixed response from the API call
+    def redeem(user_id, 
+               reward_id)
+
+      # Validate required parameters
+      if user_id == nil
+        raise ArgumentError.new "Required parameter 'user_id' cannot be nil."
+      elsif reward_id == nil
+        raise ArgumentError.new "Required parameter 'reward_id' cannot be nil."
+      end
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/rewards/{reward_id}/redemptions'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'reward_id' => reward_id
+      }
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'user_id' => user_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+
+    # Show a reward's details.
+    # @param [Integer] reward_id Required parameter: The ID of the reward to be retrieved.
+    # @return Mixed response from the API call
+    def show(reward_id)
+
+      # Validate required parameters
+      if reward_id == nil
+        raise ArgumentError.new "Required parameter 'reward_id' cannot be nil."
+      end
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/rewards/{reward_id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'reward_id' => reward_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+  end
+end

data/lib/reward_sciences/controllers/users.rb

@@ -0,0 +1,123 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class Users < BaseController
+    @@instance = Users.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # This endpoint lets retrieve a user's details.
+    # @param [Integer] user_id Required parameter: The ID of the user to be retrieved.
+    # @return Mixed response from the API call
+    def show(user_id)
+
+      # Validate required parameters
+      if user_id == nil
+        raise ArgumentError.new "Required parameter 'user_id' cannot be nil."
+      end
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users/{user_id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'user_id' => user_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+
+    # This endpoint lets you tie a user with his/her activities. You’ll want to identify a user with any relevant information as soon as they log-in or sign-up.
+    # @param [String] email Required parameter: The user's email address
+    # @param [String] first_name Optional parameter: The user's first name
+    # @param [String] last_name Optional parameter: The user's last name
+    # @return Mixed response from the API call
+    def identify(email, 
+                 first_name = nil, 
+                 last_name = nil)
+
+      # Validate required parameters
+      if email == nil
+        raise ArgumentError.new "Required parameter 'email' cannot be nil."
+      end
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'email' => email,
+        'first_name' => first_name,
+        'last_name' => last_name
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+  end
+end

data/lib/reward_sciences/exceptions/api_exception.rb

@@ -0,0 +1,28 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class APIException < StandardError
+    attr_reader :context, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      response = context.response
+      super("#{ reason }: #{ exception_details(response) }")
+      @context = context
+      @response_code = response.status_code
+    end
+
+    private
+
+    def exception_details(response)
+      begin
+        detail = JSON.parse(response.raw_body)['detail']
+        detail.is_a?(Array) ? detail.to_sentence : detail
+      rescue JSON::ParserError
+        'Please contact support'
+      end
+    end
+  end
+end

data/lib/reward_sciences/http/http_call_back.rb

@@ -0,0 +1,17 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient will execute.
+    def on_before_request(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpResponse object received from the HttpClient.
+    def on_after_response(http_response)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+  end
+end

data/lib/reward_sciences/http/http_client.rb

@@ -0,0 +1,112 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(response)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def get(query_url,
+            headers: nil,
+            username: nil,
+            password: nil)
+      return HttpRequest.new(HttpMethodEnum::GET,
+                             query_url,
+                             headers: headers,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def post(query_url,
+             headers: nil,
+             parameters: nil,
+             username: nil,
+             password: nil)
+      return HttpRequest.new(HttpMethodEnum::POST,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def put(query_url,
+            headers: nil,
+            parameters: nil,
+            username: nil,
+            password: nil)
+      return HttpRequest.new(HttpMethodEnum::PUT,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def patch(query_url,
+              headers: nil,
+              parameters: nil,
+              username: nil,
+              password: nil)
+      return HttpRequest.new(HttpMethodEnum::PATCH,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def delete(query_url,
+               headers: nil,
+               username: nil,
+               password: nil)
+      return HttpRequest.new(HttpMethodEnum::DELETE,
+                             query_url,
+                             headers: headers,
+                             username: username,
+                             password: password)
+    end
+  end
+end

data/lib/reward_sciences/http/http_context.rb

@@ -0,0 +1,15 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/reward_sciences/http/http_method_enum.rb

@@ -0,0 +1,7 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = "GET", POST = "POST", PUT = "PUT", PATCH = "PATCH", DELETE = "DELETE"]
+  end
+end

data/lib/reward_sciences/http/http_request.rb

@@ -0,0 +1,28 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers, :parameters, :username, :password
+
+    # The constructor.	
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def initialize(http_method,
+                   query_url,
+                   headers: nil,
+                   parameters: nil,
+                   username: nil,
+                   password: nil)
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+      @username = username
+      @password = password
+    end
+  end
+end

data/lib/reward_sciences/http/http_response.rb

@@ -0,0 +1,19 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class HttpResponse
+    attr_accessor :status_code, :headers, :raw_body
+    
+    # The constructor.	
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    def initialize(status_code,
+                   headers,
+                   raw_body)
+      @status_code = status_code
+      @headers = headers
+      @raw_body = raw_body
+    end
+  end
+end