Class: CloudmersiveConvertApiClient::ConvertTemplateApi
- Inherits:
-
Object
- Object
- CloudmersiveConvertApiClient::ConvertTemplateApi
- Defined in:
- lib/cloudmersive-convert-api-client/api/convert_template_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#convert_template_apply_docx_template(input_file, opts = {}) ⇒ String
Apply Word DOCX template Apply operations to fill in a Word DOCX template by replacing target template/placeholder strings in the DOCX with values, generating a final Word DOCX result.
-
#convert_template_apply_docx_template_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Apply Word DOCX template Apply operations to fill in a Word DOCX template by replacing target template/placeholder strings in the DOCX with values, generating a final Word DOCX result.
-
#convert_template_apply_html_template(value, opts = {}) ⇒ HtmlTemplateApplicationResponse
Apply HTML template Apply operations to fill in an HTML template, generating a final HTML result.
-
#convert_template_apply_html_template_with_http_info(value, opts = {}) ⇒ Array<(HtmlTemplateApplicationResponse, Fixnum, Hash)>
Apply HTML template Apply operations to fill in an HTML template, generating a final HTML result.
-
#initialize(api_client = ApiClient.default) ⇒ ConvertTemplateApi
constructor
A new instance of ConvertTemplateApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ConvertTemplateApi
Returns a new instance of ConvertTemplateApi.
19 20 21 |
# File 'lib/cloudmersive-convert-api-client/api/convert_template_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cloudmersive-convert-api-client/api/convert_template_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#convert_template_apply_docx_template(input_file, opts = {}) ⇒ String
Apply Word DOCX template Apply operations to fill in a Word DOCX template by replacing target template/placeholder strings in the DOCX with values, generating a final Word DOCX result. For example, you could create a Word Document invoice containing strings such as "FirstName" and "LastName" and then replace these values with "John" and "Smith".
28 29 30 31 |
# File 'lib/cloudmersive-convert-api-client/api/convert_template_api.rb', line 28 def convert_template_apply_docx_template(input_file, opts = {}) data, _status_code, _headers = convert_template_apply_docx_template_with_http_info(input_file, opts) data end |
#convert_template_apply_docx_template_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Apply Word DOCX template Apply operations to fill in a Word DOCX template by replacing target template/placeholder strings in the DOCX with values, generating a final Word DOCX result. For example, you could create a Word Document invoice containing strings such as "FirstName" and "LastName" and then replace these values with "John" and "Smith".
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 72 73 74 75 76 77 78 79 |
# File 'lib/cloudmersive-convert-api-client/api/convert_template_api.rb', line 39 def convert_template_apply_docx_template_with_http_info(input_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertTemplateApi.convert_template_apply_docx_template ...' end # verify the required parameter 'input_file' is set if @api_client.config.client_side_validation && input_file.nil? fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertTemplateApi.convert_template_apply_docx_template" end # resource path local_var_path = '/convert/template/docx/apply' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) header_params[:'templateDefinition'] = opts[:'template_definition'] if !opts[:'template_definition'].nil? # form parameters form_params = {} form_params['inputFile'] = input_file # http body (model) post_body = nil auth_names = ['Apikey'] 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: ConvertTemplateApi#convert_template_apply_docx_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#convert_template_apply_html_template(value, opts = {}) ⇒ HtmlTemplateApplicationResponse
Apply HTML template Apply operations to fill in an HTML template, generating a final HTML result
85 86 87 88 |
# File 'lib/cloudmersive-convert-api-client/api/convert_template_api.rb', line 85 def convert_template_apply_html_template(value, opts = {}) data, _status_code, _headers = convert_template_apply_html_template_with_http_info(value, opts) data end |
#convert_template_apply_html_template_with_http_info(value, opts = {}) ⇒ Array<(HtmlTemplateApplicationResponse, Fixnum, Hash)>
Apply HTML template Apply operations to fill in an HTML template, generating a final HTML result
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 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/cloudmersive-convert-api-client/api/convert_template_api.rb', line 95 def convert_template_apply_html_template_with_http_info(value, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConvertTemplateApi.convert_template_apply_html_template ...' end # verify the required parameter 'value' is set if @api_client.config.client_side_validation && value.nil? fail ArgumentError, "Missing the required parameter 'value' when calling ConvertTemplateApi.convert_template_apply_html_template" end # resource path local_var_path = '/convert/template/html/apply' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(value) auth_names = ['Apikey'] 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 => 'HtmlTemplateApplicationResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConvertTemplateApi#convert_template_apply_html_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |