Class: DocRaptor::DocApi
- Inherits:
-
Object
- Object
- DocRaptor::DocApi
- Defined in:
- lib/docraptor/api/doc_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_async_doc(doc, opts = {}) ⇒ AsyncDoc
Creates a document asynchronously.
-
#create_async_doc_with_http_info(doc, opts = {}) ⇒ Array<(AsyncDoc, Fixnum, Hash)>
Creates a document asynchronously.
-
#create_doc(doc, opts = {}) ⇒ String
Creates a document synchronously.
-
#create_doc_with_http_info(doc, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Creates a document synchronously.
-
#create_hosted_async_doc(doc, opts = {}) ⇒ AsyncDoc
Creates a hosted document asynchronously.
-
#create_hosted_async_doc_with_http_info(doc, opts = {}) ⇒ Array<(AsyncDoc, Fixnum, Hash)>
Creates a hosted document asynchronously.
-
#create_hosted_doc(doc, opts = {}) ⇒ DocStatus
Creates a hosted document synchronously.
-
#create_hosted_doc_with_http_info(doc, opts = {}) ⇒ Array<(DocStatus, Fixnum, Hash)>
Creates a hosted document synchronously.
-
#expire(id, opts = {}) ⇒ nil
Expires a previously created hosted doc.
-
#expire_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Expires a previously created hosted doc.
-
#get_async_doc(id, opts = {}) ⇒ String
Downloads a finished document.
-
#get_async_doc_status(id, opts = {}) ⇒ DocStatus
Check on the status of an asynchronously created document.
-
#get_async_doc_status_with_http_info(id, opts = {}) ⇒ Array<(DocStatus, Fixnum, Hash)>
Check on the status of an asynchronously created document.
-
#get_async_doc_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Downloads a finished document.
-
#initialize(api_client = ApiClient.default) ⇒ DocApi
constructor
A new instance of DocApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/docraptor/api/doc_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_async_doc(doc, opts = {}) ⇒ AsyncDoc
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.
26 27 28 29 |
# 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 |
#create_async_doc_with_http_info(doc, opts = {}) ⇒ Array<(AsyncDoc, Fixnum, Hash)>
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.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# 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 = {} # 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_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_doc(doc, opts = {}) ⇒ String
Creates a document synchronously.
76 77 78 79 |
# File 'lib/docraptor/api/doc_api.rb', line 76 def create_doc(doc, opts = {}) data, _status_code, _headers = create_doc_with_http_info(doc, opts) data end |
#create_doc_with_http_info(doc, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Creates a document synchronously.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/docraptor/api/doc_api.rb', line 85 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 = {} # 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 => 'String') 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 |
#create_hosted_async_doc(doc, opts = {}) ⇒ AsyncDoc
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.
126 127 128 129 |
# File 'lib/docraptor/api/doc_api.rb', line 126 def create_hosted_async_doc(doc, opts = {}) data, _status_code, _headers = create_hosted_async_doc_with_http_info(doc, opts) data end |
#create_hosted_async_doc_with_http_info(doc, opts = {}) ⇒ Array<(AsyncDoc, Fixnum, Hash)>
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.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/docraptor/api/doc_api.rb', line 135 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 |
#create_hosted_doc(doc, opts = {}) ⇒ DocStatus
Creates a hosted document synchronously.
176 177 178 179 |
# File 'lib/docraptor/api/doc_api.rb', line 176 def create_hosted_doc(doc, opts = {}) data, _status_code, _headers = create_hosted_doc_with_http_info(doc, opts) data end |
#create_hosted_doc_with_http_info(doc, opts = {}) ⇒ Array<(DocStatus, Fixnum, Hash)>
Creates a hosted document synchronously.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/docraptor/api/doc_api.rb', line 185 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 |
#expire(id, opts = {}) ⇒ nil
Expires a previously created hosted doc.
226 227 228 229 |
# File 'lib/docraptor/api/doc_api.rb', line 226 def expire(id, opts = {}) expire_with_http_info(id, opts) nil end |
#expire_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Expires a previously created hosted doc.
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/docraptor/api/doc_api.rb', line 235 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 = {} # 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 |
#get_async_doc(id, opts = {}) ⇒ String
Downloads a finished document.
275 276 277 278 |
# File 'lib/docraptor/api/doc_api.rb', line 275 def get_async_doc(id, opts = {}) data, _status_code, _headers = get_async_doc_with_http_info(id, opts) data end |
#get_async_doc_status(id, opts = {}) ⇒ DocStatus
Check on the status of an asynchronously created document.
325 326 327 328 |
# File 'lib/docraptor/api/doc_api.rb', line 325 def get_async_doc_status(id, opts = {}) data, _status_code, _headers = get_async_doc_status_with_http_info(id, opts) data end |
#get_async_doc_status_with_http_info(id, opts = {}) ⇒ Array<(DocStatus, Fixnum, Hash)>
Check on the status of an asynchronously created document.
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/docraptor/api/doc_api.rb', line 334 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' + '}', 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 = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, 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#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_async_doc_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Downloads a finished document.
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/docraptor/api/doc_api.rb', line 284 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' + '}', 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 = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') 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 |