hubspot-api-client 1.0.1

data/lib/hubspot/codegen/crm/tickets/api/search_api.rb

@@ -0,0 +1,90 @@
+=begin
+#Tickets
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Client
+    module Crm
+      module Tickets
+        module Api
+          class SearchApi
+            attr_accessor :api_client
+
+            def initialize(api_client = ApiClient.default)
+              @api_client = api_client
+            end
+            # Filter, Sort, and Search CRM Objects
+            # # Filter, Sort, and Search CRM Objects  The CRM Search API is a powerful API that allows developers to filter, sort, and search across all ticket types, including contacts, deals, companies and tickets. Using this API, developers can more efficiently retrieve a subset of data they are looking for to better suit their business needs.  Common use cases this API allows for include, but are not limited to the following: <ul> <li>Getting a list of contacts for a specific account</li> <li>Retrieving a list of all open deals</li> <li>Searching for contacts by custom properties</li> <li>& more</li> </ul>  Prerequisite for using this API: To use the CRM Search API with an OAuth token, your app must request and be granted access to the contacts scope.  <br /> `engagements` including `tasks`, `calls`, `emails`, and `notes` are not supported.  <br /> ## Filter  Use `filterGroups` in the request body to limit results to specific CRM tickets.  *Example*: Find all contacts with a first name of \"Alice\" ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"filterGroups\":[     {       \"filters\":[         {           \"propertyName\": \"firstname\",           \"operator\": \"EQ\",           \"value\": \"Alice\"         }       ]     }]   }' ```  When multiple `filters` are provided within a `filterGroup`, they will be combined using a logical `AND` operator. When multiple `filterGroup`s are provided, they will be combined using a logical `OR` operator. The system supports a maximum of three `filterGroups` with up to three `filters` per `filterGroup`.  *Example*: Find all contacts with (a first name of \"Alice\" `AND` a last name that is not \"Smith\") OR has the property \"enum1\" ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"filterGroups\":[     {       \"filters\": [         {           \"propertyName\": \"firstname\",           \"operator\": \"EQ\",           \"value\": \"Alice\"         },         {           \"propertyName\": \"lastname\",           \"operator\": \"NEQ\",           \"value\": \"Smith\"         }       ]     },     {       \"filters\": [         {           \"property\": \"enum1\",           \"operator\": \"HAS_PROPERTY\"         }       ]     }]   }' ```   <br /> ### Operators  Supported operators include: |Operator|Description| |--|--| |`EQ`| equal to | |`NEQ`| not equal to | |`LT`| less than | |`LTE`| less than or equal to | |`GT`| greater than | |`GTE`| greater than or equal to | |`HAS_PROPERTY`| has the property | |`NOT_HAS_PROPERTY`| does not have the property | |`CONTAINS_TOKEN`| contains token, strings only | |`NOT_CONTAINS_TOKEN`| not contains token, strings only |  <br /> ### Associations You can find tickets associated with a different object type by ID using the `associations.tickets` psuedo-property. Support for this is limited to `deals` and `tickets`.  Supported association filters: |Object Type |Filter `propertyName` | |--|--| | `deals` | `associations.company`, `associations.contact`, `associations.ticket` | | `tickets` | `associations.company`, `associations.contact`, `associations.deal` |  *Example*: Find all tickets associated with the contact using ID \"123\" ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/tickets/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"filters\": [       {         \"propertyName\": \"associations.contact\",         \"operator\": \"EQ\",         \"value\": \"123\"       }     ]   }' ```  <br /> ## Sort  Use `sorts`, which contain a property name and a direction, to sort the returned collection.  *Example*: List all contacts with most recently created first ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"sorts\": [       {         \"propertyName\": \"createdate\",         \"direction\": \"DESCENDING\"       }     ]   }' ``` The system supports a single sort.   <br /> ## Search  Perform a text search against all property values for a ticket type. By default, the results will be returned in order of object creation (oldest first) but this can be overridden using `sorts`.  *Example*: Find all contacts with a property value containing the letter `x` ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"query\": \"x\"   }' ```  <br /> ## Controlling returned properties  Each object type is returned with a default set of properties. You can override this by providing an array of property names in the `properties` property of the request body.  *Example*: Return all contacts and include their email and mailing address state ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"properties\": [ \"email\", \"state\" ]   }' ```  <br /> ## Paging through results By default, the Search API returns results containing 10 tickets per page. The system supports a maximum of 100 results per page.  *Example*: Get pages of size 20 ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"limit\": 20   } ```  In order to access the next page of results, you must pass the `after` parameter that was provided in the previous response in the `paging.next.after` property. If no `paging.next.after` property is provided, no additional results will be shown. Note that the after parameter is expected to be a string.  *Example*: Get the next page of results ``` curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey=demo \\   --header \"Content-Type: application/json\" \\   --data '{     \"after\": \"20\"   }' ```  <br /> ## Sample Response (Success)  ``` {   \"results\": [     {       \"id\": \"174\",       \"properties\": {         \"firstname\": \"Brantley\",         \"lastname\": \"Forrest\",         \"email\": \"bforrest8@acme.com\"       },       \"createdAt\":\"2019-10-30T03:30:17.883Z\",       \"updatedAt\": \"1569516907T16:50:06.678Z\",       \"archived\": false     },     ...   ],   \"paging\": {     \"next\": {       \"after\": \"10\"     }   } } ```  <br /> ## Limitations  1. It can take a few moments between creating or updating a ticket in HubSpot and seeing it in CRM Search API results. 2. CRM tickets in an archived state will not be available in the Search API. 3. The Search API is rate limited to 1 request per second per authentication token, which is more stringent than our general rate limits. The `X-HubSpot-RateLimit-*` headers will not reflect this during the beta period. Read more about [rate limits](https://developers.hubspot.com/docs/faq/working-within-the-hubspot-api-rate-limits).  <br /> ## Error Handling Read our [error documentation](https://developers.hubspot.com/docs/faq/api-error-responses).
+            # @param [Hash] opts the optional parameters
+            # @option opts [PublicObjectSearchRequest] :public_object_search_request 
+            # @return [CollectionResponseWithTotalSimplePublicObject]
+            def do_search(opts = {})
+              data, _status_code, _headers = do_search_with_http_info(opts)
+              data
+            end
+
+            # Filter, Sort, and Search CRM Objects
+            # # Filter, Sort, and Search CRM Objects  The CRM Search API is a powerful API that allows developers to filter, sort, and search across all ticket types, including contacts, deals, companies and tickets. Using this API, developers can more efficiently retrieve a subset of data they are looking for to better suit their business needs.  Common use cases this API allows for include, but are not limited to the following: &lt;ul&gt; &lt;li&gt;Getting a list of contacts for a specific account&lt;/li&gt; &lt;li&gt;Retrieving a list of all open deals&lt;/li&gt; &lt;li&gt;Searching for contacts by custom properties&lt;/li&gt; &lt;li&gt;&amp; more&lt;/li&gt; &lt;/ul&gt;  Prerequisite for using this API: To use the CRM Search API with an OAuth token, your app must request and be granted access to the contacts scope.  &lt;br /&gt; &#x60;engagements&#x60; including &#x60;tasks&#x60;, &#x60;calls&#x60;, &#x60;emails&#x60;, and &#x60;notes&#x60; are not supported.  &lt;br /&gt; ## Filter  Use &#x60;filterGroups&#x60; in the request body to limit results to specific CRM tickets.  *Example*: Find all contacts with a first name of \&quot;Alice\&quot; &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;filterGroups\&quot;:[     {       \&quot;filters\&quot;:[         {           \&quot;propertyName\&quot;: \&quot;firstname\&quot;,           \&quot;operator\&quot;: \&quot;EQ\&quot;,           \&quot;value\&quot;: \&quot;Alice\&quot;         }       ]     }]   }&#39; &#x60;&#x60;&#x60;  When multiple &#x60;filters&#x60; are provided within a &#x60;filterGroup&#x60;, they will be combined using a logical &#x60;AND&#x60; operator. When multiple &#x60;filterGroup&#x60;s are provided, they will be combined using a logical &#x60;OR&#x60; operator. The system supports a maximum of three &#x60;filterGroups&#x60; with up to three &#x60;filters&#x60; per &#x60;filterGroup&#x60;.  *Example*: Find all contacts with (a first name of \&quot;Alice\&quot; &#x60;AND&#x60; a last name that is not \&quot;Smith\&quot;) OR has the property \&quot;enum1\&quot; &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;filterGroups\&quot;:[     {       \&quot;filters\&quot;: [         {           \&quot;propertyName\&quot;: \&quot;firstname\&quot;,           \&quot;operator\&quot;: \&quot;EQ\&quot;,           \&quot;value\&quot;: \&quot;Alice\&quot;         },         {           \&quot;propertyName\&quot;: \&quot;lastname\&quot;,           \&quot;operator\&quot;: \&quot;NEQ\&quot;,           \&quot;value\&quot;: \&quot;Smith\&quot;         }       ]     },     {       \&quot;filters\&quot;: [         {           \&quot;property\&quot;: \&quot;enum1\&quot;,           \&quot;operator\&quot;: \&quot;HAS_PROPERTY\&quot;         }       ]     }]   }&#39; &#x60;&#x60;&#x60;   &lt;br /&gt; ### Operators  Supported operators include: |Operator|Description| |--|--| |&#x60;EQ&#x60;| equal to | |&#x60;NEQ&#x60;| not equal to | |&#x60;LT&#x60;| less than | |&#x60;LTE&#x60;| less than or equal to | |&#x60;GT&#x60;| greater than | |&#x60;GTE&#x60;| greater than or equal to | |&#x60;HAS_PROPERTY&#x60;| has the property | |&#x60;NOT_HAS_PROPERTY&#x60;| does not have the property | |&#x60;CONTAINS_TOKEN&#x60;| contains token, strings only | |&#x60;NOT_CONTAINS_TOKEN&#x60;| not contains token, strings only |  &lt;br /&gt; ### Associations You can find tickets associated with a different object type by ID using the &#x60;associations.tickets&#x60; psuedo-property. Support for this is limited to &#x60;deals&#x60; and &#x60;tickets&#x60;.  Supported association filters: |Object Type |Filter &#x60;propertyName&#x60; | |--|--| | &#x60;deals&#x60; | &#x60;associations.company&#x60;, &#x60;associations.contact&#x60;, &#x60;associations.ticket&#x60; | | &#x60;tickets&#x60; | &#x60;associations.company&#x60;, &#x60;associations.contact&#x60;, &#x60;associations.deal&#x60; |  *Example*: Find all tickets associated with the contact using ID \&quot;123\&quot; &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/tickets/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;filters\&quot;: [       {         \&quot;propertyName\&quot;: \&quot;associations.contact\&quot;,         \&quot;operator\&quot;: \&quot;EQ\&quot;,         \&quot;value\&quot;: \&quot;123\&quot;       }     ]   }&#39; &#x60;&#x60;&#x60;  &lt;br /&gt; ## Sort  Use &#x60;sorts&#x60;, which contain a property name and a direction, to sort the returned collection.  *Example*: List all contacts with most recently created first &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;sorts\&quot;: [       {         \&quot;propertyName\&quot;: \&quot;createdate\&quot;,         \&quot;direction\&quot;: \&quot;DESCENDING\&quot;       }     ]   }&#39; &#x60;&#x60;&#x60; The system supports a single sort.   &lt;br /&gt; ## Search  Perform a text search against all property values for a ticket type. By default, the results will be returned in order of object creation (oldest first) but this can be overridden using &#x60;sorts&#x60;.  *Example*: Find all contacts with a property value containing the letter &#x60;x&#x60; &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;query\&quot;: \&quot;x\&quot;   }&#39; &#x60;&#x60;&#x60;  &lt;br /&gt; ## Controlling returned properties  Each object type is returned with a default set of properties. You can override this by providing an array of property names in the &#x60;properties&#x60; property of the request body.  *Example*: Return all contacts and include their email and mailing address state &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;properties\&quot;: [ \&quot;email\&quot;, \&quot;state\&quot; ]   }&#39; &#x60;&#x60;&#x60;  &lt;br /&gt; ## Paging through results By default, the Search API returns results containing 10 tickets per page. The system supports a maximum of 100 results per page.  *Example*: Get pages of size 20 &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;limit\&quot;: 20   } &#x60;&#x60;&#x60;  In order to access the next page of results, you must pass the &#x60;after&#x60; parameter that was provided in the previous response in the &#x60;paging.next.after&#x60; property. If no &#x60;paging.next.after&#x60; property is provided, no additional results will be shown. Note that the after parameter is expected to be a string.  *Example*: Get the next page of results &#x60;&#x60;&#x60; curl --request POST https://api.hubapi.com/crm/v3/tickets/contacts/search?hapikey&#x3D;demo \\   --header \&quot;Content-Type: application/json\&quot; \\   --data &#39;{     \&quot;after\&quot;: \&quot;20\&quot;   }&#39; &#x60;&#x60;&#x60;  &lt;br /&gt; ## Sample Response (Success)  &#x60;&#x60;&#x60; {   \&quot;results\&quot;: [     {       \&quot;id\&quot;: \&quot;174\&quot;,       \&quot;properties\&quot;: {         \&quot;firstname\&quot;: \&quot;Brantley\&quot;,         \&quot;lastname\&quot;: \&quot;Forrest\&quot;,         \&quot;email\&quot;: \&quot;bforrest8@acme.com\&quot;       },       \&quot;createdAt\&quot;:\&quot;2019-10-30T03:30:17.883Z\&quot;,       \&quot;updatedAt\&quot;: \&quot;1569516907T16:50:06.678Z\&quot;,       \&quot;archived\&quot;: false     },     ...   ],   \&quot;paging\&quot;: {     \&quot;next\&quot;: {       \&quot;after\&quot;: \&quot;10\&quot;     }   } } &#x60;&#x60;&#x60;  &lt;br /&gt; ## Limitations  1. It can take a few moments between creating or updating a ticket in HubSpot and seeing it in CRM Search API results. 2. CRM tickets in an archived state will not be available in the Search API. 3. The Search API is rate limited to 1 request per second per authentication token, which is more stringent than our general rate limits. The &#x60;X-HubSpot-RateLimit-*&#x60; headers will not reflect this during the beta period. Read more about [rate limits](https://developers.hubspot.com/docs/faq/working-within-the-hubspot-api-rate-limits).  &lt;br /&gt; ## Error Handling Read our [error documentation](https://developers.hubspot.com/docs/faq/api-error-responses).
+            # @param [Hash] opts the optional parameters
+            # @option opts [PublicObjectSearchRequest] :public_object_search_request 
+            # @return [Array<(CollectionResponseWithTotalSimplePublicObject, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObject data, response status code and response headers
+            def do_search_with_http_info(opts = {})
+              if @api_client.config.debugging
+                @api_client.config.logger.debug 'Calling API: SearchApi.do_search ...'
+              end
+              # resource path
+              local_var_path = '/tickets/search'
+
+              # query parameters
+              query_params = opts[:query_params] || {}
+
+              # header parameters
+              header_params = opts[:header_params] || {}
+              # HTTP header 'Accept' (if needed)
+              header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+              # HTTP header 'Content-Type'
+              header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+              # form parameters
+              form_params = opts[:form_params] || {}
+
+              # http body (model)
+              post_body = opts[:body] || @api_client.object_to_http_body(opts[:'public_object_search_request']) 
+
+              # return_type
+              return_type = opts[:return_type] || 'CollectionResponseWithTotalSimplePublicObject' 
+
+              # auth_names
+              auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+              new_options = opts.merge(
+                :header_params => header_params,
+                :query_params => query_params,
+                :form_params => form_params,
+                :body => post_body,
+                :auth_names => auth_names,
+                :return_type => return_type
+              )
+
+              data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+              if @api_client.config.debugging
+                @api_client.config.logger.debug "API called: SearchApi#do_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              end
+              return data, status_code, headers
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/crm/tickets/api_client.rb

@@ -0,0 +1,423 @@
+=begin
+#Tickets
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'faraday'
+
+module Hubspot
+  module Client
+    module Crm
+      module Tickets
+        class ApiClient
+          # The Configuration object holding settings to be used in the API client.
+          attr_accessor :config
+
+          # Defines the headers to be used in HTTP requests of all API calls by default.
+          #
+          # @return [Hash]
+          attr_accessor :default_headers
+
+          # Initializes the ApiClient
+          # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+          def initialize(config = Configuration.default)
+            @config = config
+            @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
+            @default_headers = {
+              'Content-Type' => 'application/json',
+              'User-Agent' => @user_agent
+            }
+          end
+
+          def self.default
+            @@default ||= ApiClient.new
+          end
+
+          # Call an API with given options.
+          #
+          # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
+          #   the data deserialized from response body (could be nil), response status code and response headers.
+          def call_api(http_method, path, opts = {})
+            ssl_options = {
+              :ca_file => @config.ssl_ca_file,
+              :verify => @config.ssl_verify,
+              :verify_mode => @config.ssl_verify_mode,
+              :client_cert => @config.ssl_client_cert,
+              :client_key => @config.ssl_client_key
+            }
+
+            connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
+              conn.basic_auth(config.username, config.password)
+              if opts[:header_params]["Content-Type"] == "multipart/form-data"
+                conn.request :multipart
+                conn.request :url_encoded
+              end
+              conn.adapter(Faraday.default_adapter)
+
+              # Errors handler settings
+              if !config.error_handler.empty?
+                config.error_handler.each do |statuses, opts|
+                  statuses = statuses.is_a?(Integer) ? [statuses] : statuses
+                  retry_options = {
+                    max: opts[:max_retries],
+                    interval: opts[:seconds_delay],
+                    retry_statuses: statuses,
+                    methods: %i[post delete get head options put],
+                    retry_block: -> (env, options, retries, exc) { opts[:retry_block].call }
+                  }
+                  conn.request :retry, retry_options
+                end
+              end
+            end
+
+            begin
+              response = connection.public_send(http_method.to_sym.downcase) do |req|
+                build_request(http_method, path, req, opts)
+              end
+
+              if @config.debugging
+                @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+              end
+
+              unless response.success?
+                if response.status == 0
+                  # Errors from libcurl will be made visible here
+                  fail ApiError.new(:code => 0,
+                                    :message => response.return_message)
+                else
+                  fail ApiError.new(:code => response.status,
+                                    :response_headers => response.headers,
+                                    :response_body => response.body),
+                      response.reason_phrase
+                end
+              end
+            rescue Faraday::TimeoutError
+              fail ApiError.new('Connection timed out')
+            end
+
+            if opts[:return_type]
+              data = deserialize(response, opts[:return_type])
+            else
+              data = nil
+            end
+            return data, response.status, response.headers
+          end
+
+          # Builds the HTTP request
+          #
+          # @param [String] http_method HTTP method/verb (e.g. POST)
+          # @param [String] path URL path (e.g. /account/new)
+          # @option opts [Hash] :header_params Header parameters
+          # @option opts [Hash] :query_params Query parameters
+          # @option opts [Hash] :form_params Query parameters
+          # @option opts [Object] :body HTTP body (JSON/XML)
+          # @return [Typhoeus::Request] A Typhoeus Request
+          def build_request(http_method, path, request, opts = {})
+            url = build_request_url(path)
+            http_method = http_method.to_sym.downcase
+
+            header_params = @default_headers.merge(opts[:header_params] || {})
+            query_params = opts[:query_params] || {}
+            form_params = opts[:form_params] || {}
+
+            update_params_for_auth! header_params, query_params, opts[:auth_names]
+
+            req_opts = {
+              :method => http_method,
+              :headers => header_params,
+              :params => query_params,
+              :params_encoding => @config.params_encoding,
+              :timeout => @config.timeout,
+              :verbose => @config.debugging
+            }
+
+            if [:post, :patch, :put, :delete].include?(http_method)
+              req_body = build_request_body(header_params, form_params, opts[:body])
+              req_opts.update :body => req_body
+              if @config.debugging
+                @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+              end
+            end
+            request.headers = header_params
+            request.body = req_body
+            request.url url
+            request.params = query_params
+            download_file(request) if opts[:return_type] == 'File'
+            request
+          end
+
+          # Builds the HTTP request body
+          #
+          # @param [Hash] header_params Header parameters
+          # @param [Hash] form_params Query parameters
+          # @param [Object] body HTTP body (JSON/XML)
+          # @return [String] HTTP body data in the form of string
+          def build_request_body(header_params, form_params, body)
+            # http form
+            if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
+              data = URI.encode_www_form(form_params)
+            elsif header_params['Content-Type'] == 'multipart/form-data'
+              data = {}
+              form_params.each do |key, value|
+                case value
+                when ::File, ::Tempfile
+                  # TODO hardcode to application/octet-stream, need better way to detect content type
+                  data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+                when ::Array, nil
+                  # let Faraday handle Array and nil parameters
+                  data[key] = value
+                else
+                  data[key] = value.to_s
+                end
+              end
+            elsif body
+              data = body.is_a?(String) ? body : body.to_json
+            else
+              data = nil
+            end
+            data
+          end
+
+          # Check if the given MIME is a JSON MIME.
+          # JSON MIME examples:
+          #   application/json
+          #   application/json; charset=UTF8
+          #   APPLICATION/JSON
+          #   */*
+          # @param [String] mime MIME
+          # @return [Boolean] True if the MIME is application/json
+          def json_mime?(mime)
+            (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+          end
+
+          # Deserialize the response to the given return type.
+          #
+          # @param [Response] response HTTP response
+          # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
+          def deserialize(response, return_type)
+            body = response.body
+
+            # handle file downloading - return the File instance processed in request callbacks
+            # note that response body is empty when the file is written in chunks in request on_body callback
+            return @tempfile if return_type == 'File'
+
+            return nil if body.nil? || body.empty?
+
+            # return response body directly for String return type
+            return body if return_type == 'String'
+
+            # ensuring a default content type
+            content_type = response.headers['Content-Type'] || 'application/json'
+
+            fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+            begin
+              data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+            rescue JSON::ParserError => e
+              if %w(String Date DateTime).include?(return_type)
+                data = body
+              else
+                raise e
+              end
+            end
+
+            convert_to_type data, return_type
+          end
+
+          # Convert data to the given return type.
+          # @param [Object] data Data to be converted
+          # @param [String] return_type Return type
+          # @return [Mixed] Data in a particular type
+          def convert_to_type(data, return_type)
+            return nil if data.nil?
+            case return_type
+            when 'String'
+              data.to_s
+            when 'Integer'
+              data.to_i
+            when 'Float'
+              data.to_f
+            when 'Boolean'
+              data == true
+            when 'DateTime'
+              # parse date time (expecting ISO 8601 format)
+              DateTime.parse data
+            when 'Date'
+              # parse date time (expecting ISO 8601 format)
+              Date.parse data
+            when 'Object'
+              # generic object (usually a Hash), return directly
+              data
+            when /\AArray<(.+)>\z/
+              # e.g. Array<Pet>
+              sub_type = $1
+              data.map { |item| convert_to_type(item, sub_type) }
+            when /\AHash\<String, (.+)\>\z/
+              # e.g. Hash<String, Integer>
+              sub_type = $1
+              {}.tap do |hash|
+                data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+              end
+            else
+              # models, e.g. Pet
+              Hubspot::Client::Crm::Tickets::Models.const_get(return_type).build_from_hash(data)
+            end
+          end
+
+          # Save response body into a file in (the defined) temporary folder, using the filename
+          # from the "Content-Disposition" header if provided, otherwise a random filename.
+          # The response body is written to the file in chunks in order to handle files which
+          # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+          # process can use.
+          #
+          # @see Configuration#temp_folder_path
+          def download_file(request)
+            tempfile = nil
+            encoding = nil
+            request.on_headers do |response|
+              content_disposition = response.headers['Content-Disposition']
+              if content_disposition && content_disposition =~ /filename=/i
+                filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+                prefix = sanitize_filename(filename)
+              else
+                prefix = 'download-'
+              end
+              prefix = prefix + '-' unless prefix.end_with?('-')
+              encoding = response.body.encoding
+              tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+              @tempfile = tempfile
+            end
+            request.on_body do |chunk|
+              chunk.force_encoding(encoding)
+              tempfile.write(chunk)
+            end
+            request.on_complete do |response|
+              tempfile.close if tempfile
+              @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                                  "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                                  "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                                  "explicitly with `tempfile.delete`"
+            end
+          end
+
+          # Sanitize filename by removing path.
+          # e.g. ../../sun.gif becomes sun.gif
+          #
+          # @param [String] filename the filename to be sanitized
+          # @return [String] the sanitized filename
+          def sanitize_filename(filename)
+            filename.gsub(/.*[\/\\]/, '')
+          end
+
+          def build_request_url(path)
+            # Add leading and trailing slashes to path
+            path = "/#{path}".gsub(/\/+/, '/')
+            @config.base_url + path
+          end
+
+          # Update hearder and query params based on authentication settings.
+          #
+          # @param [Hash] header_params Header parameters
+          # @param [Hash] query_params Query parameters
+          # @param [String] auth_names Authentication scheme name
+          def update_params_for_auth!(header_params, query_params, auth_names)
+            Array(auth_names).each do |auth_name|
+              auth_setting = @config.auth_settings[auth_name]
+              next unless auth_setting
+              case auth_setting[:in]
+              when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+              when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+              else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+              end
+            end
+          end
+
+          # Sets user agent in HTTP header
+          #
+          # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
+          def user_agent=(user_agent)
+            @user_agent = user_agent
+            @default_headers['User-Agent'] = @user_agent
+          end
+
+          # Return Accept header based on an array of accepts provided.
+          # @param [Array] accepts array for Accept
+          # @return [String] the Accept header (e.g. application/json)
+          def select_header_accept(accepts)
+            return nil if accepts.nil? || accepts.empty?
+            # use JSON when present, otherwise use all of the provided
+            json_accept = accepts.find { |s| json_mime?(s) }
+            json_accept || accepts.join(',')
+          end
+
+          # Return Content-Type header based on an array of content types provided.
+          # @param [Array] content_types array for Content-Type
+          # @return [String] the Content-Type header  (e.g. application/json)
+          def select_header_content_type(content_types)
+            # use application/json by default
+            return 'application/json' if content_types.nil? || content_types.empty?
+            # use JSON when present, otherwise use the first one
+            json_content_type = content_types.find { |s| json_mime?(s) }
+            json_content_type || content_types.first
+          end
+
+          # Convert object (array, hash, object, etc) to JSON string.
+          # @param [Object] model object to be converted into JSON string
+          # @return [String] JSON string representation of the object
+          def object_to_http_body(model)
+            return model if model.nil? || model.is_a?(String)
+            local_body = nil
+            if model.is_a?(Array)
+              local_body = model.map { |m| object_to_hash(m) }
+            else
+              local_body = object_to_hash(model)
+            end
+            local_body.to_json
+          end
+
+          # Convert object(non-array) to hash.
+          # @param [Object] obj object to be converted into JSON string
+          # @return [String] JSON string representation of the object
+          def object_to_hash(obj)
+            if obj.respond_to?(:to_hash)
+              obj.to_hash
+            else
+              obj
+            end
+          end
+
+          # Build parameter value according to the given collection format.
+          # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+          def build_collection_param(param, collection_format)
+            case collection_format
+            when :csv
+              param.join(',')
+            when :ssv
+              param.join(' ')
+            when :tsv
+              param.join("\t")
+            when :pipes
+              param.join('|')
+            when :multi
+              # return the array directly as typhoeus will handle it as expected
+              param
+            else
+              fail "unknown collection format: #{collection_format.inspect}"
+            end
+          end
+        end
+      end
+    end
+  end
+end