pinch-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3847478d602a0b7ba7d315279b6501e46dbf05fc
+  data.tar.gz: 7fa3b4f0e62309c6cd2dd48179c609f1ab9058db
+SHA512:
+  metadata.gz: 6025eea1563e0011bd82289a803965b43ec8f56de85d7dcb62b73722d6c2bf6f922ad361cccfa5a84407e3e7ffb78099b284d271eec84c355c5c86b45954f7c2
+  data.tar.gz: c3ea6842853b29a0bfe2a79920233a6bfc108a9f208dd6c9708b72775cad4df8c7421eaace36272a0f7ead67e614ba3911d9a8e881321b1b97cfe94465275723

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission 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.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,48 @@
+Pinch
+=================
+This API SDK was automatically generated by APIMATIC v2.0
+
+How To Configure:
+=================
+The generated code might need to be configured with your API credentials. To do that,
+open the file "configuration.rb" and edit it's contents.
+
+Alternatively, you can modify the Configuration parameters at run-time through the following
+```
+Pinch::Configuration.your_paramater=YOUR_VALUE
+```
+
+How To Build: 
+=============
+The generated code uses a Ruby gem namely 'unirest'. The reference to this gem is
+already added in the gemspec. Therefore, you will need internet access to resolve
+this dependency.
+
+How To Use:
+===========
+The generated code can be used to build gem, which can then be distributed online.
+Otherwise, you can include the generated code in your project to use directly.
+
+Use the following steps to build a gem and use locally
+
+    1. Run the build command
+        ```
+        gem build pinch.gemspec
+        ```
+
+    2. Run the install command  
+        ```
+        gem install ./pinch-1.0.gem
+        ```
+
+    3. In your Gemfile add this line
+        ```
+        gem 'pinch', '~> 1.0'
+        ```
+
+    4. Now create an instance and use the instance methods, like following.
+
+        ```
+        ctl = Pinch::WebhookTypeController.new params
+        ctl.list params
+        ```

data/lib/pinch.rb

@@ -0,0 +1,24 @@
+# This file was automatically generated for Pinch by APIMATIC v2.0 ( https://apimatic.io ) on 05/13/2016
+require 'openssl'
+require 'json'
+require 'unirest'
+
+# APIMATIC Helper Files
+require_relative 'pinch/api_helper.rb'
+require_relative 'pinch/api_exception.rb'
+require_relative 'pinch/configuration.rb'
+require_relative 'pinch/pinch_client.rb'
+require_relative 'pinch/custom_auth_utility.rb'
+
+# Controllers
+require_relative 'pinch/controllers/webhook_type_controller.rb'
+require_relative 'pinch/controllers/webhook_controller.rb'
+require_relative 'pinch/controllers/ticket_controller.rb'
+
+# Models
+require_relative 'pinch/models/webhook_type.rb'
+require_relative 'pinch/models/webhook.rb'
+require_relative 'pinch/models/ticket.rb'
+require_relative 'pinch/models/person.rb'
+require_relative 'pinch/models/building.rb'
+require_relative 'pinch/models/unit.rb'

data/lib/pinch/api_exception.rb

@@ -0,0 +1,21 @@
+# This file was automatically generated for Pinch by APIMATIC v2.0 ( https://apimatic.io ) on 05/13/2016
+
+module Pinch
+  class APIException < StandardError
+    # value store
+    attr_reader :response_code
+
+    # value store
+    attr_reader :response_body
+
+    # The HTTP response code from the API request
+    # @param [String]    reason    the reason for raising an exception
+    # @param [Numeric]   response_code    the HTTP response code from the API request
+    # @param [Object]    response_body    the HTTP unprased response from the API request
+    def initialize(reason, response_code, response_body)
+      super(reason)
+      @response_code = response_code
+      @response_body = response_body
+    end
+  end
+end

data/lib/pinch/api_helper.rb

@@ -0,0 +1,140 @@
+# This file was automatically generated for Pinch by APIMATIC v2.0 ( https://apimatic.io ) on 05/13/2016
+
+module Pinch
+  class APIHelper
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.is_a? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        query_builder
+      else
+        # iterate and append parameters
+        parameters.each do |key, value|
+          replace_value = ''
+
+          if value.nil?
+            replace_value = ''
+          elsif value.is_a? Enumerable
+            replace_value = value.join('/')
+          else
+            replace_value = value.to_s
+          end
+
+          # find the template parameter and replace it with its value
+          query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        end
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.is_a? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        query_builder
+      else
+        # remove any nil values
+        parameters = parameters.reject { |_key, value| value.nil? }
+
+        # does the query string already has parameters
+        has_params = query_builder.include? '?'
+        separator = has_params ? '&' : '?'
+
+        # append query with separator and parameters
+        query_builder << separator << URI.encode_www_form(parameters)
+      end
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.is_a? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+      
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(index != nil ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = index != nil ? url[url.index('?')...url.length] : ""
+
+      # return processed url
+      protocol + query  + parameters
+    end	
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = Hash.new
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode value, key)
+      end 
+      encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = Hash.new
+
+      # If this is a structure, resolve it's field names.
+      if obj.respond_to? :key_map
+        obj = obj.key_map
+      end
+      
+      # Create a form encoded hash for this object.
+      if obj == nil
+        nil         
+      elsif obj.is_a? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + index.to_s + "]"))
+        end
+      elsif obj.is_a? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + key + "]"))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end

data/lib/pinch/configuration.rb

