docraptor 2.0.0 → 3.0.0

data/lib/docraptor/api/doc_api.rb

@@ -3,14 +3,14 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0-SNAPSHOT
 
 =end
 
-require 'uri'
+require 'cgi'
 
 module DocRaptor
   class DocApi
@@ -20,7 +20,7 @@ module DocRaptor
       @api_client = api_client
     end
     # Creates a document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [AsyncDoc]
     def create_async_doc(doc, opts = {})
@@ -29,9 +29,9 @@ module DocRaptor
     end
 
     # Creates a document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AsyncDoc, Fixnum, Hash)>] AsyncDoc data, response status code and response headers
+    # @return [Array<(AsyncDoc, Integer, Hash)>] AsyncDoc data, response status code and response headers
     def create_async_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.create_async_doc ...'
@@ -44,33 +44,44 @@ module DocRaptor
       local_var_path = '/async_docs'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(doc)
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AsyncDoc'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.create_async_doc",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'AsyncDoc')
+        :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: DocApi#create_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Creates a document synchronously.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [String]
     def create_doc(doc, opts = {})
@@ -79,9 +90,9 @@ module DocRaptor
     end
 
     # Creates a document synchronously.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
     def create_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.create_doc ...'
@@ -94,33 +105,44 @@ module DocRaptor
       local_var_path = '/docs'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(doc)
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.create_doc",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'String')
+        :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: DocApi#create_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Creates a hosted document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [AsyncDoc]
     def create_hosted_async_doc(doc, opts = {})
@@ -129,9 +151,9 @@ module DocRaptor
     end
 
     # Creates a hosted document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AsyncDoc, Fixnum, Hash)>] AsyncDoc data, response status code and response headers
+    # @return [Array<(AsyncDoc, Integer, Hash)>] AsyncDoc data, response status code and response headers
     def create_hosted_async_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.create_hosted_async_doc ...'
@@ -144,33 +166,44 @@ module DocRaptor
       local_var_path = '/hosted_async_docs'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(doc)
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AsyncDoc'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.create_hosted_async_doc",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'AsyncDoc')
+        :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: DocApi#create_hosted_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Creates a hosted document synchronously.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [DocStatus]
     def create_hosted_doc(doc, opts = {})
@@ -179,9 +212,9 @@ module DocRaptor
     end
 
     # Creates a hosted document synchronously.
-    # @param doc The document to be created.
+    # @param doc [Doc] The document to be created.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(DocStatus, Fixnum, Hash)>] DocStatus data, response status code and response headers
+    # @return [Array<(DocStatus, Integer, Hash)>] DocStatus data, response status code and response headers
     def create_hosted_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.create_hosted_doc ...'
@@ -194,33 +227,44 @@ module DocRaptor
       local_var_path = '/hosted_docs'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(doc)
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DocStatus'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.create_hosted_doc",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'DocStatus')
+        :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: DocApi#create_hosted_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Expires a previously created hosted doc.
-    # @param id The download_id returned from status request or hosted document response.
+    # @param id [String] The download_id returned from status request or hosted document response.
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def expire(id, opts = {})
@@ -229,9 +273,9 @@ module DocRaptor
     end
 
     # Expires a previously created hosted doc.
-    # @param id The download_id returned from status request or hosted document response.
+    # @param id [String] The download_id returned from status request or hosted document response.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def expire_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.expire ...'
@@ -241,35 +285,45 @@ module DocRaptor
         fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.expire"
       end
       # resource path
-      local_var_path = '/expire/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/expire/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
+      header_params = opts[:header_params] || {}
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.expire",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names)
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DocApi#expire\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Downloads a finished document.
-    # @param id The download_id returned from an async status request or callback.
+    # @param id [String] The download_id returned from an async status request or callback.
     # @param [Hash] opts the optional parameters
     # @return [String]
     def get_async_doc(id, opts = {})
@@ -278,9 +332,9 @@ module DocRaptor
     end
 
     # Downloads a finished document.
-    # @param id The download_id returned from an async status request or callback.
+    # @param id [String] The download_id returned from an async status request or callback.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
     def get_async_doc_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.get_async_doc ...'
@@ -290,36 +344,47 @@ module DocRaptor
         fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.get_async_doc"
       end
       # resource path
-      local_var_path = '/download/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/download/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.get_async_doc",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'String')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DocApi#get_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Check on the status of an asynchronously created document.
-    # @param id The status_id returned when creating an asynchronous document.
+    # @param id [String] The status_id returned when creating an asynchronous document.
     # @param [Hash] opts the optional parameters
     # @return [DocStatus]
     def get_async_doc_status(id, opts = {})
@@ -328,9 +393,9 @@ module DocRaptor
     end
 
     # Check on the status of an asynchronously created document.
-    # @param id The status_id returned when creating an asynchronous document.
+    # @param id [String] The status_id returned when creating an asynchronous document.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(DocStatus, Fixnum, Hash)>] DocStatus data, response status code and response headers
+    # @return [Array<(DocStatus, Integer, Hash)>] DocStatus data, response status code and response headers
     def get_async_doc_status_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DocApi.get_async_doc_status ...'
@@ -340,29 +405,39 @@ module DocRaptor
         fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.get_async_doc_status"
       end
       # resource path
-      local_var_path = '/status/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/status/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DocStatus'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DocApi.get_async_doc_status",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'DocStatus')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DocApi#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end