freeclimb 5.1.0 → 5.3.0

data/lib/freeclimb/api_client.rb

@@ -1,21 +1,19 @@
-=begin
-#FreeClimb API
-
-#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@freeclimb.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.9.0
-
-=end
-
-require 'date'
-require 'json'
-require 'logger'
-require 'tempfile'
-require 'time'
-require 'typhoeus'
+# #FreeClimb API
+#
+# FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+#
+# The version of the OpenAPI document: 1.0.0
+# Contact: support@freeclimb.com
+# Generated by: https://openapi-generator.tech
+# OpenAPI Generator version: 7.9.0
+#
+
+require "date"
+require "json"
+require "logger"
+require "tempfile"
+require "time"
+require "typhoeus"
 
 module Freeclimb
   class ApiClient
@@ -33,8 +31,8 @@ module Freeclimb
       @config = config
       @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
       @default_headers = {
-        'Content-Type' => 'application/json',
-        'User-Agent' => @user_agent
+        "Content-Type" => "application/json",
+        "User-Agent" => @user_agent
       }
     end
 
@@ -56,25 +54,23 @@ module Freeclimb
 
       unless response.success?
         if response.timed_out?
-          fail ApiError.new('Connection timed out')
+          fail ApiError.new("Connection timed out")
         elsif response.code == 0
           # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
+          fail ApiError.new(code: 0,
+            message: response.return_message)
         else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body),
-               response.status_message
+          fail ApiError.new(code: response.code,
+            response_headers: response.headers,
+            response_body: response.body),
+            response.status_message
         end
       end
 
-      if opts[:return_type]
-        data = deserialize(response, opts[:return_type])
-      else
-        data = nil
+      data = if opts[:return_type]
+        deserialize(response, opts[:return_type])
       end
-      return data, response.code, response.headers
+      [data, response.code, response.headers]
     end
 
     # Builds the HTTP request
@@ -100,16 +96,16 @@ module Freeclimb
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
 
       req_opts = {
-        :method => http_method,
-        :headers => header_params,
-        :params => query_params,
-        :params_encoding => @config.params_encoding,
-        :timeout => @config.timeout,
-        :ssl_verifypeer => @config.verify_ssl,
-        :ssl_verifyhost => _verify_ssl_host,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        method: http_method,
+        headers: header_params,
+        params: query_params,
+        params_encoding: @config.params_encoding,
+        timeout: @config.timeout,
+        ssl_verifypeer: @config.verify_ssl,
+        ssl_verifyhost: _verify_ssl_host,
+        sslcert: @config.cert_file,
+        sslkey: @config.key_file,
+        verbose: @config.debugging
       }
 
       # set custom cert, if provided
@@ -117,14 +113,14 @@ module Freeclimb
 
       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
+        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 = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
+      download_file(request) if opts[:return_type] == "File"
       request
     end
 
@@ -136,16 +132,16 @@ module Freeclimb
     # @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' ||
-          header_params['Content-Type'] == 'multipart/form-data'
+      if header_params["Content-Type"] == "application/x-www-form-urlencoded" ||
+          header_params["Content-Type"] == "multipart/form-data"
         data = {}
         form_params.each do |key, value|
-          case value
+          data[key] = case value
           when ::File, ::Array, nil
             # let typhoeus handle File, Array and nil parameters
-            data[key] = value
+            value
           else
-            data[key] = value.to_s
+            value.to_s
           end
         end
       elsif body
@@ -167,14 +163,14 @@ module Freeclimb
       tempfile = nil
       encoding = nil
       request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
+        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-'
+          prefix = "download-"
         end
-        prefix = prefix + '-' unless prefix.end_with?('-')
+        prefix += "-" unless prefix.end_with?("-")
         encoding = response.body.encoding
         tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
         @tempfile = tempfile
@@ -186,9 +182,9 @@ module Freeclimb
       request.on_complete do |response|
         if tempfile
           tempfile.close
-          @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 "\
+          @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
@@ -203,7 +199,7 @@ module Freeclimb
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -215,22 +211,22 @@ module Freeclimb
 
       # 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 @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'
+      return body if return_type == "String"
 
       # ensuring a default content type
-      content_type = response.headers['Content-Type'] || 'application/json'
+      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]
+        data = JSON.parse("[#{body}]", symbolize_names: true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date Time).include?(return_type)
+        if %w[String Date Time].include?(return_type)
           data = body
         else
           raise e
@@ -247,28 +243,28 @@ module Freeclimb
     def convert_to_type(data, return_type)
       return nil if data.nil?
       case return_type
-      when 'String'
+      when "String"
         data.to_s
-      when 'Integer'
+      when "Integer"
         data.to_i
-      when 'Float'
+      when "Float"
         data.to_f
-      when 'Boolean'
+      when "Boolean"
         data == true
-      when 'Time'
+      when "Time"
         # parse date time (expecting ISO 8601 format)
         Time.parse data
-      when 'Date'
+      when "Date"
         # parse date time (expecting ISO 8601 format)
         Date.parse data
-      when 'Object'
+      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/
+      when /\AHash<String, (.+)>\z/
         # e.g. Hash<String, Integer>
         sub_type = $1
         {}.tap do |hash|
@@ -287,12 +283,12 @@ module Freeclimb
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.gsub(/.*[\/\\]/, "")
     end
 
     def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
+      path = "/#{path}".squeeze("/")
       @config.base_url(opts[:operation]) + path
     end
 
@@ -306,9 +302,9 @@ module Freeclimb
         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` or `header`'
+        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` or `header`"
         end
       end
     end
