docraptor 1.2.0 → 2.0.0

data/lib/docraptor/api/doc_api.rb

@@ -1,16 +1,16 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.19
 
 =end
 
-require "uri"
+require 'uri'
 
 module DocRaptor
   class DocApi
@@ -19,32 +19,29 @@ module DocRaptor
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-
-    #
-    # Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
+    # 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 [Hash] opts the optional parameters
     # @return [AsyncDoc]
     def create_async_doc(doc, opts = {})
       data, _status_code, _headers = create_async_doc_with_http_info(doc, opts)
-      return data
+      data
     end
 
-    #
-    # Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
+    # 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 [Hash] opts the optional parameters
     # @return [Array<(AsyncDoc, Fixnum, 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 ..."
+        @api_client.config.logger.debug 'Calling API: DocApi.create_async_doc ...'
       end
       # verify the required parameter 'doc' is set
       if @api_client.config.client_side_validation && doc.nil?
         fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_async_doc"
       end
       # resource path
-      local_var_path = "/async_docs"
+      local_var_path = '/async_docs'
 
       # query parameters
       query_params = {}
@@ -72,32 +69,29 @@ module DocRaptor
       end
       return data, status_code, headers
     end
-
-    #
     # Creates a document synchronously.
     # @param doc The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [String]
     def create_doc(doc, opts = {})
       data, _status_code, _headers = create_doc_with_http_info(doc, opts)
-      return data
+      data
     end
 
-    #
     # Creates a document synchronously.
     # @param 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
     def create_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DocApi.create_doc ..."
+        @api_client.config.logger.debug 'Calling API: DocApi.create_doc ...'
       end
       # verify the required parameter 'doc' is set
       if @api_client.config.client_side_validation && doc.nil?
         fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_doc"
       end
       # resource path
-      local_var_path = "/docs"
+      local_var_path = '/docs'
 
       # query parameters
       query_params = {}
@@ -125,32 +119,178 @@ module DocRaptor
       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 [Hash] opts the optional parameters
+    # @return [AsyncDoc]
+    def create_hosted_async_doc(doc, opts = {})
+      data, _status_code, _headers = create_hosted_async_doc_with_http_info(doc, opts)
+      data
+    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 [Hash] opts the optional parameters
+    # @return [Array<(AsyncDoc, Fixnum, 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 ...'
+      end
+      # verify the required parameter 'doc' is set
+      if @api_client.config.client_side_validation && doc.nil?
+        fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_hosted_async_doc"
+      end
+      # resource path
+      local_var_path = '/hosted_async_docs'
+
+      # query parameters
+      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'])
+
+      # form parameters
+      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,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AsyncDoc')
+      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 [Hash] opts the optional parameters
+    # @return [DocStatus]
+    def create_hosted_doc(doc, opts = {})
+      data, _status_code, _headers = create_hosted_doc_with_http_info(doc, opts)
+      data
+    end
+
+    # Creates a hosted document synchronously.
+    # @param 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
+    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 ...'
+      end
+      # verify the required parameter 'doc' is set
+      if @api_client.config.client_side_validation && doc.nil?
+        fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_hosted_doc"
+      end
+      # resource path
+      local_var_path = '/hosted_docs'
+
+      # query parameters
+      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'])
+
+      # form parameters
+      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,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DocStatus')
+      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 [Hash] opts the optional parameters
+    # @return [nil]
+    def expire(id, opts = {})
+      expire_with_http_info(id, opts)
+      nil
+    end
+
+    # Expires a previously created hosted doc.
+    # @param id 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
+    def expire_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocApi.expire ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.expire"
+      end
+      # resource path
+      local_var_path = '/expire/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      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'])
+
+      # form parameters
+      form_params = {}
 
-    #
-    # Downloads a document.
-    # @param id The download_id returned from status request or a callback.
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      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 [Hash] opts the optional parameters
     # @return [String]
     def get_async_doc(id, opts = {})
       data, _status_code, _headers = get_async_doc_with_http_info(id, opts)
-      return data
+      data
     end
 
-    #
-    # Downloads a document.
-    # @param id The download_id returned from status request or a callback.
+    # Downloads a finished document.
+    # @param id 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
     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 ..."
