Class: CloudmersiveConvertApiClient::TransformDocumentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/api/transform_document_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransformDocumentApi

Returns a new instance of TransformDocumentApi.



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_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/transform_document_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#transform_document_docx_replace(match_string, replace_string, opts = {}) ⇒ String

Replace string in Word DOCX document, return result Replace all instances of a string in an Office Word Document (docx)

Parameters:

  • match_string —

    String to search for and match against, to be replaced

  • replace_string —

    String to replace the matched values with

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

  • :match_case (BOOLEAN) —

    Optional: True if the case should be matched, false for case insensitive match. Default is false.

Returns:

  • (String) 


31
32
33
34
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 31

def transform_document_docx_replace(match_string, replace_string, opts = {})
  data, _status_code, _headers = transform_document_docx_replace_with_http_info(match_string, replace_string, opts)
  data
end

#transform_document_docx_replace_edit_session(match_string, replace_string, opts = {}) ⇒ DocumentTransformEditSession

Replace string in Word DOCX document, return edit session Replace all instances of a string in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

Parameters:

  • match_string —

    String to search for and match against, to be replaced

  • replace_string —

    String to replace the matched values with

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

  • :match_case (BOOLEAN) —

    Optional: True if the case should be matched, false for case insensitive match. Default is false.

Returns:



100
101
102
103
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 100

def transform_document_docx_replace_edit_session(match_string, replace_string, opts = {})
  data, _status_code, _headers = transform_document_docx_replace_edit_session_with_http_info(match_string, replace_string, opts)
  data
end

#transform_document_docx_replace_edit_session_with_http_info(match_string, replace_string, opts = {}) ⇒ Array<(DocumentTransformEditSession, Fixnum, Hash)>

Replace string in Word DOCX document, return edit session Replace all instances of a string in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

Parameters:

  • match_string —

    String to search for and match against, to be replaced

  • replace_string —

    String to replace the matched values with

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

  • :match_case (BOOLEAN) —

    Optional: True if the case should be matched, false for case insensitive match. Default is false.

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 114

def transform_document_docx_replace_edit_session_with_http_info(match_string, replace_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_replace_edit_session ...'
  end
  # verify the required parameter 'match_string' is set
  if @api_client.config.client_side_validation && match_string.nil?
    fail ArgumentError, "Missing the required parameter 'match_string' when calling TransformDocumentApi.transform_document_docx_replace_edit_session"
  end
  # verify the required parameter 'replace_string' is set
  if @api_client.config.client_side_validation && replace_string.nil?
    fail ArgumentError, "Missing the required parameter 'replace_string' when calling TransformDocumentApi.transform_document_docx_replace_edit_session"
  end
  # resource path
  local_var_path = '/convert/transform/docx/replace-all/edit-session'

  # 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'])
  header_params[:'matchString'] = match_string
  header_params[:'replaceString'] = replace_string
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'matchCase'] = opts[:'match_case'] if !opts[:'match_case'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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 => 'DocumentTransformEditSession')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransformDocumentApi#transform_document_docx_replace_edit_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transform_document_docx_replace_with_http_info(match_string, replace_string, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Replace string in Word DOCX document, return result Replace all instances of a string in an Office Word Document (docx)

Parameters:

  • match_string —

    String to search for and match against, to be replaced

  • replace_string —

    String to replace the matched values with

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

  • :match_case (BOOLEAN) —

    Optional: True if the case should be matched, false for case insensitive match. Default is false.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 45

def transform_document_docx_replace_with_http_info(match_string, replace_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_replace ...'
  end
  # verify the required parameter 'match_string' is set
  if @api_client.config.client_side_validation && match_string.nil?
    fail ArgumentError, "Missing the required parameter 'match_string' when calling TransformDocumentApi.transform_document_docx_replace"
  end
  # verify the required parameter 'replace_string' is set
  if @api_client.config.client_side_validation && replace_string.nil?
    fail ArgumentError, "Missing the required parameter 'replace_string' when calling TransformDocumentApi.transform_document_docx_replace"
  end
  # resource path
  local_var_path = '/convert/transform/docx/replace-all'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'matchString'] = match_string
  header_params[:'replaceString'] = replace_string
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'matchCase'] = opts[:'match_case'] if !opts[:'match_case'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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: TransformDocumentApi#transform_document_docx_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transform_document_docx_table_fill_in(request, opts = {}) ⇒ String

Fill in data in a table in a Word DOCX document, return result Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


165
166
167
168
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 165

def transform_document_docx_table_fill_in(request, opts = {})
  data, _status_code, _headers = transform_document_docx_table_fill_in_with_http_info(request, opts)
  data
end

#transform_document_docx_table_fill_in_edit_session(request, opts = {}) ⇒ DocumentTransformEditSession

Fill in data in a table in a Word DOCX document, return edit session Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 219

def transform_document_docx_table_fill_in_edit_session(request, opts = {})
  data, _status_code, _headers = transform_document_docx_table_fill_in_edit_session_with_http_info(request, opts)
  data
end

#transform_document_docx_table_fill_in_edit_session_with_http_info(request, opts = {}) ⇒ Array<(DocumentTransformEditSession, Fixnum, Hash)>

Fill in data in a table in a Word DOCX document, return edit session Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



229
230
231
232
233
234
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
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 229

def transform_document_docx_table_fill_in_edit_session_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_table_fill_in_edit_session ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling TransformDocumentApi.transform_document_docx_table_fill_in_edit_session"
  end
  # resource path
  local_var_path = '/convert/transform/docx/table/fill/data/edit-session'

  # 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(request)
  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 => 'DocumentTransformEditSession')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransformDocumentApi#transform_document_docx_table_fill_in_edit_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transform_document_docx_table_fill_in_multi(request, opts = {}) ⇒ String

