Class: AsposeCellsCloud::CellsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/api/cells_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_sid, app_key, app_version = 'v3.0', app_host = 'api.aspose.cloud', api_client = ApiClient.default) ⇒ CellsApi

Returns a new instance of CellsApi.



29
30
31
32
33
34
35
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 29

def initialize(app_sid,app_key, app_version = 'v3.0', app_host = 'api.aspose.cloud',  api_client = ApiClient.default)
  @api_client = api_client
  @api_client.config.app_key = app_key
  @api_client.config.app_sid = app_sid
  @api_client.config.api_version = app_version
  @api_client.config.host = app_host
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



27
28
29
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 27

def api_client
  @api_client
end

Instance Method Details

#cells_auto_filter_delete_worksheet_date_filter(name, sheet_name, field_index, date_time_grouping_type, opts = {}) ⇒ CellsCloudResponse

Removes a date filter.

Parameters:

  • name
  • sheet_name
  • field_index
  • date_time_grouping_type
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer) — default: default to 0
  • :month (Integer) — default: default to 0
  • :day (Integer) — default: default to 0
  • :hour (Integer) — default: default to 0
  • :minute (Integer) — default: default to 0
  • :second (Integer) — default: default to 0
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



53
54
55
56
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 53

def cells_auto_filter_delete_worksheet_date_filter(name, sheet_name, field_index, date_time_grouping_type, opts = {})
  data, _status_code, _headers = cells_auto_filter_delete_worksheet_date_filter_with_http_info(name, sheet_name, field_index, date_time_grouping_type, opts)
  return data
end

#cells_auto_filter_delete_worksheet_date_filter_with_http_info(name, sheet_name, field_index, date_time_grouping_type, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Removes a date filter.