@@ -0,0 +1,23 @@
+# This file was automatically generated for Pinch by APIMATIC v2.0 ( https://apimatic.io ) on 05/13/2016
+
+module Pinch
+  class Configuration
+    # The base Uri for API calls
+    @base_uri = 'https://api-company.inchbase.com/api/v1'
+
+    # Your api key
+    @x_api_token = TODO: Replace
+
+    # Your registered email
+    @x_api_email = TODO: Replace
+
+    # create the getters and setters
+    class << self
+      attr_accessor :base_uri
+      attr_accessor :x_api_token
+      attr_accessor :x_api_email
+      attr_accessor :x_api_token
+      attr_accessor :x_api_email
+    end
+  end
+end

data/lib/pinch/controllers/ticket_controller.rb

@@ -0,0 +1,537 @@
+# This file was automatically generated for Pinch by APIMATIC v2.0 ( https://apimatic.io ) on 05/13/2016
+
+module Pinch
+  class TicketController
+    @@instance = TicketController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # List all the opened tickets of every clients you are working for
+    # @return List of Ticket response from the API call
+    def list
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/tickets'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'accept' => 'application/json',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.get _query_url, headers: _headers
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+        
+      # Try to cast response to list of desired type
+      if _response.body.instance_of? Array
+        value = Array.new
+        _response.body.each do |item|
+          begin
+            value << (Ticket.from_hash(item))
+          rescue Exception
+            raise APIException.new "Invalid JSON returned.", _response.code, _response.body
+          end
+        end
+        value
+      end
+    end
+
+    # This method returns no result but the status code tells you if the operation succedded
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return String response from the API call
+    def accept_intervention(ticket_id)
+
+      # Validate required parameters
+      if ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/accept'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [DateTime] intervention_date Required parameter: TODO: type description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return String response from the API call
+    def set_intervention_date(intervention_date, 
+                              ticket_id)
+
+      # Validate required parameters
+      if intervention_date == nil
+        raise ArgumentError.new "Required parameter 'intervention_date' cannot be nil."
+      elsif ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/set_intervention_date'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # prepare parameters
+      _parameters = {
+        'intervention_date' => intervention_date
+      }
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers, parameters: _parameters
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [File] file Required parameter: TODO: type description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return String response from the API call
+    def upload_quote(file, 
+                     ticket_id)
+
+      # Validate required parameters
+      if file == nil
+        raise ArgumentError.new "Required parameter 'file' cannot be nil."
+      elsif ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/quote_upload'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # prepare parameters
+      _parameters = {
+        'file' => file
+      }
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers, parameters: _parameters
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] body Required parameter: TODO: type description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return String response from the API call
+    def send_message(body, 
+                     ticket_id)
+
+      # Validate required parameters
+      if body == nil
+        raise ArgumentError.new "Required parameter 'body' cannot be nil."
+      elsif ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/message'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # prepare parameters
+      _parameters = {
+        'body' => body
+      }
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers, parameters: _parameters
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @param [DateTime] intervention_date Optional parameter: TODO: type description here
+    # @return String response from the API call
+    def declare_intervention_done(ticket_id, 
+                                  intervention_date = nil)
+
+      # Validate required parameters
+      if ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/intervention_done'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # prepare parameters
+      _parameters = {
+        'intervention_date' => intervention_date
+      }
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers, parameters: _parameters
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # The document should not be an invoice nor a quote
+    # @param [File] file Required parameter: TODO: type description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return String response from the API call
+    def upload_document(file, 
+                        ticket_id)
+
+      # Validate required parameters
+      if file == nil
+        raise ArgumentError.new "Required parameter 'file' cannot be nil."
+      elsif ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/document_upload'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # prepare parameters
+      _parameters = {
+        'file' => file
+      }
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers, parameters: _parameters
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [File] file Required parameter: TODO: type description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return String response from the API call
+    def upload_picture(file, 
+                       ticket_id)
+
+      # Validate required parameters
+      if file == nil
+        raise ArgumentError.new "Required parameter 'file' cannot be nil."
+      elsif ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}/picture_upload'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # prepare parameters
+      _parameters = {
+        'file' => file
+      }
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.post _query_url, headers: _headers, parameters: _parameters
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Return appropriate type
+      _response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] ticket_id Required parameter: TODO: type description here
+    # @return Ticket response from the API call
+    def get(ticket_id)
+
+      # Validate required parameters
+      if ticket_id == nil
+        raise ArgumentError.new "Required parameter 'ticket_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 << '/tickets/{ticket_id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'ticket_id' => ticket_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'accept' => 'application/json',
+        'X-API-TOKEN' => Configuration.x_api_token,
+        'X-API-EMAIL' => Configuration.x_api_email
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params _headers
+
+      # invoke the API call request to fetch the response
+      _response = Unirest.get _query_url, headers: _headers
+
+      # Error handling using HTTP status codes
+      if _response.code == 401
+        raise APIException.new 'Your API key is incorrect', 401, _response.body
+      elsif _response.code == 400
+        raise APIException.new 'There is an error in the parameters you send', 400, _response.body
+      elsif _response.code == 404
+        raise APIException.new 'Cannot find the resource specified', 404, _response.body
+      elsif !_response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', _response.code, _response.body
+      end
+
+      # Try to cast response to desired type
+      if _response.body.instance_of? Hash
+        begin
+          Ticket.from_hash(_response.body)
+        rescue Exception
+          raise APIException.new "Invalid JSON returned.", _response.code, _response.body
+        end
+      end
+    end
+  end
+end