Fill in data in multiple tables in a Word DOCX document, return result Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


273
274
275
276
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 273

def transform_document_docx_table_fill_in_multi(request, opts = {})
  data, _status_code, _headers = transform_document_docx_table_fill_in_multi_with_http_info(request, opts)
  data
end

#transform_document_docx_table_fill_in_multi_with_http_info(request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Fill in data in multiple tables in a Word DOCX document, return result Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



283
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
321
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 283

def transform_document_docx_table_fill_in_multi_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_table_fill_in_multi ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling TransformDocumentApi.transform_document_docx_table_fill_in_multi"
  end
  # resource path
  local_var_path = '/convert/transform/docx/table/fill/data/multi'

  # 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(request)
  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: TransformDocumentApi#transform_document_docx_table_fill_in_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transform_document_docx_table_fill_in_with_http_info(request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Fill in data in a table in a Word DOCX document, return result Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



175
176
177
178
179
180
181
182
183
184
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
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 175

def transform_document_docx_table_fill_in_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_docx_table_fill_in ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling TransformDocumentApi.transform_document_docx_table_fill_in"
  end
  # resource path
  local_var_path = '/convert/transform/docx/table/fill/data'

  # 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(['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(request)
  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: TransformDocumentApi#transform_document_docx_table_fill_in\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transform_document_pptx_replace(match_string, replace_string, opts = {}) ⇒ String

Replace string in PowerPoint PPTX presentation, return result Replace all instances of a string in an Office PowerPoint Document (pptx)

Parameters:

  • match_string —

    String to search for and match against, to be replaced

  • replace_string —

    String to replace the matched values with

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

  • :match_case (BOOLEAN) —

    Optional: True if the case should be matched, false for case insensitive match. Default is false.

Returns:

  • (String) 


331
332
333
334
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 331

def transform_document_pptx_replace(match_string, replace_string, opts = {})
  data, _status_code, _headers = transform_document_pptx_replace_with_http_info(match_string, replace_string, opts)
  data
end

#transform_document_pptx_replace_with_http_info(match_string, replace_string, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Replace string in PowerPoint PPTX presentation, return result Replace all instances of a string in an Office PowerPoint Document (pptx)

Parameters:

  • match_string —

    String to search for and match against, to be replaced

  • replace_string —

    String to replace the matched values with

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file (File) —

    Optional: Input file to perform the operation on.

  • :input_file_url (String) —

    Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

  • :match_case (BOOLEAN) —

    Optional: True if the case should be matched, false for case insensitive match. Default is false.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/cloudmersive-convert-api-client/api/transform_document_api.rb', line 345

def transform_document_pptx_replace_with_http_info(match_string, replace_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransformDocumentApi.transform_document_pptx_replace ...'
  end
  # verify the required parameter 'match_string' is set
  if @api_client.config.client_side_validation && match_string.nil?
    fail ArgumentError, "Missing the required parameter 'match_string' when calling TransformDocumentApi.transform_document_pptx_replace"
  end
  # verify the required parameter 'replace_string' is set
  if @api_client.config.client_side_validation && replace_string.nil?
    fail ArgumentError, "Missing the required parameter 'replace_string' when calling TransformDocumentApi.transform_document_pptx_replace"
  end
  # resource path
  local_var_path = '/convert/transform/pptx/replace-all'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'matchString'] = match_string
  header_params[:'replaceString'] = replace_string
  header_params[:'inputFileUrl'] = opts[:'input_file_url'] if !opts[:'input_file_url'].nil?
  header_params[:'matchCase'] = opts[:'match_case'] if !opts[:'match_case'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?

  # 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: TransformDocumentApi#transform_document_pptx_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end