+        @api_client.config.logger.debug 'Calling API: DocApi.get_async_doc ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
         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' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -178,32 +318,29 @@ module DocRaptor
       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 [Hash] opts the optional parameters
-    # @return [AsyncDocStatus]
+    # @return [DocStatus]
     def get_async_doc_status(id, opts = {})
       data, _status_code, _headers = get_async_doc_status_with_http_info(id, opts)
-      return data
+      data
     end
 
-    #
     # Check on the status of an asynchronously created document.
     # @param id The status_id returned when creating an asynchronous document.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AsyncDocStatus, Fixnum, Hash)>] AsyncDocStatus data, response status code and response headers
+    # @return [Array<(DocStatus, Fixnum, 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 ..."
+        @api_client.config.logger.debug 'Calling API: DocApi.get_async_doc_status ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
         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' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -225,7 +362,7 @@ module DocRaptor
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'AsyncDocStatus')
+        :return_type => 'DocStatus')
       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

data/lib/docraptor/api_client.rb

@@ -1,12 +1,12 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -15,7 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
+require 'addressable/uri'
 
 module DocRaptor
   class ApiClient
@@ -33,7 +33,7 @@ module DocRaptor
       @config = config
       @user_agent = "ruby-swagger-#{VERSION}"
       @default_headers = {
-        'Content-Type' => "application/json",
+        'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
       }
     end
@@ -63,7 +63,7 @@ module DocRaptor
                             :message => response.return_message)
         else
           fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
+                            :response_headers => response.headers.to_h,
                             :response_body => response.body),
                response.status_message
         end
@@ -112,6 +112,8 @@ module DocRaptor
         :verbose => @config.debugging
       }
 
+      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+
       # set custom cert, if provided
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
@@ -137,7 +139,7 @@ module DocRaptor
     # @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.
@@ -201,12 +203,12 @@ module DocRaptor
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map {|item| convert_to_type(item, sub_type) }
+        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) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
         # models, e.g. Pet
@@ -228,7 +230,7 @@ module DocRaptor
       encoding = nil
       request.on_headers do |response|
         content_disposition = response.headers['Content-Disposition']
-        if content_disposition and content_disposition =~ /filename=/i
+        if content_disposition && content_disposition =~ /filename=/i
           filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
           prefix = sanitize_filename(filename)
         else
@@ -264,7 +266,7 @@ module DocRaptor
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      Addressable::URI.encode(@config.base_url + path)
     end
 
     # Builds the HTTP request body
@@ -280,7 +282,7 @@ module DocRaptor
         data = {}
         form_params.each do |key, value|
           case value
-          when File, Array, nil
+          when ::File, ::Array, nil
             # let typhoeus handle File, Array and nil parameters
             data[key] = value
           else
@@ -327,7 +329,7 @@ module DocRaptor
       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) }
-      return json_accept || accepts.join(',')
+      json_accept || accepts.join(',')
     end
 
     # Return Content-Type header based on an array of content types provided.
@@ -338,7 +340,7 @@ module DocRaptor
       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) }
-      return json_content_type || content_types.first
+      json_content_type || content_types.first
     end
 
     # Convert object (array, hash, object, etc) to JSON string.
@@ -348,7 +350,7 @@ module DocRaptor
       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 = model.map { |m| object_to_hash(m) }
       else
         local_body = object_to_hash(model)
       end

data/lib/docraptor/api_error.rb

@@ -1,12 +1,12 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/docraptor/configuration.rb

@@ -1,16 +1,16 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.19
 
 =end
 
-require 'uri'
+require 'addressable/uri'
 
 module DocRaptor
   class Configuration
@@ -170,12 +170,12 @@ module DocRaptor
     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 = '' if @base_path == '/'
     end
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).

data/lib/docraptor/models/async_doc.rb

@@ -1,24 +1,22 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.19
 
 =end
 
 require 'date'
 
 module DocRaptor
-
   class AsyncDoc
-    # The identifier used to get the status of the document using the status api.
+    # The identifier used to get the status of the document using the status API.
     attr_accessor :status_id
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,25 +37,24 @@ module DocRaptor
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'status_id')
         self.status_id = attributes[:'status_id']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -87,10 +84,10 @@ module DocRaptor
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -172,7 +169,7 @@ module DocRaptor
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -185,5 +182,4 @@ module DocRaptor
     end
 
   end
-
 end