@@ -318,7 +314,7 @@ module Freeclimb
     # @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
+      @default_headers["User-Agent"] = @user_agent
     end
 
     # Return Accept header based on an array of accepts provided.
@@ -328,7 +324,7 @@ module Freeclimb
       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(',')
+      json_accept || accepts.join(",")
     end
 
     # Return Content-Type header based on an array of content types provided.
@@ -347,11 +343,10 @@ module Freeclimb
     # @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) }
+      local_body = if model.is_a?(Array)
+        model.map { |m| object_to_hash(m) }
       else
-        local_body = object_to_hash(model)
+        object_to_hash(model)
       end
       local_body.to_json
     end
@@ -372,13 +367,13 @@ module Freeclimb
     def build_collection_param(param, collection_format)
       case collection_format
       when :csv
-        param.join(',')
+        param.join(",")
       when :ssv
-        param.join(' ')
+        param.join(" ")
       when :tsv
         param.join("\t")
       when :pipes
-        param.join('|')
+        param.join("|")
       when :multi
         # return the array directly as typhoeus will handle it as expected
         param

data/lib/freeclimb/api_error.rb

@@ -1,14 +1,12 @@
-=begin
-#FreeClimb API
-
-#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@freeclimb.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.9.0
-
-=end
+# #FreeClimb API
+#
+# FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+#
+# The version of the OpenAPI document: 1.0.0
+# Contact: support@freeclimb.com
+# Generated by: https://openapi-generator.tech
+# OpenAPI Generator version: 7.9.0
+#
 
 module Freeclimb
   class ApiError < StandardError
@@ -21,17 +19,17 @@ module Freeclimb
     #   ApiError.new(:code => 404, :message => "Not Found")
     def initialize(arg = nil)
       if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
+        if arg.key?(:message) || arg.key?("message")
+          super(arg[:message] || arg["message"])
         else
-          super arg
+          super
         end
 
         arg.each do |k, v|
-          instance_variable_set "@#{k}", v
+          instance_variable_set :"@#{k}", v
         end
       else
-        super arg
+        super
       end
     end
 
@@ -41,10 +39,10 @@ module Freeclimb
     end
 
     def message
-      if @message.nil?
-        msg = "Error message: the server returns an error"
+      msg = if @message.nil?
+        "Error message: the server returns an error"
       else
-        msg = @message
+        @message
       end
 
       msg += "\nHTTP status code: #{code}" if code

data/lib/freeclimb/configuration.rb

@@ -1,14 +1,12 @@
-=begin
-#FreeClimb API
-
-#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
-
-The version of the OpenAPI document: 1.0.0
-Contact: support@freeclimb.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.9.0
-
-=end
+# #FreeClimb API
+#
+# FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+#
+# The version of the OpenAPI document: 1.0.0
+# Contact: support@freeclimb.com
+# Generated by: https://openapi-generator.tech
+# OpenAPI Generator version: 7.9.0
+#
 
 module Freeclimb
   class Configuration
@@ -138,9 +136,9 @@ module Freeclimb
     attr_accessor :force_ending_format
 
     def initialize
-      @scheme = 'https'
-      @host = 'www.freeclimb.com'
-      @base_path = '/apiserver'
+      @scheme = "https"
+      @host = "www.freeclimb.com"
+      @base_path = "/apiserver"
       @server_index = 0
       @server_operation_index = {}
       @server_variables = {}
@@ -173,24 +171,24 @@ module Freeclimb
 
     def scheme=(scheme)
       # remove :// from scheme
-      @scheme = scheme.sub(/:\/\//, '')
+      @scheme = scheme.sub("://", "")
     end
 
     def host=(host)
       # remove http(s):// and anything after a slash
-      @host = host.sub(/https?:\/\//, '').split('/').first
+      @host = host.sub(/https?:\/\//, "").split("/").first
     end
 
     def base_path=(base_path)
       # Add leading and trailing slashes to base_path
-      @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = '' if @base_path == '/'
+      @base_path = "/#{base_path}".squeeze("/")
+      @base_path = "" if @base_path == "/"
     end
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
       index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
+      return "#{scheme}://#{[host, base_path].join("/").squeeze("/")}".sub(/\/+\z/, "") if index.nil?
 
       server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
     end
@@ -209,19 +207,19 @@ module Freeclimb
 
     # Gets Basic Auth token string
     def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+      "Basic " + ["#{username}:#{password}"].pack("m").delete("\r\n")
     end
 
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'fc' =>
+        "fc" =>
           {
-            type: 'basic',
-            in: 'header',
-            key: 'Authorization',
+            type: "basic",
+            in: "header",
+            key: "Authorization",
             value: basic_auth_token
-          },
+          }
       }
     end
 
@@ -230,7 +228,7 @@ module Freeclimb
       [
         {
           url: "https://www.freeclimb.com/apiserver",
-          description: "No description provided",
+          description: "No description provided"
         }
       ]
     end
@@ -244,10 +242,10 @@ module Freeclimb
     # @param index array index of the server settings
     # @param variables hash of variable and the corresponding value
     def server_url(index, variables = {}, servers = nil)
-      servers = server_settings if servers == nil
+      servers = server_settings if servers.nil?
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
+      if index < 0 || index >= servers.size
         fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
       end
 
@@ -259,7 +257,7 @@ module Freeclimb
       # go through variable and assign a value
       server[:variables].each do |name, variable|
         if variables.key?(name)
-          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
+          if !server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name])
             url.gsub! "{" + name.to_s + "}", variables[name]
           else
             fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."