class DocRaptor::DocApi
Attributes
Public Class Methods
# File lib/docraptor/api/doc_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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 [Doc] @param [Hash] opts the optional parameters @return [AsyncDoc]
# File lib/docraptor/api/doc_api.rb, line 26 def create_async_doc(doc, opts = {}) data, _status_code, _headers = create_async_doc_with_http_info(doc, opts) data 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 [Doc] @param [Hash] opts the optional parameters @return [Array<(AsyncDoc
, Integer, Hash)>] AsyncDoc
data, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 35 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 ...' 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' # 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(['*/*']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) 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 => 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 [Doc] @param [Hash] opts the optional parameters @return [String]
# File lib/docraptor/api/doc_api.rb, line 92 def create_doc(doc, opts = {}) data, _status_code, _headers = create_doc_with_http_info(doc, opts) data end
Creates a document synchronously. @param doc [Doc] @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 101 def create_doc_with_http_info(doc, opts = {}) if @api_client.config.debugging @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' # 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(['*/*']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) 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 => 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 [Doc] @param [Hash] opts the optional parameters @return [AsyncDoc]
# File lib/docraptor/api/doc_api.rb, line 158 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 [Doc] @param [Hash] opts the optional parameters @return [Array<(AsyncDoc
, Integer, Hash)>] AsyncDoc
data, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 167 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 = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) 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 => 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 [Doc] The document to be created. @param [Hash] opts the optional parameters @return [DocStatus]
# File lib/docraptor/api/doc_api.rb, line 224 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 [Doc] The document to be created. @param [Hash] opts the optional parameters @return [Array<(DocStatus
, Integer, Hash)>] DocStatus
data, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 233 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 = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) 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 => 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 [String] The download_id returned from status request or hosted document response. @param [Hash] opts the optional parameters @return [nil]
# File lib/docraptor/api/doc_api.rb, line 290 def expire(id, opts = {}) expire_with_http_info(id, opts) nil end
Expires a previously created hosted doc. @param id [String] The download_id returned from status request or hosted document response. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 299 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' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) 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, :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 [String] The download_id returned from an async status request or callback. @param [Hash] opts the optional parameters @return [String]
# File lib/docraptor/api/doc_api.rb, line 349 def get_async_doc(id, opts = {}) data, _status_code, _headers = get_async_doc_with_http_info(id, opts) data end
Check on the status of an asynchronously created document. @param id [String] The status_id returned when creating an asynchronous document. @param [Hash] opts the optional parameters @return [DocStatus]
# File lib/docraptor/api/doc_api.rb, line 410 def get_async_doc_status(id, opts = {}) data, _status_code, _headers = get_async_doc_status_with_http_info(id, opts) data end
Check on the status of an asynchronously created document. @param id [String] The status_id returned when creating an asynchronous document. @param [Hash] opts the optional parameters @return [Array<(DocStatus
, Integer, Hash)>] DocStatus
data, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 419 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 ...' 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' + '}', CGI.escape(id.to_s)) # 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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) 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 => 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 return data, status_code, headers end
Downloads a finished document. @param id [String] The download_id returned from an async status request or callback. @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
# File lib/docraptor/api/doc_api.rb, line 358 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 ...' 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' + '}', CGI.escape(id.to_s)) # 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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) 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 => 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