Parameters:

  • name
  • sheet_name
  • field_index
  • date_time_grouping_type
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer)
  • :month (Integer)
  • :day (Integer)
  • :hour (Integer)
  • :minute (Integer)
  • :second (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



74
75
76
77
78
79
80
81
82
83
84
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 74

def cells_auto_filter_delete_worksheet_date_filter_with_http_info(name, sheet_name, field_index, date_time_grouping_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_delete_worksheet_date_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_delete_worksheet_date_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_delete_worksheet_date_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_delete_worksheet_date_filter"
  end
  # verify the required parameter 'date_time_grouping_type' is set
  if @api_client.config.client_side_validation && date_time_grouping_type.nil?
    fail ArgumentError, "Missing the required parameter 'date_time_grouping_type' when calling CellsApi.cells_auto_filter_delete_worksheet_date_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/dateFilter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fieldIndex'] = field_index
  query_params[:'dateTimeGroupingType'] = date_time_grouping_type
  query_params[:'year'] = opts[:'year'] if !opts[:'year'].nil?
  query_params[:'month'] = opts[:'month'] if !opts[:'month'].nil?
  query_params[:'day'] = opts[:'day'] if !opts[:'day'].nil?
  query_params[:'hour'] = opts[:'hour'] if !opts[:'hour'].nil?
  query_params[:'minute'] = opts[:'minute'] if !opts[:'minute'].nil?
  query_params[:'second'] = opts[:'second'] if !opts[:'second'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_delete_worksheet_date_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_delete_worksheet_filter(name, sheet_name, field_index, opts = {}) ⇒ CellsCloudResponse

Delete a filter for a filter column.

Parameters:

  • name
  • sheet_name
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :criteria (String)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



148
149
150
151
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 148

def cells_auto_filter_delete_worksheet_filter(name, sheet_name, field_index, opts = {})
  data, _status_code, _headers = cells_auto_filter_delete_worksheet_filter_with_http_info(name, sheet_name, field_index, opts)
  return data
end

#cells_auto_filter_delete_worksheet_filter_with_http_info(name, sheet_name, field_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete a filter for a filter column.

Parameters:

  • name
  • sheet_name
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :criteria (String)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
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
214
215
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 163

def cells_auto_filter_delete_worksheet_filter_with_http_info(name, sheet_name, field_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_delete_worksheet_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_delete_worksheet_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_delete_worksheet_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_delete_worksheet_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/filter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fieldIndex'] = field_index
  query_params[:'criteria'] = opts[:'criteria'] if !opts[:'criteria'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_delete_worksheet_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_get_worksheet_auto_filter(name, sheet_name, opts = {}) ⇒ AutoFilterResponse

Get Auto filter Description

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



225
226
227
228
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 225

def cells_auto_filter_get_worksheet_auto_filter(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_auto_filter_get_worksheet_auto_filter_with_http_info(name, sheet_name, opts)
  return data
end

#cells_auto_filter_get_worksheet_auto_filter_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(AutoFilterResponse, Fixnum, Hash)>

Get Auto filter Description

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    AutoFilterResponse data, response status code and response headers



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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 238

def cells_auto_filter_get_worksheet_auto_filter_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_get_worksheet_auto_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_get_worksheet_auto_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_get_worksheet_auto_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'AutoFilterResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_get_worksheet_auto_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_post_worksheet_auto_filter_refresh(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



294
295
296
297
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 294

def cells_auto_filter_post_worksheet_auto_filter_refresh(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_auto_filter_post_worksheet_auto_filter_refresh_with_http_info(name, sheet_name, opts)
  return data
end

#cells_auto_filter_post_worksheet_auto_filter_refresh_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 307

def cells_auto_filter_post_worksheet_auto_filter_refresh_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_post_worksheet_auto_filter_refresh ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_post_worksheet_auto_filter_refresh"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_post_worksheet_auto_filter_refresh"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/refresh".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_post_worksheet_auto_filter_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_post_worksheet_match_blanks(name, sheet_name, field_index, opts = {}) ⇒ CellsCloudResponse

Match all blank cell in the list.

Parameters:

  • name
  • sheet_name
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



364
365
366
367
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 364

def cells_auto_filter_post_worksheet_match_blanks(name, sheet_name, field_index, opts = {})
  data, _status_code, _headers = cells_auto_filter_post_worksheet_match_blanks_with_http_info(name, sheet_name, field_index, opts)
  return data
end

#cells_auto_filter_post_worksheet_match_blanks_with_http_info(name, sheet_name, field_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Match all blank cell in the list.

Parameters:

  • name
  • sheet_name
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 378

def cells_auto_filter_post_worksheet_match_blanks_with_http_info(name, sheet_name, field_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_post_worksheet_match_blanks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_post_worksheet_match_blanks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_post_worksheet_match_blanks"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_post_worksheet_match_blanks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/matchBlanks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fieldIndex'] = field_index
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_post_worksheet_match_blanks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_post_worksheet_match_non_blanks(name, sheet_name, field_index, opts = {}) ⇒ CellsCloudResponse

Match all not blank cell in the list.

Parameters:

  • name
  • sheet_name
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



440
441
442
443
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 440

def cells_auto_filter_post_worksheet_match_non_blanks(name, sheet_name, field_index, opts = {})
  data, _status_code, _headers = cells_auto_filter_post_worksheet_match_non_blanks_with_http_info(name, sheet_name, field_index, opts)
  return data
end

#cells_auto_filter_post_worksheet_match_non_blanks_with_http_info(name, sheet_name, field_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Match all not blank cell in the list.

Parameters:

  • name
  • sheet_name
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 454

def cells_auto_filter_post_worksheet_match_non_blanks_with_http_info(name, sheet_name, field_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_post_worksheet_match_non_blanks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_post_worksheet_match_non_blanks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_post_worksheet_match_non_blanks"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_post_worksheet_match_non_blanks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/matchNonBlanks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fieldIndex'] = field_index
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_post_worksheet_match_non_blanks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_color_filter(name, sheet_name, range, field_index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :color_filter (ColorFilterRequest)
  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



520
521
522
523
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 520

def cells_auto_filter_put_worksheet_color_filter(name, sheet_name, range, field_index, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_color_filter_with_http_info(name, sheet_name, range, field_index, opts)
  return data
end

#cells_auto_filter_put_worksheet_color_filter_with_http_info(name, sheet_name, range, field_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :color_filter (ColorFilterRequest)
  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 538

def cells_auto_filter_put_worksheet_color_filter_with_http_info(name, sheet_name, range, field_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_color_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_color_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_color_filter"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_color_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_color_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/colorFilter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'color_filter'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_color_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_custom_filter(name, sheet_name, range, field_index, operator_type1, criteria1, opts = {}) ⇒ CellsCloudResponse

Filters a list with a custom criteria.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • operator_type1
  • criteria1
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_and (BOOLEAN)
  • :operator_type2 (String)
  • :criteria2 (String)
  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



615
616
617
618
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 615

def cells_auto_filter_put_worksheet_custom_filter(name, sheet_name, range, field_index, operator_type1, criteria1, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_custom_filter_with_http_info(name, sheet_name, range, field_index, operator_type1, criteria1, opts)
  return data
end

#cells_auto_filter_put_worksheet_custom_filter_with_http_info(name, sheet_name, range, field_index, operator_type1, criteria1, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Filters a list with a custom criteria.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • operator_type1
  • criteria1
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_and (BOOLEAN)
  • :operator_type2 (String)
  • :criteria2 (String)
  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 637

def cells_auto_filter_put_worksheet_custom_filter_with_http_info(name, sheet_name, range, field_index, operator_type1, criteria1, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_custom_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_custom_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_custom_filter"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_custom_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_custom_filter"
  end
  # verify the required parameter 'operator_type1' is set
  if @api_client.config.client_side_validation && operator_type1.nil?
    fail ArgumentError, "Missing the required parameter 'operator_type1' when calling CellsApi.cells_auto_filter_put_worksheet_custom_filter"
  end
  # verify the required parameter 'criteria1' is set
  if @api_client.config.client_side_validation && criteria1.nil?
    fail ArgumentError, "Missing the required parameter 'criteria1' when calling CellsApi.cells_auto_filter_put_worksheet_custom_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/custom".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'operatorType1'] = operator_type1
  query_params[:'criteria1'] = criteria1
  query_params[:'isAnd'] = opts[:'is_and'] if !opts[:'is_and'].nil?
  query_params[:'operatorType2'] = opts[:'operator_type2'] if !opts[:'operator_type2'].nil?
  query_params[:'criteria2'] = opts[:'criteria2'] if !opts[:'criteria2'].nil?
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_custom_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_date_filter(name, sheet_name, range, field_index, date_time_grouping_type, opts = {}) ⇒ CellsCloudResponse

add date filter in worksheet

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • date_time_grouping_type
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer) — default: default to 0
  • :month (Integer) — default: default to 0
  • :day (Integer) — default: default to 0
  • :hour (Integer) — default: default to 0
  • :minute (Integer) — default: default to 0
  • :second (Integer) — default: default to 0
  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



729
730
731
732
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 729

def cells_auto_filter_put_worksheet_date_filter(name, sheet_name, range, field_index, date_time_grouping_type, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_date_filter_with_http_info(name, sheet_name, range, field_index, date_time_grouping_type, opts)
  return data
end

#cells_auto_filter_put_worksheet_date_filter_with_http_info(name, sheet_name, range, field_index, date_time_grouping_type, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

add date filter in worksheet

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • date_time_grouping_type
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer)
  • :month (Integer)
  • :day (Integer)
  • :hour (Integer)
  • :minute (Integer)
  • :second (Integer)
  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 753

def cells_auto_filter_put_worksheet_date_filter_with_http_info(name, sheet_name, range, field_index, date_time_grouping_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_date_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_date_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_date_filter"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_date_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_date_filter"
  end
  # verify the required parameter 'date_time_grouping_type' is set
  if @api_client.config.client_side_validation && date_time_grouping_type.nil?
    fail ArgumentError, "Missing the required parameter 'date_time_grouping_type' when calling CellsApi.cells_auto_filter_put_worksheet_date_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/dateFilter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'dateTimeGroupingType'] = date_time_grouping_type
  query_params[:'year'] = opts[:'year'] if !opts[:'year'].nil?
  query_params[:'month'] = opts[:'month'] if !opts[:'month'].nil?
  query_params[:'day'] = opts[:'day'] if !opts[:'day'].nil?
  query_params[:'hour'] = opts[:'hour'] if !opts[:'hour'].nil?
  query_params[:'minute'] = opts[:'minute'] if !opts[:'minute'].nil?
  query_params[:'second'] = opts[:'second'] if !opts[:'second'].nil?
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_date_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_dynamic_filter(name, sheet_name, range, field_index, dynamic_filter_type, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • dynamic_filter_type
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



837
838
839
840
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 837

def cells_auto_filter_put_worksheet_dynamic_filter(name, sheet_name, range, field_index, dynamic_filter_type, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_dynamic_filter_with_http_info(name, sheet_name, range, field_index, dynamic_filter_type, opts)
  return data
end

#cells_auto_filter_put_worksheet_dynamic_filter_with_http_info(name, sheet_name, range, field_index, dynamic_filter_type, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • dynamic_filter_type
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 855

def cells_auto_filter_put_worksheet_dynamic_filter_with_http_info(name, sheet_name, range, field_index, dynamic_filter_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_dynamic_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_dynamic_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_dynamic_filter"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_dynamic_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_dynamic_filter"
  end
  # verify the required parameter 'dynamic_filter_type' is set
  if @api_client.config.client_side_validation && dynamic_filter_type.nil?
    fail ArgumentError, "Missing the required parameter 'dynamic_filter_type' when calling CellsApi.cells_auto_filter_put_worksheet_dynamic_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/dynamicFilter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'dynamicFilterType'] = dynamic_filter_type
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_dynamic_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_filter(name, sheet_name, range, field_index, criteria, opts = {}) ⇒ CellsCloudResponse

Adds a filter for a filter column.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • criteria
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



933
934
935
936
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 933

def cells_auto_filter_put_worksheet_filter(name, sheet_name, range, field_index, criteria, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_filter_with_http_info(name, sheet_name, range, field_index, criteria, opts)
  return data
end

#cells_auto_filter_put_worksheet_filter_top10(name, sheet_name, range, field_index, is_top, is_percent, item_count, opts = {}) ⇒ CellsCloudResponse

Filter the top 10 item in the list

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • is_top
  • is_percent
  • item_count
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



1031
1032
1033
1034
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1031

def cells_auto_filter_put_worksheet_filter_top10(name, sheet_name, range, field_index, is_top, is_percent, item_count, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_filter_top10_with_http_info(name, sheet_name, range, field_index, is_top, is_percent, item_count, opts)
  return data
end

#cells_auto_filter_put_worksheet_filter_top10_with_http_info(name, sheet_name, range, field_index, is_top, is_percent, item_count, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Filter the top 10 item in the list

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • is_top
  • is_percent
  • item_count
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1051

def cells_auto_filter_put_worksheet_filter_top10_with_http_info(name, sheet_name, range, field_index, is_top, is_percent, item_count, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_filter_top10 ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # verify the required parameter 'is_top' is set
  if @api_client.config.client_side_validation && is_top.nil?
    fail ArgumentError, "Missing the required parameter 'is_top' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # verify the required parameter 'is_percent' is set
  if @api_client.config.client_side_validation && is_percent.nil?
    fail ArgumentError, "Missing the required parameter 'is_percent' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # verify the required parameter 'item_count' is set
  if @api_client.config.client_side_validation && item_count.nil?
    fail ArgumentError, "Missing the required parameter 'item_count' when calling CellsApi.cells_auto_filter_put_worksheet_filter_top10"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/filterTop10".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'isTop'] = is_top
  query_params[:'isPercent'] = is_percent
  query_params[:'itemCount'] = item_count
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_filter_top10\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_filter_with_http_info(name, sheet_name, range, field_index, criteria, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Adds a filter for a filter column.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • criteria
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 951

def cells_auto_filter_put_worksheet_filter_with_http_info(name, sheet_name, range, field_index, criteria, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_filter"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_filter"
  end
  # verify the required parameter 'criteria' is set
  if @api_client.config.client_side_validation && criteria.nil?
    fail ArgumentError, "Missing the required parameter 'criteria' when calling CellsApi.cells_auto_filter_put_worksheet_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/filter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'criteria'] = criteria
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_auto_filter_put_worksheet_icon_filter(name, sheet_name, range, field_index, icon_set_type, icon_id, opts = {}) ⇒ CellsCloudResponse

Adds an icon filter.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • icon_set_type
  • icon_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



1140
1141
1142
1143
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1140

def cells_auto_filter_put_worksheet_icon_filter(name, sheet_name, range, field_index, icon_set_type, icon_id, opts = {})
  data, _status_code, _headers = cells_auto_filter_put_worksheet_icon_filter_with_http_info(name, sheet_name, range, field_index, icon_set_type, icon_id, opts)
  return data
end

#cells_auto_filter_put_worksheet_icon_filter_with_http_info(name, sheet_name, range, field_index, icon_set_type, icon_id, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Adds an icon filter.

Parameters:

  • name
  • sheet_name
  • range
  • field_index
  • icon_set_type
  • icon_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :match_blanks (BOOLEAN)
  • :refresh (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1159

def cells_auto_filter_put_worksheet_icon_filter_with_http_info(name, sheet_name, range, field_index, icon_set_type, icon_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_auto_filter_put_worksheet_icon_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_auto_filter_put_worksheet_icon_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_auto_filter_put_worksheet_icon_filter"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_auto_filter_put_worksheet_icon_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_auto_filter_put_worksheet_icon_filter"
  end
  # verify the required parameter 'icon_set_type' is set
  if @api_client.config.client_side_validation && icon_set_type.nil?
    fail ArgumentError, "Missing the required parameter 'icon_set_type' when calling CellsApi.cells_auto_filter_put_worksheet_icon_filter"
  end
  # verify the required parameter 'icon_id' is set
  if @api_client.config.client_side_validation && icon_id.nil?
    fail ArgumentError, "Missing the required parameter 'icon_id' when calling CellsApi.cells_auto_filter_put_worksheet_icon_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoFilter/iconFilter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'fieldIndex'] = field_index
  query_params[:'iconSetType'] = icon_set_type
  query_params[:'iconId'] = icon_id
  query_params[:'matchBlanks'] = opts[:'match_blanks'] if !opts[:'match_blanks'].nil?
  query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_auto_filter_put_worksheet_icon_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_autoshapes_get_worksheet_autoshape(name, sheet_name, autoshape_number, opts = {}) ⇒ File

Get autoshape info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • autoshape_number —

    The autoshape number.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Exported format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (File) 


1239
1240
1241
1242
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1239

def cells_autoshapes_get_worksheet_autoshape(name, sheet_name, autoshape_number, opts = {})
  data, _status_code, _headers = cells_autoshapes_get_worksheet_autoshape_with_http_info(name, sheet_name, autoshape_number, opts)
  return data
end

#cells_autoshapes_get_worksheet_autoshape_with_http_info(name, sheet_name, autoshape_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get autoshape info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • autoshape_number —

    The autoshape number.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Exported format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    File data, response status code and response headers



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1254

def cells_autoshapes_get_worksheet_autoshape_with_http_info(name, sheet_name, autoshape_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_autoshapes_get_worksheet_autoshape ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_autoshapes_get_worksheet_autoshape"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_autoshapes_get_worksheet_autoshape"
  end
  # verify the required parameter 'autoshape_number' is set
  if @api_client.config.client_side_validation && autoshape_number.nil?
    fail ArgumentError, "Missing the required parameter 'autoshape_number' when calling CellsApi.cells_autoshapes_get_worksheet_autoshape"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoshapes/{autoshapeNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'autoshapeNumber' + '}', autoshape_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_autoshapes_get_worksheet_autoshape\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_autoshapes_get_worksheet_autoshapes(name, sheet_name, opts = {}) ⇒ AutoShapesResponse

Get worksheet autoshapes info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



1315
1316
1317
1318
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1315

def cells_autoshapes_get_worksheet_autoshapes(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_autoshapes_get_worksheet_autoshapes_with_http_info(name, sheet_name, opts)
  return data
end

#cells_autoshapes_get_worksheet_autoshapes_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(AutoShapesResponse, Fixnum, Hash)>

Get worksheet autoshapes info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    AutoShapesResponse data, response status code and response headers



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1328

def cells_autoshapes_get_worksheet_autoshapes_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_autoshapes_get_worksheet_autoshapes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_autoshapes_get_worksheet_autoshapes"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_autoshapes_get_worksheet_autoshapes"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autoshapes".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'AutoShapesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_autoshapes_get_worksheet_autoshapes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_chart_area_get_chart_area(name, sheet_name, chart_index, opts = {}) ⇒ ChartAreaResponse

Get chart area info.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1385
1386
1387
1388
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1385

def cells_chart_area_get_chart_area(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_chart_area_get_chart_area_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_chart_area_get_chart_area_border(name, sheet_name, chart_index, opts = {}) ⇒ LineResponse

Get chart area border info.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1460
1461
1462
1463
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1460

def cells_chart_area_get_chart_area_border(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_chart_area_get_chart_area_border_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_chart_area_get_chart_area_border_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(LineResponse, Fixnum, Hash)>

Get chart area border info.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    LineResponse data, response status code and response headers



1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1474

def cells_chart_area_get_chart_area_border_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_chart_area_get_chart_area_border ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_chart_area_get_chart_area_border"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_chart_area_get_chart_area_border"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_chart_area_get_chart_area_border"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/chartArea/border".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'LineResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_chart_area_get_chart_area_border\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_chart_area_get_chart_area_fill_format(name, sheet_name, chart_index, opts = {}) ⇒ FillFormatResponse

Get chart area fill format info.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1535
1536
1537
1538
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1535

def cells_chart_area_get_chart_area_fill_format(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_chart_area_get_chart_area_fill_format_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_chart_area_get_chart_area_fill_format_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(FillFormatResponse, Fixnum, Hash)>

Get chart area fill format info.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    FillFormatResponse data, response status code and response headers



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1549

def cells_chart_area_get_chart_area_fill_format_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_chart_area_get_chart_area_fill_format ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_chart_area_get_chart_area_fill_format"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_chart_area_get_chart_area_fill_format"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_chart_area_get_chart_area_fill_format"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/chartArea/fillFormat".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'FillFormatResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_chart_area_get_chart_area_fill_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_chart_area_get_chart_area_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(ChartAreaResponse, Fixnum, Hash)>

Get chart area info.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ChartAreaResponse data, response status code and response headers



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1399

def cells_chart_area_get_chart_area_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_chart_area_get_chart_area ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_chart_area_get_chart_area"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_chart_area_get_chart_area"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_chart_area_get_chart_area"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/chartArea".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ChartAreaResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_chart_area_get_chart_area\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_delete_worksheet_chart_legend(name, sheet_name, chart_index, opts = {}) ⇒ CellsCloudResponse

Hide legend in chart

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1610
1611
1612
1613
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1610

def cells_charts_delete_worksheet_chart_legend(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_delete_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_delete_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Hide legend in chart

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1624

def cells_charts_delete_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_delete_worksheet_chart_legend ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_delete_worksheet_chart_legend"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_delete_worksheet_chart_legend"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_delete_worksheet_chart_legend"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/legend".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_delete_worksheet_chart_legend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_delete_worksheet_chart_title(name, sheet_name, chart_index, opts = {}) ⇒ CellsCloudResponse

Hide title in chart

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1685
1686
1687
1688
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1685

def cells_charts_delete_worksheet_chart_title(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_delete_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_delete_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Hide title in chart

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1699

def cells_charts_delete_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_delete_worksheet_chart_title ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_delete_worksheet_chart_title"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_delete_worksheet_chart_title"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_delete_worksheet_chart_title"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/title".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_delete_worksheet_chart_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_delete_worksheet_clear_charts(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Clear the charts.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1759
1760
1761
1762
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1759

def cells_charts_delete_worksheet_clear_charts(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_charts_delete_worksheet_clear_charts_with_http_info(name, sheet_name, opts)
  return data
end

#cells_charts_delete_worksheet_clear_charts_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clear the charts.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1772

def cells_charts_delete_worksheet_clear_charts_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_delete_worksheet_clear_charts ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_delete_worksheet_clear_charts"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_delete_worksheet_clear_charts"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_delete_worksheet_clear_charts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_delete_worksheet_delete_chart(name, sheet_name, chart_index, opts = {}) ⇒ ChartsResponse

Delete worksheet chart by index.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1829
1830
1831
1832
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1829

def cells_charts_delete_worksheet_delete_chart(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_delete_worksheet_delete_chart_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_delete_worksheet_delete_chart_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(ChartsResponse, Fixnum, Hash)>

Delete worksheet chart by index.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ChartsResponse data, response status code and response headers



1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1843

def cells_charts_delete_worksheet_delete_chart_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_delete_worksheet_delete_chart ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_delete_worksheet_delete_chart"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_delete_worksheet_delete_chart"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_delete_worksheet_delete_chart"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChartsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_delete_worksheet_delete_chart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_get_worksheet_chart(name, sheet_name, chart_number, opts = {}) ⇒ File

Get chart info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • chart_number —

    The chart number.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported file format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (File) 


1905
1906
1907
1908
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1905

def cells_charts_get_worksheet_chart(name, sheet_name, chart_number, opts = {})
  data, _status_code, _headers = cells_charts_get_worksheet_chart_with_http_info(name, sheet_name, chart_number, opts)
  return data
end

#cells_charts_get_worksheet_chart_legend(name, sheet_name, chart_index, opts = {}) ⇒ LegendResponse

Get chart legend

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



1982
1983
1984
1985
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1982

def cells_charts_get_worksheet_chart_legend(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_get_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_get_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(LegendResponse, Fixnum, Hash)>

Get chart legend

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    LegendResponse data, response status code and response headers



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1996

def cells_charts_get_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_get_worksheet_chart_legend ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_get_worksheet_chart_legend"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_get_worksheet_chart_legend"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_get_worksheet_chart_legend"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/legend".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'LegendResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_get_worksheet_chart_legend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_get_worksheet_chart_title(name, sheet_name, chart_index, opts = {}) ⇒ TitleResponse

Get chart title

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



2057
2058
2059
2060
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2057

def cells_charts_get_worksheet_chart_title(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_get_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_get_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(TitleResponse, Fixnum, Hash)>

Get chart title

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TitleResponse data, response status code and response headers



2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2071

def cells_charts_get_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_get_worksheet_chart_title ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_get_worksheet_chart_title"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_get_worksheet_chart_title"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_get_worksheet_chart_title"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/title".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'TitleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_get_worksheet_chart_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_get_worksheet_chart_with_http_info(name, sheet_name, chart_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get chart info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • chart_number —

    The chart number.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported file format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    File data, response status code and response headers



1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 1920

def cells_charts_get_worksheet_chart_with_http_info(name, sheet_name, chart_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_get_worksheet_chart ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_get_worksheet_chart"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_get_worksheet_chart"
  end
  # verify the required parameter 'chart_number' is set
  if @api_client.config.client_side_validation && chart_number.nil?
    fail ArgumentError, "Missing the required parameter 'chart_number' when calling CellsApi.cells_charts_get_worksheet_chart"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartNumber' + '}', chart_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_get_worksheet_chart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_get_worksheet_charts(name, sheet_name, opts = {}) ⇒ ChartsResponse

Get worksheet charts info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



2131
2132
2133
2134
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2131

def cells_charts_get_worksheet_charts(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_charts_get_worksheet_charts_with_http_info(name, sheet_name, opts)
  return data
end

#cells_charts_get_worksheet_charts_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ChartsResponse, Fixnum, Hash)>

Get worksheet charts info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ChartsResponse data, response status code and response headers



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2144

def cells_charts_get_worksheet_charts_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_get_worksheet_charts ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_get_worksheet_charts"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_get_worksheet_charts"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ChartsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_get_worksheet_charts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_post_worksheet_chart(name, sheet_name, chart_index, opts = {}) ⇒ CellsCloudResponse

Update chart propreties

Parameters:

  • name
  • sheet_name
  • chart_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :chart (Chart)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



2202
2203
2204
2205
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2202

def cells_charts_post_worksheet_chart(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_post_worksheet_chart_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_post_worksheet_chart_legend(name, sheet_name, chart_index, opts = {}) ⇒ LegendResponse

Update chart legend

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :legend (Legend)
  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



2279
2280
2281
2282
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2279

def cells_charts_post_worksheet_chart_legend(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_post_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_post_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(LegendResponse, Fixnum, Hash)>

Update chart legend

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :legend (Legend)
  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    LegendResponse data, response status code and response headers



2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2294

def cells_charts_post_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_post_worksheet_chart_legend ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_post_worksheet_chart_legend"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_post_worksheet_chart_legend"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_post_worksheet_chart_legend"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/legend".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'legend'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'LegendResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_post_worksheet_chart_legend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_post_worksheet_chart_title(name, sheet_name, chart_index, opts = {}) ⇒ TitleResponse

Update chart title

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :title (Title) —

    Chart title

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



2356
2357
2358
2359
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2356

def cells_charts_post_worksheet_chart_title(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_post_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_post_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(TitleResponse, Fixnum, Hash)>

Update chart title

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :title (Title) —

    Chart title

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TitleResponse data, response status code and response headers



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2371

def cells_charts_post_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_post_worksheet_chart_title ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_post_worksheet_chart_title"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_post_worksheet_chart_title"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_post_worksheet_chart_title"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/title".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'title'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'TitleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_post_worksheet_chart_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_post_worksheet_chart_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update chart propreties

Parameters:

  • name
  • sheet_name
  • chart_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :chart (Chart)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2217

def cells_charts_post_worksheet_chart_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_post_worksheet_chart ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_post_worksheet_chart"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_post_worksheet_chart"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_post_worksheet_chart"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'chart'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_post_worksheet_chart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_put_worksheet_add_chart(name, sheet_name, chart_type, opts = {}) ⇒ ChartsResponse

Add new chart to worksheet.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

  • chart_type —

    Chart type, please refer property Type in chart resource.

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

    the optional parameters

Options Hash (opts):

  • :upper_left_row (Integer) —

    New chart upper left row. (default to 0)

  • :upper_left_column (Integer) —

    New chart upperleft column. (default to 0)

  • :lower_right_row (Integer) —

    New chart lower right row. (default to 0)

  • :lower_right_column (Integer) —

    New chart lower right column. (default to 0)

  • :area (String) —

    Specifies values from which to plot the data series.

  • :is_vertical (BOOLEAN) —

    Specifies whether to plot the series from a range of cell values by row or by column. (default to true)

  • :category_data (String) —

    Gets or sets the range of category Axis values. It can be a range of cells (such as, &quot;d1:e10&quot;).

  • :is_auto_get_serial_name (BOOLEAN) —

    Specifies whether auto update serial name. (default to true)

  • :title (String) —

    Specifies chart title name.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

  • :data_labels (BOOLEAN) — default: default to true
  • :data_labels_position (String) — default: default to Above
  • :pivot_table_sheet (String)
  • :pivot_table_name (String)

Returns:



2445
2446
2447
2448
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2445

def cells_charts_put_worksheet_add_chart(name, sheet_name, chart_type, opts = {})
  data, _status_code, _headers = cells_charts_put_worksheet_add_chart_with_http_info(name, sheet_name, chart_type, opts)
  return data
end

#cells_charts_put_worksheet_add_chart_with_http_info(name, sheet_name, chart_type, opts = {}) ⇒ Array<(ChartsResponse, Fixnum, Hash)>

Add new chart to worksheet.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

  • chart_type —

    Chart type, please refer property Type in chart resource.

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

    the optional parameters

Options Hash (opts):

  • :upper_left_row (Integer) —

    New chart upper left row.

  • :upper_left_column (Integer) —

    New chart upperleft column.

  • :lower_right_row (Integer) —

    New chart lower right row.

  • :lower_right_column (Integer) —

    New chart lower right column.

  • :area (String) —

    Specifies values from which to plot the data series.

  • :is_vertical (BOOLEAN) —

    Specifies whether to plot the series from a range of cell values by row or by column.

  • :category_data (String) —

    Gets or sets the range of category Axis values. It can be a range of cells (such as, &quot;d1:e10&quot;).

  • :is_auto_get_serial_name (BOOLEAN) —

    Specifies whether auto update serial name.

  • :title (String) —

    Specifies chart title name.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

  • :data_labels (BOOLEAN)
  • :data_labels_position (String)
  • :pivot_table_sheet (String)
  • :pivot_table_name (String)

Returns:

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

    ChartsResponse data, response status code and response headers



2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2472

def cells_charts_put_worksheet_add_chart_with_http_info(name, sheet_name, chart_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_put_worksheet_add_chart ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_put_worksheet_add_chart"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_put_worksheet_add_chart"
  end
  # verify the required parameter 'chart_type' is set
  if @api_client.config.client_side_validation && chart_type.nil?
    fail ArgumentError, "Missing the required parameter 'chart_type' when calling CellsApi.cells_charts_put_worksheet_add_chart"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'chartType'] = chart_type
  query_params[:'upperLeftRow'] = opts[:'upper_left_row'] if !opts[:'upper_left_row'].nil?
  query_params[:'upperLeftColumn'] = opts[:'upper_left_column'] if !opts[:'upper_left_column'].nil?
  query_params[:'lowerRightRow'] = opts[:'lower_right_row'] if !opts[:'lower_right_row'].nil?
  query_params[:'lowerRightColumn'] = opts[:'lower_right_column'] if !opts[:'lower_right_column'].nil?
  query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
  query_params[:'isVertical'] = opts[:'is_vertical'] if !opts[:'is_vertical'].nil?
  query_params[:'categoryData'] = opts[:'category_data'] if !opts[:'category_data'].nil?
  query_params[:'isAutoGetSerialName'] = opts[:'is_auto_get_serial_name'] if !opts[:'is_auto_get_serial_name'].nil?
  query_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'dataLabels'] = opts[:'data_labels'] if !opts[:'data_labels'].nil?
  query_params[:'dataLabelsPosition'] = opts[:'data_labels_position'] if !opts[:'data_labels_position'].nil?
  query_params[:'pivotTableSheet'] = opts[:'pivot_table_sheet'] if !opts[:'pivot_table_sheet'].nil?
  query_params[:'pivotTableName'] = opts[:'pivot_table_name'] if !opts[:'pivot_table_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChartsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_put_worksheet_add_chart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_put_worksheet_chart_legend(name, sheet_name, chart_index, opts = {}) ⇒ CellsCloudResponse

Show legend in chart

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



2547
2548
2549
2550
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2547

def cells_charts_put_worksheet_chart_legend(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_put_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_put_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Show legend in chart

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2561

def cells_charts_put_worksheet_chart_legend_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_put_worksheet_chart_legend ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_put_worksheet_chart_legend"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_put_worksheet_chart_legend"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_put_worksheet_chart_legend"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/legend".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_put_worksheet_chart_legend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_charts_put_worksheet_chart_title(name, sheet_name, chart_index, opts = {}) ⇒ TitleResponse

Add chart title / Set chart title visible

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :title (Title) —

    Chart title.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



2623
2624
2625
2626
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2623

def cells_charts_put_worksheet_chart_title(name, sheet_name, chart_index, opts = {})
  data, _status_code, _headers = cells_charts_put_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts)
  return data
end

#cells_charts_put_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {}) ⇒ Array<(TitleResponse, Fixnum, Hash)>

Add chart title / Set chart title visible

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • chart_index —

    The chart index.

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

    the optional parameters

Options Hash (opts):

  • :title (Title) —

    Chart title.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TitleResponse data, response status code and response headers



2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2638

def cells_charts_put_worksheet_chart_title_with_http_info(name, sheet_name, chart_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_charts_put_worksheet_chart_title ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_charts_put_worksheet_chart_title"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_charts_put_worksheet_chart_title"
  end
  # verify the required parameter 'chart_index' is set
  if @api_client.config.client_side_validation && chart_index.nil?
    fail ArgumentError, "Missing the required parameter 'chart_index' when calling CellsApi.cells_charts_put_worksheet_chart_title"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/charts/{chartIndex}/title".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'chartIndex' + '}', chart_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'title'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TitleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_charts_put_worksheet_chart_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_delete_worksheet_conditional_formatting(name, sheet_name, index, opts = {}) ⇒ CellsCloudResponse

Remove conditional formatting

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



2699
2700
2701
2702
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2699

def cells_conditional_formattings_delete_worksheet_conditional_formatting(name, sheet_name, index, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_delete_worksheet_conditional_formatting_with_http_info(name, sheet_name, index, opts)
  return data
end

#cells_conditional_formattings_delete_worksheet_conditional_formatting_area(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {}) ⇒ CellsCloudResponse

Remove cell area from conditional formatting.

Parameters:

  • name
  • sheet_name
  • start_row
  • start_column
  • total_rows
  • total_columns
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



2777
2778
2779
2780
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2777

def cells_conditional_formattings_delete_worksheet_conditional_formatting_area(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_delete_worksheet_conditional_formatting_area_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts)
  return data
end

#cells_conditional_formattings_delete_worksheet_conditional_formatting_area_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Remove cell area from conditional formatting.

Parameters:

  • name
  • sheet_name
  • start_row
  • start_column
  • total_rows
  • total_columns
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2794

def cells_conditional_formattings_delete_worksheet_conditional_formatting_area_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area"
  end
  # verify the required parameter 'start_row' is set
  if @api_client.config.client_side_validation && start_row.nil?
    fail ArgumentError, "Missing the required parameter 'start_row' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area"
  end
  # verify the required parameter 'start_column' is set
  if @api_client.config.client_side_validation && start_column.nil?
    fail ArgumentError, "Missing the required parameter 'start_column' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area"
  end
  # verify the required parameter 'total_rows' is set
  if @api_client.config.client_side_validation && total_rows.nil?
    fail ArgumentError, "Missing the required parameter 'total_rows' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area"
  end
  # verify the required parameter 'total_columns' is set
  if @api_client.config.client_side_validation && total_columns.nil?
    fail ArgumentError, "Missing the required parameter 'total_columns' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting_area"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/area".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startRow'] = start_row
  query_params[:'startColumn'] = start_column
  query_params[:'totalRows'] = total_rows
  query_params[:'totalColumns'] = total_columns
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_delete_worksheet_conditional_formatting_area\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_delete_worksheet_conditional_formatting_with_http_info(name, sheet_name, index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Remove conditional formatting

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2713

def cells_conditional_formattings_delete_worksheet_conditional_formatting_with_http_info(name, sheet_name, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formatting"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_delete_worksheet_conditional_formatting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_delete_worksheet_conditional_formattings(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Clear all condition formattings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



2870
2871
2872
2873
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2870

def cells_conditional_formattings_delete_worksheet_conditional_formattings(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_delete_worksheet_conditional_formattings_with_http_info(name, sheet_name, opts)
  return data
end

#cells_conditional_formattings_delete_worksheet_conditional_formattings_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clear all condition formattings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2883

def cells_conditional_formattings_delete_worksheet_conditional_formattings_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formattings ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formattings"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_delete_worksheet_conditional_formattings"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_delete_worksheet_conditional_formattings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_get_worksheet_conditional_formatting(name, sheet_name, index, opts = {}) ⇒ ConditionalFormattingResponse

Get conditional formatting

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



2940
2941
2942
2943
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2940

def cells_conditional_formattings_get_worksheet_conditional_formatting(name, sheet_name, index, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_get_worksheet_conditional_formatting_with_http_info(name, sheet_name, index, opts)
  return data
end

#cells_conditional_formattings_get_worksheet_conditional_formatting_with_http_info(name, sheet_name, index, opts = {}) ⇒ Array<(ConditionalFormattingResponse, Fixnum, Hash)>

Get conditional formatting

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 2954

def cells_conditional_formattings_get_worksheet_conditional_formatting_with_http_info(name, sheet_name, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_get_worksheet_conditional_formatting ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_get_worksheet_conditional_formatting"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_get_worksheet_conditional_formatting"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_conditional_formattings_get_worksheet_conditional_formatting"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ConditionalFormattingResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_get_worksheet_conditional_formatting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_get_worksheet_conditional_formattings(name, sheet_name, opts = {}) ⇒ ConditionalFormattingsResponse

Get conditional formattings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



3014
3015
3016
3017
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3014

def cells_conditional_formattings_get_worksheet_conditional_formattings(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_get_worksheet_conditional_formattings_with_http_info(name, sheet_name, opts)
  return data
end

#cells_conditional_formattings_get_worksheet_conditional_formattings_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ConditionalFormattingsResponse, Fixnum, Hash)>

Get conditional formattings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3027

def cells_conditional_formattings_get_worksheet_conditional_formattings_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_get_worksheet_conditional_formattings ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_get_worksheet_conditional_formattings"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_get_worksheet_conditional_formattings"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ConditionalFormattingsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_get_worksheet_conditional_formattings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_put_worksheet_conditional_formatting(name, sheet_name, cell_area, opts = {}) ⇒ CellsCloudResponse

Add a condition formatting.

Parameters:

  • name
  • sheet_name
  • cell_area
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format_condition (FormatCondition)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



3085
3086
3087
3088
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3085

def cells_conditional_formattings_put_worksheet_conditional_formatting(name, sheet_name, cell_area, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_put_worksheet_conditional_formatting_with_http_info(name, sheet_name, cell_area, opts)
  return data
end

#cells_conditional_formattings_put_worksheet_conditional_formatting_with_http_info(name, sheet_name, cell_area, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Add a condition formatting.

Parameters:

  • name
  • sheet_name
  • cell_area
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format_condition (FormatCondition)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3100

def cells_conditional_formattings_put_worksheet_conditional_formatting_with_http_info(name, sheet_name, cell_area, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_put_worksheet_conditional_formatting ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_put_worksheet_conditional_formatting"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_put_worksheet_conditional_formatting"
  end
  # verify the required parameter 'cell_area' is set
  if @api_client.config.client_side_validation && cell_area.nil?
    fail ArgumentError, "Missing the required parameter 'cell_area' when calling CellsApi.cells_conditional_formattings_put_worksheet_conditional_formatting"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellArea'] = cell_area
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'format_condition'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_put_worksheet_conditional_formatting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_put_worksheet_format_condition(name, sheet_name, index, cell_area, type, operator_type, formula1, formula2, opts = {}) ⇒ CellsCloudResponse

Add a format condition.

Parameters:

  • name
  • sheet_name
  • index
  • cell_area
  • type
  • operator_type
  • formula1
  • formula2
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



3167
3168
3169
3170
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3167

def cells_conditional_formattings_put_worksheet_format_condition(name, sheet_name, index, cell_area, type, operator_type, formula1, formula2, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_put_worksheet_format_condition_with_http_info(name, sheet_name, index, cell_area, type, operator_type, formula1, formula2, opts)
  return data
end

#cells_conditional_formattings_put_worksheet_format_condition_area(name, sheet_name, index, cell_area, opts = {}) ⇒ CellsCloudResponse

add a cell area for format condition

Parameters:

  • name
  • sheet_name
  • index
  • cell_area
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



3273
3274
3275
3276
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3273

def cells_conditional_formattings_put_worksheet_format_condition_area(name, sheet_name, index, cell_area, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_put_worksheet_format_condition_area_with_http_info(name, sheet_name, index, cell_area, opts)
  return data
end

#cells_conditional_formattings_put_worksheet_format_condition_area_with_http_info(name, sheet_name, index, cell_area, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

add a cell area for format condition

Parameters:

  • name
  • sheet_name
  • index
  • cell_area
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3288

def cells_conditional_formattings_put_worksheet_format_condition_area_with_http_info(name, sheet_name, index, cell_area, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_put_worksheet_format_condition_area ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_area"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_area"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_area"
  end
  # verify the required parameter 'cell_area' is set
  if @api_client.config.client_side_validation && cell_area.nil?
    fail ArgumentError, "Missing the required parameter 'cell_area' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_area"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}/area".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellArea'] = cell_area
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_put_worksheet_format_condition_area\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_put_worksheet_format_condition_condition(name, sheet_name, index, type, operator_type, formula1, formula2, opts = {}) ⇒ CellsCloudResponse

Add a condition for format condition.

Parameters:

  • name
  • sheet_name
  • index
  • type
  • operator_type
  • formula1
  • formula2
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



3358
3359
3360
3361
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3358

def cells_conditional_formattings_put_worksheet_format_condition_condition(name, sheet_name, index, type, operator_type, formula1, formula2, opts = {})
  data, _status_code, _headers = cells_conditional_formattings_put_worksheet_format_condition_condition_with_http_info(name, sheet_name, index, type, operator_type, formula1, formula2, opts)
  return data
end

#cells_conditional_formattings_put_worksheet_format_condition_condition_with_http_info(name, sheet_name, index, type, operator_type, formula1, formula2, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Add a condition for format condition.

Parameters:

  • name
  • sheet_name
  • index
  • type
  • operator_type
  • formula1
  • formula2
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3376

def cells_conditional_formattings_put_worksheet_format_condition_condition_with_http_info(name, sheet_name, index, type, operator_type, formula1, formula2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # verify the required parameter 'operator_type' is set
  if @api_client.config.client_side_validation && operator_type.nil?
    fail ArgumentError, "Missing the required parameter 'operator_type' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # verify the required parameter 'formula1' is set
  if @api_client.config.client_side_validation && formula1.nil?
    fail ArgumentError, "Missing the required parameter 'formula1' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # verify the required parameter 'formula2' is set
  if @api_client.config.client_side_validation && formula2.nil?
    fail ArgumentError, "Missing the required parameter 'formula2' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition_condition"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}/condition".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = type
  query_params[:'operatorType'] = operator_type
  query_params[:'formula1'] = formula1
  query_params[:'formula2'] = formula2
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_put_worksheet_format_condition_condition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_conditional_formattings_put_worksheet_format_condition_with_http_info(name, sheet_name, index, cell_area, type, operator_type, formula1, formula2, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Add a format condition.

Parameters:

  • name
  • sheet_name
  • index
  • cell_area
  • type
  • operator_type
  • formula1
  • formula2
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3186

def cells_conditional_formattings_put_worksheet_format_condition_with_http_info(name, sheet_name, index, cell_area, type, operator_type, formula1, formula2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_conditional_formattings_put_worksheet_format_condition ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'cell_area' is set
  if @api_client.config.client_side_validation && cell_area.nil?
    fail ArgumentError, "Missing the required parameter 'cell_area' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'operator_type' is set
  if @api_client.config.client_side_validation && operator_type.nil?
    fail ArgumentError, "Missing the required parameter 'operator_type' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'formula1' is set
  if @api_client.config.client_side_validation && formula1.nil?
    fail ArgumentError, "Missing the required parameter 'formula1' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # verify the required parameter 'formula2' is set
  if @api_client.config.client_side_validation && formula2.nil?
    fail ArgumentError, "Missing the required parameter 'formula2' when calling CellsApi.cells_conditional_formattings_put_worksheet_format_condition"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/conditionalFormattings/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellArea'] = cell_area
  query_params[:'type'] = type
  query_params[:'operatorType'] = operator_type
  query_params[:'formula1'] = formula1
  query_params[:'formula2'] = formula2
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_conditional_formattings_put_worksheet_format_condition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_delete_worksheet_columns(name, sheet_name, column_index, columns, update_reference, opts = {}) ⇒ ColumnsResponse

Delete worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

  • columns —

    The columns.

  • update_reference —

    The update reference.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



3459
3460
3461
3462
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3459

def cells_delete_worksheet_columns(name, sheet_name, column_index, columns, update_reference, opts = {})
  data, _status_code, _headers = cells_delete_worksheet_columns_with_http_info(name, sheet_name, column_index, columns, update_reference, opts)
  return data
end

#cells_delete_worksheet_columns_with_http_info(name, sheet_name, column_index, columns, update_reference, opts = {}) ⇒ Array<(ColumnsResponse, Fixnum, Hash)>

Delete worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

  • columns —

    The columns.

  • update_reference —

    The update reference.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ColumnsResponse data, response status code and response headers



3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3475

def cells_delete_worksheet_columns_with_http_info(name, sheet_name, column_index, columns, update_reference, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_delete_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_delete_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_delete_worksheet_columns"
  end
  # verify the required parameter 'column_index' is set
  if @api_client.config.client_side_validation && column_index.nil?
    fail ArgumentError, "Missing the required parameter 'column_index' when calling CellsApi.cells_delete_worksheet_columns"
  end
  # verify the required parameter 'columns' is set
  if @api_client.config.client_side_validation && columns.nil?
    fail ArgumentError, "Missing the required parameter 'columns' when calling CellsApi.cells_delete_worksheet_columns"
  end
  # verify the required parameter 'update_reference' is set
  if @api_client.config.client_side_validation && update_reference.nil?
    fail ArgumentError, "Missing the required parameter 'update_reference' when calling CellsApi.cells_delete_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'columnIndex' + '}', column_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'columns'] = columns
  query_params[:'updateReference'] = update_reference
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ColumnsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_delete_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_delete_worksheet_row(name, sheet_name, row_index, opts = {}) ⇒ CellsCloudResponse

Delete worksheet row.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet bame.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



3546
3547
3548
3549
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3546

def cells_delete_worksheet_row(name, sheet_name, row_index, opts = {})
  data, _status_code, _headers = cells_delete_worksheet_row_with_http_info(name, sheet_name, row_index, opts)
  return data
end

#cells_delete_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet row.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet bame.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3560

def cells_delete_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_delete_worksheet_row ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_delete_worksheet_row"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_delete_worksheet_row"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling CellsApi.cells_delete_worksheet_row"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'rowIndex' + '}', row_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_delete_worksheet_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_delete_worksheet_rows(name, sheet_name, startrow, opts = {}) ⇒ CellsCloudResponse

Delete several worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet bame.

  • startrow —

    The begin row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :total_rows (Integer) —

    Number of rows to be operated. (default to 1)

  • :update_reference (BOOLEAN) —

    Indicates if update references in other worksheets. (default to true)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



3623
3624
3625
3626
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3623

def cells_delete_worksheet_rows(name, sheet_name, startrow, opts = {})
  data, _status_code, _headers = cells_delete_worksheet_rows_with_http_info(name, sheet_name, startrow, opts)
  return data
end

#cells_delete_worksheet_rows_with_http_info(name, sheet_name, startrow, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete several worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet bame.

  • startrow —

    The begin row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :total_rows (Integer) —

    Number of rows to be operated.

  • :update_reference (BOOLEAN) —

    Indicates if update references in other worksheets.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3639

def cells_delete_worksheet_rows_with_http_info(name, sheet_name, startrow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_delete_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_delete_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_delete_worksheet_rows"
  end
  # verify the required parameter 'startrow' is set
  if @api_client.config.client_side_validation && startrow.nil?
    fail ArgumentError, "Missing the required parameter 'startrow' when calling CellsApi.cells_delete_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startrow'] = startrow
  query_params[:'totalRows'] = opts[:'total_rows'] if !opts[:'total_rows'].nil?
  query_params[:'updateReference'] = opts[:'update_reference'] if !opts[:'update_reference'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_delete_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_cell_html_string(name, sheet_name, cell_name, opts = {}) ⇒ Object

Read cell data by cell’s name.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    The cell&#39;s name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (Object) 


3703
3704
3705
3706
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3703

def cells_get_cell_html_string(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_get_cell_html_string_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_get_cell_html_string_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Read cell data by cell&#39;s name.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    The cell&#39;s name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    Object data, response status code and response headers



3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3717

def cells_get_cell_html_string_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_cell_html_string ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_cell_html_string"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_cell_html_string"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_get_cell_html_string"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/htmlstring".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_cell_html_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_cell(name, sheet_name, cell_or_method_name, opts = {}) ⇒ Object

Read cell data by cell’s name.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • cell_or_method_name —

    The cell&#39;s or method name. (Method name like firstcell, endcell etc.)

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (Object) 


3778
3779
3780
3781
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3778

def cells_get_worksheet_cell(name, sheet_name, cell_or_method_name, opts = {})
  data, _status_code, _headers = cells_get_worksheet_cell_with_http_info(name, sheet_name, cell_or_method_name, opts)
  return data
end

#cells_get_worksheet_cell_style(name, sheet_name, cell_name, opts = {}) ⇒ StyleResponse

Read cell’s style info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    Cell&#39;s name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



3853
3854
3855
3856
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3853

def cells_get_worksheet_cell_style(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_get_worksheet_cell_style_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_get_worksheet_cell_style_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(StyleResponse, Fixnum, Hash)>

Read cell&#39;s style info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    Cell&#39;s name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    StyleResponse data, response status code and response headers



3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3867

def cells_get_worksheet_cell_style_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_cell_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_cell_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_cell_style"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_get_worksheet_cell_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/style".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'StyleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_cell_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_cell_with_http_info(name, sheet_name, cell_or_method_name, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Read cell data by cell&#39;s name.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • cell_or_method_name —

    The cell&#39;s or method name. (Method name like firstcell, endcell etc.)

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    Object data, response status code and response headers



3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3792

def cells_get_worksheet_cell_with_http_info(name, sheet_name, cell_or_method_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_cell ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_cell"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_cell"
  end
  # verify the required parameter 'cell_or_method_name' is set
  if @api_client.config.client_side_validation && cell_or_method_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_or_method_name' when calling CellsApi.cells_get_worksheet_cell"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellOrMethodName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellOrMethodName' + '}', cell_or_method_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_cell\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_cells(name, sheet_name, opts = {}) ⇒ CellsResponse

Get cells info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :offest (Integer) —

    Begginig offset. (default to 0)

  • :count (Integer) —

    Maximum amount of cells in the response. (default to 0)

  • :folder (String) —

    Document&#39;s folder name.

  • :storage_name (String) —

    storage name.

Returns:



3929
3930
3931
3932
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3929

def cells_get_worksheet_cells(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_get_worksheet_cells_with_http_info(name, sheet_name, opts)
  return data
end

#cells_get_worksheet_cells_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsResponse, Fixnum, Hash)>

Get cells info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :offest (Integer) —

    Begginig offset.

  • :count (Integer) —

    Maximum amount of cells in the response.

  • :folder (String) —

    Document&#39;s folder name.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsResponse data, response status code and response headers



3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 3944

def cells_get_worksheet_cells_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_cells ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_cells"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_cells"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'offest'] = opts[:'offest'] if !opts[:'offest'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_cells\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_column(name, sheet_name, column_index, opts = {}) ⇒ ColumnResponse

Read worksheet column data by column’s index.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



4003
4004
4005
4006
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4003

def cells_get_worksheet_column(name, sheet_name, column_index, opts = {})
  data, _status_code, _headers = cells_get_worksheet_column_with_http_info(name, sheet_name, column_index, opts)
  return data
end

#cells_get_worksheet_column_with_http_info(name, sheet_name, column_index, opts = {}) ⇒ Array<(ColumnResponse, Fixnum, Hash)>

Read worksheet column data by column&#39;s index.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ColumnResponse data, response status code and response headers



4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4017

def cells_get_worksheet_column_with_http_info(name, sheet_name, column_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_column ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_column"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_column"
  end
  # verify the required parameter 'column_index' is set
  if @api_client.config.client_side_validation && column_index.nil?
    fail ArgumentError, "Missing the required parameter 'column_index' when calling CellsApi.cells_get_worksheet_column"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'columnIndex' + '}', column_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ColumnResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_column\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_columns(name, sheet_name, opts = {}) ⇒ ColumnsResponse

Read worksheet columns info.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workdook folder.

  • :storage_name (String) —

    storage name.

Returns:



4077
4078
4079
4080
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4077

def cells_get_worksheet_columns(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_get_worksheet_columns_with_http_info(name, sheet_name, opts)
  return data
end

#cells_get_worksheet_columns_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ColumnsResponse, Fixnum, Hash)>

Read worksheet columns info.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workdook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ColumnsResponse data, response status code and response headers



4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4090

def cells_get_worksheet_columns_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ColumnsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_row(name, sheet_name, row_index, opts = {}) ⇒ RowResponse

Read worksheet row data by row’s index.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



4147
4148
4149
4150
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4147

def cells_get_worksheet_row(name, sheet_name, row_index, opts = {})
  data, _status_code, _headers = cells_get_worksheet_row_with_http_info(name, sheet_name, row_index, opts)
  return data
end

#cells_get_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {}) ⇒ Array<(RowResponse, Fixnum, Hash)>

Read worksheet row data by row&#39;s index.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RowResponse data, response status code and response headers



4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4161

def cells_get_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_row ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_row"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_row"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling CellsApi.cells_get_worksheet_row"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'rowIndex' + '}', row_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'RowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_get_worksheet_rows(name, sheet_name, opts = {}) ⇒ RowsResponse

Read worksheet rows info.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workdook folder.

  • :storage_name (String) —

    storage name.

Returns:



4221
4222
4223
4224
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4221

def cells_get_worksheet_rows(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_get_worksheet_rows_with_http_info(name, sheet_name, opts)
  return data
end

#cells_get_worksheet_rows_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(RowsResponse, Fixnum, Hash)>

Read worksheet rows info.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workdook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RowsResponse data, response status code and response headers



4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4234

def cells_get_worksheet_rows_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_get_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_get_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_get_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'RowsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_get_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_hypelinks_delete_worksheet_hyperlink(name, sheet_name, hyperlink_index, opts = {}) ⇒ CellsCloudResponse

Delete worksheet hyperlink by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • hyperlink_index —

    The hyperlink&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



4291
4292
4293
4294
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4291

def cells_hypelinks_delete_worksheet_hyperlink(name, sheet_name, hyperlink_index, opts = {})
  data, _status_code, _headers = cells_hypelinks_delete_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts)
  return data
end

#cells_hypelinks_delete_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet hyperlink by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • hyperlink_index —

    The hyperlink&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4305

def cells_hypelinks_delete_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_hypelinks_delete_worksheet_hyperlink ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_hypelinks_delete_worksheet_hyperlink"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_hypelinks_delete_worksheet_hyperlink"
  end
  # verify the required parameter 'hyperlink_index' is set
  if @api_client.config.client_side_validation && hyperlink_index.nil?
    fail ArgumentError, "Missing the required parameter 'hyperlink_index' when calling CellsApi.cells_hypelinks_delete_worksheet_hyperlink"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/hyperlinks/{hyperlinkIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'hyperlinkIndex' + '}', hyperlink_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_hypelinks_delete_worksheet_hyperlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_hypelinks_delete_worksheet_hyperlinks(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Delete all hyperlinks in worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



4365
4366
4367
4368
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4365

def cells_hypelinks_delete_worksheet_hyperlinks(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_hypelinks_delete_worksheet_hyperlinks_with_http_info(name, sheet_name, opts)
  return data
end

#cells_hypelinks_delete_worksheet_hyperlinks_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete all hyperlinks in worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4378

def cells_hypelinks_delete_worksheet_hyperlinks_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_hypelinks_delete_worksheet_hyperlinks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_hypelinks_delete_worksheet_hyperlinks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_hypelinks_delete_worksheet_hyperlinks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/hyperlinks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_hypelinks_delete_worksheet_hyperlinks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_hypelinks_get_worksheet_hyperlink(name, sheet_name, hyperlink_index, opts = {}) ⇒ HyperlinkResponse

Get worksheet hyperlink by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • hyperlink_index —

    The hyperlink&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



4435
4436
4437
4438
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4435

def cells_hypelinks_get_worksheet_hyperlink(name, sheet_name, hyperlink_index, opts = {})
  data, _status_code, _headers = cells_hypelinks_get_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts)
  return data
end

#cells_hypelinks_get_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts = {}) ⇒ Array<(HyperlinkResponse, Fixnum, Hash)>

Get worksheet hyperlink by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • hyperlink_index —

    The hyperlink&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    HyperlinkResponse data, response status code and response headers



4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4449

def cells_hypelinks_get_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_hypelinks_get_worksheet_hyperlink ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_hypelinks_get_worksheet_hyperlink"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_hypelinks_get_worksheet_hyperlink"
  end
  # verify the required parameter 'hyperlink_index' is set
  if @api_client.config.client_side_validation && hyperlink_index.nil?
    fail ArgumentError, "Missing the required parameter 'hyperlink_index' when calling CellsApi.cells_hypelinks_get_worksheet_hyperlink"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/hyperlinks/{hyperlinkIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'hyperlinkIndex' + '}', hyperlink_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'HyperlinkResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_hypelinks_get_worksheet_hyperlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_hypelinks_get_worksheet_hyperlinks(name, sheet_name, opts = {}) ⇒ HyperlinksResponse

Get worksheet hyperlinks.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



4509
4510
4511
4512
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4509

def cells_hypelinks_get_worksheet_hyperlinks(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_hypelinks_get_worksheet_hyperlinks_with_http_info(name, sheet_name, opts)
  return data
end

#cells_hypelinks_get_worksheet_hyperlinks_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(HyperlinksResponse, Fixnum, Hash)>

Get worksheet hyperlinks.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    HyperlinksResponse data, response status code and response headers



4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4522

def cells_hypelinks_get_worksheet_hyperlinks_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_hypelinks_get_worksheet_hyperlinks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_hypelinks_get_worksheet_hyperlinks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_hypelinks_get_worksheet_hyperlinks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/hyperlinks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'HyperlinksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_hypelinks_get_worksheet_hyperlinks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_hypelinks_post_worksheet_hyperlink(name, sheet_name, hyperlink_index, opts = {}) ⇒ HyperlinkResponse

Update worksheet hyperlink by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • hyperlink_index —

    The hyperlink&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :hyperlink (Hyperlink) —

    Hyperlink object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



4580
4581
4582
4583
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4580

def cells_hypelinks_post_worksheet_hyperlink(name, sheet_name, hyperlink_index, opts = {})
  data, _status_code, _headers = cells_hypelinks_post_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts)
  return data
end

#cells_hypelinks_post_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts = {}) ⇒ Array<(HyperlinkResponse, Fixnum, Hash)>

Update worksheet hyperlink by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • hyperlink_index —

    The hyperlink&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :hyperlink (Hyperlink) —

    Hyperlink object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    HyperlinkResponse data, response status code and response headers



4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4595

def cells_hypelinks_post_worksheet_hyperlink_with_http_info(name, sheet_name, hyperlink_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_hypelinks_post_worksheet_hyperlink ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_hypelinks_post_worksheet_hyperlink"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_hypelinks_post_worksheet_hyperlink"
  end
  # verify the required parameter 'hyperlink_index' is set
  if @api_client.config.client_side_validation && hyperlink_index.nil?
    fail ArgumentError, "Missing the required parameter 'hyperlink_index' when calling CellsApi.cells_hypelinks_post_worksheet_hyperlink"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/hyperlinks/{hyperlinkIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'hyperlinkIndex' + '}', hyperlink_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'hyperlink'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'HyperlinkResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_hypelinks_post_worksheet_hyperlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_hypelinks_put_worksheet_hyperlink(name, sheet_name, first_row, first_column, total_rows, total_columns, address, opts = {}) ⇒ HyperlinkResponse

Add worksheet hyperlink.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • first_row
  • first_column
  • total_rows
  • total_columns
  • address
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



4660
4661
4662
4663
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4660

def cells_hypelinks_put_worksheet_hyperlink(name, sheet_name, first_row, first_column, total_rows, total_columns, address, opts = {})
  data, _status_code, _headers = cells_hypelinks_put_worksheet_hyperlink_with_http_info(name, sheet_name, first_row, first_column, total_rows, total_columns, address, opts)
  return data
end

#cells_hypelinks_put_worksheet_hyperlink_with_http_info(name, sheet_name, first_row, first_column, total_rows, total_columns, address, opts = {}) ⇒ Array<(HyperlinkResponse, Fixnum, Hash)>

Add worksheet hyperlink.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • first_row
  • first_column
  • total_rows
  • total_columns
  • address
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    HyperlinkResponse data, response status code and response headers



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4678

def cells_hypelinks_put_worksheet_hyperlink_with_http_info(name, sheet_name, first_row, first_column, total_rows, total_columns, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_hypelinks_put_worksheet_hyperlink ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # verify the required parameter 'first_row' is set
  if @api_client.config.client_side_validation && first_row.nil?
    fail ArgumentError, "Missing the required parameter 'first_row' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # verify the required parameter 'first_column' is set
  if @api_client.config.client_side_validation && first_column.nil?
    fail ArgumentError, "Missing the required parameter 'first_column' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # verify the required parameter 'total_rows' is set
  if @api_client.config.client_side_validation && total_rows.nil?
    fail ArgumentError, "Missing the required parameter 'total_rows' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # verify the required parameter 'total_columns' is set
  if @api_client.config.client_side_validation && total_columns.nil?
    fail ArgumentError, "Missing the required parameter 'total_columns' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling CellsApi.cells_hypelinks_put_worksheet_hyperlink"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/hyperlinks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'firstRow'] = first_row
  query_params[:'firstColumn'] = first_column
  query_params[:'totalRows'] = total_rows
  query_params[:'totalColumns'] = total_columns
  query_params[:'address'] = address
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HyperlinkResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_hypelinks_put_worksheet_hyperlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_delete_worksheet_list_object(name, sheet_name, list_object_index, opts = {}) ⇒ CellsCloudResponse

Delete worksheet list object by index

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • list_object_index —

    List object index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



4760
4761
4762
4763
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4760

def cells_list_objects_delete_worksheet_list_object(name, sheet_name, list_object_index, opts = {})
  data, _status_code, _headers = cells_list_objects_delete_worksheet_list_object_with_http_info(name, sheet_name, list_object_index, opts)
  return data
end

#cells_list_objects_delete_worksheet_list_object_with_http_info(name, sheet_name, list_object_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet list object by index

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • list_object_index —

    List object index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4774

def cells_list_objects_delete_worksheet_list_object_with_http_info(name, sheet_name, list_object_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_delete_worksheet_list_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_delete_worksheet_list_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_delete_worksheet_list_object"
  end
  # verify the required parameter 'list_object_index' is set
  if @api_client.config.client_side_validation && list_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'list_object_index' when calling CellsApi.cells_list_objects_delete_worksheet_list_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'listObjectIndex' + '}', list_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_delete_worksheet_list_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_delete_worksheet_list_objects(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Delete worksheet list objects

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



4834
4835
4836
4837
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4834

def cells_list_objects_delete_worksheet_list_objects(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_list_objects_delete_worksheet_list_objects_with_http_info(name, sheet_name, opts)
  return data
end

#cells_list_objects_delete_worksheet_list_objects_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet list objects

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4847

def cells_list_objects_delete_worksheet_list_objects_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_delete_worksheet_list_objects ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_delete_worksheet_list_objects"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_delete_worksheet_list_objects"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_delete_worksheet_list_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_get_worksheet_list_object(name, sheet_name, listobjectindex, opts = {}) ⇒ ListObjectResponse

Get worksheet list object info by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • listobjectindex —

    list object index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



4904
4905
4906
4907
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4904

def cells_list_objects_get_worksheet_list_object(name, sheet_name, listobjectindex, opts = {})
  data, _status_code, _headers = cells_list_objects_get_worksheet_list_object_with_http_info(name, sheet_name, listobjectindex, opts)
  return data
end

#cells_list_objects_get_worksheet_list_object_with_http_info(name, sheet_name, listobjectindex, opts = {}) ⇒ Array<(ListObjectResponse, Fixnum, Hash)>

Get worksheet list object info by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • listobjectindex —

    list object index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ListObjectResponse data, response status code and response headers



4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4918

def cells_list_objects_get_worksheet_list_object_with_http_info(name, sheet_name, listobjectindex, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_get_worksheet_list_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_get_worksheet_list_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_get_worksheet_list_object"
  end
  # verify the required parameter 'listobjectindex' is set
  if @api_client.config.client_side_validation && listobjectindex.nil?
    fail ArgumentError, "Missing the required parameter 'listobjectindex' when calling CellsApi.cells_list_objects_get_worksheet_list_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects/{listobjectindex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'listobjectindex' + '}', listobjectindex.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ListObjectResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_get_worksheet_list_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_get_worksheet_list_objects(name, sheet_name, opts = {}) ⇒ ListObjectsResponse

Get worksheet listobjects info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



4978
4979
4980
4981
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4978

def cells_list_objects_get_worksheet_list_objects(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_list_objects_get_worksheet_list_objects_with_http_info(name, sheet_name, opts)
  return data
end

#cells_list_objects_get_worksheet_list_objects_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ListObjectsResponse, Fixnum, Hash)>

Get worksheet listobjects info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ListObjectsResponse data, response status code and response headers



4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 4991

def cells_list_objects_get_worksheet_list_objects_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_get_worksheet_list_objects ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_get_worksheet_list_objects"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_get_worksheet_list_objects"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ListObjectsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_get_worksheet_list_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_post_worksheet_list_object(name, sheet_name, list_object_index, opts = {}) ⇒ CellsCloudResponse

Update list object

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • list_object_index —

    list Object index

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

    the optional parameters

Options Hash (opts):

  • :list_object (ListObject) —

    listObject dto in request body.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



5049
5050
5051
5052
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5049

def cells_list_objects_post_worksheet_list_object(name, sheet_name, list_object_index, opts = {})
  data, _status_code, _headers = cells_list_objects_post_worksheet_list_object_with_http_info(name, sheet_name, list_object_index, opts)
  return data
end

#cells_list_objects_post_worksheet_list_object_convert_to_range(name, sheet_name, list_object_index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • list_object_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



5125
5126
5127
5128
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5125

def cells_list_objects_post_worksheet_list_object_convert_to_range(name, sheet_name, list_object_index, opts = {})
  data, _status_code, _headers = cells_list_objects_post_worksheet_list_object_convert_to_range_with_http_info(name, sheet_name, list_object_index, opts)
  return data
end

#cells_list_objects_post_worksheet_list_object_convert_to_range_with_http_info(name, sheet_name, list_object_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • list_object_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5139

def cells_list_objects_post_worksheet_list_object_convert_to_range_with_http_info(name, sheet_name, list_object_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_post_worksheet_list_object_convert_to_range ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_convert_to_range"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_convert_to_range"
  end
  # verify the required parameter 'list_object_index' is set
  if @api_client.config.client_side_validation && list_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'list_object_index' when calling CellsApi.cells_list_objects_post_worksheet_list_object_convert_to_range"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/ConvertToRange".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'listObjectIndex' + '}', list_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_post_worksheet_list_object_convert_to_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_post_worksheet_list_object_sort_table(name, sheet_name, list_object_index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • list_object_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :data_sorter (DataSorter)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



5201
5202
5203
5204
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5201

def cells_list_objects_post_worksheet_list_object_sort_table(name, sheet_name, list_object_index, opts = {})
  data, _status_code, _headers = cells_list_objects_post_worksheet_list_object_sort_table_with_http_info(name, sheet_name, list_object_index, opts)
  return data
end

#cells_list_objects_post_worksheet_list_object_sort_table_with_http_info(name, sheet_name, list_object_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • list_object_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :data_sorter (DataSorter)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5216

def cells_list_objects_post_worksheet_list_object_sort_table_with_http_info(name, sheet_name, list_object_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_post_worksheet_list_object_sort_table ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_sort_table"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_sort_table"
  end
  # verify the required parameter 'list_object_index' is set
  if @api_client.config.client_side_validation && list_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'list_object_index' when calling CellsApi.cells_list_objects_post_worksheet_list_object_sort_table"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/sort".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'listObjectIndex' + '}', list_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data_sorter'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_post_worksheet_list_object_sort_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table(name, sheet_name, list_object_index, destsheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • list_object_index
  • destsheet_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



5279
5280
5281
5282
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5279

def cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table(name, sheet_name, list_object_index, destsheet_name, opts = {})
  data, _status_code, _headers = cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table_with_http_info(name, sheet_name, list_object_index, destsheet_name, opts)
  return data
end

#cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table_with_http_info(name, sheet_name, list_object_index, destsheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • list_object_index
  • destsheet_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    CellsCloudResponse data, response status code and response headers



5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5295

def cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table_with_http_info(name, sheet_name, list_object_index, destsheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table"
  end
  # verify the required parameter 'list_object_index' is set
  if @api_client.config.client_side_validation && list_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'list_object_index' when calling CellsApi.cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table"
  end
  # verify the required parameter 'destsheet_name' is set
  if @api_client.config.client_side_validation && destsheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'destsheet_name' when calling CellsApi.cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/SummarizeWithPivotTable".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'listObjectIndex' + '}', list_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'destsheetName'] = destsheet_name
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'request'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_post_worksheet_list_object_summarize_with_pivot_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_post_worksheet_list_object_with_http_info(name, sheet_name, list_object_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update list object

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • list_object_index —

    list Object index

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

    the optional parameters

Options Hash (opts):

  • :list_object (ListObject) —

    listObject dto in request body.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5064

def cells_list_objects_post_worksheet_list_object_with_http_info(name, sheet_name, list_object_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_post_worksheet_list_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_post_worksheet_list_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_post_worksheet_list_object"
  end
  # verify the required parameter 'list_object_index' is set
  if @api_client.config.client_side_validation && list_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'list_object_index' when calling CellsApi.cells_list_objects_post_worksheet_list_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'listObjectIndex' + '}', list_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'list_object'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_post_worksheet_list_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_list_objects_put_worksheet_list_object(name, sheet_name, start_row, start_column, end_row, end_column, opts = {}) ⇒ ListObjectResponse

Add a list object into worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • start_row —

    The start row of the list range.

  • start_column —

    The start row of the list range.

  • end_row —

    The start row of the list range.

  • end_column —

    The start row of the list range.

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

    the optional parameters

Options Hash (opts):

  • :has_headers (BOOLEAN) —

    Whether the range has headers. (default to true)

  • :list_object (ListObject) —

    List Object

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



5366
5367
5368
5369
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5366

def cells_list_objects_put_worksheet_list_object(name, sheet_name, start_row, start_column, end_row, end_column, opts = {})
  data, _status_code, _headers = cells_list_objects_put_worksheet_list_object_with_http_info(name, sheet_name, start_row, start_column, end_row, end_column, opts)
  return data
end

#cells_list_objects_put_worksheet_list_object_with_http_info(name, sheet_name, start_row, start_column, end_row, end_column, opts = {}) ⇒ Array<(ListObjectResponse, Fixnum, Hash)>

Add a list object into worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • start_row —

    The start row of the list range.

  • start_column —

    The start row of the list range.

  • end_row —

    The start row of the list range.

  • end_column —

    The start row of the list range.

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

    the optional parameters

Options Hash (opts):

  • :has_headers (BOOLEAN) —

    Whether the range has headers.

  • :list_object (ListObject) —

    List Object

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ListObjectResponse data, response status code and response headers



5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5385

def cells_list_objects_put_worksheet_list_object_with_http_info(name, sheet_name, start_row, start_column, end_row, end_column, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_list_objects_put_worksheet_list_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_list_objects_put_worksheet_list_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_list_objects_put_worksheet_list_object"
  end
  # verify the required parameter 'start_row' is set
  if @api_client.config.client_side_validation && start_row.nil?
    fail ArgumentError, "Missing the required parameter 'start_row' when calling CellsApi.cells_list_objects_put_worksheet_list_object"
  end
  # verify the required parameter 'start_column' is set
  if @api_client.config.client_side_validation && start_column.nil?
    fail ArgumentError, "Missing the required parameter 'start_column' when calling CellsApi.cells_list_objects_put_worksheet_list_object"
  end
  # verify the required parameter 'end_row' is set
  if @api_client.config.client_side_validation && end_row.nil?
    fail ArgumentError, "Missing the required parameter 'end_row' when calling CellsApi.cells_list_objects_put_worksheet_list_object"
  end
  # verify the required parameter 'end_column' is set
  if @api_client.config.client_side_validation && end_column.nil?
    fail ArgumentError, "Missing the required parameter 'end_column' when calling CellsApi.cells_list_objects_put_worksheet_list_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/listobjects".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startRow'] = start_row
  query_params[:'startColumn'] = start_column
  query_params[:'endRow'] = end_row
  query_params[:'endColumn'] = end_column
  query_params[:'hasHeaders'] = opts[:'has_headers'] if !opts[:'has_headers'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'list_object'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListObjectResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_list_objects_put_worksheet_list_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ole_objects_delete_worksheet_ole_object(name, sheet_name, ole_object_index, opts = {}) ⇒ CellsCloudResponse

Delete OLE object.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

  • ole_object_index —

    Ole object index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



5463
5464
5465
5466
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5463

def cells_ole_objects_delete_worksheet_ole_object(name, sheet_name, ole_object_index, opts = {})
  data, _status_code, _headers = cells_ole_objects_delete_worksheet_ole_object_with_http_info(name, sheet_name, ole_object_index, opts)
  return data
end

#cells_ole_objects_delete_worksheet_ole_object_with_http_info(name, sheet_name, ole_object_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete OLE object.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

  • ole_object_index —

    Ole object index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5477

def cells_ole_objects_delete_worksheet_ole_object_with_http_info(name, sheet_name, ole_object_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ole_objects_delete_worksheet_ole_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ole_objects_delete_worksheet_ole_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ole_objects_delete_worksheet_ole_object"
  end
  # verify the required parameter 'ole_object_index' is set
  if @api_client.config.client_side_validation && ole_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'ole_object_index' when calling CellsApi.cells_ole_objects_delete_worksheet_ole_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/oleobjects/{oleObjectIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'oleObjectIndex' + '}', ole_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ole_objects_delete_worksheet_ole_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ole_objects_delete_worksheet_ole_objects(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Delete all OLE objects.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



5537
5538
5539
5540
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5537

def cells_ole_objects_delete_worksheet_ole_objects(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ole_objects_delete_worksheet_ole_objects_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ole_objects_delete_worksheet_ole_objects_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete all OLE objects.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5550

def cells_ole_objects_delete_worksheet_ole_objects_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ole_objects_delete_worksheet_ole_objects ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ole_objects_delete_worksheet_ole_objects"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ole_objects_delete_worksheet_ole_objects"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/oleobjects".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ole_objects_delete_worksheet_ole_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ole_objects_get_worksheet_ole_object(name, sheet_name, object_number, opts = {}) ⇒ File

Get OLE object info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • object_number —

    The object number.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported object format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (File) 


5608
5609
5610
5611
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5608

def cells_ole_objects_get_worksheet_ole_object(name, sheet_name, object_number, opts = {})
  data, _status_code, _headers = cells_ole_objects_get_worksheet_ole_object_with_http_info(name, sheet_name, object_number, opts)
  return data
end

#cells_ole_objects_get_worksheet_ole_object_with_http_info(name, sheet_name, object_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get OLE object info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • object_number —

    The object number.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported object format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    File data, response status code and response headers



5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5623

def cells_ole_objects_get_worksheet_ole_object_with_http_info(name, sheet_name, object_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ole_objects_get_worksheet_ole_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ole_objects_get_worksheet_ole_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ole_objects_get_worksheet_ole_object"
  end
  # verify the required parameter 'object_number' is set
  if @api_client.config.client_side_validation && object_number.nil?
    fail ArgumentError, "Missing the required parameter 'object_number' when calling CellsApi.cells_ole_objects_get_worksheet_ole_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/oleobjects/{objectNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'objectNumber' + '}', object_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ole_objects_get_worksheet_ole_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ole_objects_get_worksheet_ole_objects(name, sheet_name, opts = {}) ⇒ OleObjectsResponse

Get worksheet OLE objects info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



5684
5685
5686
5687
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5684

def cells_ole_objects_get_worksheet_ole_objects(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ole_objects_get_worksheet_ole_objects_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ole_objects_get_worksheet_ole_objects_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(OleObjectsResponse, Fixnum, Hash)>

Get worksheet OLE objects info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    OleObjectsResponse data, response status code and response headers



5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5697

def cells_ole_objects_get_worksheet_ole_objects_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ole_objects_get_worksheet_ole_objects ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ole_objects_get_worksheet_ole_objects"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ole_objects_get_worksheet_ole_objects"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/oleobjects".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'OleObjectsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ole_objects_get_worksheet_ole_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ole_objects_post_update_worksheet_ole_object(name, sheet_name, ole_object_index, opts = {}) ⇒ CellsCloudResponse

Update OLE object.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

  • ole_object_index —

    Ole object index

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

    the optional parameters

Options Hash (opts):

  • :ole (OleObject) —

    Ole Object

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



5755
5756
5757
5758
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5755

def cells_ole_objects_post_update_worksheet_ole_object(name, sheet_name, ole_object_index, opts = {})
  data, _status_code, _headers = cells_ole_objects_post_update_worksheet_ole_object_with_http_info(name, sheet_name, ole_object_index, opts)
  return data
end

#cells_ole_objects_post_update_worksheet_ole_object_with_http_info(name, sheet_name, ole_object_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update OLE object.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

  • ole_object_index —

    Ole object index

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

    the optional parameters

Options Hash (opts):

  • :ole (OleObject) —

    Ole Object

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5770

def cells_ole_objects_post_update_worksheet_ole_object_with_http_info(name, sheet_name, ole_object_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ole_objects_post_update_worksheet_ole_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ole_objects_post_update_worksheet_ole_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ole_objects_post_update_worksheet_ole_object"
  end
  # verify the required parameter 'ole_object_index' is set
  if @api_client.config.client_side_validation && ole_object_index.nil?
    fail ArgumentError, "Missing the required parameter 'ole_object_index' when calling CellsApi.cells_ole_objects_post_update_worksheet_ole_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/oleobjects/{oleObjectIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'oleObjectIndex' + '}', ole_object_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'ole'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ole_objects_post_update_worksheet_ole_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ole_objects_put_worksheet_ole_object(name, sheet_name, opts = {}) ⇒ OleObjectResponse

Add OLE object

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

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

    the optional parameters

Options Hash (opts):

  • :ole_object (OleObject) —

    Ole Object

  • :upper_left_row (Integer) —

    Upper left row index (default to 0)

  • :upper_left_column (Integer) —

    Upper left column index (default to 0)

  • :height (Integer) —

    Height of oleObject, in unit of pixel (default to 0)

  • :width (Integer) —

    Width of oleObject, in unit of pixel (default to 0)

  • :ole_file (String) —

    OLE filename

  • :image_file (String) —

    Image filename

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



5837
5838
5839
5840
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5837

def cells_ole_objects_put_worksheet_ole_object(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ole_objects_put_worksheet_ole_object_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ole_objects_put_worksheet_ole_object_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(OleObjectResponse, Fixnum, Hash)>

Add OLE object

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

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

    the optional parameters

Options Hash (opts):

  • :ole_object (OleObject) —

    Ole Object

  • :upper_left_row (Integer) —

    Upper left row index

  • :upper_left_column (Integer) —

    Upper left column index

  • :height (Integer) —

    Height of oleObject, in unit of pixel

  • :width (Integer) —

    Width of oleObject, in unit of pixel

  • :ole_file (String) —

    OLE filename

  • :image_file (String) —

    Image filename

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    OleObjectResponse data, response status code and response headers



5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5857

def cells_ole_objects_put_worksheet_ole_object_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ole_objects_put_worksheet_ole_object ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ole_objects_put_worksheet_ole_object"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ole_objects_put_worksheet_ole_object"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/oleobjects".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'upperLeftRow'] = opts[:'upper_left_row'] if !opts[:'upper_left_row'].nil?
  query_params[:'upperLeftColumn'] = opts[:'upper_left_column'] if !opts[:'upper_left_column'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'oleFile'] = opts[:'ole_file'] if !opts[:'ole_file'].nil?
  query_params[:'imageFile'] = opts[:'image_file'] if !opts[:'image_file'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'ole_object'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OleObjectResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ole_objects_put_worksheet_ole_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_delete_horizontal_page_break(name, sheet_name, index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



5920
5921
5922
5923
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5920

def cells_page_breaks_delete_horizontal_page_break(name, sheet_name, index, opts = {})
  data, _status_code, _headers = cells_page_breaks_delete_horizontal_page_break_with_http_info(name, sheet_name, index, opts)
  return data
end

#cells_page_breaks_delete_horizontal_page_break_with_http_info(name, sheet_name, index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5934

def cells_page_breaks_delete_horizontal_page_break_with_http_info(name, sheet_name, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_delete_horizontal_page_break ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_delete_horizontal_page_break"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_delete_horizontal_page_break"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_page_breaks_delete_horizontal_page_break"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_delete_horizontal_page_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_delete_horizontal_page_breaks(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :row (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



5995
5996
5997
5998
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 5995

def cells_page_breaks_delete_horizontal_page_breaks(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_breaks_delete_horizontal_page_breaks_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_breaks_delete_horizontal_page_breaks_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :row (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6009

def cells_page_breaks_delete_horizontal_page_breaks_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_delete_horizontal_page_breaks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_delete_horizontal_page_breaks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_delete_horizontal_page_breaks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'row'] = opts[:'row'] if !opts[:'row'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_delete_horizontal_page_breaks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_delete_vertical_page_break(name, sheet_name, index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6067
6068
6069
6070
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6067

def cells_page_breaks_delete_vertical_page_break(name, sheet_name, index, opts = {})
  data, _status_code, _headers = cells_page_breaks_delete_vertical_page_break_with_http_info(name, sheet_name, index, opts)
  return data
end

#cells_page_breaks_delete_vertical_page_break_with_http_info(name, sheet_name, index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6081

def cells_page_breaks_delete_vertical_page_break_with_http_info(name, sheet_name, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_delete_vertical_page_break ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_delete_vertical_page_break"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_delete_vertical_page_break"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_page_breaks_delete_vertical_page_break"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_delete_vertical_page_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_delete_vertical_page_breaks(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :column (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6142
6143
6144
6145
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6142

def cells_page_breaks_delete_vertical_page_breaks(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_breaks_delete_vertical_page_breaks_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_breaks_delete_vertical_page_breaks_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :column (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6156

def cells_page_breaks_delete_vertical_page_breaks_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_delete_vertical_page_breaks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_delete_vertical_page_breaks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_delete_vertical_page_breaks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'column'] = opts[:'column'] if !opts[:'column'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_delete_vertical_page_breaks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_get_horizontal_page_break(name, sheet_name, index, opts = {}) ⇒ HorizontalPageBreakResponse

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6214
6215
6216
6217
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6214

def cells_page_breaks_get_horizontal_page_break(name, sheet_name, index, opts = {})
  data, _status_code, _headers = cells_page_breaks_get_horizontal_page_break_with_http_info(name, sheet_name, index, opts)
  return data
end

#cells_page_breaks_get_horizontal_page_break_with_http_info(name, sheet_name, index, opts = {}) ⇒ Array<(HorizontalPageBreakResponse, Fixnum, Hash)>

Returns HorizontalPageBreakResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6228

def cells_page_breaks_get_horizontal_page_break_with_http_info(name, sheet_name, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_get_horizontal_page_break ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_get_horizontal_page_break"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_get_horizontal_page_break"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_page_breaks_get_horizontal_page_break"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'HorizontalPageBreakResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_get_horizontal_page_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_get_horizontal_page_breaks(name, sheet_name, opts = {}) ⇒ HorizontalPageBreaksResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6288
6289
6290
6291
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6288

def cells_page_breaks_get_horizontal_page_breaks(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_breaks_get_horizontal_page_breaks_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_breaks_get_horizontal_page_breaks_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(HorizontalPageBreaksResponse, Fixnum, Hash)>

Returns HorizontalPageBreaksResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6301

def cells_page_breaks_get_horizontal_page_breaks_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_get_horizontal_page_breaks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_get_horizontal_page_breaks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_get_horizontal_page_breaks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'HorizontalPageBreaksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_get_horizontal_page_breaks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_get_vertical_page_break(name, sheet_name, index, opts = {}) ⇒ VerticalPageBreakResponse

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6358
6359
6360
6361
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6358

def cells_page_breaks_get_vertical_page_break(name, sheet_name, index, opts = {})
  data, _status_code, _headers = cells_page_breaks_get_vertical_page_break_with_http_info(name, sheet_name, index, opts)
  return data
end

#cells_page_breaks_get_vertical_page_break_with_http_info(name, sheet_name, index, opts = {}) ⇒ Array<(VerticalPageBreakResponse, Fixnum, Hash)>

Returns VerticalPageBreakResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    VerticalPageBreakResponse data, response status code and response headers



6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6372

def cells_page_breaks_get_vertical_page_break_with_http_info(name, sheet_name, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_get_vertical_page_break ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_get_vertical_page_break"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_get_vertical_page_break"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling CellsApi.cells_page_breaks_get_vertical_page_break"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks/{index}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'index' + '}', index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'VerticalPageBreakResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_get_vertical_page_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_get_vertical_page_breaks(name, sheet_name, opts = {}) ⇒ VerticalPageBreaksResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6432
6433
6434
6435
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6432

def cells_page_breaks_get_vertical_page_breaks(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_breaks_get_vertical_page_breaks_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_breaks_get_vertical_page_breaks_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(VerticalPageBreaksResponse, Fixnum, Hash)>

Returns VerticalPageBreaksResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    VerticalPageBreaksResponse data, response status code and response headers



6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6445

def cells_page_breaks_get_vertical_page_breaks_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_get_vertical_page_breaks ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_get_vertical_page_breaks"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_get_vertical_page_breaks"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'VerticalPageBreaksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_get_vertical_page_breaks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_put_horizontal_page_break(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cellname (String)
  • :row (Integer)
  • :column (Integer)
  • :start_column (Integer)
  • :end_column (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6506
6507
6508
6509
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6506

def cells_page_breaks_put_horizontal_page_break(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_breaks_put_horizontal_page_break_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_breaks_put_horizontal_page_break_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cellname (String)
  • :row (Integer)
  • :column (Integer)
  • :start_column (Integer)
  • :end_column (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6524

def cells_page_breaks_put_horizontal_page_break_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_put_horizontal_page_break ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_put_horizontal_page_break"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_put_horizontal_page_break"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/horizontalpagebreaks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellname'] = opts[:'cellname'] if !opts[:'cellname'].nil?
  query_params[:'row'] = opts[:'row'] if !opts[:'row'].nil?
  query_params[:'column'] = opts[:'column'] if !opts[:'column'].nil?
  query_params[:'startColumn'] = opts[:'start_column'] if !opts[:'start_column'].nil?
  query_params[:'endColumn'] = opts[:'end_column'] if !opts[:'end_column'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_put_horizontal_page_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_breaks_put_vertical_page_break(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cellname (String)
  • :column (Integer)
  • :row (Integer)
  • :start_row (Integer)
  • :end_row (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6590
6591
6592
6593
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6590

def cells_page_breaks_put_vertical_page_break(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_breaks_put_vertical_page_break_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_breaks_put_vertical_page_break_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cellname (String)
  • :column (Integer)
  • :row (Integer)
  • :start_row (Integer)
  • :end_row (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6608

def cells_page_breaks_put_vertical_page_break_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_breaks_put_vertical_page_break ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_breaks_put_vertical_page_break"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_breaks_put_vertical_page_break"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/verticalpagebreaks".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellname'] = opts[:'cellname'] if !opts[:'cellname'].nil?
  query_params[:'column'] = opts[:'column'] if !opts[:'column'].nil?
  query_params[:'row'] = opts[:'row'] if !opts[:'row'].nil?
  query_params[:'startRow'] = opts[:'start_row'] if !opts[:'start_row'].nil?
  query_params[:'endRow'] = opts[:'end_row'] if !opts[:'end_row'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_breaks_put_vertical_page_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_delete_header_footer(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

clear header footer

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6669
6670
6671
6672
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6669

def cells_page_setup_delete_header_footer(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_setup_delete_header_footer_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_setup_delete_header_footer_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

clear header footer

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6682

def cells_page_setup_delete_header_footer_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_delete_header_footer ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_delete_header_footer"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_delete_header_footer"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup/clearheaderfooter".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_delete_header_footer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_get_footer(name, sheet_name, opts = {}) ⇒ PageSectionsResponse

get page footer information

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6738
6739
6740
6741
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6738

def cells_page_setup_get_footer(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_setup_get_footer_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_setup_get_footer_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PageSectionsResponse, Fixnum, Hash)>

get page footer information

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    PageSectionsResponse data, response status code and response headers



6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6751

def cells_page_setup_get_footer_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_get_footer ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_get_footer"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_get_footer"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup/footer".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PageSectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_get_footer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_get_header(name, sheet_name, opts = {}) ⇒ PageSectionsResponse

get page header information

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6807
6808
6809
6810
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6807

def cells_page_setup_get_header(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_setup_get_header_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_setup_get_header_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PageSectionsResponse, Fixnum, Hash)>

get page header information

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    PageSectionsResponse data, response status code and response headers



6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6820

def cells_page_setup_get_header_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_get_header ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_get_header"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_get_header"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup/header".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PageSectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_get_header\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_get_page_setup(name, sheet_name, opts = {}) ⇒ PageSetupResponse

Get Page Setup information.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6876
6877
6878
6879
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6876

def cells_page_setup_get_page_setup(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_setup_get_page_setup_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_setup_get_page_setup_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PageSetupResponse, Fixnum, Hash)>

Get Page Setup information.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    PageSetupResponse data, response status code and response headers



6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6889

def cells_page_setup_get_page_setup_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_get_page_setup ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_get_page_setup"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_get_page_setup"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PageSetupResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_get_page_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_post_footer(name, sheet_name, section, script, is_first_page, opts = {}) ⇒ CellsCloudResponse

update page footer information

Parameters:

  • name
  • sheet_name
  • section
  • script
  • is_first_page
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



6948
6949
6950
6951
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6948

def cells_page_setup_post_footer(name, sheet_name, section, script, is_first_page, opts = {})
  data, _status_code, _headers = cells_page_setup_post_footer_with_http_info(name, sheet_name, section, script, is_first_page, opts)
  return data
end

#cells_page_setup_post_footer_with_http_info(name, sheet_name, section, script, is_first_page, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

update page footer information

Parameters:

  • name
  • sheet_name
  • section
  • script
  • is_first_page
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 6964

def cells_page_setup_post_footer_with_http_info(name, sheet_name, section, script, is_first_page, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_post_footer ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_post_footer"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_post_footer"
  end
  # verify the required parameter 'section' is set
  if @api_client.config.client_side_validation && section.nil?
    fail ArgumentError, "Missing the required parameter 'section' when calling CellsApi.cells_page_setup_post_footer"
  end
  # verify the required parameter 'script' is set
  if @api_client.config.client_side_validation && script.nil?
    fail ArgumentError, "Missing the required parameter 'script' when calling CellsApi.cells_page_setup_post_footer"
  end
  # verify the required parameter 'is_first_page' is set
  if @api_client.config.client_side_validation && is_first_page.nil?
    fail ArgumentError, "Missing the required parameter 'is_first_page' when calling CellsApi.cells_page_setup_post_footer"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup/footer".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'section'] = section
  query_params[:'script'] = script
  query_params[:'isFirstPage'] = is_first_page
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_post_footer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_post_header(name, sheet_name, section, script, is_first_page, opts = {}) ⇒ CellsCloudResponse

update page header information

Parameters:

  • name
  • sheet_name
  • section
  • script
  • is_first_page
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



7038
7039
7040
7041
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7038

def cells_page_setup_post_header(name, sheet_name, section, script, is_first_page, opts = {})
  data, _status_code, _headers = cells_page_setup_post_header_with_http_info(name, sheet_name, section, script, is_first_page, opts)
  return data
end

#cells_page_setup_post_header_with_http_info(name, sheet_name, section, script, is_first_page, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

update page header information

Parameters:

  • name
  • sheet_name
  • section
  • script
  • is_first_page
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7054

def cells_page_setup_post_header_with_http_info(name, sheet_name, section, script, is_first_page, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_post_header ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_post_header"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_post_header"
  end
  # verify the required parameter 'section' is set
  if @api_client.config.client_side_validation && section.nil?
    fail ArgumentError, "Missing the required parameter 'section' when calling CellsApi.cells_page_setup_post_header"
  end
  # verify the required parameter 'script' is set
  if @api_client.config.client_side_validation && script.nil?
    fail ArgumentError, "Missing the required parameter 'script' when calling CellsApi.cells_page_setup_post_header"
  end
  # verify the required parameter 'is_first_page' is set
  if @api_client.config.client_side_validation && is_first_page.nil?
    fail ArgumentError, "Missing the required parameter 'is_first_page' when calling CellsApi.cells_page_setup_post_header"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup/header".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'section'] = section
  query_params[:'script'] = script
  query_params[:'isFirstPage'] = is_first_page
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_post_header\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_page_setup_post_page_setup(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Update Page Setup information.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_setup (PageSetup)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



7126
7127
7128
7129
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7126

def cells_page_setup_post_page_setup(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_page_setup_post_page_setup_with_http_info(name, sheet_name, opts)
  return data
end

#cells_page_setup_post_page_setup_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update Page Setup information.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_setup (PageSetup)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7140

def cells_page_setup_post_page_setup_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_page_setup_post_page_setup ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_page_setup_post_page_setup"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_page_setup_post_page_setup"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pagesetup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'page_setup'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_page_setup_post_page_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pictures_delete_worksheet_picture(name, sheet_name, picture_index, opts = {}) ⇒ CellsCloudResponse

Delete a picture object in worksheet

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

  • picture_index —

    Picture index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



7197
7198
7199
7200
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7197

def cells_pictures_delete_worksheet_picture(name, sheet_name, picture_index, opts = {})
  data, _status_code, _headers = cells_pictures_delete_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts)
  return data
end

#cells_pictures_delete_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete a picture object in worksheet

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

  • picture_index —

    Picture index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7211

def cells_pictures_delete_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pictures_delete_worksheet_picture ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pictures_delete_worksheet_picture"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pictures_delete_worksheet_picture"
  end
  # verify the required parameter 'picture_index' is set
  if @api_client.config.client_side_validation && picture_index.nil?
    fail ArgumentError, "Missing the required parameter 'picture_index' when calling CellsApi.cells_pictures_delete_worksheet_picture"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pictures/{pictureIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pictureIndex' + '}', picture_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pictures_delete_worksheet_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pictures_delete_worksheet_pictures(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Delete all pictures in worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



7271
7272
7273
7274
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7271

def cells_pictures_delete_worksheet_pictures(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_pictures_delete_worksheet_pictures_with_http_info(name, sheet_name, opts)
  return data
end

#cells_pictures_delete_worksheet_pictures_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete all pictures in worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7284

def cells_pictures_delete_worksheet_pictures_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pictures_delete_worksheet_pictures ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pictures_delete_worksheet_pictures"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pictures_delete_worksheet_pictures"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pictures".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pictures_delete_worksheet_pictures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pictures_get_worksheet_picture(name, sheet_name, picture_index, opts = {}) ⇒ File

GRead worksheet picture by number.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • picture_index —

    The picture index.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported object format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (File) 


7342
7343
7344
7345
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7342

def cells_pictures_get_worksheet_picture(name, sheet_name, picture_index, opts = {})
  data, _status_code, _headers = cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts)
  return data
end

#cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

GRead worksheet picture by number.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • picture_index —

    The picture index.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported object format.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    File data, response status code and response headers



7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7357

def cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pictures_get_worksheet_picture ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pictures_get_worksheet_picture"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pictures_get_worksheet_picture"
  end
  # verify the required parameter 'picture_index' is set
  if @api_client.config.client_side_validation && picture_index.nil?
    fail ArgumentError, "Missing the required parameter 'picture_index' when calling CellsApi.cells_pictures_get_worksheet_picture"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pictures/{pictureIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pictureIndex' + '}', picture_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pictures_get_worksheet_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pictures_get_worksheet_pictures(name, sheet_name, opts = {}) ⇒ PicturesResponse

Read worksheet pictures.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



7418
7419
7420
7421
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7418

def cells_pictures_get_worksheet_pictures(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_pictures_get_worksheet_pictures_with_http_info(name, sheet_name, opts)
  return data
end

#cells_pictures_get_worksheet_pictures_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PicturesResponse, Fixnum, Hash)>

Read worksheet pictures.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    PicturesResponse data, response status code and response headers



7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7431

def cells_pictures_get_worksheet_pictures_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pictures_get_worksheet_pictures ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pictures_get_worksheet_pictures"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pictures_get_worksheet_pictures"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pictures".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PicturesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pictures_get_worksheet_pictures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pictures_post_worksheet_picture(name, sheet_name, picture_index, opts = {}) ⇒ PictureResponse

Update worksheet picture by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • picture_index —

    The picture&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :picture (Picture) —

    Picture object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



7489
7490
7491
7492
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7489

def cells_pictures_post_worksheet_picture(name, sheet_name, picture_index, opts = {})
  data, _status_code, _headers = cells_pictures_post_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts)
  return data
end

#cells_pictures_post_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts = {}) ⇒ Array<(PictureResponse, Fixnum, Hash)>

Update worksheet picture by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • picture_index —

    The picture&#39;s index.

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

    the optional parameters

Options Hash (opts):

  • :picture (Picture) —

    Picture object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    PictureResponse data, response status code and response headers



7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7504

def cells_pictures_post_worksheet_picture_with_http_info(name, sheet_name, picture_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pictures_post_worksheet_picture ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pictures_post_worksheet_picture"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pictures_post_worksheet_picture"
  end
  # verify the required parameter 'picture_index' is set
  if @api_client.config.client_side_validation && picture_index.nil?
    fail ArgumentError, "Missing the required parameter 'picture_index' when calling CellsApi.cells_pictures_post_worksheet_picture"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pictures/{pictureIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pictureIndex' + '}', picture_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'picture'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PictureResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pictures_post_worksheet_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pictures_put_worksheet_add_picture(name, sheet_name, opts = {}) ⇒ PicturesResponse

Add a new worksheet picture.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

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

    the optional parameters

Options Hash (opts):

  • :picture (Picture) —

    Pictute object

  • :upper_left_row (Integer) —

    The image upper left row. (default to 0)

  • :upper_left_column (Integer) —

    The image upper left column. (default to 0)

  • :lower_right_row (Integer) —

    The image low right row. (default to 0)

  • :lower_right_column (Integer) —

    The image low right column. (default to 0)

  • :picture_path (String) —

    The picture path, if not provided the picture data is inspected in the request body.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



7570
7571
7572
7573
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7570

def cells_pictures_put_worksheet_add_picture(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_pictures_put_worksheet_add_picture_with_http_info(name, sheet_name, opts)
  return data
end

#cells_pictures_put_worksheet_add_picture_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PicturesResponse, Fixnum, Hash)>

Add a new worksheet picture.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worsheet name.

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

    the optional parameters

Options Hash (opts):

  • :picture (Picture) —

    Pictute object

  • :upper_left_row (Integer) —

    The image upper left row.

  • :upper_left_column (Integer) —

    The image upper left column.

  • :lower_right_row (Integer) —

    The image low right row.

  • :lower_right_column (Integer) —

    The image low right column.

  • :picture_path (String) —

    The picture path, if not provided the picture data is inspected in the request body.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    PicturesResponse data, response status code and response headers



7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7589

def cells_pictures_put_worksheet_add_picture_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pictures_put_worksheet_add_picture ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pictures_put_worksheet_add_picture"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pictures_put_worksheet_add_picture"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pictures".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'upperLeftRow'] = opts[:'upper_left_row'] if !opts[:'upper_left_row'].nil?
  query_params[:'upperLeftColumn'] = opts[:'upper_left_column'] if !opts[:'upper_left_column'].nil?
  query_params[:'lowerRightRow'] = opts[:'lower_right_row'] if !opts[:'lower_right_row'].nil?
  query_params[:'lowerRightColumn'] = opts[:'lower_right_column'] if !opts[:'lower_right_column'].nil?
  query_params[:'picturePath'] = opts[:'picture_path'] if !opts[:'picture_path'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'picture'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PicturesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pictures_put_worksheet_add_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_delete_pivot_table_field(name, sheet_name, pivot_table_index, pivot_field_type, opts = {}) ⇒ CellsCloudResponse

Delete pivot field into into pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

  • pivot_field_type —

    The fields area type.

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

    the optional parameters

Options Hash (opts):

  • :request (PivotTableFieldRequest) —

    Dto that conrains field indexes

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



7653
7654
7655
7656
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7653

def cells_pivot_tables_delete_pivot_table_field(name, sheet_name, pivot_table_index, pivot_field_type, opts = {})
  data, _status_code, _headers = cells_pivot_tables_delete_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, opts)
  return data
end

#cells_pivot_tables_delete_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete pivot field into into pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

  • pivot_field_type —

    The fields area type.

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

    the optional parameters

Options Hash (opts):

  • :request (PivotTableFieldRequest) —

    Dto that conrains field indexes

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7669

def cells_pivot_tables_delete_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_delete_pivot_table_field ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_delete_pivot_table_field"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_delete_pivot_table_field"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_delete_pivot_table_field"
  end
  # verify the required parameter 'pivot_field_type' is set
  if @api_client.config.client_side_validation && pivot_field_type.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.cells_pivot_tables_delete_pivot_table_field"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'pivotFieldType'] = pivot_field_type
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'request'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_delete_pivot_table_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_delete_worksheet_pivot_table(name, sheet_name, pivot_table_index, opts = {}) ⇒ CellsCloudResponse

Delete worksheet pivot table by index

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



7735
7736
7737
7738
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7735

def cells_pivot_tables_delete_worksheet_pivot_table(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_delete_worksheet_pivot_table_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_delete_worksheet_pivot_table_filter(name, sheet_name, pivot_table_index, field_index, opts = {}) ⇒ CellsCloudResponse

delete pivot filter for piovt table

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



7812
7813
7814
7815
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7812

def cells_pivot_tables_delete_worksheet_pivot_table_filter(name, sheet_name, pivot_table_index, field_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_delete_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, field_index, opts)
  return data
end

#cells_pivot_tables_delete_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, field_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

delete pivot filter for piovt table

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • field_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7828

def cells_pivot_tables_delete_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, field_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters/{fieldIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s).sub('{' + 'fieldIndex' + '}', field_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_delete_worksheet_pivot_table_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_delete_worksheet_pivot_table_filters(name, sheet_name, pivot_table_index, opts = {}) ⇒ CellsCloudResponse

delete all pivot filters for piovt table

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



7895
7896
7897
7898
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7895

def cells_pivot_tables_delete_worksheet_pivot_table_filters(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_delete_worksheet_pivot_table_filters_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_delete_worksheet_pivot_table_filters_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

delete all pivot filters for piovt table

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7910

def cells_pivot_tables_delete_worksheet_pivot_table_filters_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filters ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filters"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filters"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table_filters"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_delete_worksheet_pivot_table_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_delete_worksheet_pivot_table_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet pivot table by index

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7749

def cells_pivot_tables_delete_worksheet_pivot_table_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_delete_worksheet_pivot_table ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_table"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_delete_worksheet_pivot_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_delete_worksheet_pivot_tables(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Delete worksheet pivot tables

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



7971
7972
7973
7974
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7971

def cells_pivot_tables_delete_worksheet_pivot_tables(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_pivot_tables_delete_worksheet_pivot_tables_with_http_info(name, sheet_name, opts)
  return data
end

#cells_pivot_tables_delete_worksheet_pivot_tables_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet pivot tables

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 7984

def cells_pivot_tables_delete_worksheet_pivot_tables_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_delete_worksheet_pivot_tables ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_tables"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_delete_worksheet_pivot_tables"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_delete_worksheet_pivot_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_get_pivot_table_field(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, opts = {}) ⇒ PivotFieldResponse

Get pivot field into into pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

  • pivot_field_index —

    The field index in the base fields.

  • pivot_field_type —

    The fields area type.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



8043
8044
8045
8046
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8043

def cells_pivot_tables_get_pivot_table_field(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, opts = {})
  data, _status_code, _headers = cells_pivot_tables_get_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, opts)
  return data
end

#cells_pivot_tables_get_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, opts = {}) ⇒ Array<(PivotFieldResponse, Fixnum, Hash)>

Get pivot field into into pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

  • pivot_field_index —

    The field index in the base fields.

  • pivot_field_type —

    The fields area type.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    PivotFieldResponse data, response status code and response headers



8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8059

def cells_pivot_tables_get_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_get_pivot_table_field ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_get_pivot_table_field"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_get_pivot_table_field"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_get_pivot_table_field"
  end
  # verify the required parameter 'pivot_field_index' is set
  if @api_client.config.client_side_validation && pivot_field_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_index' when calling CellsApi.cells_pivot_tables_get_pivot_table_field"
  end
  # verify the required parameter 'pivot_field_type' is set
  if @api_client.config.client_side_validation && pivot_field_type.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.cells_pivot_tables_get_pivot_table_field"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'pivotFieldIndex'] = pivot_field_index
  query_params[:'pivotFieldType'] = pivot_field_type
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PivotFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_get_pivot_table_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_get_worksheet_pivot_table(name, sheet_name, pivottable_index, opts = {}) ⇒ PivotTableResponse

Get worksheet pivottable info by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



8130
8131
8132
8133
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8130

def cells_pivot_tables_get_worksheet_pivot_table(name, sheet_name, pivottable_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_get_worksheet_pivot_table_with_http_info(name, sheet_name, pivottable_index, opts)
  return data
end

#cells_pivot_tables_get_worksheet_pivot_table_filter(name, sheet_name, pivot_table_index, filter_index, opts = {}) ⇒ PivotFilterResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • filter_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



8206
8207
8208
8209
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8206

def cells_pivot_tables_get_worksheet_pivot_table_filter(name, sheet_name, pivot_table_index, filter_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_get_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, filter_index, opts)
  return data
end

#cells_pivot_tables_get_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, filter_index, opts = {}) ⇒ Array<(PivotFilterResponse, Fixnum, Hash)>

Returns PivotFilterResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • filter_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    PivotFilterResponse data, response status code and response headers



8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8221

def cells_pivot_tables_get_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, filter_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'filter_index' is set
  if @api_client.config.client_side_validation && filter_index.nil?
    fail ArgumentError, "Missing the required parameter 'filter_index' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters/{filterIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s).sub('{' + 'filterIndex' + '}', filter_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PivotFilterResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_get_worksheet_pivot_table_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_get_worksheet_pivot_table_filters(name, sheet_name, pivot_table_index, opts = {}) ⇒ PivotFiltersResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



8286
8287
8288
8289
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8286

def cells_pivot_tables_get_worksheet_pivot_table_filters(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_get_worksheet_pivot_table_filters_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_get_worksheet_pivot_table_filters_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(PivotFiltersResponse, Fixnum, Hash)>

Returns PivotFiltersResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    PivotFiltersResponse data, response status code and response headers



8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8300

def cells_pivot_tables_get_worksheet_pivot_table_filters_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filters ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filters"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filters"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table_filters"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PivotFiltersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_get_worksheet_pivot_table_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_get_worksheet_pivot_table_with_http_info(name, sheet_name, pivottable_index, opts = {}) ⇒ Array<(PivotTableResponse, Fixnum, Hash)>

Get worksheet pivottable info by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    PivotTableResponse data, response status code and response headers



8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8144

def cells_pivot_tables_get_worksheet_pivot_table_with_http_info(name, sheet_name, pivottable_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_get_worksheet_pivot_table ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table"
  end
  # verify the required parameter 'pivottable_index' is set
  if @api_client.config.client_side_validation && pivottable_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivottable_index' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_table"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivottableIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivottableIndex' + '}', pivottable_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PivotTableResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_get_worksheet_pivot_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_get_worksheet_pivot_tables(name, sheet_name, opts = {}) ⇒ PivotTablesResponse

Get worksheet pivottables info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



8360
8361
8362
8363
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8360

def cells_pivot_tables_get_worksheet_pivot_tables(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_pivot_tables_get_worksheet_pivot_tables_with_http_info(name, sheet_name, opts)
  return data
end

#cells_pivot_tables_get_worksheet_pivot_tables_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PivotTablesResponse, Fixnum, Hash)>

Get worksheet pivottables info.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    PivotTablesResponse data, response status code and response headers



8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8373

def cells_pivot_tables_get_worksheet_pivot_tables_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_get_worksheet_pivot_tables ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_tables"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_get_worksheet_pivot_tables"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'PivotTablesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_get_worksheet_pivot_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_pivot_table_cell_style(name, sheet_name, pivot_table_index, column, row, opts = {}) ⇒ CellsCloudResponse

Update cell style for pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto in request body.

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



8434
8435
8436
8437
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8434

def cells_pivot_tables_post_pivot_table_cell_style(name, sheet_name, pivot_table_index, column, row, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_pivot_table_cell_style_with_http_info(name, sheet_name, pivot_table_index, column, row, opts)
  return data
end

#cells_pivot_tables_post_pivot_table_cell_style_with_http_info(name, sheet_name, pivot_table_index, column, row, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update cell style for pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto in request body.

  • :need_re_calculate (BOOLEAN)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8452

def cells_pivot_tables_post_pivot_table_cell_style_with_http_info(name, sheet_name, pivot_table_index, column, row, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_pivot_table_cell_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_pivot_table_cell_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_pivot_table_cell_style"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_cell_style"
  end
  # verify the required parameter 'column' is set
  if @api_client.config.client_side_validation && column.nil?
    fail ArgumentError, "Missing the required parameter 'column' when calling CellsApi.cells_pivot_tables_post_pivot_table_cell_style"
  end
  # verify the required parameter 'row' is set
  if @api_client.config.client_side_validation && row.nil?
    fail ArgumentError, "Missing the required parameter 'row' when calling CellsApi.cells_pivot_tables_post_pivot_table_cell_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/Format".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'column'] = column
  query_params[:'row'] = row
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'style'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_pivot_table_cell_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_pivot_table_field_hide_item(name, sheet_name, pivot_table_index, pivot_field_type, field_index, item_index, is_hide, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • pivot_field_type
  • field_index
  • item_index
  • is_hide
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



8529
8530
8531
8532
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8529

def cells_pivot_tables_post_pivot_table_field_hide_item(name, sheet_name, pivot_table_index, pivot_field_type, field_index, item_index, is_hide, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_pivot_table_field_hide_item_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, field_index, item_index, is_hide, opts)
  return data
end

#cells_pivot_tables_post_pivot_table_field_hide_item_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, field_index, item_index, is_hide, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • pivot_field_type
  • field_index
  • item_index
  • is_hide
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8548

def cells_pivot_tables_post_pivot_table_field_hide_item_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, field_index, item_index, is_hide, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # verify the required parameter 'pivot_field_type' is set
  if @api_client.config.client_side_validation && pivot_field_type.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # verify the required parameter 'item_index' is set
  if @api_client.config.client_side_validation && item_index.nil?
    fail ArgumentError, "Missing the required parameter 'item_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # verify the required parameter 'is_hide' is set
  if @api_client.config.client_side_validation && is_hide.nil?
    fail ArgumentError, "Missing the required parameter 'is_hide' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_hide_item"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField/Hide".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'pivotFieldType'] = pivot_field_type
  query_params[:'fieldIndex'] = field_index
  query_params[:'itemIndex'] = item_index
  query_params[:'isHide'] = is_hide
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_pivot_table_field_hide_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_pivot_table_field_move_to(name, sheet_name, pivot_table_index, field_index, from, to, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • field_index
  • from
  • to
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



8633
8634
8635
8636
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8633

def cells_pivot_tables_post_pivot_table_field_move_to(name, sheet_name, pivot_table_index, field_index, from, to, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_pivot_table_field_move_to_with_http_info(name, sheet_name, pivot_table_index, field_index, from, to, opts)
  return data
end

#cells_pivot_tables_post_pivot_table_field_move_to_with_http_info(name, sheet_name, pivot_table_index, field_index, from, to, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • field_index
  • from
  • to
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8650

def cells_pivot_tables_post_pivot_table_field_move_to_with_http_info(name, sheet_name, pivot_table_index, field_index, from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_pivot_table_field_move_to ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_move_to"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_move_to"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_move_to"
  end
  # verify the required parameter 'field_index' is set
  if @api_client.config.client_side_validation && field_index.nil?
    fail ArgumentError, "Missing the required parameter 'field_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_move_to"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_move_to"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling CellsApi.cells_pivot_tables_post_pivot_table_field_move_to"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField/Move".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'fieldIndex'] = field_index
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_pivot_table_field_move_to\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_pivot_table_style(name, sheet_name, pivot_table_index, opts = {}) ⇒ CellsCloudResponse

Update style for pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto in request body.

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



8728
8729
8730
8731
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8728

def cells_pivot_tables_post_pivot_table_style(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_pivot_table_style_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_post_pivot_table_style_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update style for pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto in request body.

  • :need_re_calculate (BOOLEAN)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8744

def cells_pivot_tables_post_pivot_table_style_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_pivot_table_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_pivot_table_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_pivot_table_style"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/FormatAll".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'style'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_pivot_table_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_pivot_table_update_pivot_field(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, pivot_field, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • pivot_field_index
  • pivot_field_type
  • pivot_field
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String)

Returns:



8809
8810
8811
8812
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8809

def cells_pivot_tables_post_pivot_table_update_pivot_field(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, pivot_field, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_pivot_table_update_pivot_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, pivot_field, opts)
  return data
end

#cells_pivot_tables_post_pivot_table_update_pivot_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, pivot_field, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • pivot_field_index
  • pivot_field_type
  • pivot_field
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN)
  • :folder (String)

Returns:

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

    CellsCloudResponse data, response status code and response headers



8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8826

def cells_pivot_tables_post_pivot_table_update_pivot_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_index, pivot_field_type, pivot_field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field"
  end
  # verify the required parameter 'pivot_field_index' is set
  if @api_client.config.client_side_validation && pivot_field_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field"
  end
  # verify the required parameter 'pivot_field_type' is set
  if @api_client.config.client_side_validation && pivot_field_type.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field"
  end
  # verify the required parameter 'pivot_field' is set
  if @api_client.config.client_side_validation && pivot_field.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_field"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFields/{pivotFieldIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s).sub('{' + 'pivotFieldIndex' + '}', pivot_field_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'pivotFieldType'] = pivot_field_type
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(pivot_field)
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_pivot_table_update_pivot_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_pivot_table_update_pivot_fields(name, sheet_name, pivot_table_index, pivot_field_type, pivot_field, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • pivot_field_type
  • pivot_field
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String)

Returns:



8902
8903
8904
8905
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8902

def cells_pivot_tables_post_pivot_table_update_pivot_fields(name, sheet_name, pivot_table_index, pivot_field_type, pivot_field, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_pivot_table_update_pivot_fields_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, pivot_field, opts)
  return data
end

#cells_pivot_tables_post_pivot_table_update_pivot_fields_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, pivot_field, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • pivot_field_type
  • pivot_field
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :need_re_calculate (BOOLEAN)
  • :folder (String)

Returns:

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

    CellsCloudResponse data, response status code and response headers



8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8918

def cells_pivot_tables_post_pivot_table_update_pivot_fields_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, pivot_field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_fields ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_fields"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_fields"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_fields"
  end
  # verify the required parameter 'pivot_field_type' is set
  if @api_client.config.client_side_validation && pivot_field_type.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_fields"
  end
  # verify the required parameter 'pivot_field' is set
  if @api_client.config.client_side_validation && pivot_field.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field' when calling CellsApi.cells_pivot_tables_post_pivot_table_update_pivot_fields"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFields".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'pivotFieldType'] = pivot_field_type
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(pivot_field)
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_pivot_table_update_pivot_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_worksheet_pivot_table_calculate(name, sheet_name, pivot_table_index, opts = {}) ⇒ CellsCloudResponse

Calculates pivottable’s data to cells.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



8988
8989
8990
8991
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 8988

def cells_pivot_tables_post_worksheet_pivot_table_calculate(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_worksheet_pivot_table_calculate_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_post_worksheet_pivot_table_calculate_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Calculates pivottable&#39;s data to cells.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9002

def cells_pivot_tables_post_worksheet_pivot_table_calculate_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_worksheet_pivot_table_calculate ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_worksheet_pivot_table_calculate"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_worksheet_pivot_table_calculate"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_worksheet_pivot_table_calculate"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/Calculate".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_worksheet_pivot_table_calculate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_post_worksheet_pivot_table_move(name, sheet_name, pivot_table_index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :row (Integer)
  • :column (Integer)
  • :dest_cell_name (String)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



9066
9067
9068
9069
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9066

def cells_pivot_tables_post_worksheet_pivot_table_move(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_post_worksheet_pivot_table_move_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_post_worksheet_pivot_table_move_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :row (Integer)
  • :column (Integer)
  • :dest_cell_name (String)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9083

def cells_pivot_tables_post_worksheet_pivot_table_move_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_post_worksheet_pivot_table_move ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_post_worksheet_pivot_table_move"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_post_worksheet_pivot_table_move"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_post_worksheet_pivot_table_move"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/Move".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'row'] = opts[:'row'] if !opts[:'row'].nil?
  query_params[:'column'] = opts[:'column'] if !opts[:'column'].nil?
  query_params[:'destCellName'] = opts[:'dest_cell_name'] if !opts[:'dest_cell_name'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_post_worksheet_pivot_table_move\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_put_pivot_table_field(name, sheet_name, pivot_table_index, pivot_field_type, opts = {}) ⇒ CellsCloudResponse

Add pivot field into into pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

  • pivot_field_type —

    The fields area type.

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

    the optional parameters

Options Hash (opts):

  • :request (PivotTableFieldRequest) —

    Dto that conrains field indexes

  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



9150
9151
9152
9153
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9150

def cells_pivot_tables_put_pivot_table_field(name, sheet_name, pivot_table_index, pivot_field_type, opts = {})
  data, _status_code, _headers = cells_pivot_tables_put_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, opts)
  return data
end

#cells_pivot_tables_put_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Add pivot field into into pivot table

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • pivot_table_index —

    Pivot table index

  • pivot_field_type —

    The fields area type.

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

    the optional parameters

Options Hash (opts):

  • :request (PivotTableFieldRequest) —

    Dto that conrains field indexes

  • :need_re_calculate (BOOLEAN)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9167

def cells_pivot_tables_put_pivot_table_field_with_http_info(name, sheet_name, pivot_table_index, pivot_field_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_put_pivot_table_field ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_put_pivot_table_field"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_put_pivot_table_field"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_put_pivot_table_field"
  end
  # verify the required parameter 'pivot_field_type' is set
  if @api_client.config.client_side_validation && pivot_field_type.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.cells_pivot_tables_put_pivot_table_field"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'pivotFieldType'] = pivot_field_type
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'request'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_put_pivot_table_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_put_worksheet_pivot_table(name, sheet_name, opts = {}) ⇒ PivotTableResponse

Add a pivot table into worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :request (CreatePivotTableRequest) —

    CreatePivotTableRequest dto in request body.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

  • :source_data (String) —

    The data for the new PivotTable cache.

  • :dest_cell_name (String) —

    The cell in the upper-left corner of the PivotTable report&#39;s destination range.

  • :table_name (String) —

    The name of the new PivotTable report.

  • :use_same_source (BOOLEAN) —

    Indicates whether using same data source when another existing pivot table has used this data source. If the property is true, it will save memory.

Returns:



9238
9239
9240
9241
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9238

def cells_pivot_tables_put_worksheet_pivot_table(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_pivot_tables_put_worksheet_pivot_table_with_http_info(name, sheet_name, opts)
  return data
end

#cells_pivot_tables_put_worksheet_pivot_table_filter(name, sheet_name, pivot_table_index, opts = {}) ⇒ CellsCloudResponse

Add pivot filter for piovt table index

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (PivotFilter)
  • :need_re_calculate (BOOLEAN) — default: default to false
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



9319
9320
9321
9322
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9319

def cells_pivot_tables_put_worksheet_pivot_table_filter(name, sheet_name, pivot_table_index, opts = {})
  data, _status_code, _headers = cells_pivot_tables_put_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, opts)
  return data
end

#cells_pivot_tables_put_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Add pivot filter for piovt table index

Parameters:

  • name
  • sheet_name
  • pivot_table_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (PivotFilter)
  • :need_re_calculate (BOOLEAN)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9335

def cells_pivot_tables_put_worksheet_pivot_table_filter_with_http_info(name, sheet_name, pivot_table_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_put_worksheet_pivot_table_filter ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_put_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_put_worksheet_pivot_table_filter"
  end
  # verify the required parameter 'pivot_table_index' is set
  if @api_client.config.client_side_validation && pivot_table_index.nil?
    fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.cells_pivot_tables_put_worksheet_pivot_table_filter"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotFilters".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'needReCalculate'] = opts[:'need_re_calculate'] if !opts[:'need_re_calculate'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_put_worksheet_pivot_table_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_pivot_tables_put_worksheet_pivot_table_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(PivotTableResponse, Fixnum, Hash)>

Add a pivot table into worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :request (CreatePivotTableRequest) —

    CreatePivotTableRequest dto in request body.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

  • :source_data (String) —

    The data for the new PivotTable cache.

  • :dest_cell_name (String) —

    The cell in the upper-left corner of the PivotTable report&#39;s destination range.

  • :table_name (String) —

    The name of the new PivotTable report.

  • :use_same_source (BOOLEAN) —

    Indicates whether using same data source when another existing pivot table has used this data source. If the property is true, it will save memory.

Returns:

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

    PivotTableResponse data, response status code and response headers



9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9256

def cells_pivot_tables_put_worksheet_pivot_table_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_pivot_tables_put_worksheet_pivot_table ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_pivot_tables_put_worksheet_pivot_table"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_pivot_tables_put_worksheet_pivot_table"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'sourceData'] = opts[:'source_data'] if !opts[:'source_data'].nil?
  query_params[:'destCellName'] = opts[:'dest_cell_name'] if !opts[:'dest_cell_name'].nil?
  query_params[:'tableName'] = opts[:'table_name'] if !opts[:'table_name'].nil?
  query_params[:'useSameSource'] = opts[:'use_same_source'] if !opts[:'use_same_source'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'request'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PivotTableResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_pivot_tables_put_worksheet_pivot_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_cell_calculate(name, sheet_name, cell_name, opts = {}) ⇒ CellsCloudResponse

Cell calculate formula

Parameters:

  • name
  • sheet_name
  • cell_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



9398
9399
9400
9401
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9398

def cells_post_cell_calculate(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_post_cell_calculate_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_post_cell_calculate_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Cell calculate formula

Parameters:

  • name
  • sheet_name
  • cell_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    CellsCloudResponse data, response status code and response headers



9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9413

def cells_post_cell_calculate_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_cell_calculate ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_cell_calculate"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_cell_calculate"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_post_cell_calculate"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/calculate".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_cell_calculate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_cell_characters(name, sheet_name, cell_name, opts = {}) ⇒ CellsCloudResponse

Set cell characters

Parameters:

  • name
  • sheet_name
  • cell_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :options (Array<FontSetting>)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



9475
9476
9477
9478
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9475

def cells_post_cell_characters(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_post_cell_characters_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_post_cell_characters_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set cell characters

Parameters:

  • name
  • sheet_name
  • cell_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :options (Array<FontSetting>)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9490

def cells_post_cell_characters_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_cell_characters ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_cell_characters"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_cell_characters"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_post_cell_characters"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/characters".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_cell_characters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_clear_contents(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Clear cells contents.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :range (String) —

    The range.

  • :start_row (Integer) —

    The start row.

  • :start_column (Integer) —

    The start column.

  • :end_row (Integer) —

    The end row.

  • :end_column (Integer) —

    The end column.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



9555
9556
9557
9558
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9555

def cells_post_clear_contents(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_post_clear_contents_with_http_info(name, sheet_name, opts)
  return data
end

#cells_post_clear_contents_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clear cells contents.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :range (String) —

    The range.

  • :start_row (Integer) —

    The start row.

  • :start_column (Integer) —

    The start column.

  • :end_row (Integer) —

    The end row.

  • :end_column (Integer) —

    The end column.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9573

def cells_post_clear_contents_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_clear_contents ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_clear_contents"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_clear_contents"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/clearcontents".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
  query_params[:'startRow'] = opts[:'start_row'] if !opts[:'start_row'].nil?
  query_params[:'startColumn'] = opts[:'start_column'] if !opts[:'start_column'].nil?
  query_params[:'endRow'] = opts[:'end_row'] if !opts[:'end_row'].nil?
  query_params[:'endColumn'] = opts[:'end_column'] if !opts[:'end_column'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_clear_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_clear_formats(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Clear cells contents.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :range (String) —

    The range.

  • :start_row (Integer) —

    The start row.

  • :start_column (Integer) —

    The start column.

  • :end_row (Integer) —

    The end row.

  • :end_column (Integer) —

    The end column.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



9639
9640
9641
9642
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9639

def cells_post_clear_formats(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_post_clear_formats_with_http_info(name, sheet_name, opts)
  return data
end

#cells_post_clear_formats_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clear cells contents.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :range (String) —

    The range.

  • :start_row (Integer) —

    The start row.

  • :start_column (Integer) —

    The start column.

  • :end_row (Integer) —

    The end row.

  • :end_column (Integer) —

    The end column.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9657

def cells_post_clear_formats_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_clear_formats ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_clear_formats"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_clear_formats"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/clearformats".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
  query_params[:'startRow'] = opts[:'start_row'] if !opts[:'start_row'].nil?
  query_params[:'startColumn'] = opts[:'start_column'] if !opts[:'start_column'].nil?
  query_params[:'endRow'] = opts[:'end_row'] if !opts[:'end_row'].nil?
  query_params[:'endColumn'] = opts[:'end_column'] if !opts[:'end_column'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_clear_formats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_column_style(name, sheet_name, column_index, opts = {}) ⇒ CellsCloudResponse

Set column style

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



9720
9721
9722
9723
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9720

def cells_post_column_style(name, sheet_name, column_index, opts = {})
  data, _status_code, _headers = cells_post_column_style_with_http_info(name, sheet_name, column_index, opts)
  return data
end

#cells_post_column_style_with_http_info(name, sheet_name, column_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set column style

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9735

def cells_post_column_style_with_http_info(name, sheet_name, column_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_column_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_column_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_column_style"
  end
  # verify the required parameter 'column_index' is set
  if @api_client.config.client_side_validation && column_index.nil?
    fail ArgumentError, "Missing the required parameter 'column_index' when calling CellsApi.cells_post_column_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}/style".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'columnIndex' + '}', column_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'style'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_column_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_copy_cell_into_cell(name, dest_cell_name, sheet_name, worksheet, opts = {}) ⇒ CellsCloudResponse

Copy cell into cell

Parameters:

  • name —

    Workbook name.

  • dest_cell_name —

    Destination cell name

  • sheet_name —

    Destination worksheet name.

  • worksheet —

    Source worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :cellname (String) —

    Source cell name

  • :row (Integer) —

    Source row

  • :column (Integer) —

    Source column

  • :folder (String) —

    Folder name

  • :storage_name (String) —

    storage name.

Returns:



9800
9801
9802
9803
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9800

def cells_post_copy_cell_into_cell(name, dest_cell_name, sheet_name, worksheet, opts = {})
  data, _status_code, _headers = cells_post_copy_cell_into_cell_with_http_info(name, dest_cell_name, sheet_name, worksheet, opts)
  return data
end

#cells_post_copy_cell_into_cell_with_http_info(name, dest_cell_name, sheet_name, worksheet, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Copy cell into cell

Parameters:

  • name —

    Workbook name.

  • dest_cell_name —

    Destination cell name

  • sheet_name —

    Destination worksheet name.

  • worksheet —

    Source worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :cellname (String) —

    Source cell name

  • :row (Integer) —

    Source row

  • :column (Integer) —

    Source column

  • :folder (String) —

    Folder name

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9818

def cells_post_copy_cell_into_cell_with_http_info(name, dest_cell_name, sheet_name, worksheet, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_copy_cell_into_cell ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_copy_cell_into_cell"
  end
  # verify the required parameter 'dest_cell_name' is set
  if @api_client.config.client_side_validation && dest_cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'dest_cell_name' when calling CellsApi.cells_post_copy_cell_into_cell"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_copy_cell_into_cell"
  end
  # verify the required parameter 'worksheet' is set
  if @api_client.config.client_side_validation && worksheet.nil?
    fail ArgumentError, "Missing the required parameter 'worksheet' when calling CellsApi.cells_post_copy_cell_into_cell"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{destCellName}/copy".sub('{' + 'name' + '}', name.to_s).sub('{' + 'destCellName' + '}', dest_cell_name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'worksheet'] = worksheet
  query_params[:'cellname'] = opts[:'cellname'] if !opts[:'cellname'].nil?
  query_params[:'row'] = opts[:'row'] if !opts[:'row'].nil?
  query_params[:'column'] = opts[:'column'] if !opts[:'column'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_copy_cell_into_cell\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_copy_worksheet_columns(name, sheet_name, source_column_index, destination_column_index, column_number, opts = {}) ⇒ CellsCloudResponse

Copy worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • source_column_index —

    Source column index

  • destination_column_index —

    Destination column index

  • column_number —

    The copied column number

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

    the optional parameters

Options Hash (opts):

  • :worksheet (String) —

    The Worksheet (default to )

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



9890
9891
9892
9893
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9890

def cells_post_copy_worksheet_columns(name, sheet_name, source_column_index, destination_column_index, column_number, opts = {})
  data, _status_code, _headers = cells_post_copy_worksheet_columns_with_http_info(name, sheet_name, source_column_index, destination_column_index, column_number, opts)
  return data
end

#cells_post_copy_worksheet_columns_with_http_info(name, sheet_name, source_column_index, destination_column_index, column_number, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Copy worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • source_column_index —

    Source column index

  • destination_column_index —

    Destination column index

  • column_number —

    The copied column number

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

    the optional parameters

Options Hash (opts):

  • :worksheet (String) —

    The Worksheet

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9907

def cells_post_copy_worksheet_columns_with_http_info(name, sheet_name, source_column_index, destination_column_index, column_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_copy_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_copy_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_copy_worksheet_columns"
  end
  # verify the required parameter 'source_column_index' is set
  if @api_client.config.client_side_validation && source_column_index.nil?
    fail ArgumentError, "Missing the required parameter 'source_column_index' when calling CellsApi.cells_post_copy_worksheet_columns"
  end
  # verify the required parameter 'destination_column_index' is set
  if @api_client.config.client_side_validation && destination_column_index.nil?
    fail ArgumentError, "Missing the required parameter 'destination_column_index' when calling CellsApi.cells_post_copy_worksheet_columns"
  end
  # verify the required parameter 'column_number' is set
  if @api_client.config.client_side_validation && column_number.nil?
    fail ArgumentError, "Missing the required parameter 'column_number' when calling CellsApi.cells_post_copy_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/copy".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'sourceColumnIndex'] = source_column_index
  query_params[:'destinationColumnIndex'] = destination_column_index
  query_params[:'columnNumber'] = column_number
  query_params[:'worksheet'] = opts[:'worksheet'] if !opts[:'worksheet'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_copy_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_copy_worksheet_rows(name, sheet_name, source_row_index, destination_row_index, row_number, opts = {}) ⇒ CellsCloudResponse

Copy worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • source_row_index —

    Source row index

  • destination_row_index —

    Destination row index

  • row_number —

    The copied row number

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

    the optional parameters

Options Hash (opts):

  • :worksheet (String) —

    worksheet

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



9983
9984
9985
9986
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 9983

def cells_post_copy_worksheet_rows(name, sheet_name, source_row_index, destination_row_index, row_number, opts = {})
  data, _status_code, _headers = cells_post_copy_worksheet_rows_with_http_info(name, sheet_name, source_row_index, destination_row_index, row_number, opts)
  return data
end

#cells_post_copy_worksheet_rows_with_http_info(name, sheet_name, source_row_index, destination_row_index, row_number, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Copy worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • source_row_index —

    Source row index

  • destination_row_index —

    Destination row index

  • row_number —

    The copied row number

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

    the optional parameters

Options Hash (opts):

  • :worksheet (String) —

    worksheet

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10000

def cells_post_copy_worksheet_rows_with_http_info(name, sheet_name, source_row_index, destination_row_index, row_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_copy_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_copy_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_copy_worksheet_rows"
  end
  # verify the required parameter 'source_row_index' is set
  if @api_client.config.client_side_validation && source_row_index.nil?
    fail ArgumentError, "Missing the required parameter 'source_row_index' when calling CellsApi.cells_post_copy_worksheet_rows"
  end
  # verify the required parameter 'destination_row_index' is set
  if @api_client.config.client_side_validation && destination_row_index.nil?
    fail ArgumentError, "Missing the required parameter 'destination_row_index' when calling CellsApi.cells_post_copy_worksheet_rows"
  end
  # verify the required parameter 'row_number' is set
  if @api_client.config.client_side_validation && row_number.nil?
    fail ArgumentError, "Missing the required parameter 'row_number' when calling CellsApi.cells_post_copy_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/copy".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'sourceRowIndex'] = source_row_index
  query_params[:'destinationRowIndex'] = destination_row_index
  query_params[:'rowNumber'] = row_number
  query_params[:'worksheet'] = opts[:'worksheet'] if !opts[:'worksheet'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_copy_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_group_worksheet_columns(name, sheet_name, first_index, last_index, opts = {}) ⇒ CellsCloudResponse

Group worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first column index to be operated.

  • last_index —

    The last column index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :hide (BOOLEAN) —

    columns visible state

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10075
10076
10077
10078
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10075

def cells_post_group_worksheet_columns(name, sheet_name, first_index, last_index, opts = {})
  data, _status_code, _headers = cells_post_group_worksheet_columns_with_http_info(name, sheet_name, first_index, last_index, opts)
  return data
end

#cells_post_group_worksheet_columns_with_http_info(name, sheet_name, first_index, last_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Group worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first column index to be operated.

  • last_index —

    The last column index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :hide (BOOLEAN) —

    columns visible state

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10091

def cells_post_group_worksheet_columns_with_http_info(name, sheet_name, first_index, last_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_group_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_group_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_group_worksheet_columns"
  end
  # verify the required parameter 'first_index' is set
  if @api_client.config.client_side_validation && first_index.nil?
    fail ArgumentError, "Missing the required parameter 'first_index' when calling CellsApi.cells_post_group_worksheet_columns"
  end
  # verify the required parameter 'last_index' is set
  if @api_client.config.client_side_validation && last_index.nil?
    fail ArgumentError, "Missing the required parameter 'last_index' when calling CellsApi.cells_post_group_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/group".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'firstIndex'] = first_index
  query_params[:'lastIndex'] = last_index
  query_params[:'hide'] = opts[:'hide'] if !opts[:'hide'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_group_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_group_worksheet_rows(name, sheet_name, first_index, last_index, opts = {}) ⇒ CellsCloudResponse

Group worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first row index to be operated.

  • last_index —

    The last row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :hide (BOOLEAN) —

    rows visible state

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10161
10162
10163
10164
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10161

def cells_post_group_worksheet_rows(name, sheet_name, first_index, last_index, opts = {})
  data, _status_code, _headers = cells_post_group_worksheet_rows_with_http_info(name, sheet_name, first_index, last_index, opts)
  return data
end

#cells_post_group_worksheet_rows_with_http_info(name, sheet_name, first_index, last_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Group worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first row index to be operated.

  • last_index —

    The last row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :hide (BOOLEAN) —

    rows visible state

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10177

def cells_post_group_worksheet_rows_with_http_info(name, sheet_name, first_index, last_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_group_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_group_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_group_worksheet_rows"
  end
  # verify the required parameter 'first_index' is set
  if @api_client.config.client_side_validation && first_index.nil?
    fail ArgumentError, "Missing the required parameter 'first_index' when calling CellsApi.cells_post_group_worksheet_rows"
  end
  # verify the required parameter 'last_index' is set
  if @api_client.config.client_side_validation && last_index.nil?
    fail ArgumentError, "Missing the required parameter 'last_index' when calling CellsApi.cells_post_group_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/group".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'firstIndex'] = first_index
  query_params[:'lastIndex'] = last_index
  query_params[:'hide'] = opts[:'hide'] if !opts[:'hide'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_group_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_hide_worksheet_columns(name, sheet_name, start_column, total_columns, opts = {}) ⇒ CellsCloudResponse

Hide worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • start_column —

    The begin column index to be operated.

  • total_columns —

    Number of columns to be operated.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10246
10247
10248
10249
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10246

def cells_post_hide_worksheet_columns(name, sheet_name, start_column, total_columns, opts = {})
  data, _status_code, _headers = cells_post_hide_worksheet_columns_with_http_info(name, sheet_name, start_column, total_columns, opts)
  return data
end

#cells_post_hide_worksheet_columns_with_http_info(name, sheet_name, start_column, total_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Hide worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • start_column —

    The begin column index to be operated.

  • total_columns —

    Number of columns to be operated.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10261

def cells_post_hide_worksheet_columns_with_http_info(name, sheet_name, start_column, total_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_hide_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_hide_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_hide_worksheet_columns"
  end
  # verify the required parameter 'start_column' is set
  if @api_client.config.client_side_validation && start_column.nil?
    fail ArgumentError, "Missing the required parameter 'start_column' when calling CellsApi.cells_post_hide_worksheet_columns"
  end
  # verify the required parameter 'total_columns' is set
  if @api_client.config.client_side_validation && total_columns.nil?
    fail ArgumentError, "Missing the required parameter 'total_columns' when calling CellsApi.cells_post_hide_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/hide".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startColumn'] = start_column
  query_params[:'totalColumns'] = total_columns
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_hide_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_hide_worksheet_rows(name, sheet_name, startrow, total_rows, opts = {}) ⇒ CellsCloudResponse

Hide worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startrow —

    The begin row index to be operated.

  • total_rows —

    Number of rows to be operated.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10329
10330
10331
10332
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10329

def cells_post_hide_worksheet_rows(name, sheet_name, startrow, total_rows, opts = {})
  data, _status_code, _headers = cells_post_hide_worksheet_rows_with_http_info(name, sheet_name, startrow, total_rows, opts)
  return data
end

#cells_post_hide_worksheet_rows_with_http_info(name, sheet_name, startrow, total_rows, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Hide worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startrow —

    The begin row index to be operated.

  • total_rows —

    Number of rows to be operated.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10344

def cells_post_hide_worksheet_rows_with_http_info(name, sheet_name, startrow, total_rows, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_hide_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_hide_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_hide_worksheet_rows"
  end
  # verify the required parameter 'startrow' is set
  if @api_client.config.client_side_validation && startrow.nil?
    fail ArgumentError, "Missing the required parameter 'startrow' when calling CellsApi.cells_post_hide_worksheet_rows"
  end
  # verify the required parameter 'total_rows' is set
  if @api_client.config.client_side_validation && total_rows.nil?
    fail ArgumentError, "Missing the required parameter 'total_rows' when calling CellsApi.cells_post_hide_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/hide".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startrow'] = startrow
  query_params[:'totalRows'] = total_rows
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_hide_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_row_style(name, sheet_name, row_index, opts = {}) ⇒ CellsCloudResponse

Set row style.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10412
10413
10414
10415
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10412

def cells_post_row_style(name, sheet_name, row_index, opts = {})
  data, _status_code, _headers = cells_post_row_style_with_http_info(name, sheet_name, row_index, opts)
  return data
end

#cells_post_row_style_with_http_info(name, sheet_name, row_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set row style.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    Style dto

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10427

def cells_post_row_style_with_http_info(name, sheet_name, row_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_row_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_row_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_row_style"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling CellsApi.cells_post_row_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}/style".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'rowIndex' + '}', row_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'style'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_row_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_set_cell_html_string(name, sheet_name, cell_name, html_string, opts = {}) ⇒ CellResponse

Set htmlstring value into cell

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    The cell name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



10489
10490
10491
10492
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10489

def cells_post_set_cell_html_string(name, sheet_name, cell_name, html_string, opts = {})
  data, _status_code, _headers = cells_post_set_cell_html_string_with_http_info(name, sheet_name, cell_name, html_string, opts)
  return data
end

#cells_post_set_cell_html_string_with_http_info(name, sheet_name, cell_name, html_string, opts = {}) ⇒ Array<(CellResponse, Fixnum, Hash)>

Set htmlstring value into cell

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    The cell name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellResponse data, response status code and response headers



10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10504

def cells_post_set_cell_html_string_with_http_info(name, sheet_name, cell_name, html_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_set_cell_html_string ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_set_cell_html_string"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_set_cell_html_string"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_post_set_cell_html_string"
  end
  # verify the required parameter 'html_string' is set
  if @api_client.config.client_side_validation && html_string.nil?
    fail ArgumentError, "Missing the required parameter 'html_string' when calling CellsApi.cells_post_set_cell_html_string"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/htmlstring".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(html_string)
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_set_cell_html_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_set_cell_range_value(name, sheet_name, cellarea, value, type, opts = {}) ⇒ CellsCloudResponse

Set cell range value

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • cellarea —

    Cell area (like &quot;A1:C2&quot;)

  • value —

    Range value

  • type —

    Value data type (like &quot;int&quot;)

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Folder name

  • :storage_name (String) —

    storage name.

Returns:



10571
10572
10573
10574
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10571

def cells_post_set_cell_range_value(name, sheet_name, cellarea, value, type, opts = {})
  data, _status_code, _headers = cells_post_set_cell_range_value_with_http_info(name, sheet_name, cellarea, value, type, opts)
  return data
end

#cells_post_set_cell_range_value_with_http_info(name, sheet_name, cellarea, value, type, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set cell range value

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • cellarea —

    Cell area (like &quot;A1:C2&quot;)

  • value —

    Range value

  • type —

    Value data type (like &quot;int&quot;)

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Folder name

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10587

def cells_post_set_cell_range_value_with_http_info(name, sheet_name, cellarea, value, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_set_cell_range_value ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_set_cell_range_value"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_set_cell_range_value"
  end
  # verify the required parameter 'cellarea' is set
  if @api_client.config.client_side_validation && cellarea.nil?
    fail ArgumentError, "Missing the required parameter 'cellarea' when calling CellsApi.cells_post_set_cell_range_value"
  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 CellsApi.cells_post_set_cell_range_value"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling CellsApi.cells_post_set_cell_range_value"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellarea'] = cellarea
  query_params[:'value'] = value
  query_params[:'type'] = type
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_set_cell_range_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_set_worksheet_column_width(name, sheet_name, column_index, width, opts = {}) ⇒ ColumnResponse

Set worksheet column width.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

  • width —

    The width.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



10660
10661
10662
10663
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10660

def cells_post_set_worksheet_column_width(name, sheet_name, column_index, width, opts = {})
  data, _status_code, _headers = cells_post_set_worksheet_column_width_with_http_info(name, sheet_name, column_index, width, opts)
  return data
end

#cells_post_set_worksheet_column_width_with_http_info(name, sheet_name, column_index, width, opts = {}) ⇒ Array<(ColumnResponse, Fixnum, Hash)>

Set worksheet column width.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

  • width —

    The width.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ColumnResponse data, response status code and response headers



10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10675

def cells_post_set_worksheet_column_width_with_http_info(name, sheet_name, column_index, width, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_set_worksheet_column_width ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_set_worksheet_column_width"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_set_worksheet_column_width"
  end
  # verify the required parameter 'column_index' is set
  if @api_client.config.client_side_validation && column_index.nil?
    fail ArgumentError, "Missing the required parameter 'column_index' when calling CellsApi.cells_post_set_worksheet_column_width"
  end
  # verify the required parameter 'width' is set
  if @api_client.config.client_side_validation && width.nil?
    fail ArgumentError, "Missing the required parameter 'width' when calling CellsApi.cells_post_set_worksheet_column_width"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'columnIndex' + '}', column_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = width
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ColumnResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_set_worksheet_column_width\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_ungroup_worksheet_columns(name, sheet_name, first_index, last_index, opts = {}) ⇒ CellsCloudResponse

Ungroup worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first column index to be operated.

  • last_index —

    The last column index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10742
10743
10744
10745
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10742

def cells_post_ungroup_worksheet_columns(name, sheet_name, first_index, last_index, opts = {})
  data, _status_code, _headers = cells_post_ungroup_worksheet_columns_with_http_info(name, sheet_name, first_index, last_index, opts)
  return data
end

#cells_post_ungroup_worksheet_columns_with_http_info(name, sheet_name, first_index, last_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Ungroup worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first column index to be operated.

  • last_index —

    The last column index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10757

def cells_post_ungroup_worksheet_columns_with_http_info(name, sheet_name, first_index, last_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_ungroup_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_ungroup_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_ungroup_worksheet_columns"
  end
  # verify the required parameter 'first_index' is set
  if @api_client.config.client_side_validation && first_index.nil?
    fail ArgumentError, "Missing the required parameter 'first_index' when calling CellsApi.cells_post_ungroup_worksheet_columns"
  end
  # verify the required parameter 'last_index' is set
  if @api_client.config.client_side_validation && last_index.nil?
    fail ArgumentError, "Missing the required parameter 'last_index' when calling CellsApi.cells_post_ungroup_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/ungroup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'firstIndex'] = first_index
  query_params[:'lastIndex'] = last_index
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_ungroup_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_ungroup_worksheet_rows(name, sheet_name, first_index, last_index, opts = {}) ⇒ CellsCloudResponse

Ungroup worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first row index to be operated.

  • last_index —

    The last row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :is_all (BOOLEAN) —

    Is all row to be operated

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10826
10827
10828
10829
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10826

def cells_post_ungroup_worksheet_rows(name, sheet_name, first_index, last_index, opts = {})
  data, _status_code, _headers = cells_post_ungroup_worksheet_rows_with_http_info(name, sheet_name, first_index, last_index, opts)
  return data
end

#cells_post_ungroup_worksheet_rows_with_http_info(name, sheet_name, first_index, last_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Ungroup worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • first_index —

    The first row index to be operated.

  • last_index —

    The last row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :is_all (BOOLEAN) —

    Is all row to be operated

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10842

def cells_post_ungroup_worksheet_rows_with_http_info(name, sheet_name, first_index, last_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_ungroup_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_ungroup_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_ungroup_worksheet_rows"
  end
  # verify the required parameter 'first_index' is set
  if @api_client.config.client_side_validation && first_index.nil?
    fail ArgumentError, "Missing the required parameter 'first_index' when calling CellsApi.cells_post_ungroup_worksheet_rows"
  end
  # verify the required parameter 'last_index' is set
  if @api_client.config.client_side_validation && last_index.nil?
    fail ArgumentError, "Missing the required parameter 'last_index' when calling CellsApi.cells_post_ungroup_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/ungroup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'firstIndex'] = first_index
  query_params[:'lastIndex'] = last_index
  query_params[:'isAll'] = opts[:'is_all'] if !opts[:'is_all'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_ungroup_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_unhide_worksheet_columns(name, sheet_name, startcolumn, total_columns, opts = {}) ⇒ CellsCloudResponse

Unhide worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startcolumn —

    The begin column index to be operated.

  • total_columns —

    Number of columns to be operated.

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

    the optional parameters

Options Hash (opts):

  • :width (Float) —

    The new column width. (default to 50.0)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10912
10913
10914
10915
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10912

def cells_post_unhide_worksheet_columns(name, sheet_name, startcolumn, total_columns, opts = {})
  data, _status_code, _headers = cells_post_unhide_worksheet_columns_with_http_info(name, sheet_name, startcolumn, total_columns, opts)
  return data
end

#cells_post_unhide_worksheet_columns_with_http_info(name, sheet_name, startcolumn, total_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unhide worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startcolumn —

    The begin column index to be operated.

  • total_columns —

    Number of columns to be operated.

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

    the optional parameters

Options Hash (opts):

  • :width (Float) —

    The new column width.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10928

def cells_post_unhide_worksheet_columns_with_http_info(name, sheet_name, startcolumn, total_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_unhide_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_unhide_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_unhide_worksheet_columns"
  end
  # verify the required parameter 'startcolumn' is set
  if @api_client.config.client_side_validation && startcolumn.nil?
    fail ArgumentError, "Missing the required parameter 'startcolumn' when calling CellsApi.cells_post_unhide_worksheet_columns"
  end
  # verify the required parameter 'total_columns' is set
  if @api_client.config.client_side_validation && total_columns.nil?
    fail ArgumentError, "Missing the required parameter 'total_columns' when calling CellsApi.cells_post_unhide_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/unhide".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startcolumn'] = startcolumn
  query_params[:'totalColumns'] = total_columns
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_unhide_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_unhide_worksheet_rows(name, sheet_name, startrow, total_rows, opts = {}) ⇒ CellsCloudResponse

Unhide worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startrow —

    The begin row index to be operated.

  • total_rows —

    Number of rows to be operated.

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    The new row height. (default to 15.0)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



10998
10999
11000
11001
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 10998

def cells_post_unhide_worksheet_rows(name, sheet_name, startrow, total_rows, opts = {})
  data, _status_code, _headers = cells_post_unhide_worksheet_rows_with_http_info(name, sheet_name, startrow, total_rows, opts)
  return data
end

#cells_post_unhide_worksheet_rows_with_http_info(name, sheet_name, startrow, total_rows, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unhide worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startrow —

    The begin row index to be operated.

  • total_rows —

    Number of rows to be operated.

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    The new row height.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11014

def cells_post_unhide_worksheet_rows_with_http_info(name, sheet_name, startrow, total_rows, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_unhide_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_unhide_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_unhide_worksheet_rows"
  end
  # verify the required parameter 'startrow' is set
  if @api_client.config.client_side_validation && startrow.nil?
    fail ArgumentError, "Missing the required parameter 'startrow' when calling CellsApi.cells_post_unhide_worksheet_rows"
  end
  # verify the required parameter 'total_rows' is set
  if @api_client.config.client_side_validation && total_rows.nil?
    fail ArgumentError, "Missing the required parameter 'total_rows' when calling CellsApi.cells_post_unhide_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/unhide".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startrow'] = startrow
  query_params[:'totalRows'] = total_rows
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_unhide_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_update_worksheet_cell_style(name, sheet_name, cell_name, opts = {}) ⇒ StyleResponse

Update cell’s style.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    The cell name.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    with update style settings.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



11083
11084
11085
11086
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11083

def cells_post_update_worksheet_cell_style(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_post_update_worksheet_cell_style_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_post_update_worksheet_cell_style_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(StyleResponse, Fixnum, Hash)>

Update cell&#39;s style.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • cell_name —

    The cell name.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    with update style settings.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    StyleResponse data, response status code and response headers



11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11098

def cells_post_update_worksheet_cell_style_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_update_worksheet_cell_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_update_worksheet_cell_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_update_worksheet_cell_style"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_post_update_worksheet_cell_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}/style".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'style'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'StyleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_update_worksheet_cell_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_update_worksheet_range_style(name, sheet_name, range, opts = {}) ⇒ CellsCloudResponse

Update cell’s range style.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • range —

    The range.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    with update style settings.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



11160
11161
11162
11163
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11160

def cells_post_update_worksheet_range_style(name, sheet_name, range, opts = {})
  data, _status_code, _headers = cells_post_update_worksheet_range_style_with_http_info(name, sheet_name, range, opts)
  return data
end

#cells_post_update_worksheet_range_style_with_http_info(name, sheet_name, range, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update cell&#39;s range style.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    Worksheet name.

  • range —

    The range.

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

    the optional parameters

Options Hash (opts):

  • :style (Style) —

    with update style settings.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11175

def cells_post_update_worksheet_range_style_with_http_info(name, sheet_name, range, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_update_worksheet_range_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_update_worksheet_range_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_update_worksheet_range_style"
  end
  # verify the required parameter 'range' is set
  if @api_client.config.client_side_validation && range.nil?
    fail ArgumentError, "Missing the required parameter 'range' when calling CellsApi.cells_post_update_worksheet_range_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/style".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = range
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'style'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_update_worksheet_range_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_update_worksheet_row(name, sheet_name, row_index, opts = {}) ⇒ RowResponse

Update worksheet row.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    The new row height. (default to 0.0)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11238
11239
11240
11241
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11238

def cells_post_update_worksheet_row(name, sheet_name, row_index, opts = {})
  data, _status_code, _headers = cells_post_update_worksheet_row_with_http_info(name, sheet_name, row_index, opts)
  return data
end

#cells_post_update_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {}) ⇒ Array<(RowResponse, Fixnum, Hash)>

Update worksheet row.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The row index.

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    The new row height.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RowResponse data, response status code and response headers



11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11253

def cells_post_update_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_update_worksheet_row ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_update_worksheet_row"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_update_worksheet_row"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling CellsApi.cells_post_update_worksheet_row"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'rowIndex' + '}', row_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'RowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_update_worksheet_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_worksheet_cell_set_value(name, sheet_name, cell_name, opts = {}) ⇒ CellResponse

Set cell value.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name.

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

    the optional parameters

Options Hash (opts):

  • :value (String) —

    The cell value.

  • :type (String) —

    The value type.

  • :formula (String) —

    Formula for cell

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11318
11319
11320
11321
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11318

def cells_post_worksheet_cell_set_value(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_post_worksheet_cell_set_value_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_post_worksheet_cell_set_value_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CellResponse, Fixnum, Hash)>

Set cell value.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name.

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

    the optional parameters

Options Hash (opts):

  • :value (String) —

    The cell value.

  • :type (String) —

    The value type.

  • :formula (String) —

    Formula for cell

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellResponse data, response status code and response headers



11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11335

def cells_post_worksheet_cell_set_value_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_worksheet_cell_set_value ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_worksheet_cell_set_value"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_worksheet_cell_set_value"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_post_worksheet_cell_set_value"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/{cellName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'formula'] = opts[:'formula'] if !opts[:'formula'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_worksheet_cell_set_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_worksheet_merge(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {}) ⇒ CellsCloudResponse

Merge cells.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • start_row —

    The start row.

  • start_column —

    The start column.

  • total_rows —

    The total rows

  • total_columns —

    The total columns.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



11402
11403
11404
11405
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11402

def cells_post_worksheet_merge(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {})
  data, _status_code, _headers = cells_post_worksheet_merge_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts)
  return data
end

#cells_post_worksheet_merge_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Merge cells.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • start_row —

    The start row.

  • start_column —

    The start column.

  • total_rows —

    The total rows

  • total_columns —

    The total columns.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11419

def cells_post_worksheet_merge_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_worksheet_merge ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_worksheet_merge"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_worksheet_merge"
  end
  # verify the required parameter 'start_row' is set
  if @api_client.config.client_side_validation && start_row.nil?
    fail ArgumentError, "Missing the required parameter 'start_row' when calling CellsApi.cells_post_worksheet_merge"
  end
  # verify the required parameter 'start_column' is set
  if @api_client.config.client_side_validation && start_column.nil?
    fail ArgumentError, "Missing the required parameter 'start_column' when calling CellsApi.cells_post_worksheet_merge"
  end
  # verify the required parameter 'total_rows' is set
  if @api_client.config.client_side_validation && total_rows.nil?
    fail ArgumentError, "Missing the required parameter 'total_rows' when calling CellsApi.cells_post_worksheet_merge"
  end
  # verify the required parameter 'total_columns' is set
  if @api_client.config.client_side_validation && total_columns.nil?
    fail ArgumentError, "Missing the required parameter 'total_columns' when calling CellsApi.cells_post_worksheet_merge"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/merge".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startRow'] = start_row
  query_params[:'startColumn'] = start_column
  query_params[:'totalRows'] = total_rows
  query_params[:'totalColumns'] = total_columns
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_worksheet_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_post_worksheet_unmerge(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {}) ⇒ CellsCloudResponse

Unmerge cells.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • start_row —

    The start row.

  • start_column —

    The start column.

  • total_rows —

    The total rows

  • total_columns —

    The total columns.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



11499
11500
11501
11502
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11499

def cells_post_worksheet_unmerge(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {})
  data, _status_code, _headers = cells_post_worksheet_unmerge_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts)
  return data
end

#cells_post_worksheet_unmerge_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unmerge cells.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • start_row —

    The start row.

  • start_column —

    The start column.

  • total_rows —

    The total rows

  • total_columns —

    The total columns.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11516

def cells_post_worksheet_unmerge_with_http_info(name, sheet_name, start_row, start_column, total_rows, total_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_post_worksheet_unmerge ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_post_worksheet_unmerge"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_post_worksheet_unmerge"
  end
  # verify the required parameter 'start_row' is set
  if @api_client.config.client_side_validation && start_row.nil?
    fail ArgumentError, "Missing the required parameter 'start_row' when calling CellsApi.cells_post_worksheet_unmerge"
  end
  # verify the required parameter 'start_column' is set
  if @api_client.config.client_side_validation && start_column.nil?
    fail ArgumentError, "Missing the required parameter 'start_column' when calling CellsApi.cells_post_worksheet_unmerge"
  end
  # verify the required parameter 'total_rows' is set
  if @api_client.config.client_side_validation && total_rows.nil?
    fail ArgumentError, "Missing the required parameter 'total_rows' when calling CellsApi.cells_post_worksheet_unmerge"
  end
  # verify the required parameter 'total_columns' is set
  if @api_client.config.client_side_validation && total_columns.nil?
    fail ArgumentError, "Missing the required parameter 'total_columns' when calling CellsApi.cells_post_worksheet_unmerge"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/unmerge".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startRow'] = start_row
  query_params[:'startColumn'] = start_column
  query_params[:'totalRows'] = total_rows
  query_params[:'totalColumns'] = total_columns
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_post_worksheet_unmerge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_properties_delete_document_properties(name, opts = {}) ⇒ CellsDocumentPropertiesResponse

Delete all custom document properties and clean built-in ones.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11591
11592
11593
11594
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11591

def cells_properties_delete_document_properties(name, opts = {})
  data, _status_code, _headers = cells_properties_delete_document_properties_with_http_info(name, opts)
  return data
end

#cells_properties_delete_document_properties_with_http_info(name, opts = {}) ⇒ Array<(CellsDocumentPropertiesResponse, Fixnum, Hash)>

Delete all custom document properties and clean built-in ones.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11603

def cells_properties_delete_document_properties_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_properties_delete_document_properties ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_properties_delete_document_properties"
  end
  # resource path
  local_var_path = "/cells/{name}/documentproperties".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsDocumentPropertiesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_properties_delete_document_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_properties_delete_document_property(name, property_name, opts = {}) ⇒ CellsDocumentPropertiesResponse

Delete document property.

Parameters:

  • name —

    The document name.

  • property_name —

    The property name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11655
11656
11657
11658
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11655

def cells_properties_delete_document_property(name, property_name, opts = {})
  data, _status_code, _headers = cells_properties_delete_document_property_with_http_info(name, property_name, opts)
  return data
end

#cells_properties_delete_document_property_with_http_info(name, property_name, opts = {}) ⇒ Array<(CellsDocumentPropertiesResponse, Fixnum, Hash)>

Delete document property.

Parameters:

  • name —

    The document name.

  • property_name —

    The property name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11668

def cells_properties_delete_document_property_with_http_info(name, property_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_properties_delete_document_property ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_properties_delete_document_property"
  end
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling CellsApi.cells_properties_delete_document_property"
  end
  # resource path
  local_var_path = "/cells/{name}/documentproperties/{propertyName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsDocumentPropertiesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_properties_delete_document_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_properties_get_document_properties(name, opts = {}) ⇒ CellsDocumentPropertiesResponse

Read document properties.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11723
11724
11725
11726
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11723

def cells_properties_get_document_properties(name, opts = {})
  data, _status_code, _headers = cells_properties_get_document_properties_with_http_info(name, opts)
  return data
end

#cells_properties_get_document_properties_with_http_info(name, opts = {}) ⇒ Array<(CellsDocumentPropertiesResponse, Fixnum, Hash)>

Read document properties.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11735

def cells_properties_get_document_properties_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_properties_get_document_properties ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_properties_get_document_properties"
  end
  # resource path
  local_var_path = "/cells/{name}/documentproperties".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsDocumentPropertiesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_properties_get_document_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_properties_get_document_property(name, property_name, opts = {}) ⇒ CellsDocumentPropertyResponse

Read document property by name.

Parameters:

  • name —

    The document name.

  • property_name —

    The property name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11787
11788
11789
11790
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11787

def cells_properties_get_document_property(name, property_name, opts = {})
  data, _status_code, _headers = cells_properties_get_document_property_with_http_info(name, property_name, opts)
  return data
end

#cells_properties_get_document_property_with_http_info(name, property_name, opts = {}) ⇒ Array<(CellsDocumentPropertyResponse, Fixnum, Hash)>

Read document property by name.

Parameters:

  • name —

    The document name.

  • property_name —

    The property name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11800

def cells_properties_get_document_property_with_http_info(name, property_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_properties_get_document_property ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_properties_get_document_property"
  end
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling CellsApi.cells_properties_get_document_property"
  end
  # resource path
  local_var_path = "/cells/{name}/documentproperties/{propertyName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsDocumentPropertyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_properties_get_document_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_properties_put_document_property(name, property_name, opts = {}) ⇒ CellsDocumentPropertyResponse

Set/create document property.

Parameters:

  • name —

    The document name.

  • property_name —

    The property name.

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

    the optional parameters

Options Hash (opts):

  • :property (CellsDocumentProperty) —

    with new property value.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11857
11858
11859
11860
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11857

def cells_properties_put_document_property(name, property_name, opts = {})
  data, _status_code, _headers = cells_properties_put_document_property_with_http_info(name, property_name, opts)
  return data
end

#cells_properties_put_document_property_with_http_info(name, property_name, opts = {}) ⇒ Array<(CellsDocumentPropertyResponse, Fixnum, Hash)>

Set/create document property.

Parameters:

  • name —

    The document name.

  • property_name —

    The property name.

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

    the optional parameters

Options Hash (opts):

  • :property (CellsDocumentProperty) —

    with new property value.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11871

def cells_properties_put_document_property_with_http_info(name, property_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_properties_put_document_property ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_properties_put_document_property"
  end
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling CellsApi.cells_properties_put_document_property"
  end
  # resource path
  local_var_path = "/cells/{name}/documentproperties/{propertyName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'property'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsDocumentPropertyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_properties_put_document_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_put_insert_worksheet_columns(name, sheet_name, column_index, columns, opts = {}) ⇒ ColumnsResponse

Insert worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

  • columns —

    The columns.

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

    the optional parameters

Options Hash (opts):

  • :update_reference (BOOLEAN) —

    The update reference. (default to true)

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



11930
11931
11932
11933
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11930

def cells_put_insert_worksheet_columns(name, sheet_name, column_index, columns, opts = {})
  data, _status_code, _headers = cells_put_insert_worksheet_columns_with_http_info(name, sheet_name, column_index, columns, opts)
  return data
end

#cells_put_insert_worksheet_columns_with_http_info(name, sheet_name, column_index, columns, opts = {}) ⇒ Array<(ColumnsResponse, Fixnum, Hash)>

Insert worksheet columns.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • column_index —

    The column index.

  • columns —

    The columns.

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

    the optional parameters

Options Hash (opts):

  • :update_reference (BOOLEAN) —

    The update reference.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ColumnsResponse data, response status code and response headers



11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 11946

def cells_put_insert_worksheet_columns_with_http_info(name, sheet_name, column_index, columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_put_insert_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_put_insert_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_put_insert_worksheet_columns"
  end
  # verify the required parameter 'column_index' is set
  if @api_client.config.client_side_validation && column_index.nil?
    fail ArgumentError, "Missing the required parameter 'column_index' when calling CellsApi.cells_put_insert_worksheet_columns"
  end
  # verify the required parameter 'columns' is set
  if @api_client.config.client_side_validation && columns.nil?
    fail ArgumentError, "Missing the required parameter 'columns' when calling CellsApi.cells_put_insert_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/columns/{columnIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'columnIndex' + '}', column_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'columns'] = columns
  query_params[:'updateReference'] = opts[:'update_reference'] if !opts[:'update_reference'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ColumnsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_put_insert_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_put_insert_worksheet_row(name, sheet_name, row_index, opts = {}) ⇒ RowResponse

Insert new worksheet row.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The new row index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



12013
12014
12015
12016
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12013

def cells_put_insert_worksheet_row(name, sheet_name, row_index, opts = {})
  data, _status_code, _headers = cells_put_insert_worksheet_row_with_http_info(name, sheet_name, row_index, opts)
  return data
end

#cells_put_insert_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {}) ⇒ Array<(RowResponse, Fixnum, Hash)>

Insert new worksheet row.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • row_index —

    The new row index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RowResponse data, response status code and response headers



12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12027

def cells_put_insert_worksheet_row_with_http_info(name, sheet_name, row_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_put_insert_worksheet_row ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_put_insert_worksheet_row"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_put_insert_worksheet_row"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling CellsApi.cells_put_insert_worksheet_row"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows/{rowIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'rowIndex' + '}', row_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_put_insert_worksheet_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_put_insert_worksheet_rows(name, sheet_name, startrow, opts = {}) ⇒ CellsCloudResponse

Insert several new worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startrow —

    The begin row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :total_rows (Integer) —

    Number of rows to be operated. (default to 1)

  • :update_reference (BOOLEAN) —

    Indicates if update references in other worksheets. (default to true)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



12090
12091
12092
12093
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12090

def cells_put_insert_worksheet_rows(name, sheet_name, startrow, opts = {})
  data, _status_code, _headers = cells_put_insert_worksheet_rows_with_http_info(name, sheet_name, startrow, opts)
  return data
end

#cells_put_insert_worksheet_rows_with_http_info(name, sheet_name, startrow, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Insert several new worksheet rows.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • startrow —

    The begin row index to be operated.

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

    the optional parameters

Options Hash (opts):

  • :total_rows (Integer) —

    Number of rows to be operated.

  • :update_reference (BOOLEAN) —

    Indicates if update references in other worksheets.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12106

def cells_put_insert_worksheet_rows_with_http_info(name, sheet_name, startrow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_put_insert_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_put_insert_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_put_insert_worksheet_rows"
  end
  # verify the required parameter 'startrow' is set
  if @api_client.config.client_side_validation && startrow.nil?
    fail ArgumentError, "Missing the required parameter 'startrow' when calling CellsApi.cells_put_insert_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/cells/rows".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startrow'] = startrow
  query_params[:'totalRows'] = opts[:'total_rows'] if !opts[:'total_rows'].nil?
  query_params[:'updateReference'] = opts[:'update_reference'] if !opts[:'update_reference'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_put_insert_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_get_worksheet_cells_range_value(name, sheet_name, opts = {}) ⇒ RangeValueResponse

Get cells list in a range by range name or row column indexes

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :namerange (String) —

    range name, for example: &#39;A1:B2&#39; or &#39;range_name1&#39;

  • :first_row (Integer) —

    the first row of the range

  • :first_column (Integer) —

    the first column of the range

  • :row_count (Integer) —

    the count of rows in the range

  • :column_count (Integer) —

    the count of columns in the range

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12174
12175
12176
12177
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12174

def cells_ranges_get_worksheet_cells_range_value(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ranges_get_worksheet_cells_range_value_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ranges_get_worksheet_cells_range_value_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(RangeValueResponse, Fixnum, Hash)>

Get cells list in a range by range name or row column indexes

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :namerange (String) —

    range name, for example: &#39;A1:B2&#39; or &#39;range_name1&#39;

  • :first_row (Integer) —

    the first row of the range

  • :first_column (Integer) —

    the first column of the range

  • :row_count (Integer) —

    the count of rows in the range

  • :column_count (Integer) —

    the count of columns in the range

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RangeValueResponse data, response status code and response headers



12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12192

def cells_ranges_get_worksheet_cells_range_value_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_get_worksheet_cells_range_value ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_get_worksheet_cells_range_value"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_get_worksheet_cells_range_value"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/value".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'namerange'] = opts[:'namerange'] if !opts[:'namerange'].nil?
  query_params[:'firstRow'] = opts[:'first_row'] if !opts[:'first_row'].nil?
  query_params[:'firstColumn'] = opts[:'first_column'] if !opts[:'first_column'].nil?
  query_params[:'rowCount'] = opts[:'row_count'] if !opts[:'row_count'].nil?
  query_params[:'columnCount'] = opts[:'column_count'] if !opts[:'column_count'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'RangeValueResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_get_worksheet_cells_range_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_column_width(name, sheet_name, value, opts = {}) ⇒ CellsCloudResponse

Set column width of range

Parameters:

  • name
  • sheet_name
  • value
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :range (Range)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



12255
12256
12257
12258
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12255

def cells_ranges_post_worksheet_cells_range_column_width(name, sheet_name, value, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_column_width_with_http_info(name, sheet_name, value, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_column_width_with_http_info(name, sheet_name, value, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set column width of range

Parameters:

  • name
  • sheet_name
  • value
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :range (Range)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12270

def cells_ranges_post_worksheet_cells_range_column_width_with_http_info(name, sheet_name, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_column_width ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_column_width"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_column_width"
  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 CellsApi.cells_ranges_post_worksheet_cells_range_column_width"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/columnWidth".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'value'] = value
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_column_width\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_merge(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Combines a range of cells into a single cell.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12332
12333
12334
12335
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12332

def cells_ranges_post_worksheet_cells_range_merge(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_merge_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_merge_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Combines a range of cells into a single cell.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12346

def cells_ranges_post_worksheet_cells_range_merge_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_merge ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_merge"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_merge"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/merge".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_move_to(name, sheet_name, dest_row, dest_column, opts = {}) ⇒ CellsCloudResponse

Move the current range to the dest range.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

  • dest_row —

    The start row of the dest range.

  • dest_column —

    The start column of the dest range.

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12405
12406
12407
12408
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12405

def cells_ranges_post_worksheet_cells_range_move_to(name, sheet_name, dest_row, dest_column, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_move_to_with_http_info(name, sheet_name, dest_row, dest_column, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_move_to_with_http_info(name, sheet_name, dest_row, dest_column, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Move the current range to the dest range.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

  • dest_row —

    The start row of the dest range.

  • dest_column —

    The start column of the dest range.

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12421

def cells_ranges_post_worksheet_cells_range_move_to_with_http_info(name, sheet_name, dest_row, dest_column, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_move_to ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_move_to"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_move_to"
  end
  # verify the required parameter 'dest_row' is set
  if @api_client.config.client_side_validation && dest_row.nil?
    fail ArgumentError, "Missing the required parameter 'dest_row' when calling CellsApi.cells_ranges_post_worksheet_cells_range_move_to"
  end
  # verify the required parameter 'dest_column' is set
  if @api_client.config.client_side_validation && dest_column.nil?
    fail ArgumentError, "Missing the required parameter 'dest_column' when calling CellsApi.cells_ranges_post_worksheet_cells_range_move_to"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/moveto".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'destRow'] = dest_row
  query_params[:'destColumn'] = dest_column
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_move_to\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_outline_border(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Sets outline border around a range of cells.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range_operate (RangeSetOutlineBorderRequest) —

    Range Set OutlineBorder Request

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12488
12489
12490
12491
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12488

def cells_ranges_post_worksheet_cells_range_outline_border(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_outline_border_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_outline_border_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Sets outline border around a range of cells.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range_operate (RangeSetOutlineBorderRequest) —

    Range Set OutlineBorder Request

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12502

def cells_ranges_post_worksheet_cells_range_outline_border_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_outline_border ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_outline_border"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_outline_border"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/outlineBorder".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range_operate'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_outline_border\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_row_height(name, sheet_name, value, opts = {}) ⇒ CellsCloudResponse

set row height of range

Parameters:

  • name
  • sheet_name
  • value
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :range (Range)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



12560
12561
12562
12563
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12560

def cells_ranges_post_worksheet_cells_range_row_height(name, sheet_name, value, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_row_height_with_http_info(name, sheet_name, value, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_row_height_with_http_info(name, sheet_name, value, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

set row height of range

Parameters:

  • name
  • sheet_name
  • value
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :range (Range)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12575

def cells_ranges_post_worksheet_cells_range_row_height_with_http_info(name, sheet_name, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_row_height ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_row_height"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_row_height"
  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 CellsApi.cells_ranges_post_worksheet_cells_range_row_height"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/rowHeight".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'value'] = value
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_row_height\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_style(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Sets the style of the range.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range_operate (RangeSetStyleRequest) —

    Range Set Style Request

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12637
12638
12639
12640
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12637

def cells_ranges_post_worksheet_cells_range_style(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_style_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_style_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Sets the style of the range.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range_operate (RangeSetStyleRequest) —

    Range Set Style Request

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12651

def cells_ranges_post_worksheet_cells_range_style_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_style"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_style"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/style".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range_operate'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_unmerge(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Unmerges merged cells of this range.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12708
12709
12710
12711
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12708

def cells_ranges_post_worksheet_cells_range_unmerge(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_unmerge_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_unmerge_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unmerges merged cells of this range.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12722

def cells_ranges_post_worksheet_cells_range_unmerge_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_unmerge ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_unmerge"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_unmerge"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/unmerge".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_unmerge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_range_value(name, sheet_name, value, opts = {}) ⇒ CellsCloudResponse

Puts a value into the range, if appropriate the value will be converted to other data type and cell’s number format will be reset.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

  • value —

    Input value

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :is_converted (BOOLEAN) —

    True: converted to other data type if appropriate. (default to false)

  • :set_style (BOOLEAN) —

    True: set the number format to cell&#39;s style when converting to other data type (default to false)

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12782
12783
12784
12785
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12782

def cells_ranges_post_worksheet_cells_range_value(name, sheet_name, value, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_range_value_with_http_info(name, sheet_name, value, opts)
  return data
end

#cells_ranges_post_worksheet_cells_range_value_with_http_info(name, sheet_name, value, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Puts a value into the range, if appropriate the value will be converted to other data type and cell&#39;s number format will be reset.

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

  • value —

    Input value

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

    the optional parameters

Options Hash (opts):

  • :range (Range) —

    range in worksheet

  • :is_converted (BOOLEAN) —

    True: converted to other data type if appropriate.

  • :set_style (BOOLEAN) —

    True: set the number format to cell&#39;s style when converting to other data type

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12799

def cells_ranges_post_worksheet_cells_range_value_with_http_info(name, sheet_name, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_range_value ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_value"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_range_value"
  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 CellsApi.cells_ranges_post_worksheet_cells_range_value"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges/value".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'Value'] = value
  query_params[:'isConverted'] = opts[:'is_converted'] if !opts[:'is_converted'].nil?
  query_params[:'setStyle'] = opts[:'set_style'] if !opts[:'set_style'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_range_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_ranges_post_worksheet_cells_ranges(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

copy range in the worksheet

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range_operate (RangeCopyRequest) —

    copydata,copystyle,copyto,copyvalue

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



12863
12864
12865
12866
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12863

def cells_ranges_post_worksheet_cells_ranges(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_ranges_post_worksheet_cells_ranges_with_http_info(name, sheet_name, opts)
  return data
end

#cells_ranges_post_worksheet_cells_ranges_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

copy range in the worksheet

Parameters:

  • name —

    workbook name

  • sheet_name —

    worksheet name

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

    the optional parameters

Options Hash (opts):

  • :range_operate (RangeCopyRequest) —

    copydata,copystyle,copyto,copyvalue

  • :folder (String) —

    Workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12877

def cells_ranges_post_worksheet_cells_ranges_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_ranges_post_worksheet_cells_ranges ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_ranges_post_worksheet_cells_ranges"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_ranges_post_worksheet_cells_ranges"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/ranges".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'range_operate'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_ranges_post_worksheet_cells_ranges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_save_as_post_document_save_as(name, opts = {}) ⇒ SaveResponse

Convert document and save result to storage.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :save_options (SaveOptions) —

    Save options.

  • :newfilename (String) —

    The new file name.

  • :is_auto_fit_rows (BOOLEAN) —

    Autofit rows. (default to false)

  • :is_auto_fit_columns (BOOLEAN) —

    Autofit columns. (default to false)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



12936
12937
12938
12939
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12936

def cells_save_as_post_document_save_as(name, opts = {})
  data, _status_code, _headers = cells_save_as_post_document_save_as_with_http_info(name, opts)
  return data
end

#cells_save_as_post_document_save_as_with_http_info(name, opts = {}) ⇒ Array<(SaveResponse, Fixnum, Hash)>

Convert document and save result to storage.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :save_options (SaveOptions) —

    Save options.

  • :newfilename (String) —

    The new file name.

  • :is_auto_fit_rows (BOOLEAN) —

    Autofit rows.

  • :is_auto_fit_columns (BOOLEAN) —

    Autofit columns.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    SaveResponse data, response status code and response headers



12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 12952

def cells_save_as_post_document_save_as_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_save_as_post_document_save_as ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_save_as_post_document_save_as"
  end
  # resource path
  local_var_path = "/cells/{name}/SaveAs".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'newfilename'] = opts[:'newfilename'] if !opts[:'newfilename'].nil?
  query_params[:'isAutoFitRows'] = opts[:'is_auto_fit_rows'] if !opts[:'is_auto_fit_rows'].nil?
  query_params[:'isAutoFitColumns'] = opts[:'is_auto_fit_columns'] if !opts[:'is_auto_fit_columns'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'save_options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'SaveResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_save_as_post_document_save_as\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_shapes_delete_worksheet_shape(name, sheet_name, shapeindex, opts = {}) ⇒ CellsCloudResponse

Delete a shape in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

  • shapeindex —

    shape index in worksheet shapes.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13008
13009
13010
13011
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13008

def cells_shapes_delete_worksheet_shape(name, sheet_name, shapeindex, opts = {})
  data, _status_code, _headers = cells_shapes_delete_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts)
  return data
end

#cells_shapes_delete_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete a shape in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

  • shapeindex —

    shape index in worksheet shapes.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13022

def cells_shapes_delete_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_shapes_delete_worksheet_shape ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_shapes_delete_worksheet_shape"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_shapes_delete_worksheet_shape"
  end
  # verify the required parameter 'shapeindex' is set
  if @api_client.config.client_side_validation && shapeindex.nil?
    fail ArgumentError, "Missing the required parameter 'shapeindex' when calling CellsApi.cells_shapes_delete_worksheet_shape"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/shapes/{shapeindex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'shapeindex' + '}', shapeindex.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_shapes_delete_worksheet_shape\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_shapes_delete_worksheet_shapes(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

delete all shapes in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13082
13083
13084
13085
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13082

def cells_shapes_delete_worksheet_shapes(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_shapes_delete_worksheet_shapes_with_http_info(name, sheet_name, opts)
  return data
end

#cells_shapes_delete_worksheet_shapes_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

delete all shapes in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13095

def cells_shapes_delete_worksheet_shapes_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_shapes_delete_worksheet_shapes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_shapes_delete_worksheet_shapes"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_shapes_delete_worksheet_shapes"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/shapes".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_shapes_delete_worksheet_shapes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_shapes_get_worksheet_shape(name, sheet_name, shapeindex, opts = {}) ⇒ ShapeResponse

Get worksheet shape

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

  • shapeindex —

    shape index in worksheet shapes.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13152
13153
13154
13155
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13152

def cells_shapes_get_worksheet_shape(name, sheet_name, shapeindex, opts = {})
  data, _status_code, _headers = cells_shapes_get_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts)
  return data
end

#cells_shapes_get_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts = {}) ⇒ Array<(ShapeResponse, Fixnum, Hash)>

Get worksheet shape

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

  • shapeindex —

    shape index in worksheet shapes.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ShapeResponse data, response status code and response headers



13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13166

def cells_shapes_get_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_shapes_get_worksheet_shape ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_shapes_get_worksheet_shape"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_shapes_get_worksheet_shape"
  end
  # verify the required parameter 'shapeindex' is set
  if @api_client.config.client_side_validation && shapeindex.nil?
    fail ArgumentError, "Missing the required parameter 'shapeindex' when calling CellsApi.cells_shapes_get_worksheet_shape"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/shapes/{shapeindex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'shapeindex' + '}', shapeindex.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ShapeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_shapes_get_worksheet_shape\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_shapes_get_worksheet_shapes(name, sheet_name, opts = {}) ⇒ ShapesResponse

Get worksheet shapes

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13226
13227
13228
13229
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13226

def cells_shapes_get_worksheet_shapes(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_shapes_get_worksheet_shapes_with_http_info(name, sheet_name, opts)
  return data
end

#cells_shapes_get_worksheet_shapes_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ShapesResponse, Fixnum, Hash)>

Get worksheet shapes

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ShapesResponse data, response status code and response headers



13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13239

def cells_shapes_get_worksheet_shapes_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_shapes_get_worksheet_shapes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_shapes_get_worksheet_shapes"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_shapes_get_worksheet_shapes"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/shapes".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ShapesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_shapes_get_worksheet_shapes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_shapes_post_worksheet_shape(name, sheet_name, shapeindex, opts = {}) ⇒ CellsCloudResponse

Update a shape in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

  • shapeindex —

    shape index in worksheet shapes.

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

    the optional parameters

Options Hash (opts):

  • :dto (Shape)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13297
13298
13299
13300
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13297

def cells_shapes_post_worksheet_shape(name, sheet_name, shapeindex, opts = {})
  data, _status_code, _headers = cells_shapes_post_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts)
  return data
end

#cells_shapes_post_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update a shape in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

  • shapeindex —

    shape index in worksheet shapes.

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

    the optional parameters

Options Hash (opts):

  • :dto (Shape)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13312

def cells_shapes_post_worksheet_shape_with_http_info(name, sheet_name, shapeindex, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_shapes_post_worksheet_shape ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_shapes_post_worksheet_shape"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_shapes_post_worksheet_shape"
  end
  # verify the required parameter 'shapeindex' is set
  if @api_client.config.client_side_validation && shapeindex.nil?
    fail ArgumentError, "Missing the required parameter 'shapeindex' when calling CellsApi.cells_shapes_post_worksheet_shape"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/shapes/{shapeindex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'shapeindex' + '}', shapeindex.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'dto'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_shapes_post_worksheet_shape\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_shapes_put_worksheet_shape(name, sheet_name, opts = {}) ⇒ ShapeResponse

Add shape in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :shape_dto (Shape)
  • :drawing_type (String) —

    shape object type

  • :upper_left_row (Integer) —

    Upper left row index.

  • :upper_left_column (Integer) —

    Upper left column index.

  • :top (Integer) —

    Represents the vertical offset of Spinner from its left row, in unit of pixel.

  • :left (Integer) —

    Represents the horizontal offset of Spinner from its left column, in unit of pixel.

  • :width (Integer) —

    Represents the height of Spinner, in unit of pixel.

  • :height (Integer) —

    Represents the width of Spinner, in unit of pixel.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13380
13381
13382
13383
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13380

def cells_shapes_put_worksheet_shape(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_shapes_put_worksheet_shape_with_http_info(name, sheet_name, opts)
  return data
end

#cells_shapes_put_worksheet_shape_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ShapeResponse, Fixnum, Hash)>

Add shape in worksheet

Parameters:

  • name —

    document name.

  • sheet_name —

    worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :shape_dto (Shape)
  • :drawing_type (String) —

    shape object type

  • :upper_left_row (Integer) —

    Upper left row index.

  • :upper_left_column (Integer) —

    Upper left column index.

  • :top (Integer) —

    Represents the vertical offset of Spinner from its left row, in unit of pixel.

  • :left (Integer) —

    Represents the horizontal offset of Spinner from its left column, in unit of pixel.

  • :width (Integer) —

    Represents the height of Spinner, in unit of pixel.

  • :height (Integer) —

    Represents the width of Spinner, in unit of pixel.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ShapeResponse data, response status code and response headers



13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13401

def cells_shapes_put_worksheet_shape_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_shapes_put_worksheet_shape ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_shapes_put_worksheet_shape"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_shapes_put_worksheet_shape"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/shapes".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'DrawingType'] = opts[:'drawing_type'] if !opts[:'drawing_type'].nil?
  query_params[:'upperLeftRow'] = opts[:'upper_left_row'] if !opts[:'upper_left_row'].nil?
  query_params[:'upperLeftColumn'] = opts[:'upper_left_column'] if !opts[:'upper_left_column'].nil?
  query_params[:'top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'left'] = opts[:'left'] if !opts[:'left'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'shape_dto'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShapeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_shapes_put_worksheet_shape\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_sparkline_groups_delete_worksheet_sparkline_group(name, sheet_name, sparkline_group_index, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • sparkline_group_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



13465
13466
13467
13468
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13465

def cells_sparkline_groups_delete_worksheet_sparkline_group(name, sheet_name, sparkline_group_index, opts = {})
  data, _status_code, _headers = cells_sparkline_groups_delete_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, opts)
  return data
end

#cells_sparkline_groups_delete_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • sparkline_group_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13479

def cells_sparkline_groups_delete_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_group ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_group"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_group"
  end
  # verify the required parameter 'sparkline_group_index' is set
  if @api_client.config.client_side_validation && sparkline_group_index.nil?
    fail ArgumentError, "Missing the required parameter 'sparkline_group_index' when calling CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_group"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sparklinegroups/{sparklineGroupIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'sparklineGroupIndex' + '}', sparkline_group_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_sparkline_groups_delete_worksheet_sparkline_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_sparkline_groups_delete_worksheet_sparkline_groups(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



13539
13540
13541
13542
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13539

def cells_sparkline_groups_delete_worksheet_sparkline_groups(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_sparkline_groups_delete_worksheet_sparkline_groups_with_http_info(name, sheet_name, opts)
  return data
end

#cells_sparkline_groups_delete_worksheet_sparkline_groups_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13552

def cells_sparkline_groups_delete_worksheet_sparkline_groups_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_groups ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_groups"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_sparkline_groups_delete_worksheet_sparkline_groups"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sparklinegroups".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_sparkline_groups_delete_worksheet_sparkline_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_sparkline_groups_get_worksheet_sparkline_group(name, sheet_name, sparkline_group_index, opts = {}) ⇒ SparklineGroupResponse

Parameters:

  • name
  • sheet_name
  • sparkline_group_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



13609
13610
13611
13612
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13609

def cells_sparkline_groups_get_worksheet_sparkline_group(name, sheet_name, sparkline_group_index, opts = {})
  data, _status_code, _headers = cells_sparkline_groups_get_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, opts)
  return data
end

#cells_sparkline_groups_get_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, opts = {}) ⇒ Array<(SparklineGroupResponse, Fixnum, Hash)>

Returns SparklineGroupResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • sparkline_group_index
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    SparklineGroupResponse data, response status code and response headers



13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13623

def cells_sparkline_groups_get_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_sparkline_groups_get_worksheet_sparkline_group ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_sparkline_groups_get_worksheet_sparkline_group"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_sparkline_groups_get_worksheet_sparkline_group"
  end
  # verify the required parameter 'sparkline_group_index' is set
  if @api_client.config.client_side_validation && sparkline_group_index.nil?
    fail ArgumentError, "Missing the required parameter 'sparkline_group_index' when calling CellsApi.cells_sparkline_groups_get_worksheet_sparkline_group"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sparklinegroups/{sparklineGroupIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'sparklineGroupIndex' + '}', sparkline_group_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'SparklineGroupResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_sparkline_groups_get_worksheet_sparkline_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_sparkline_groups_get_worksheet_sparkline_groups(name, sheet_name, opts = {}) ⇒ SparklineGroupsResponse

Get worksheet charts description.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



13683
13684
13685
13686
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13683

def cells_sparkline_groups_get_worksheet_sparkline_groups(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_sparkline_groups_get_worksheet_sparkline_groups_with_http_info(name, sheet_name, opts)
  return data
end

#cells_sparkline_groups_get_worksheet_sparkline_groups_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(SparklineGroupsResponse, Fixnum, Hash)>

Get worksheet charts description.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    SparklineGroupsResponse data, response status code and response headers



13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13696

def cells_sparkline_groups_get_worksheet_sparkline_groups_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_sparkline_groups_get_worksheet_sparkline_groups ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_sparkline_groups_get_worksheet_sparkline_groups"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_sparkline_groups_get_worksheet_sparkline_groups"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sparklinegroups".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'SparklineGroupsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_sparkline_groups_get_worksheet_sparkline_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_sparkline_groups_post_worksheet_sparkline_group(name, sheet_name, sparkline_group_index, sparkline_group, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • sparkline_group_index
  • sparkline_group
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



13754
13755
13756
13757
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13754

def cells_sparkline_groups_post_worksheet_sparkline_group(name, sheet_name, sparkline_group_index, sparkline_group, opts = {})
  data, _status_code, _headers = cells_sparkline_groups_post_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, sparkline_group, opts)
  return data
end

#cells_sparkline_groups_post_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, sparkline_group, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • sparkline_group_index
  • sparkline_group
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13769

def cells_sparkline_groups_post_worksheet_sparkline_group_with_http_info(name, sheet_name, sparkline_group_index, sparkline_group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_sparkline_groups_post_worksheet_sparkline_group ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_sparkline_groups_post_worksheet_sparkline_group"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_sparkline_groups_post_worksheet_sparkline_group"
  end
  # verify the required parameter 'sparkline_group_index' is set
  if @api_client.config.client_side_validation && sparkline_group_index.nil?
    fail ArgumentError, "Missing the required parameter 'sparkline_group_index' when calling CellsApi.cells_sparkline_groups_post_worksheet_sparkline_group"
  end
  # verify the required parameter 'sparkline_group' is set
  if @api_client.config.client_side_validation && sparkline_group.nil?
    fail ArgumentError, "Missing the required parameter 'sparkline_group' when calling CellsApi.cells_sparkline_groups_post_worksheet_sparkline_group"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sparklinegroups/{sparklineGroupIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'sparklineGroupIndex' + '}', sparkline_group_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(sparkline_group)
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_sparkline_groups_post_worksheet_sparkline_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_sparkline_groups_put_worksheet_sparkline_group(name, sheet_name, type, data_range, is_vertical, location_range, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • type
  • data_range
  • is_vertical
  • location_range
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



13837
13838
13839
13840
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13837

def cells_sparkline_groups_put_worksheet_sparkline_group(name, sheet_name, type, data_range, is_vertical, location_range, opts = {})
  data, _status_code, _headers = cells_sparkline_groups_put_worksheet_sparkline_group_with_http_info(name, sheet_name, type, data_range, is_vertical, location_range, opts)
  return data
end

#cells_sparkline_groups_put_worksheet_sparkline_group_with_http_info(name, sheet_name, type, data_range, is_vertical, location_range, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • type
  • data_range
  • is_vertical
  • location_range
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13854

def cells_sparkline_groups_put_worksheet_sparkline_group_with_http_info(name, sheet_name, type, data_range, is_vertical, location_range, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group"
  end
  # verify the required parameter 'data_range' is set
  if @api_client.config.client_side_validation && data_range.nil?
    fail ArgumentError, "Missing the required parameter 'data_range' when calling CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group"
  end
  # verify the required parameter 'is_vertical' is set
  if @api_client.config.client_side_validation && is_vertical.nil?
    fail ArgumentError, "Missing the required parameter 'is_vertical' when calling CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group"
  end
  # verify the required parameter 'location_range' is set
  if @api_client.config.client_side_validation && location_range.nil?
    fail ArgumentError, "Missing the required parameter 'location_range' when calling CellsApi.cells_sparkline_groups_put_worksheet_sparkline_group"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sparklinegroups".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = type
  query_params[:'dataRange'] = data_range
  query_params[:'isVertical'] = is_vertical
  query_params[:'locationRange'] = location_range
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_sparkline_groups_put_worksheet_sparkline_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_task_post_run_task(task_data, opts = {}) ⇒ Object

Run tasks

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


13927
13928
13929
13930
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13927

def cells_task_post_run_task(task_data, opts = {})
  data, _status_code, _headers = cells_task_post_run_task_with_http_info(task_data, opts)
  return data
end

#cells_task_post_run_task_with_http_info(task_data, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Run tasks

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13937

def cells_task_post_run_task_with_http_info(task_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_task_post_run_task ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'task_data' is set
  if @api_client.config.client_side_validation && task_data.nil?
    fail ArgumentError, "Missing the required parameter 'task_data' when calling CellsApi.cells_task_post_run_task"
  end
  # resource path
  local_var_path = "/cells/task/runtask"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(task_data)
  #auth_names = []
  auth_names = ['JWT']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_task_post_run_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_delete_decrypt_document(name, opts = {}) ⇒ CellsCloudResponse

Decrypt document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :encryption (WorkbookEncryptionRequest) —

    Encryption settings, only password can be specified.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



13987
13988
13989
13990
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 13987

def cells_workbook_delete_decrypt_document(name, opts = {})
  data, _status_code, _headers = cells_workbook_delete_decrypt_document_with_http_info(name, opts)
  return data
end

#cells_workbook_delete_decrypt_document_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Decrypt document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :encryption (WorkbookEncryptionRequest) —

    Encryption settings, only password can be specified.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14000

def cells_workbook_delete_decrypt_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_delete_decrypt_document ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_delete_decrypt_document"
  end
  # resource path
  local_var_path = "/cells/{name}/encryption".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'encryption'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_delete_decrypt_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_delete_document_unprotect_from_changes(name, opts = {}) ⇒ CellsCloudResponse

Unprotect document from changes.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



14051
14052
14053
14054
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14051

def cells_workbook_delete_document_unprotect_from_changes(name, opts = {})
  data, _status_code, _headers = cells_workbook_delete_document_unprotect_from_changes_with_http_info(name, opts)
  return data
end

#cells_workbook_delete_document_unprotect_from_changes_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unprotect document from changes.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14063

def cells_workbook_delete_document_unprotect_from_changes_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_delete_document_unprotect_from_changes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_delete_document_unprotect_from_changes"
  end
  # resource path
  local_var_path = "/cells/{name}/writeProtection".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_delete_document_unprotect_from_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_delete_unprotect_document(name, opts = {}) ⇒ CellsCloudResponse

Unprotect document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :protection (WorkbookProtectionRequest) —

    Protection settings, only password can be specified.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



14115
14116
14117
14118
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14115

def cells_workbook_delete_unprotect_document(name, opts = {})
  data, _status_code, _headers = cells_workbook_delete_unprotect_document_with_http_info(name, opts)
  return data
end

#cells_workbook_delete_unprotect_document_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unprotect document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :protection (WorkbookProtectionRequest) —

    Protection settings, only password can be specified.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14128

def cells_workbook_delete_unprotect_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_delete_unprotect_document ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_delete_unprotect_document"
  end
  # resource path
  local_var_path = "/cells/{name}/protection".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'protection'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_delete_unprotect_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_delete_workbook_background(name, opts = {}) ⇒ CellsCloudResponse

Set worksheet background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



14179
14180
14181
14182
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14179

def cells_workbook_delete_workbook_background(name, opts = {})
  data, _status_code, _headers = cells_workbook_delete_workbook_background_with_http_info(name, opts)
  return data
end

#cells_workbook_delete_workbook_background_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set worksheet background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14191

def cells_workbook_delete_workbook_background_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_delete_workbook_background ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_delete_workbook_background"
  end
  # resource path
  local_var_path = "/cells/{name}/background".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_delete_workbook_background\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_delete_workbook_name(name, name_name, opts = {}) ⇒ CellsCloudResponse

Clean workbook’s names.

Parameters:

  • name —

    The workbook name.

  • name_name —

    The name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



14243
14244
14245
14246
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14243

def cells_workbook_delete_workbook_name(name, name_name, opts = {})
  data, _status_code, _headers = cells_workbook_delete_workbook_name_with_http_info(name, name_name, opts)
  return data
end

#cells_workbook_delete_workbook_name_with_http_info(name, name_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clean workbook&#39;s names.

Parameters:

  • name —

    The workbook name.

  • name_name —

    The name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14256

def cells_workbook_delete_workbook_name_with_http_info(name, name_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_delete_workbook_name ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_delete_workbook_name"
  end
  # verify the required parameter 'name_name' is set
  if @api_client.config.client_side_validation && name_name.nil?
    fail ArgumentError, "Missing the required parameter 'name_name' when calling CellsApi.cells_workbook_delete_workbook_name"
  end
  # resource path
  local_var_path = "/cells/{name}/names/{nameName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'nameName' + '}', name_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_delete_workbook_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_delete_workbook_names(name, opts = {}) ⇒ CellsCloudResponse

Clean workbook’s names.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



14311
14312
14313
14314
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14311

def cells_workbook_delete_workbook_names(name, opts = {})
  data, _status_code, _headers = cells_workbook_delete_workbook_names_with_http_info(name, opts)
  return data
end

#cells_workbook_delete_workbook_names_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clean workbook&#39;s names.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14323

def cells_workbook_delete_workbook_names_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_delete_workbook_names ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_delete_workbook_names"
  end
  # resource path
  local_var_path = "/cells/{name}/names".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_delete_workbook_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook(name, opts = {}) ⇒ File

Read workbook info or export.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :password (String) —

    The document password.

  • :format (String) —

    The exported file format.

  • :is_auto_fit (BOOLEAN) —

    Set document rows to be autofit. (default to false)

  • :only_save_table (BOOLEAN) —

    Only save table data. (default to false)

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

  • :out_path (String) —

    The document output folder.

Returns:

  • (File) 


14379
14380
14381
14382
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14379

def cells_workbook_get_workbook(name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_with_http_info(name, opts)
  return data
end

#cells_workbook_get_workbook_default_style(name, opts = {}) ⇒ StyleResponse

Read workbook default style info.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



14452
14453
14454
14455
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14452

def cells_workbook_get_workbook_default_style(name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_default_style_with_http_info(name, opts)
  return data
end

#cells_workbook_get_workbook_default_style_with_http_info(name, opts = {}) ⇒ Array<(StyleResponse, Fixnum, Hash)>

Read workbook default style info.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    StyleResponse data, response status code and response headers



14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14464

def cells_workbook_get_workbook_default_style_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook_default_style ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook_default_style"
  end
  # resource path
  local_var_path = "/cells/{name}/defaultstyle".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'StyleResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook_default_style\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook_name(name, name_name, opts = {}) ⇒ NameResponse

Read workbook’s name.

Parameters:

  • name —

    The workbook name.

  • name_name —

    The name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



14516
14517
14518
14519
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14516

def cells_workbook_get_workbook_name(name, name_name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_name_with_http_info(name, name_name, opts)
  return data
end

#cells_workbook_get_workbook_name_value(name, name_name, opts = {}) ⇒ RangeValueResponse

Get workbook’s name value.

Parameters:

  • name —

    The workbook name.

  • name_name —

    The name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



14585
14586
14587
14588
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14585

def cells_workbook_get_workbook_name_value(name, name_name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_name_value_with_http_info(name, name_name, opts)
  return data
end

#cells_workbook_get_workbook_name_value_with_http_info(name, name_name, opts = {}) ⇒ Array<(RangeValueResponse, Fixnum, Hash)>

Get workbook&#39;s name value.

Parameters:

  • name —

    The workbook name.

  • name_name —

    The name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RangeValueResponse data, response status code and response headers



14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14598

def cells_workbook_get_workbook_name_value_with_http_info(name, name_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook_name_value ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook_name_value"
  end
  # verify the required parameter 'name_name' is set
  if @api_client.config.client_side_validation && name_name.nil?
    fail ArgumentError, "Missing the required parameter 'name_name' when calling CellsApi.cells_workbook_get_workbook_name_value"
  end
  # resource path
  local_var_path = "/cells/{name}/names/{nameName}/value".sub('{' + 'name' + '}', name.to_s).sub('{' + 'nameName' + '}', name_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'RangeValueResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook_name_value\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook_name_with_http_info(name, name_name, opts = {}) ⇒ Array<(NameResponse, Fixnum, Hash)>

Read workbook&#39;s name.

Parameters:

  • name —

    The workbook name.

  • name_name —

    The name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    NameResponse data, response status code and response headers



14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14529

def cells_workbook_get_workbook_name_with_http_info(name, name_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook_name ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook_name"
  end
  # verify the required parameter 'name_name' is set
  if @api_client.config.client_side_validation && name_name.nil?
    fail ArgumentError, "Missing the required parameter 'name_name' when calling CellsApi.cells_workbook_get_workbook_name"
  end
  # resource path
  local_var_path = "/cells/{name}/names/{nameName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'nameName' + '}', name_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'NameResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook_names(name, opts = {}) ⇒ NamesResponse

Read workbook’s names.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



14653
14654
14655
14656
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14653

def cells_workbook_get_workbook_names(name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_names_with_http_info(name, opts)
  return data
end

#cells_workbook_get_workbook_names_with_http_info(name, opts = {}) ⇒ Array<(NamesResponse, Fixnum, Hash)>

Read workbook&#39;s names.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    NamesResponse data, response status code and response headers



14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14665

def cells_workbook_get_workbook_names_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook_names ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook_names"
  end
  # resource path
  local_var_path = "/cells/{name}/names".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'NamesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook_settings(name, opts = {}) ⇒ WorkbookSettingsResponse

Get Workbook Settings DTO

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



14716
14717
14718
14719
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14716

def cells_workbook_get_workbook_settings(name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_settings_with_http_info(name, opts)
  return data
end

#cells_workbook_get_workbook_settings_with_http_info(name, opts = {}) ⇒ Array<(WorkbookSettingsResponse, Fixnum, Hash)>

Get Workbook Settings DTO

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorkbookSettingsResponse data, response status code and response headers



14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14728

def cells_workbook_get_workbook_settings_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook_settings ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook_settings"
  end
  # resource path
  local_var_path = "/cells/{name}/settings".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorkbookSettingsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook_text_items(name, opts = {}) ⇒ TextItemsResponse

Read workbook’s text items.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



14779
14780
14781
14782
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14779

def cells_workbook_get_workbook_text_items(name, opts = {})
  data, _status_code, _headers = cells_workbook_get_workbook_text_items_with_http_info(name, opts)
  return data
end

#cells_workbook_get_workbook_text_items_with_http_info(name, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Read workbook&#39;s text items.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TextItemsResponse data, response status code and response headers



14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14791

def cells_workbook_get_workbook_text_items_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook_text_items ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook_text_items"
  end
  # resource path
  local_var_path = "/cells/{name}/textItems".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook_text_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_get_workbook_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read workbook info or export.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :password (String) —

    The document password.

  • :format (String) —

    The exported file format.

  • :is_auto_fit (BOOLEAN) —

    Set document rows to be autofit.

  • :only_save_table (BOOLEAN) —

    Only save table data.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

  • :out_path (String) —

    The document output folder.

Returns:

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

    File data, response status code and response headers



14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14396

def cells_workbook_get_workbook_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_get_workbook ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_get_workbook"
  end
  # resource path
  local_var_path = "/cells/{name}".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'isAutoFit'] = opts[:'is_auto_fit'] if !opts[:'is_auto_fit'].nil?
  query_params[:'onlySaveTable'] = opts[:'only_save_table'] if !opts[:'only_save_table'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'outPath'] = opts[:'out_path'] if !opts[:'out_path'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_get_workbook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_autofit_workbook_rows(name, opts = {}) ⇒ CellsCloudResponse

Autofit workbook rows.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions) —

    Auto Fitter Options.

  • :start_row (Integer) —

    Start row.

  • :end_row (Integer) —

    End row.

  • :only_auto (BOOLEAN) —

    Only auto. (default to false)

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



14846
14847
14848
14849
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14846

def cells_workbook_post_autofit_workbook_rows(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_autofit_workbook_rows_with_http_info(name, opts)
  return data
end

#cells_workbook_post_autofit_workbook_rows_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Autofit workbook rows.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions) —

    Auto Fitter Options.

  • :start_row (Integer) —

    Start row.

  • :end_row (Integer) —

    End row.

  • :only_auto (BOOLEAN) —

    Only auto.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14862

def cells_workbook_post_autofit_workbook_rows_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_autofit_workbook_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_autofit_workbook_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/autofitrows".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startRow'] = opts[:'start_row'] if !opts[:'start_row'].nil?
  query_params[:'endRow'] = opts[:'end_row'] if !opts[:'end_row'].nil?
  query_params[:'onlyAuto'] = opts[:'only_auto'] if !opts[:'only_auto'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'auto_fitter_options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_autofit_workbook_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_encrypt_document(name, opts = {}) ⇒ CellsCloudResponse

Encript document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :encryption (WorkbookEncryptionRequest) —

    Encryption parameters.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



14917
14918
14919
14920
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14917

def cells_workbook_post_encrypt_document(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_encrypt_document_with_http_info(name, opts)
  return data
end

#cells_workbook_post_encrypt_document_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Encript document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :encryption (WorkbookEncryptionRequest) —

    Encryption parameters.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14930

def cells_workbook_post_encrypt_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_encrypt_document ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_encrypt_document"
  end
  # resource path
  local_var_path = "/cells/{name}/encryption".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'encryption'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_encrypt_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_import_data(name, import_data, opts = {}) ⇒ CellsCloudResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



14982
14983
14984
14985
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14982

def cells_workbook_post_import_data(name, import_data, opts = {})
  data, _status_code, _headers = cells_workbook_post_import_data_with_http_info(name, import_data, opts)
  return data
end

#cells_workbook_post_import_data_with_http_info(name, import_data, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 14995

def cells_workbook_post_import_data_with_http_info(name, import_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_import_data ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_import_data"
  end
  # verify the required parameter 'import_data' is set
  if @api_client.config.client_side_validation && import_data.nil?
    fail ArgumentError, "Missing the required parameter 'import_data' when calling CellsApi.cells_workbook_post_import_data"
  end
  # resource path
  local_var_path = "/cells/{name}/importdata".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(import_data)
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_import_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_protect_document(name, opts = {}) ⇒ CellsCloudResponse

Protect document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :protection (WorkbookProtectionRequest) —

    The protection settings.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



15051
15052
15053
15054
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15051

def cells_workbook_post_protect_document(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_protect_document_with_http_info(name, opts)
  return data
end

#cells_workbook_post_protect_document_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Protect document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :protection (WorkbookProtectionRequest) —

    The protection settings.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15064

def cells_workbook_post_protect_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_protect_document ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_protect_document"
  end
  # resource path
  local_var_path = "/cells/{name}/protection".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'protection'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_protect_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbook_calculate_formula(name, opts = {}) ⇒ CellsCloudResponse

Calculate all formulas in workbook.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :options (CalculationOptions) —

    Calculation Options.

  • :ignore_error (BOOLEAN) —

    ignore Error.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



15117
15118
15119
15120
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15117

def cells_workbook_post_workbook_calculate_formula(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbook_calculate_formula_with_http_info(name, opts)
  return data
end

#cells_workbook_post_workbook_calculate_formula_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Calculate all formulas in workbook.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :options (CalculationOptions) —

    Calculation Options.

  • :ignore_error (BOOLEAN) —

    ignore Error.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15131

def cells_workbook_post_workbook_calculate_formula_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbook_calculate_formula ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbook_calculate_formula"
  end
  # resource path
  local_var_path = "/cells/{name}/calculateformula".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'ignoreError'] = opts[:'ignore_error'] if !opts[:'ignore_error'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbook_calculate_formula\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbook_get_smart_marker_result(name, opts = {}) ⇒ File

Smart marker processing result.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :xml_file (String) —

    The xml file full path, if empty the data is read from request body.

  • :folder (String) —

    The workbook folder full path.

  • :storage_name (String) —

    storage name.

  • :out_path (String) —

    Path to save result

Returns:

  • (File) 


15185
15186
15187
15188
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15185

def cells_workbook_post_workbook_get_smart_marker_result(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbook_get_smart_marker_result_with_http_info(name, opts)
  return data
end

#cells_workbook_post_workbook_get_smart_marker_result_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Smart marker processing result.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :xml_file (String) —

    The xml file full path, if empty the data is read from request body.

  • :folder (String) —

    The workbook folder full path.

  • :storage_name (String) —

    storage name.

  • :out_path (String) —

    Path to save result

Returns:

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

    File data, response status code and response headers



15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15199

def cells_workbook_post_workbook_get_smart_marker_result_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbook_get_smart_marker_result ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbook_get_smart_marker_result"
  end
  # resource path
  local_var_path = "/cells/{name}/smartmarker".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xmlFile'] = opts[:'xml_file'] if !opts[:'xml_file'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'outPath'] = opts[:'out_path'] if !opts[:'out_path'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbook_get_smart_marker_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbook_settings(name, opts = {}) ⇒ CellsCloudResponse

Update Workbook setting

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :settings (WorkbookSettings) —

    Workbook Setting DTO

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



15253
15254
15255
15256
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15253

def cells_workbook_post_workbook_settings(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbook_settings_with_http_info(name, opts)
  return data
end

#cells_workbook_post_workbook_settings_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update Workbook setting

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :settings (WorkbookSettings) —

    Workbook Setting DTO

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15266

def cells_workbook_post_workbook_settings_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbook_settings ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbook_settings"
  end
  # resource path
  local_var_path = "/cells/{name}/settings".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'settings'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbook_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbook_split(name, opts = {}) ⇒ SplitResultResponse

Split workbook.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Split format.

  • :from (Integer) —

    Start worksheet index. (default to 0)

  • :to (Integer) —

    End worksheet index. (default to 0)

  • :horizontal_resolution (Integer) —

    Image horizontal resolution. (default to 0)

  • :vertical_resolution (Integer) —

    Image vertical resolution. (default to 0)

  • :folder (String) —

    The workbook folder.

  • :out_folder (String) —

    out Folder.

  • :storage_name (String) —

    storage name.

Returns:



15323
15324
15325
15326
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15323

def cells_workbook_post_workbook_split(name, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbook_split_with_http_info(name, opts)
  return data
end

#cells_workbook_post_workbook_split_with_http_info(name, opts = {}) ⇒ Array<(SplitResultResponse, Fixnum, Hash)>

Split workbook.

Parameters:

  • name —

    The workbook name.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Split format.

  • :from (Integer) —

    Start worksheet index.

  • :to (Integer) —

    End worksheet index.

  • :horizontal_resolution (Integer) —

    Image horizontal resolution.

  • :vertical_resolution (Integer) —

    Image vertical resolution.

  • :folder (String) —

    The workbook folder.

  • :out_folder (String) —

    out Folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    SplitResultResponse data, response status code and response headers



15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15341

def cells_workbook_post_workbook_split_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbook_split ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbook_split"
  end
  # resource path
  local_var_path = "/cells/{name}/split".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'horizontalResolution'] = opts[:'horizontal_resolution'] if !opts[:'horizontal_resolution'].nil?
  query_params[:'verticalResolution'] = opts[:'vertical_resolution'] if !opts[:'vertical_resolution'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'outFolder'] = opts[:'out_folder'] if !opts[:'out_folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'SplitResultResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbook_split\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbooks_merge(name, merge_with, opts = {}) ⇒ WorkbookResponse

Merge workbooks.

Parameters:

  • name —

    Workbook name.

  • merge_with —

    The workbook to merge with.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Source workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



15399
15400
15401
15402
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15399

def cells_workbook_post_workbooks_merge(name, merge_with, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbooks_merge_with_http_info(name, merge_with, opts)
  return data
end

#cells_workbook_post_workbooks_merge_with_http_info(name, merge_with, opts = {}) ⇒ Array<(WorkbookResponse, Fixnum, Hash)>

Merge workbooks.

Parameters:

  • name —

    Workbook name.

  • merge_with —

    The workbook to merge with.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Source workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorkbookResponse data, response status code and response headers



15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15412

def cells_workbook_post_workbooks_merge_with_http_info(name, merge_with, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbooks_merge ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbooks_merge"
  end
  # verify the required parameter 'merge_with' is set
  if @api_client.config.client_side_validation && merge_with.nil?
    fail ArgumentError, "Missing the required parameter 'merge_with' when calling CellsApi.cells_workbook_post_workbooks_merge"
  end
  # resource path
  local_var_path = "/cells/{name}/merge".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'mergeWith'] = merge_with
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorkbookResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbooks_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbooks_text_replace(name, old_value, new_value, opts = {}) ⇒ WorkbookReplaceResponse

Replace text.

Parameters:

  • name —

    Document name.

  • old_value —

    The old value.

  • new_value —

    The new value.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



15470
15471
15472
15473
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15470

def cells_workbook_post_workbooks_text_replace(name, old_value, new_value, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbooks_text_replace_with_http_info(name, old_value, new_value, opts)
  return data
end

#cells_workbook_post_workbooks_text_replace_with_http_info(name, old_value, new_value, opts = {}) ⇒ Array<(WorkbookReplaceResponse, Fixnum, Hash)>

Replace text.

Parameters:

  • name —

    Document name.

  • old_value —

    The old value.

  • new_value —

    The new value.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorkbookReplaceResponse data, response status code and response headers



15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15484

def cells_workbook_post_workbooks_text_replace_with_http_info(name, old_value, new_value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbooks_text_replace ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbooks_text_replace"
  end
  # verify the required parameter 'old_value' is set
  if @api_client.config.client_side_validation && old_value.nil?
    fail ArgumentError, "Missing the required parameter 'old_value' when calling CellsApi.cells_workbook_post_workbooks_text_replace"
  end
  # verify the required parameter 'new_value' is set
  if @api_client.config.client_side_validation && new_value.nil?
    fail ArgumentError, "Missing the required parameter 'new_value' when calling CellsApi.cells_workbook_post_workbooks_text_replace"
  end
  # resource path
  local_var_path = "/cells/{name}/replaceText".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'oldValue'] = old_value
  query_params[:'newValue'] = new_value
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorkbookReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbooks_text_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_post_workbooks_text_search(name, text, opts = {}) ⇒ TextItemsResponse

Search text.

Parameters:

  • name —

    Document name.

  • text —

    Text sample.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



15546
15547
15548
15549
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15546

def cells_workbook_post_workbooks_text_search(name, text, opts = {})
  data, _status_code, _headers = cells_workbook_post_workbooks_text_search_with_http_info(name, text, opts)
  return data
end

#cells_workbook_post_workbooks_text_search_with_http_info(name, text, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Search text.

Parameters:

  • name —

    Document name.

  • text —

    Text sample.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TextItemsResponse data, response status code and response headers



15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15559

def cells_workbook_post_workbooks_text_search_with_http_info(name, text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_post_workbooks_text_search ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_post_workbooks_text_search"
  end
  # verify the required parameter 'text' is set
  if @api_client.config.client_side_validation && text.nil?
    fail ArgumentError, "Missing the required parameter 'text' when calling CellsApi.cells_workbook_post_workbooks_text_search"
  end
  # resource path
  local_var_path = "/cells/{name}/findText".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'text'] = text
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_post_workbooks_text_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_put_convert_workbook(workbook, opts = {}) ⇒ File

Convert workbook from request content to some format.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The format to convert.

  • :password (String) —

    The workbook password.

  • :out_path (String) —

    Path to save result

Returns:

  • (File) 


15616
15617
15618
15619
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15616

def cells_workbook_put_convert_workbook(workbook, opts = {})
  data, _status_code, _headers = cells_workbook_put_convert_workbook_with_http_info(workbook, opts)
  return data
end

#cells_workbook_put_convert_workbook_with_http_info(workbook, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert workbook from request content to some format.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The format to convert.

  • :password (String) —

    The workbook password.

  • :out_path (String) —

    Path to save result

Returns:

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

    File data, response status code and response headers



15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15629

def cells_workbook_put_convert_workbook_with_http_info(workbook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_put_convert_workbook ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'workbook' is set
  if @api_client.config.client_side_validation && workbook.nil?
    fail ArgumentError, "Missing the required parameter 'workbook' when calling CellsApi.cells_workbook_put_convert_workbook"
  end
  # resource path
  local_var_path = "/cells/convert"

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?
  query_params[:'outPath'] = opts[:'out_path'] if !opts[:'out_path'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  post_body =workbook
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_put_convert_workbook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_put_document_protect_from_changes(name, opts = {}) ⇒ CellsCloudResponse

Protect document from changes.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :password (PasswordRequest) —

    Modification password.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



15683
15684
15685
15686
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15683

def cells_workbook_put_document_protect_from_changes(name, opts = {})
  data, _status_code, _headers = cells_workbook_put_document_protect_from_changes_with_http_info(name, opts)
  return data
end

#cells_workbook_put_document_protect_from_changes_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Protect document from changes.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :password (PasswordRequest) —

    Modification password.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15696

def cells_workbook_put_document_protect_from_changes_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_put_document_protect_from_changes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_put_document_protect_from_changes"
  end
  # resource path
  local_var_path = "/cells/{name}/writeProtection".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'password'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_put_document_protect_from_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_put_workbook_background(name, png, opts = {}) ⇒ CellsCloudResponse

Set workbook background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



15748
15749
15750
15751
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15748

def cells_workbook_put_workbook_background(name, png, opts = {})
  data, _status_code, _headers = cells_workbook_put_workbook_background_with_http_info(name, png, opts)
  return data
end

#cells_workbook_put_workbook_background_with_http_info(name, png, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set workbook background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15761

def cells_workbook_put_workbook_background_with_http_info(name, png, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_put_workbook_background ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_put_workbook_background"
  end
  # verify the required parameter 'png' is set
  if @api_client.config.client_side_validation && png.nil?
    fail ArgumentError, "Missing the required parameter 'png' when calling CellsApi.cells_workbook_put_workbook_background"
  end
  # resource path
  local_var_path = "/cells/{name}/background".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(png)
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_put_workbook_background\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_put_workbook_create(name, opts = {}) ⇒ WorkbookResponse

Create new workbook using deferent methods.

Parameters:

  • name —

    The new document name.

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

    the optional parameters

Options Hash (opts):

  • :template_file (String) —

    The template file, if the data not provided default workbook is created.

  • :data_file (String) —

    Smart marker data file, if the data not provided the request content is checked for the data.

  • :is_write_over (BOOLEAN) —

    write over file.

  • :folder (String) —

    The new document folder.

  • :storage_name (String) —

    storage name.

Returns:



15819
15820
15821
15822
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15819

def cells_workbook_put_workbook_create(name, opts = {})
  data, _status_code, _headers = cells_workbook_put_workbook_create_with_http_info(name, opts)
  return data
end

#cells_workbook_put_workbook_create_with_http_info(name, opts = {}) ⇒ Array<(WorkbookResponse, Fixnum, Hash)>

Create new workbook using deferent methods.

Parameters:

  • name —

    The new document name.

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

    the optional parameters

Options Hash (opts):

  • :template_file (String) —

    The template file, if the data not provided default workbook is created.

  • :data_file (String) —

    Smart marker data file, if the data not provided the request content is checked for the data.

  • :is_write_over (BOOLEAN) —

    write over file.

  • :folder (String) —

    The new document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorkbookResponse data, response status code and response headers



15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15834

def cells_workbook_put_workbook_create_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_put_workbook_create ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_put_workbook_create"
  end
  # resource path
  local_var_path = "/cells/{name}".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'templateFile'] = opts[:'template_file'] if !opts[:'template_file'].nil?
  query_params[:'dataFile'] = opts[:'data_file'] if !opts[:'data_file'].nil?
  query_params[:'isWriteOver'] = opts[:'is_write_over'] if !opts[:'is_write_over'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkbookResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_put_workbook_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_workbook_put_workbook_water_marker(name, opts = {}) ⇒ CellsCloudResponse

Set workbook background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

  • :text_water_marker_request (TextWaterMarkerRequest) —

    The text water marker request.

Returns:



15889
15890
15891
15892
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15889

def cells_workbook_put_workbook_water_marker(name, opts = {})
  data, _status_code, _headers = cells_workbook_put_workbook_water_marker_with_http_info(name, opts)
  return data
end

#cells_workbook_put_workbook_water_marker_with_http_info(name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set workbook background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

  • :text_water_marker_request (TextWaterMarkerRequest) —

    The text water marker request.

Returns:

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

    CellsCloudResponse data, response status code and response headers



15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15902

def cells_workbook_put_workbook_water_marker_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_workbook_put_workbook_water_marker ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_workbook_put_workbook_water_marker"
  end
  # resource path
  local_var_path = "/cells/{name}/watermarker".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'text_water_marker_request'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_workbook_put_workbook_water_marker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheet_validations_delete_worksheet_validation(name, sheet_name, validation_index, opts = {}) ⇒ ValidationResponse

Delete worksheet validation by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • validation_index —

    The validation index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



15955
15956
15957
15958
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15955

def cells_worksheet_validations_delete_worksheet_validation(name, sheet_name, validation_index, opts = {})
  data, _status_code, _headers = cells_worksheet_validations_delete_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts)
  return data
end

#cells_worksheet_validations_delete_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts = {}) ⇒ Array<(ValidationResponse, Fixnum, Hash)>

Delete worksheet validation by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • validation_index —

    The validation index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ValidationResponse data, response status code and response headers



15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 15969

def cells_worksheet_validations_delete_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheet_validations_delete_worksheet_validation ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheet_validations_delete_worksheet_validation"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheet_validations_delete_worksheet_validation"
  end
  # verify the required parameter 'validation_index' is set
  if @api_client.config.client_side_validation && validation_index.nil?
    fail ArgumentError, "Missing the required parameter 'validation_index' when calling CellsApi.cells_worksheet_validations_delete_worksheet_validation"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/validations/{validationIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'validationIndex' + '}', validation_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheet_validations_delete_worksheet_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheet_validations_delete_worksheet_validations(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Clear all validation in worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



16029
16030
16031
16032
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16029

def cells_worksheet_validations_delete_worksheet_validations(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheet_validations_delete_worksheet_validations_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheet_validations_delete_worksheet_validations_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Clear all validation in worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16042

def cells_worksheet_validations_delete_worksheet_validations_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheet_validations_delete_worksheet_validations ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheet_validations_delete_worksheet_validations"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheet_validations_delete_worksheet_validations"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/validations".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheet_validations_delete_worksheet_validations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheet_validations_get_worksheet_validation(name, sheet_name, validation_index, opts = {}) ⇒ ValidationResponse

Get worksheet validation by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • validation_index —

    The validation index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



16099
16100
16101
16102
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16099

def cells_worksheet_validations_get_worksheet_validation(name, sheet_name, validation_index, opts = {})
  data, _status_code, _headers = cells_worksheet_validations_get_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts)
  return data
end

#cells_worksheet_validations_get_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts = {}) ⇒ Array<(ValidationResponse, Fixnum, Hash)>

Get worksheet validation by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • validation_index —

    The validation index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ValidationResponse data, response status code and response headers



16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16113

def cells_worksheet_validations_get_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheet_validations_get_worksheet_validation ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheet_validations_get_worksheet_validation"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheet_validations_get_worksheet_validation"
  end
  # verify the required parameter 'validation_index' is set
  if @api_client.config.client_side_validation && validation_index.nil?
    fail ArgumentError, "Missing the required parameter 'validation_index' when calling CellsApi.cells_worksheet_validations_get_worksheet_validation"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/validations/{validationIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'validationIndex' + '}', validation_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheet_validations_get_worksheet_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheet_validations_get_worksheet_validations(name, sheet_name, opts = {}) ⇒ ValidationsResponse

Get worksheet validations.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



16173
16174
16175
16176
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16173

def cells_worksheet_validations_get_worksheet_validations(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheet_validations_get_worksheet_validations_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheet_validations_get_worksheet_validations_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ValidationsResponse, Fixnum, Hash)>

Get worksheet validations.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ValidationsResponse data, response status code and response headers



16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16186

def cells_worksheet_validations_get_worksheet_validations_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheet_validations_get_worksheet_validations ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheet_validations_get_worksheet_validations"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheet_validations_get_worksheet_validations"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/validations".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ValidationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheet_validations_get_worksheet_validations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheet_validations_post_worksheet_validation(name, sheet_name, validation_index, opts = {}) ⇒ ValidationResponse

Update worksheet validation by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • validation_index —

    The validation index.

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

    the optional parameters

Options Hash (opts):

  • :validation (Validation)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



16244
16245
16246
16247
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16244

def cells_worksheet_validations_post_worksheet_validation(name, sheet_name, validation_index, opts = {})
  data, _status_code, _headers = cells_worksheet_validations_post_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts)
  return data
end

#cells_worksheet_validations_post_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts = {}) ⇒ Array<(ValidationResponse, Fixnum, Hash)>

Update worksheet validation by index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • validation_index —

    The validation index.

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

    the optional parameters

Options Hash (opts):

  • :validation (Validation)
  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ValidationResponse data, response status code and response headers



16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16259

def cells_worksheet_validations_post_worksheet_validation_with_http_info(name, sheet_name, validation_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheet_validations_post_worksheet_validation ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheet_validations_post_worksheet_validation"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheet_validations_post_worksheet_validation"
  end
  # verify the required parameter 'validation_index' is set
  if @api_client.config.client_side_validation && validation_index.nil?
    fail ArgumentError, "Missing the required parameter 'validation_index' when calling CellsApi.cells_worksheet_validations_post_worksheet_validation"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/validations/{validationIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'validationIndex' + '}', validation_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'validation'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheet_validations_post_worksheet_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheet_validations_put_worksheet_validation(name, sheet_name, opts = {}) ⇒ ValidationResponse

Add worksheet validation at index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :range (String) —

    Specified cells area

  • :validation (Validation) —

    validation

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



16321
16322
16323
16324
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16321

def cells_worksheet_validations_put_worksheet_validation(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheet_validations_put_worksheet_validation_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheet_validations_put_worksheet_validation_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(ValidationResponse, Fixnum, Hash)>

Add worksheet validation at index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :range (String) —

    Specified cells area

  • :validation (Validation) —

    validation

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    ValidationResponse data, response status code and response headers



16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16336

def cells_worksheet_validations_put_worksheet_validation_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheet_validations_put_worksheet_validation ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheet_validations_put_worksheet_validation"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheet_validations_put_worksheet_validation"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/validations".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'validation'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheet_validations_put_worksheet_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_delete_unprotect_worksheet(name, sheet_name, opts = {}) ⇒ WorksheetResponse

Unprotect worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :protect_parameter (ProtectSheetParameter) —

    with protection settings. Only password is used here.

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



16394
16395
16396
16397
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16394

def cells_worksheets_delete_unprotect_worksheet(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_delete_unprotect_worksheet_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_delete_unprotect_worksheet_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(WorksheetResponse, Fixnum, Hash)>

Unprotect worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :protect_parameter (ProtectSheetParameter) —

    with protection settings. Only password is used here.

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetResponse data, response status code and response headers



16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16408

def cells_worksheets_delete_unprotect_worksheet_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_delete_unprotect_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_delete_unprotect_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_delete_unprotect_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/protection".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'protect_parameter'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorksheetResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_delete_unprotect_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_delete_worksheet(name, sheet_name, opts = {}) ⇒ WorksheetsResponse

Delete worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



16464
16465
16466
16467
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16464

def cells_worksheets_delete_worksheet(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_delete_worksheet_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_delete_worksheet_background(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Set worksheet background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



16533
16534
16535
16536
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16533

def cells_worksheets_delete_worksheet_background(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_delete_worksheet_background_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_delete_worksheet_background_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set worksheet background image.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16546

def cells_worksheets_delete_worksheet_background_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_delete_worksheet_background ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_delete_worksheet_background"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_delete_worksheet_background"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/background".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_delete_worksheet_background\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_delete_worksheet_comment(name, sheet_name, cell_name, opts = {}) ⇒ CellsCloudResponse

Delete worksheet’s cell comment.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



16603
16604
16605
16606
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16603

def cells_worksheets_delete_worksheet_comment(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_worksheets_delete_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_worksheets_delete_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete worksheet&#39;s cell comment.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16617

def cells_worksheets_delete_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_delete_worksheet_comment ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_delete_worksheet_comment"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_delete_worksheet_comment"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_worksheets_delete_worksheet_comment"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/comments/{cellName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_delete_worksheet_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_delete_worksheet_comments(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Delete all comments for worksheet.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



16677
16678
16679
16680
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16677

def cells_worksheets_delete_worksheet_comments(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_delete_worksheet_comments_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_delete_worksheet_comments_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Delete all comments for worksheet.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16690

def cells_worksheets_delete_worksheet_comments_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_delete_worksheet_comments ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_delete_worksheet_comments"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_delete_worksheet_comments"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/comments".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_delete_worksheet_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_delete_worksheet_freeze_panes(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {}) ⇒ CellsCloudResponse

Unfreeze panes

Parameters:

  • name
  • sheet_name
  • row
  • column
  • freezed_rows
  • freezed_columns
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



16750
16751
16752
16753
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16750

def cells_worksheets_delete_worksheet_freeze_panes(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {})
  data, _status_code, _headers = cells_worksheets_delete_worksheet_freeze_panes_with_http_info(name, sheet_name, row, column, freezed_rows, freezed_columns, opts)
  return data
end

#cells_worksheets_delete_worksheet_freeze_panes_with_http_info(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Unfreeze panes

Parameters:

  • name
  • sheet_name
  • row
  • column
  • freezed_rows
  • freezed_columns
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16767

def cells_worksheets_delete_worksheet_freeze_panes_with_http_info(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_delete_worksheet_freeze_panes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_delete_worksheet_freeze_panes"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_delete_worksheet_freeze_panes"
  end
  # verify the required parameter 'row' is set
  if @api_client.config.client_side_validation && row.nil?
    fail ArgumentError, "Missing the required parameter 'row' when calling CellsApi.cells_worksheets_delete_worksheet_freeze_panes"
  end
  # verify the required parameter 'column' is set
  if @api_client.config.client_side_validation && column.nil?
    fail ArgumentError, "Missing the required parameter 'column' when calling CellsApi.cells_worksheets_delete_worksheet_freeze_panes"
  end
  # verify the required parameter 'freezed_rows' is set
  if @api_client.config.client_side_validation && freezed_rows.nil?
    fail ArgumentError, "Missing the required parameter 'freezed_rows' when calling CellsApi.cells_worksheets_delete_worksheet_freeze_panes"
  end
  # verify the required parameter 'freezed_columns' is set
  if @api_client.config.client_side_validation && freezed_columns.nil?
    fail ArgumentError, "Missing the required parameter 'freezed_columns' when calling CellsApi.cells_worksheets_delete_worksheet_freeze_panes"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/freezepanes".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'row'] = row
  query_params[:'column'] = column
  query_params[:'freezedRows'] = freezed_rows
  query_params[:'freezedColumns'] = freezed_columns
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_delete_worksheet_freeze_panes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_delete_worksheet_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(WorksheetsResponse, Fixnum, Hash)>

Delete worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetsResponse data, response status code and response headers



16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16477

def cells_worksheets_delete_worksheet_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_delete_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_delete_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_delete_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorksheetsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_delete_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_named_ranges(name, opts = {}) ⇒ RangesResponse

Read worksheets ranges info.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



16842
16843
16844
16845
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16842

def cells_worksheets_get_named_ranges(name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_named_ranges_with_http_info(name, opts)
  return data
end

#cells_worksheets_get_named_ranges_with_http_info(name, opts = {}) ⇒ Array<(RangesResponse, Fixnum, Hash)>

Read worksheets ranges info.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    RangesResponse data, response status code and response headers



16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16854

def cells_worksheets_get_named_ranges_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_named_ranges ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_named_ranges"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/ranges".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'RangesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_named_ranges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet(name, sheet_name, opts = {}) ⇒ File

Read worksheet info or export.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported file format.

  • :vertical_resolution (Integer) —

    Image vertical resolution. (default to 0)

  • :horizontal_resolution (Integer) —

    Image horizontal resolution. (default to 0)

  • :area (String) —

    Exported area.

  • :page_index (Integer) —

    Exported page index.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

  • (File) 


16911
16912
16913
16914
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16911

def cells_worksheets_get_worksheet(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_get_worksheet_calculate_formula(name, sheet_name, formula, opts = {}) ⇒ SingleValueResponse

Calculate formula value.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • formula —

    The formula.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



16991
16992
16993
16994
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16991

def cells_worksheets_get_worksheet_calculate_formula(name, sheet_name, formula, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_calculate_formula_with_http_info(name, sheet_name, formula, opts)
  return data
end

#cells_worksheets_get_worksheet_calculate_formula_with_http_info(name, sheet_name, formula, opts = {}) ⇒ Array<(SingleValueResponse, Fixnum, Hash)>

Calculate formula value.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • formula —

    The formula.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    SingleValueResponse data, response status code and response headers



17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17005

def cells_worksheets_get_worksheet_calculate_formula_with_http_info(name, sheet_name, formula, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet_calculate_formula ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet_calculate_formula"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet_calculate_formula"
  end
  # verify the required parameter 'formula' is set
  if @api_client.config.client_side_validation && formula.nil?
    fail ArgumentError, "Missing the required parameter 'formula' when calling CellsApi.cells_worksheets_get_worksheet_calculate_formula"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/formulaResult".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'formula'] = formula
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'SingleValueResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet_calculate_formula\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet_comment(name, sheet_name, cell_name, opts = {}) ⇒ CommentResponse

Get worksheet comment by cell name.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



17067
17068
17069
17070
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17067

def cells_worksheets_get_worksheet_comment(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_worksheets_get_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CommentResponse, Fixnum, Hash)>

Get worksheet comment by cell name.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CommentResponse data, response status code and response headers



17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17081

def cells_worksheets_get_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet_comment ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet_comment"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet_comment"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_worksheets_get_worksheet_comment"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/comments/{cellName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CommentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet_comments(name, sheet_name, opts = {}) ⇒ CommentsResponse

Get worksheet comments.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



17141
17142
17143
17144
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17141

def cells_worksheets_get_worksheet_comments(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_comments_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_get_worksheet_comments_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CommentsResponse, Fixnum, Hash)>

Get worksheet comments.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CommentsResponse data, response status code and response headers



17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17154

def cells_worksheets_get_worksheet_comments_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet_comments ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet_comments"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet_comments"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/comments".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CommentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet_merged_cell(name, sheet_name, merged_cell_index, opts = {}) ⇒ MergedCellResponse

Get worksheet merged cell by its index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • merged_cell_index —

    Merged cell index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



17211
17212
17213
17214
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17211

def cells_worksheets_get_worksheet_merged_cell(name, sheet_name, merged_cell_index, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_merged_cell_with_http_info(name, sheet_name, merged_cell_index, opts)
  return data
end

#cells_worksheets_get_worksheet_merged_cell_with_http_info(name, sheet_name, merged_cell_index, opts = {}) ⇒ Array<(MergedCellResponse, Fixnum, Hash)>

Get worksheet merged cell by its index.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • merged_cell_index —

    Merged cell index.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    MergedCellResponse data, response status code and response headers



17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17225

def cells_worksheets_get_worksheet_merged_cell_with_http_info(name, sheet_name, merged_cell_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet_merged_cell ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet_merged_cell"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet_merged_cell"
  end
  # verify the required parameter 'merged_cell_index' is set
  if @api_client.config.client_side_validation && merged_cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'merged_cell_index' when calling CellsApi.cells_worksheets_get_worksheet_merged_cell"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/mergedCells/{mergedCellIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'mergedCellIndex' + '}', merged_cell_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'MergedCellResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet_merged_cell\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet_merged_cells(name, sheet_name, opts = {}) ⇒ MergedCellsResponse

Get worksheet merged cells.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The workseet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



17285
17286
17287
17288
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17285

def cells_worksheets_get_worksheet_merged_cells(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_merged_cells_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_get_worksheet_merged_cells_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(MergedCellsResponse, Fixnum, Hash)>

Get worksheet merged cells.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The workseet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    MergedCellsResponse data, response status code and response headers



17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17298

def cells_worksheets_get_worksheet_merged_cells_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet_merged_cells ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet_merged_cells"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet_merged_cells"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/mergedCells".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'MergedCellsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet_merged_cells\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet_text_items(name, sheet_name, opts = {}) ⇒ TextItemsResponse

Get worksheet text items.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



17354
17355
17356
17357
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17354

def cells_worksheets_get_worksheet_text_items(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheet_text_items_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_get_worksheet_text_items_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Get worksheet text items.

Parameters:

  • name —

    Workbook name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The workbook&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TextItemsResponse data, response status code and response headers



17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17367

def cells_worksheets_get_worksheet_text_items_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet_text_items ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet_text_items"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet_text_items"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/textItems".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet_text_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheet_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read worksheet info or export.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The exported file format.

  • :vertical_resolution (Integer) —

    Image vertical resolution.

  • :horizontal_resolution (Integer) —

    Image horizontal resolution.

  • :area (String) —

    Exported area.

  • :page_index (Integer) —

    Exported page index.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    File data, response status code and response headers



16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 16929

def cells_worksheets_get_worksheet_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_get_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'verticalResolution'] = opts[:'vertical_resolution'] if !opts[:'vertical_resolution'].nil?
  query_params[:'horizontalResolution'] = opts[:'horizontal_resolution'] if !opts[:'horizontal_resolution'].nil?
  query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_get_worksheets(name, opts = {}) ⇒ WorksheetsResponse

Read worksheets info.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



17422
17423
17424
17425
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17422

def cells_worksheets_get_worksheets(name, opts = {})
  data, _status_code, _headers = cells_worksheets_get_worksheets_with_http_info(name, opts)
  return data
end

#cells_worksheets_get_worksheets_with_http_info(name, opts = {}) ⇒ Array<(WorksheetsResponse, Fixnum, Hash)>

Read worksheets info.

Parameters:

  • name —

    Document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetsResponse data, response status code and response headers



17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17434

def cells_worksheets_get_worksheets_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_get_worksheets ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_get_worksheets"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorksheetsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_get_worksheets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_autofit_worksheet_columns(name, sheet_name, first_column, last_column, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • first_column
  • last_column
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions)
  • :first_row (Integer)
  • :last_row (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



17491
17492
17493
17494
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17491

def cells_worksheets_post_autofit_worksheet_columns(name, sheet_name, first_column, last_column, opts = {})
  data, _status_code, _headers = cells_worksheets_post_autofit_worksheet_columns_with_http_info(name, sheet_name, first_column, last_column, opts)
  return data
end

#cells_worksheets_post_autofit_worksheet_columns_with_http_info(name, sheet_name, first_column, last_column, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • first_column
  • last_column
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions)
  • :first_row (Integer)
  • :last_row (Integer)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17509

def cells_worksheets_post_autofit_worksheet_columns_with_http_info(name, sheet_name, first_column, last_column, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_autofit_worksheet_columns ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_autofit_worksheet_columns"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_autofit_worksheet_columns"
  end
  # verify the required parameter 'first_column' is set
  if @api_client.config.client_side_validation && first_column.nil?
    fail ArgumentError, "Missing the required parameter 'first_column' when calling CellsApi.cells_worksheets_post_autofit_worksheet_columns"
  end
  # verify the required parameter 'last_column' is set
  if @api_client.config.client_side_validation && last_column.nil?
    fail ArgumentError, "Missing the required parameter 'last_column' when calling CellsApi.cells_worksheets_post_autofit_worksheet_columns"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autofitcolumns".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'firstColumn'] = first_column
  query_params[:'lastColumn'] = last_column
  query_params[:'firstRow'] = opts[:'first_row'] if !opts[:'first_row'].nil?
  query_params[:'lastRow'] = opts[:'last_row'] if !opts[:'last_row'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'auto_fitter_options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_autofit_worksheet_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_autofit_worksheet_row(name, sheet_name, row_index, first_column, last_column, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • row_index
  • first_column
  • last_column
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



17581
17582
17583
17584
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17581

def cells_worksheets_post_autofit_worksheet_row(name, sheet_name, row_index, first_column, last_column, opts = {})
  data, _status_code, _headers = cells_worksheets_post_autofit_worksheet_row_with_http_info(name, sheet_name, row_index, first_column, last_column, opts)
  return data
end

#cells_worksheets_post_autofit_worksheet_row_with_http_info(name, sheet_name, row_index, first_column, last_column, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • row_index
  • first_column
  • last_column
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17598

def cells_worksheets_post_autofit_worksheet_row_with_http_info(name, sheet_name, row_index, first_column, last_column, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_autofit_worksheet_row ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_autofit_worksheet_row"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_autofit_worksheet_row"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling CellsApi.cells_worksheets_post_autofit_worksheet_row"
  end
  # verify the required parameter 'first_column' is set
  if @api_client.config.client_side_validation && first_column.nil?
    fail ArgumentError, "Missing the required parameter 'first_column' when calling CellsApi.cells_worksheets_post_autofit_worksheet_row"
  end
  # verify the required parameter 'last_column' is set
  if @api_client.config.client_side_validation && last_column.nil?
    fail ArgumentError, "Missing the required parameter 'last_column' when calling CellsApi.cells_worksheets_post_autofit_worksheet_row"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autofitrow".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'rowIndex'] = row_index
  query_params[:'firstColumn'] = first_column
  query_params[:'lastColumn'] = last_column
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'auto_fitter_options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_autofit_worksheet_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_autofit_worksheet_rows(name, sheet_name, opts = {}) ⇒ CellsCloudResponse

Autofit worksheet rows.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions) —

    Auto Fitter Options.

  • :start_row (Integer) —

    Start row.

  • :end_row (Integer) —

    End row.

  • :only_auto (BOOLEAN) —

    Only auto. (default to false)

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



17673
17674
17675
17676
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17673

def cells_worksheets_post_autofit_worksheet_rows(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_post_autofit_worksheet_rows_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_post_autofit_worksheet_rows_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Autofit worksheet rows.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :auto_fitter_options (AutoFitterOptions) —

    Auto Fitter Options.

  • :start_row (Integer) —

    Start row.

  • :end_row (Integer) —

    End row.

  • :only_auto (BOOLEAN) —

    Only auto.

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17690

def cells_worksheets_post_autofit_worksheet_rows_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_autofit_worksheet_rows ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_autofit_worksheet_rows"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_autofit_worksheet_rows"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/autofitrows".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startRow'] = opts[:'start_row'] if !opts[:'start_row'].nil?
  query_params[:'endRow'] = opts[:'end_row'] if !opts[:'end_row'].nil?
  query_params[:'onlyAuto'] = opts[:'only_auto'] if !opts[:'only_auto'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'auto_fitter_options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_autofit_worksheet_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_copy_worksheet(name, sheet_name, source_sheet, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • source_sheet
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :options (CopyOptions)
  • :source_workbook (String)
  • :source_folder (String)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



17753
17754
17755
17756
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17753

def cells_worksheets_post_copy_worksheet(name, sheet_name, source_sheet, opts = {})
  data, _status_code, _headers = cells_worksheets_post_copy_worksheet_with_http_info(name, sheet_name, source_sheet, opts)
  return data
end

#cells_worksheets_post_copy_worksheet_with_http_info(name, sheet_name, source_sheet, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • source_sheet
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :options (CopyOptions)
  • :source_workbook (String)
  • :source_folder (String)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17770

def cells_worksheets_post_copy_worksheet_with_http_info(name, sheet_name, source_sheet, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_copy_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_copy_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_copy_worksheet"
  end
  # verify the required parameter 'source_sheet' is set
  if @api_client.config.client_side_validation && source_sheet.nil?
    fail ArgumentError, "Missing the required parameter 'source_sheet' when calling CellsApi.cells_worksheets_post_copy_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/copy".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'sourceSheet'] = source_sheet
  query_params[:'sourceWorkbook'] = opts[:'source_workbook'] if !opts[:'source_workbook'].nil?
  query_params[:'sourceFolder'] = opts[:'source_folder'] if !opts[:'source_folder'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'options'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_copy_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_move_worksheet(name, sheet_name, opts = {}) ⇒ WorksheetsResponse

Move worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :moving (WorksheetMovingRequest) —

    with moving parameters.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



17834
17835
17836
17837
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17834

def cells_worksheets_post_move_worksheet(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_post_move_worksheet_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_post_move_worksheet_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(WorksheetsResponse, Fixnum, Hash)>

Move worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :moving (WorksheetMovingRequest) —

    with moving parameters.

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetsResponse data, response status code and response headers



17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17848

def cells_worksheets_post_move_worksheet_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_move_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_move_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_move_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/position".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'moving'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorksheetsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_move_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_rename_worksheet(name, sheet_name, newname, opts = {}) ⇒ CellsCloudResponse

Rename worksheet

Parameters:

  • name
  • sheet_name
  • newname
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



17905
17906
17907
17908
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17905

def cells_worksheets_post_rename_worksheet(name, sheet_name, newname, opts = {})
  data, _status_code, _headers = cells_worksheets_post_rename_worksheet_with_http_info(name, sheet_name, newname, opts)
  return data
end

#cells_worksheets_post_rename_worksheet_with_http_info(name, sheet_name, newname, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Rename worksheet

Parameters:

  • name
  • sheet_name
  • newname
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17919

def cells_worksheets_post_rename_worksheet_with_http_info(name, sheet_name, newname, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_rename_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_rename_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_rename_worksheet"
  end
  # verify the required parameter 'newname' is set
  if @api_client.config.client_side_validation && newname.nil?
    fail ArgumentError, "Missing the required parameter 'newname' when calling CellsApi.cells_worksheets_post_rename_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/rename".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'newname'] = newname
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_rename_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_update_worksheet_property(name, sheet_name, opts = {}) ⇒ WorksheetResponse

Update worksheet property

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sheet (Worksheet)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



17981
17982
17983
17984
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17981

def cells_worksheets_post_update_worksheet_property(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_post_update_worksheet_property_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_post_update_worksheet_property_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(WorksheetResponse, Fixnum, Hash)>

Update worksheet property

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sheet (Worksheet)
  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetResponse data, response status code and response headers



17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 17995

def cells_worksheets_post_update_worksheet_property_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_update_worksheet_property ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_update_worksheet_property"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_update_worksheet_property"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'sheet'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorksheetResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_update_worksheet_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_update_worksheet_zoom(name, sheet_name, value, opts = {}) ⇒ CellsCloudResponse

Parameters:

  • name
  • sheet_name
  • value
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



18052
18053
18054
18055
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18052

def cells_worksheets_post_update_worksheet_zoom(name, sheet_name, value, opts = {})
  data, _status_code, _headers = cells_worksheets_post_update_worksheet_zoom_with_http_info(name, sheet_name, value, opts)
  return data
end

#cells_worksheets_post_update_worksheet_zoom_with_http_info(name, sheet_name, value, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Returns CellsCloudResponse data, response status code and response headers.

Parameters:

  • name
  • sheet_name
  • value
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18066

def cells_worksheets_post_update_worksheet_zoom_with_http_info(name, sheet_name, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_update_worksheet_zoom ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_update_worksheet_zoom"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_update_worksheet_zoom"
  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 CellsApi.cells_worksheets_post_update_worksheet_zoom"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/zoom".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'value'] = value
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_update_worksheet_zoom\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_worksheet_comment(name, sheet_name, cell_name, opts = {}) ⇒ CellsCloudResponse

Update worksheet’s cell comment.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :comment (Comment) —

    Comment object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



18129
18130
18131
18132
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18129

def cells_worksheets_post_worksheet_comment(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_worksheets_post_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_worksheets_post_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Update worksheet&#39;s cell comment.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :comment (Comment) —

    Comment object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18144

def cells_worksheets_post_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_worksheet_comment ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_worksheet_comment"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_worksheet_comment"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_worksheets_post_worksheet_comment"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/comments/{cellName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'comment'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_worksheet_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_worksheet_range_sort(name, sheet_name, cell_area, opts = {}) ⇒ CellsCloudResponse

Sort worksheet range.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • cell_area —

    The range to sort.

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

    the optional parameters

Options Hash (opts):

  • :data_sorter (DataSorter) —

    with sorting settings.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:



18206
18207
18208
18209
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18206

def cells_worksheets_post_worksheet_range_sort(name, sheet_name, cell_area, opts = {})
  data, _status_code, _headers = cells_worksheets_post_worksheet_range_sort_with_http_info(name, sheet_name, cell_area, opts)
  return data
end

#cells_worksheets_post_worksheet_range_sort_with_http_info(name, sheet_name, cell_area, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Sort worksheet range.

Parameters:

  • name —

    The workbook name.

  • sheet_name —

    The worksheet name.

  • cell_area —

    The range to sort.

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

    the optional parameters

Options Hash (opts):

  • :data_sorter (DataSorter) —

    with sorting settings.

  • :folder (String) —

    The workbook folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18221

def cells_worksheets_post_worksheet_range_sort_with_http_info(name, sheet_name, cell_area, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_worksheet_range_sort ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_worksheet_range_sort"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_worksheet_range_sort"
  end
  # verify the required parameter 'cell_area' is set
  if @api_client.config.client_side_validation && cell_area.nil?
    fail ArgumentError, "Missing the required parameter 'cell_area' when calling CellsApi.cells_worksheets_post_worksheet_range_sort"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/sort".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'cellArea'] = cell_area
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data_sorter'])
  #auth_names = []
  auth_names = ['JWT']
  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 => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_worksheet_range_sort\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_worksheet_text_search(name, sheet_name, text, opts = {}) ⇒ TextItemsResponse

Search text.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • text —

    Text to search.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



18283
18284
18285
18286
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18283

def cells_worksheets_post_worksheet_text_search(name, sheet_name, text, opts = {})
  data, _status_code, _headers = cells_worksheets_post_worksheet_text_search_with_http_info(name, sheet_name, text, opts)
  return data
end

#cells_worksheets_post_worksheet_text_search_with_http_info(name, sheet_name, text, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Search text.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

  • text —

    Text to search.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    TextItemsResponse data, response status code and response headers



18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18297

def cells_worksheets_post_worksheet_text_search_with_http_info(name, sheet_name, text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_worksheet_text_search ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_worksheet_text_search"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_worksheet_text_search"
  end
  # verify the required parameter 'text' is set
  if @api_client.config.client_side_validation && text.nil?
    fail ArgumentError, "Missing the required parameter 'text' when calling CellsApi.cells_worksheets_post_worksheet_text_search"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/findText".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'text'] = text
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_worksheet_text_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_post_worsheet_text_replace(name, sheet_name, old_value, new_value, opts = {}) ⇒ WorksheetReplaceResponse

Replace text.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • old_value —

    The old text to replace.

  • new_value —

    The new text to replace by.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:



18360
18361
18362
18363
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18360

def cells_worksheets_post_worsheet_text_replace(name, sheet_name, old_value, new_value, opts = {})
  data, _status_code, _headers = cells_worksheets_post_worsheet_text_replace_with_http_info(name, sheet_name, old_value, new_value, opts)
  return data
end

#cells_worksheets_post_worsheet_text_replace_with_http_info(name, sheet_name, old_value, new_value, opts = {}) ⇒ Array<(WorksheetReplaceResponse, Fixnum, Hash)>

Replace text.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • old_value —

    The old text to replace.

  • new_value —

    The new text to replace by.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document&#39;s folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetReplaceResponse data, response status code and response headers



18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18375

def cells_worksheets_post_worsheet_text_replace_with_http_info(name, sheet_name, old_value, new_value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_post_worsheet_text_replace ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_post_worsheet_text_replace"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_post_worsheet_text_replace"
  end
  # verify the required parameter 'old_value' is set
  if @api_client.config.client_side_validation && old_value.nil?
    fail ArgumentError, "Missing the required parameter 'old_value' when calling CellsApi.cells_worksheets_post_worsheet_text_replace"
  end
  # verify the required parameter 'new_value' is set
  if @api_client.config.client_side_validation && new_value.nil?
    fail ArgumentError, "Missing the required parameter 'new_value' when calling CellsApi.cells_worksheets_post_worsheet_text_replace"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/replaceText".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'oldValue'] = old_value
  query_params[:'newValue'] = new_value
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'WorksheetReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_post_worsheet_text_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_put_add_new_worksheet(name, sheet_name, opts = {}) ⇒ WorksheetsResponse

Add new worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The new sheet name.

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

    the optional parameters

Options Hash (opts):

  • :position (Integer) —

    The new sheet position.

  • :sheettype (String) —

    The new sheet type.

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



18443
18444
18445
18446
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18443

def cells_worksheets_put_add_new_worksheet(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_put_add_new_worksheet_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_put_add_new_worksheet_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(WorksheetsResponse, Fixnum, Hash)>

Add new worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The new sheet name.

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

    the optional parameters

Options Hash (opts):

  • :position (Integer) —

    The new sheet position.

  • :sheettype (String) —

    The new sheet type.

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetsResponse data, response status code and response headers



18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18458

def cells_worksheets_put_add_new_worksheet_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_put_add_new_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_put_add_new_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_put_add_new_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'position'] = opts[:'position'] if !opts[:'position'].nil?
  query_params[:'sheettype'] = opts[:'sheettype'] if !opts[:'sheettype'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorksheetsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_put_add_new_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_put_change_visibility_worksheet(name, sheet_name, is_visible, opts = {}) ⇒ WorksheetResponse

Change worksheet visibility.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • is_visible —

    New worksheet visibility value.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



18517
18518
18519
18520
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18517

def cells_worksheets_put_change_visibility_worksheet(name, sheet_name, is_visible, opts = {})
  data, _status_code, _headers = cells_worksheets_put_change_visibility_worksheet_with_http_info(name, sheet_name, is_visible, opts)
  return data
end

#cells_worksheets_put_change_visibility_worksheet_with_http_info(name, sheet_name, is_visible, opts = {}) ⇒ Array<(WorksheetResponse, Fixnum, Hash)>

Change worksheet visibility.

Parameters:

  • name —

    Document name.

  • sheet_name —

    Worksheet name.

  • is_visible —

    New worksheet visibility value.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetResponse data, response status code and response headers



18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18531

def cells_worksheets_put_change_visibility_worksheet_with_http_info(name, sheet_name, is_visible, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_put_change_visibility_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_put_change_visibility_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_put_change_visibility_worksheet"
  end
  # verify the required parameter 'is_visible' is set
  if @api_client.config.client_side_validation && is_visible.nil?
    fail ArgumentError, "Missing the required parameter 'is_visible' when calling CellsApi.cells_worksheets_put_change_visibility_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/visible".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'isVisible'] = is_visible
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorksheetResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_put_change_visibility_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_put_protect_worksheet(name, sheet_name, opts = {}) ⇒ WorksheetResponse

Protect worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :protect_parameter (ProtectSheetParameter) —

    with protection settings.

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:



18593
18594
18595
18596
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18593

def cells_worksheets_put_protect_worksheet(name, sheet_name, opts = {})
  data, _status_code, _headers = cells_worksheets_put_protect_worksheet_with_http_info(name, sheet_name, opts)
  return data
end

#cells_worksheets_put_protect_worksheet_with_http_info(name, sheet_name, opts = {}) ⇒ Array<(WorksheetResponse, Fixnum, Hash)>

Protect worksheet.

Parameters:

  • name —

    Document name.

  • sheet_name —

    The worksheet name.

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

    the optional parameters

Options Hash (opts):

  • :protect_parameter (ProtectSheetParameter) —

    with protection settings.

  • :folder (String) —

    Document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    WorksheetResponse data, response status code and response headers



18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18607

def cells_worksheets_put_protect_worksheet_with_http_info(name, sheet_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_put_protect_worksheet ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_put_protect_worksheet"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_put_protect_worksheet"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/protection".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'protect_parameter'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorksheetResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_put_protect_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_put_worksheet_background(name, sheet_name, png, opts = {}) ⇒ CellsCloudResponse

Set worksheet background image.

Parameters:

  • name
  • sheet_name
  • png
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



18664
18665
18666
18667
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18664

def cells_worksheets_put_worksheet_background(name, sheet_name, png, opts = {})
  data, _status_code, _headers = cells_worksheets_put_worksheet_background_with_http_info(name, sheet_name, png, opts)
  return data
end

#cells_worksheets_put_worksheet_background_with_http_info(name, sheet_name, png, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set worksheet background image.

Parameters:

  • name
  • sheet_name
  • png
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18678

def cells_worksheets_put_worksheet_background_with_http_info(name, sheet_name, png, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_put_worksheet_background ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_put_worksheet_background"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_put_worksheet_background"
  end
  # verify the required parameter 'png' is set
  if @api_client.config.client_side_validation && png.nil?
    fail ArgumentError, "Missing the required parameter 'png' when calling CellsApi.cells_worksheets_put_worksheet_background"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/background".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(png)
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_put_worksheet_background\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_put_worksheet_comment(name, sheet_name, cell_name, opts = {}) ⇒ CommentResponse

Add worksheet’s cell comment.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :comment (Comment) —

    Comment object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:



18740
18741
18742
18743
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18740

def cells_worksheets_put_worksheet_comment(name, sheet_name, cell_name, opts = {})
  data, _status_code, _headers = cells_worksheets_put_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts)
  return data
end

#cells_worksheets_put_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {}) ⇒ Array<(CommentResponse, Fixnum, Hash)>

Add worksheet&#39;s cell comment.

Parameters:

  • name —

    The document name.

  • sheet_name —

    The worksheet name.

  • cell_name —

    The cell name

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

    the optional parameters

Options Hash (opts):

  • :comment (Comment) —

    Comment object

  • :folder (String) —

    The document folder.

  • :storage_name (String) —

    storage name.

Returns:

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

    CommentResponse data, response status code and response headers



18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18755

def cells_worksheets_put_worksheet_comment_with_http_info(name, sheet_name, cell_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_put_worksheet_comment ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_put_worksheet_comment"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_put_worksheet_comment"
  end
  # verify the required parameter 'cell_name' is set
  if @api_client.config.client_side_validation && cell_name.nil?
    fail ArgumentError, "Missing the required parameter 'cell_name' when calling CellsApi.cells_worksheets_put_worksheet_comment"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/comments/{cellName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'cellName' + '}', cell_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'comment'])
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CommentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_put_worksheet_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cells_worksheets_put_worksheet_freeze_panes(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {}) ⇒ CellsCloudResponse

Set freeze panes

Parameters:

  • name
  • sheet_name
  • row
  • column
  • freezed_rows
  • freezed_columns
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:



18819
18820
18821
18822
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18819

def cells_worksheets_put_worksheet_freeze_panes(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {})
  data, _status_code, _headers = cells_worksheets_put_worksheet_freeze_panes_with_http_info(name, sheet_name, row, column, freezed_rows, freezed_columns, opts)
  return data
end

#cells_worksheets_put_worksheet_freeze_panes_with_http_info(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {}) ⇒ Array<(CellsCloudResponse, Fixnum, Hash)>

Set freeze panes

Parameters:

  • name
  • sheet_name
  • row
  • column
  • freezed_rows
  • freezed_columns
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String)
  • :storage_name (String) —

    storage name.

Returns:

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

    CellsCloudResponse data, response status code and response headers



18836
18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18836

def cells_worksheets_put_worksheet_freeze_panes_with_http_info(name, sheet_name, row, column, freezed_rows, freezed_columns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.cells_worksheets_put_worksheet_freeze_panes ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.cells_worksheets_put_worksheet_freeze_panes"
  end
  # verify the required parameter 'sheet_name' is set
  if @api_client.config.client_side_validation && sheet_name.nil?
    fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.cells_worksheets_put_worksheet_freeze_panes"
  end
  # verify the required parameter 'row' is set
  if @api_client.config.client_side_validation && row.nil?
    fail ArgumentError, "Missing the required parameter 'row' when calling CellsApi.cells_worksheets_put_worksheet_freeze_panes"
  end
  # verify the required parameter 'column' is set
  if @api_client.config.client_side_validation && column.nil?
    fail ArgumentError, "Missing the required parameter 'column' when calling CellsApi.cells_worksheets_put_worksheet_freeze_panes"
  end
  # verify the required parameter 'freezed_rows' is set
  if @api_client.config.client_side_validation && freezed_rows.nil?
    fail ArgumentError, "Missing the required parameter 'freezed_rows' when calling CellsApi.cells_worksheets_put_worksheet_freeze_panes"
  end
  # verify the required parameter 'freezed_columns' is set
  if @api_client.config.client_side_validation && freezed_columns.nil?
    fail ArgumentError, "Missing the required parameter 'freezed_columns' when calling CellsApi.cells_worksheets_put_worksheet_freeze_panes"
  end
  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/freezepanes".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'row'] = row
  query_params[:'column'] = column
  query_params[:'freezedRows'] = freezed_rows
  query_params[:'freezedColumns'] = freezed_columns
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CellsCloudResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#cells_worksheets_put_worksheet_freeze_panes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_file(src_path, dest_path, opts = {}) ⇒ nil

Copy file

Parameters:

  • src_path —

    Source file path e.g. &#39;/folder/file.ext&#39;

  • dest_path —

    Destination file path

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to copy

Returns:

  • (nil) 


18913
18914
18915
18916
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18913

def copy_file(src_path, dest_path, opts = {})
  copy_file_with_http_info(src_path, dest_path, opts)
  return nil
end

#copy_file_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Copy file

Parameters:

  • src_path —

    Source file path e.g. &#39;/folder/file.ext&#39;

  • dest_path —

    Destination file path

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to copy

Returns:

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

    nil, response status code and response headers



18927
18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18927

def copy_file_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.copy_file ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'src_path' is set
  if @api_client.config.client_side_validation && src_path.nil?
    fail ArgumentError, "Missing the required parameter 'src_path' when calling CellsApi.copy_file"
  end
  # verify the required parameter 'dest_path' is set
  if @api_client.config.client_side_validation && dest_path.nil?
    fail ArgumentError, "Missing the required parameter 'dest_path' when calling CellsApi.copy_file"
  end
  # resource path
  local_var_path = "/cells/storage/file/copy/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'dest_storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'version_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, 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: CellsApi#copy_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_folder(src_path, dest_path, opts = {}) ⇒ nil

Copy folder

Parameters:

  • src_path —

    Source folder path e.g. &#39;/src&#39;

  • dest_path —

    Destination folder path e.g. &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

  • (nil) 


18984
18985
18986
18987
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18984

def copy_folder(src_path, dest_path, opts = {})
  copy_folder_with_http_info(src_path, dest_path, opts)
  return nil
end

#copy_folder_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Copy folder

Parameters:

  • src_path —

    Source folder path e.g. &#39;/src&#39;

  • dest_path —

    Destination folder path e.g. &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

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

    nil, response status code and response headers



18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 18997

def copy_folder_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.copy_folder ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'src_path' is set
  if @api_client.config.client_side_validation && src_path.nil?
    fail ArgumentError, "Missing the required parameter 'src_path' when calling CellsApi.copy_folder"
  end
  # verify the required parameter 'dest_path' is set
  if @api_client.config.client_side_validation && dest_path.nil?
    fail ArgumentError, "Missing the required parameter 'dest_path' when calling CellsApi.copy_folder"
  end
  # resource path
  local_var_path = "/cells/storage/folder/copy/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'dest_storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, 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: CellsApi#copy_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_folder(path, opts = {}) ⇒ nil

Create the folder

Parameters:

  • path —

    Folder path to create e.g. &#39;folder_1/folder_2/&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

  • (nil) 


19051
19052
19053
19054
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19051

def create_folder(path, opts = {})
  create_folder_with_http_info(path, opts)
  return nil
end

#create_folder_with_http_info(path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create the folder

Parameters:

  • path —

    Folder path to create e.g. &#39;folder_1/folder_2/&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    nil, response status code and response headers



19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19062

def create_folder_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.create_folder ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.create_folder"
  end
  # resource path
  local_var_path = "/cells/storage/folder/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, 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: CellsApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_file(path, opts = {}) ⇒ nil

Delete file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to delete

Returns:

  • (nil) 


19111
19112
19113
19114
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19111

def delete_file(path, opts = {})
  delete_file_with_http_info(path, opts)
  return nil
end

#delete_file_with_http_info(path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to delete

Returns:

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

    nil, response status code and response headers



19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19123

def delete_file_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.delete_file ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.delete_file"
  end
  # resource path
  local_var_path = "/cells/storage/file/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'version_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: CellsApi#delete_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_folder(path, opts = {}) ⇒ nil

Delete folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :recursive (BOOLEAN) —

    Enable to delete folders, subfolders and files (default to false)

Returns:

  • (nil) 


19173
19174
19175
19176
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19173

def delete_folder(path, opts = {})
  delete_folder_with_http_info(path, opts)
  return nil
end

#delete_folder_with_http_info(path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :recursive (BOOLEAN) —

    Enable to delete folders, subfolders and files

Returns:

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

    nil, response status code and response headers



19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19185

def delete_folder_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.delete_folder ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.delete_folder"
  end
  # resource path
  local_var_path = "/cells/storage/folder/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'recursive'] = opts[:'recursive'] if !opts[:'recursive'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: CellsApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_file(path, opts = {}) ⇒ File

Download file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to download

Returns:

  • (File) 


19235
19236
19237
19238
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19235

def download_file(path, opts = {})
  data, _status_code, _headers = download_file_with_http_info(path, opts)
  return data
end

#download_file_with_http_info(path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Download file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to download

Returns:

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

    File data, response status code and response headers



19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19247

def download_file_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.download_file ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.download_file"
  end
  # resource path
  local_var_path = "/cells/storage/file/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'version_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#download_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_disc_usage(opts = {}) ⇒ DiscUsage

Get disc usage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



19296
19297
19298
19299
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19296

def get_disc_usage(opts = {})
  data, _status_code, _headers = get_disc_usage_with_http_info(opts)
  return data
end

#get_disc_usage_with_http_info(opts = {}) ⇒ Array<(DiscUsage, Fixnum, Hash)>

Get disc usage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    DiscUsage data, response status code and response headers



19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19306

def get_disc_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.get_disc_usage ..."
  end
  @api_client.request_token_if_needed
  # resource path
  local_var_path = "/cells/storage/disc"

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'DiscUsage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#get_disc_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file_versions(path, opts = {}) ⇒ FileVersions

Get file versions

Parameters:

  • path —

    File path e.g. &#39;/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



19351
19352
19353
19354
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19351

def get_file_versions(path, opts = {})
  data, _status_code, _headers = get_file_versions_with_http_info(path, opts)
  return data
end

#get_file_versions_with_http_info(path, opts = {}) ⇒ Array<(FileVersions, Fixnum, Hash)>

Get file versions

Parameters:

  • path —

    File path e.g. &#39;/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    FileVersions data, response status code and response headers



19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19362

def get_file_versions_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.get_file_versions ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.get_file_versions"
  end
  # resource path
  local_var_path = "/cells/storage/version/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'FileVersions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#get_file_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_files_list(path, opts = {}) ⇒ FilesList

Get all files and folders within a folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



19411
19412
19413
19414
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19411

def get_files_list(path, opts = {})
  data, _status_code, _headers = get_files_list_with_http_info(path, opts)
  return data
end

#get_files_list_with_http_info(path, opts = {}) ⇒ Array<(FilesList, Fixnum, Hash)>

Get all files and folders within a folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    FilesList data, response status code and response headers



19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19422

def get_files_list_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.get_files_list ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.get_files_list"
  end
  # resource path
  local_var_path = "/cells/storage/folder/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'FilesList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#get_files_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_file(src_path, dest_path, opts = {}) ⇒ nil

Move file

Parameters:

  • src_path —

    Source file path e.g. &#39;/src.ext&#39;

  • dest_path —

    Destination file path e.g. &#39;/dest.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to move

Returns:

  • (nil) 


19474
19475
19476
19477
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19474

def move_file(src_path, dest_path, opts = {})
  move_file_with_http_info(src_path, dest_path, opts)
  return nil
end

#move_file_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Move file

Parameters:

  • src_path —

    Source file path e.g. &#39;/src.ext&#39;

  • dest_path —

    Destination file path e.g. &#39;/dest.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to move

Returns:

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

    nil, response status code and response headers



19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19488

def move_file_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.move_file ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'src_path' is set
  if @api_client.config.client_side_validation && src_path.nil?
    fail ArgumentError, "Missing the required parameter 'src_path' when calling CellsApi.move_file"
  end
  # verify the required parameter 'dest_path' is set
  if @api_client.config.client_side_validation && dest_path.nil?
    fail ArgumentError, "Missing the required parameter 'dest_path' when calling CellsApi.move_file"
  end
  # resource path
  local_var_path = "/cells/storage/file/move/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'dest_storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'version_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, 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: CellsApi#move_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_folder(src_path, dest_path, opts = {}) ⇒ nil

Move folder

Parameters:

  • src_path —

    Folder path to move e.g. &#39;/folder&#39;

  • dest_path —

    Destination folder path to move to e.g &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

  • (nil) 


19545
19546
19547
19548
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19545

def move_folder(src_path, dest_path, opts = {})
  move_folder_with_http_info(src_path, dest_path, opts)
  return nil
end

#move_folder_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Move folder

Parameters:

  • src_path —

    Folder path to move e.g. &#39;/folder&#39;

  • dest_path —

    Destination folder path to move to e.g &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

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

    nil, response status code and response headers



19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19558

def move_folder_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.move_folder ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'src_path' is set
  if @api_client.config.client_side_validation && src_path.nil?
    fail ArgumentError, "Missing the required parameter 'src_path' when calling CellsApi.move_folder"
  end
  # verify the required parameter 'dest_path' is set
  if @api_client.config.client_side_validation && dest_path.nil?
    fail ArgumentError, "Missing the required parameter 'dest_path' when calling CellsApi.move_folder"
  end
  # resource path
  local_var_path = "/cells/storage/folder/move/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'dest_storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, 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: CellsApi#move_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#o_auth_post(grant_type, client_id, client_secret, opts = {}) ⇒ AccessTokenResponse

Get Access token

Parameters:

  • grant_type —

    Grant Type

  • client_id —

    App SID

  • client_secret —

    App Key

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

    the optional parameters

Returns:



19613
19614
19615
19616
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19613

def o_auth_post(grant_type, client_id, client_secret, opts = {})
  data, _status_code, _headers = o_auth_post_with_http_info(grant_type, client_id, client_secret, opts)
  return data
end

#o_auth_post_with_http_info(grant_type, client_id, client_secret, opts = {}) ⇒ Array<(AccessTokenResponse, Fixnum, Hash)>

Get Access token

Parameters:

  • grant_type —

    Grant Type

  • client_id —

    App SID

  • client_secret —

    App Key

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

    the optional parameters

Returns:

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

    AccessTokenResponse data, response status code and response headers



19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19625

def o_auth_post_with_http_info(grant_type, client_id, client_secret, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.o_auth_post ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'grant_type' is set
  if @api_client.config.client_side_validation && grant_type.nil?
    fail ArgumentError, "Missing the required parameter 'grant_type' when calling CellsApi.o_auth_post"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling CellsApi.o_auth_post"
  end
  # verify the required parameter 'client_secret' is set
  if @api_client.config.client_side_validation && client_secret.nil?
    fail ArgumentError, "Missing the required parameter 'client_secret' when calling CellsApi.o_auth_post"
  end
  # resource path
  local_var_path = "/connect/token"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["grant_type"] = grant_type
  form_params["client_id"] = client_id
  form_params["client_secret"] = client_secret

  # http body (model)
  post_body = nil
  post_body = nil
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'AccessTokenResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#o_auth_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#object_exists(path, opts = {}) ⇒ ObjectExist

Check if file or folder exists

Parameters:

  • path —

    File or folder path e.g. &#39;/file.ext&#39; or &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID

Returns:



19687
19688
19689
19690
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19687

def object_exists(path, opts = {})
  data, _status_code, _headers = object_exists_with_http_info(path, opts)
  return data
end

#object_exists_with_http_info(path, opts = {}) ⇒ Array<(ObjectExist, Fixnum, Hash)>

Check if file or folder exists

Parameters:

  • path —

    File or folder path e.g. &#39;/file.ext&#39; or &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID

Returns:

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

    ObjectExist data, response status code and response headers



19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19699

def object_exists_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.object_exists ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.object_exists"
  end
  # resource path
  local_var_path = "/cells/storage/exist/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'version_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'ObjectExist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#object_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#storage_exists(storage_name, opts = {}) ⇒ StorageExist

Check if storage exists

Parameters:

  • storage_name —

    Storage name

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

    the optional parameters

Returns:



19748
19749
19750
19751
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19748

def storage_exists(storage_name, opts = {})
  data, _status_code, _headers = storage_exists_with_http_info(storage_name, opts)
  return data
end

#storage_exists_with_http_info(storage_name, opts = {}) ⇒ Array<(StorageExist, Fixnum, Hash)>

Check if storage exists

Parameters:

  • storage_name —

    Storage name

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

    the optional parameters

Returns:

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

    StorageExist data, response status code and response headers



19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19758

def storage_exists_with_http_info(storage_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.storage_exists ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'storage_name' is set
  if @api_client.config.client_side_validation && storage_name.nil?
    fail ArgumentError, "Missing the required parameter 'storage_name' when calling CellsApi.storage_exists"
  end
  # resource path
  local_var_path = "/cells/storage/{storageName}/exist".sub('{' + 'storageName' + '}', storage_name.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  #auth_names = []
  auth_names = ['JWT']
  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 => 'StorageExist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#storage_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_file(path, file, opts = {}) ⇒ FilesUploadResult

Upload file

Parameters:

  • path —

    Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.

  • file —

    File to upload

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



19807
19808
19809
19810
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19807

def upload_file(path, file, opts = {})
  data, _status_code, _headers = upload_file_with_http_info(path, file, opts)
  return data
end

#upload_file_with_http_info(path, file, opts = {}) ⇒ Array<(FilesUploadResult, Fixnum, Hash)>

Upload file

Parameters:

  • path —

    Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.

  • file —

    File to upload

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    FilesUploadResult data, response status code and response headers



19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
 
# File 'lib/aspose_cells_cloud/api/cells_api.rb', line 19819

def upload_file_with_http_info(path, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CellsApi.upload_file ..."
  end
  @api_client.request_token_if_needed
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling CellsApi.upload_file"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling CellsApi.upload_file"
  end
  # resource path
  local_var_path = "/cells/storage/file/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  post_body =file
  #auth_names = []
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FilesUploadResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CellsApi#upload_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end