Class: WordsRubySdk::WordsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/api/words_api.rb

Overview

Aspose.Words for Cloud API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WordsApi

Returns a new instance of WordsApi.



35
36
37
38
39
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 35

def initialize(api_client = ApiClient.default)
  @api_client = api_client
  require_all '../models/requests'
  request_token
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#accept_all_revisions(request) ⇒ RevisionsModificationResponse

Accept all revisions in document

Parameters:

  • request —

    AcceptAllRevisionsRequest

Returns:



45
46
47
48
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 45

def accept_all_revisions(request)
  data, _status_code, _headers = accept_all_revisions_with_http_info(request)
  data
end

#classify(request) ⇒ ClassificationResponse

Classify raw text.

Parameters:

  • request —

    ClassifyRequest

Returns:



124
125
126
127
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 124

def classify(request)
  data, _status_code, _headers = classify_with_http_info(request)
  data
end

#classify_document(request) ⇒ ClassificationResponse

Classify document.

Parameters:

  • request —

    ClassifyDocumentRequest

Returns:



182
183
184
185
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 182

def classify_document(request)
  data, _status_code, _headers = classify_document_with_http_info(request)
  data
end

#create_or_update_document_property(request) ⇒ DocumentPropertyResponse

Add new or update existing document property.

Parameters:

  • request —

    CreateOrUpdateDocumentPropertyRequest

Returns:



261
262
263
264
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 261

def create_or_update_document_property(request)
  data, _status_code, _headers = create_or_update_document_property_with_http_info(request)
  data
end

#delete_border(request) ⇒ BorderResponse

Resets border properties to default values.

‘nodePath’ should refer to node with cell or row

Parameters:

  • request —

    DeleteBorderRequest

Returns:



355
356
357
358
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 355

def delete_border(request)
  data, _status_code, _headers = delete_border_with_http_info(request)
  data
end

#delete_borders(request) ⇒ BordersResponse

Resets borders properties to default values.

‘nodePath’ should refer to node with cell or row

Parameters:

  • request —

    DeleteBordersRequest

Returns:



450
451
452
453
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 450

def delete_borders(request)
  data, _status_code, _headers = delete_borders_with_http_info(request)
  data
end

#delete_comment(request) ⇒ AsposeResponse

Remove comment from document.

Parameters:

  • request —

    DeleteCommentRequest

Returns:



542
543
544
545
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 542

def delete_comment(request)
  data, _status_code, _headers = delete_comment_with_http_info(request)
  data
end

#delete_document_macros(request) ⇒ AsposeResponse

Remove macros from document.

Parameters:

  • request —

    DeleteDocumentMacrosRequest

Returns:



634
635
636
637
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 634

def delete_document_macros(request)
  data, _status_code, _headers = delete_document_macros_with_http_info(request)
  data
end

#delete_document_property(request) ⇒ AsposeResponse

Delete document property.

Parameters:

  • request —

    DeleteDocumentPropertyRequest

Returns:



723
724
725
726
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 723

def delete_document_property(request)
  data, _status_code, _headers = delete_document_property_with_http_info(request)
  data
end

#delete_document_watermark(request) ⇒ DocumentResponse

Delete watermark (for deleting last watermark from the document).

Parameters:

  • request —

    DeleteDocumentWatermarkRequest

Returns:



815
816
817
818
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 815

def delete_document_watermark(request)
  data, _status_code, _headers = delete_document_watermark_with_http_info(request)
  data
end

#delete_drawing_object(request) ⇒ AsposeResponse

Removes drawing object from document.

Parameters:

  • request —

    DeleteDrawingObjectRequest

Returns:



904
905
906
907
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 904

def delete_drawing_object(request)
  data, _status_code, _headers = delete_drawing_object_with_http_info(request)
  data
end

#delete_field(request) ⇒ AsposeResponse

Delete field from document.

Parameters:

  • request —

    DeleteFieldRequest

Returns:



1001
1002
1003
1004
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1001

def delete_field(request)
  data, _status_code, _headers = delete_field_with_http_info(request)
  data
end

#delete_fields(request) ⇒ AsposeResponse

Remove fields from section paragraph.

Parameters:

  • request —

    DeleteFieldsRequest

Returns:



1098
1099
1100
1101
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1098

def delete_fields(request)
  data, _status_code, _headers = delete_fields_with_http_info(request)
  data
end

#delete_footnote(request) ⇒ AsposeResponse

Removes footnote from document.

Parameters:

  • request —

    DeleteFootnoteRequest

Returns:



1192
1193
1194
1195
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1192

def delete_footnote(request)
  data, _status_code, _headers = delete_footnote_with_http_info(request)
  data
end

#delete_form_field(request) ⇒ AsposeResponse

Removes form field from document.

Parameters:

  • request —

    DeleteFormFieldRequest

Returns:



1289
1290
1291
1292
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1289

def delete_form_field(request)
  data, _status_code, _headers = delete_form_field_with_http_info(request)
  data
end

#delete_header_footer(request) ⇒ AsposeResponse

Delete header/footer from document.

Parameters:

  • request —

    DeleteHeaderFooterRequest

Returns:



1386
1387
1388
1389
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1386

def delete_header_footer(request)
  data, _status_code, _headers = delete_header_footer_with_http_info(request)
  data
end

#delete_headers_footers(request) ⇒ AsposeResponse

Delete document headers and footers.

Parameters:

  • request —

    DeleteHeadersFootersRequest

Returns:



1483
1484
1485
1486
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1483

def delete_headers_footers(request)
  data, _status_code, _headers = delete_headers_footers_with_http_info(request)
  data
end

#delete_office_math_object(request) ⇒ AsposeResponse

Removes OfficeMath object from document.

Parameters:

  • request —

    DeleteOfficeMathObjectRequest

Returns:



1582
1583
1584
1585
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1582

def delete_office_math_object(request)
  data, _status_code, _headers = delete_office_math_object_with_http_info(request)
  data
end

#delete_paragraph(request) ⇒ AsposeResponse

Remove paragraph from section.

Parameters:

  • request —

    DeleteParagraphRequest

Returns:



1679
1680
1681
1682
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1679

def delete_paragraph(request)
  data, _status_code, _headers = delete_paragraph_with_http_info(request)
  data
end

#delete_run(request) ⇒ AsposeResponse

Removes run from document.

Parameters:

  • request —

    DeleteRunRequest

Returns:



1776
1777
1778
1779
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1776

def delete_run(request)
  data, _status_code, _headers = delete_run_with_http_info(request)
  data
end

#delete_table(request) ⇒ AsposeResponse

Delete a table.

Parameters:

  • request —

    DeleteTableRequest

Returns:



1871
1872
1873
1874
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1871

def delete_table(request)
  data, _status_code, _headers = delete_table_with_http_info(request)
  data
end

#delete_table_cell(request) ⇒ AsposeResponse

Delete a table cell.

Parameters:

  • request —

    DeleteTableCellRequest

Returns:



1968
1969
1970
1971
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 1968

def delete_table_cell(request)
  data, _status_code, _headers = delete_table_cell_with_http_info(request)
  data
end

#delete_table_row(request) ⇒ AsposeResponse

Delete a table row.

Parameters:

  • request —

    DeleteTableRowRequest

Returns:



2063
2064
2065
2066
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2063

def delete_table_row(request)
  data, _status_code, _headers = delete_table_row_with_http_info(request)
  data
end

#delete_unprotect_document(request) ⇒ ProtectionDataResponse

Unprotect document.

Parameters:

  • request —

    DeleteUnprotectDocumentRequest

Returns:



2158
2159
2160
2161
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2158

def delete_unprotect_document(request)
  data, _status_code, _headers = delete_unprotect_document_with_http_info(request)
  data
end

#get_border(request) ⇒ BorderResponse

Return a border. ‘nodePath’ should refer to node with cell or row

Parameters:

  • request —

    GetBorderRequest

Returns:



2239
2240
2241
2242
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2239

def get_border(request)
  data, _status_code, _headers = get_border_with_http_info(request)
  data
end

#get_borders(request) ⇒ BordersResponse

Return a collection of borders. ‘nodePath’ should refer to node with cell or row

Parameters:

  • request —

    GetBordersRequest

Returns:



2319
2320
2321
2322
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2319

def get_borders(request)
  data, _status_code, _headers = get_borders_with_http_info(request)
  data
end

#get_comment(request) ⇒ CommentResponse

Get comment from document.

Parameters:

  • request —

    GetCommentRequest

Returns:



2396
2397
2398
2399
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2396

def get_comment(request)
  data, _status_code, _headers = get_comment_with_http_info(request)
  data
end

#get_comments(request) ⇒ CommentsResponse

Get comments from document.

Parameters:

  • request —

    GetCommentsRequest

Returns:



2473
2474
2475
2476
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2473

def get_comments(request)
  data, _status_code, _headers = get_comments_with_http_info(request)
  data
end

#get_document(request) ⇒ DocumentResponse

Read document common info.

Parameters:

  • request —

    GetDocumentRequest

Returns:



2547
2548
2549
2550
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2547

def get_document(request)
  data, _status_code, _headers = get_document_with_http_info(request)
  data
end

#get_document_bookmark_by_name(request) ⇒ BookmarkResponse

Read document bookmark data by its name.

Parameters:

  • request —

    GetDocumentBookmarkByNameRequest

Returns:



2621
2622
2623
2624
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2621

def get_document_bookmark_by_name(request)
  data, _status_code, _headers = get_document_bookmark_by_name_with_http_info(request)
  data
end

#get_document_bookmarks(request) ⇒ BookmarksResponse

Read document bookmarks common info.

Parameters:

  • request —

    GetDocumentBookmarksRequest

Returns:



2698
2699
2700
2701
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2698

def get_document_bookmarks(request)
  data, _status_code, _headers = get_document_bookmarks_with_http_info(request)
  data
end

#get_document_drawing_object_by_index(request) ⇒ DrawingObjectResponse

Read document drawing object common info by its index or convert to format specified.

Parameters:

  • request —

    GetDocumentDrawingObjectByIndexRequest

Returns:



2772
2773
2774
2775
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2772

def get_document_drawing_object_by_index(request)
  data, _status_code, _headers = get_document_drawing_object_by_index_with_http_info(request)
  data
end

#get_document_drawing_object_image_data(request) ⇒ File

Read drawing object image data.

Parameters:

  • request —

    GetDocumentDrawingObjectImageDataRequest

Returns:

  • (File) 


2854
2855
2856
2857
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2854

def get_document_drawing_object_image_data(request)
  data, _status_code, _headers = get_document_drawing_object_image_data_with_http_info(request)
  data
end

#get_document_drawing_object_ole_data(request) ⇒ File

Get drawing object OLE data.

Parameters:

  • request —

    GetDocumentDrawingObjectOleDataRequest

Returns:

  • (File) 


2936
2937
2938
2939
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 2936

def get_document_drawing_object_ole_data(request)
  data, _status_code, _headers = get_document_drawing_object_ole_data_with_http_info(request)
  data
end

#get_document_drawing_objects(request) ⇒ DrawingObjectsResponse

Read document drawing objects common info.

Parameters:

  • request —

    GetDocumentDrawingObjectsRequest

Returns:



3018
3019
3020
3021
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3018

def get_document_drawing_objects(request)
  data, _status_code, _headers = get_document_drawing_objects_with_http_info(request)
  data
end

#get_document_field_names(request) ⇒ FieldNamesResponse

Read document field names.

Parameters:

  • request —

    GetDocumentFieldNamesRequest

Returns:



3097
3098
3099
3100
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3097

def get_document_field_names(request)
  data, _status_code, _headers = get_document_field_names_with_http_info(request)
  data
end

#get_document_hyperlink_by_index(request) ⇒ HyperlinkResponse

Read document hyperlink by its index.

Parameters:

  • request —

    GetDocumentHyperlinkByIndexRequest

Returns:



3176
3177
3178
3179
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3176

def get_document_hyperlink_by_index(request)
  data, _status_code, _headers = get_document_hyperlink_by_index_with_http_info(request)
  data
end

#get_document_hyperlinks(request) ⇒ HyperlinksResponse

Read document hyperlinks common info.

Parameters:

  • request —

    GetDocumentHyperlinksRequest

Returns:



3253
3254
3255
3256
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3253

def get_document_hyperlinks(request)
  data, _status_code, _headers = get_document_hyperlinks_with_http_info(request)
  data
end

#get_document_paragraph(request) ⇒ ParagraphResponse

This resource represents one of the paragraphs contained in the document.

Parameters:

  • request —

    GetDocumentParagraphRequest

Returns:



3327
3328
3329
3330
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3327

def get_document_paragraph(request)
  data, _status_code, _headers = get_document_paragraph_with_http_info(request)
  data
end

#get_document_paragraph_run(request) ⇒ RunResponse

This resource represents run of text contained in the document.

Parameters:

  • request —

    GetDocumentParagraphRunRequest

Returns:



3409
3410
3411
3412
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3409

def get_document_paragraph_run(request)
  data, _status_code, _headers = get_document_paragraph_run_with_http_info(request)
  data
end

#get_document_paragraph_run_font(request) ⇒ FontResponse

This resource represents font of run.

Parameters:

  • request —

    GetDocumentParagraphRunFontRequest

Returns:



3489
3490
3491
3492
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3489

def get_document_paragraph_run_font(request)
  data, _status_code, _headers = get_document_paragraph_run_font_with_http_info(request)
  data
end

#get_document_paragraph_runs(request) ⇒ RunsResponse

This resource represents collection of runs in the paragraph.

Parameters:

  • request —

    GetDocumentParagraphRunsRequest

Returns:



3569
3570
3571
3572
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3569

def get_document_paragraph_runs(request)
  data, _status_code, _headers = get_document_paragraph_runs_with_http_info(request)
  data
end

#get_document_paragraphs(request) ⇒ ParagraphLinkCollectionResponse

Return a list of paragraphs that are contained in the document.

Parameters:

  • request —

    GetDocumentParagraphsRequest

Returns:



3646
3647
3648
3649
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3646

def get_document_paragraphs(request)
  data, _status_code, _headers = get_document_paragraphs_with_http_info(request)
  data
end

#get_document_properties(request) ⇒ DocumentPropertiesResponse

Read document properties info.

Parameters:

  • request —

    GetDocumentPropertiesRequest

Returns:



3725
3726
3727
3728
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3725

def get_document_properties(request)
  data, _status_code, _headers = get_document_properties_with_http_info(request)
  data
end

#get_document_property(request) ⇒ DocumentPropertyResponse

Read document property info by the property name.

Parameters:

  • request —

    GetDocumentPropertyRequest

Returns:



3799
3800
3801
3802
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3799

def get_document_property(request)
  data, _status_code, _headers = get_document_property_with_http_info(request)
  data
end

#get_document_protection(request) ⇒ ProtectionDataResponse

Read document protection common info.

Parameters:

  • request —

    GetDocumentProtectionRequest

Returns:



3876
3877
3878
3879
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3876

def get_document_protection(request)
  data, _status_code, _headers = get_document_protection_with_http_info(request)
  data
end

#get_document_statistics(request) ⇒ StatDataResponse

Read document statistics.

Parameters:

  • request —

    GetDocumentStatisticsRequest

Returns:



3950
3951
3952
3953
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 3950

def get_document_statistics(request)
  data, _status_code, _headers = get_document_statistics_with_http_info(request)
  data
end

#get_document_text_items(request) ⇒ TextItemsResponse

Read document text items.

Parameters:

  • request —

    GetDocumentTextItemsRequest

Returns:



4039
4040
4041
4042
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4039

def get_document_text_items(request)
  data, _status_code, _headers = get_document_text_items_with_http_info(request)
  data
end

#get_document_with_format(request) ⇒ File

Export the document into the specified format.

Parameters:

  • request —

    GetDocumentWithFormatRequest

Returns:

  • (File) 


4113
4114
4115
4116
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4113

def get_document_with_format(request)
  data, _status_code, _headers = get_document_with_format_with_http_info(request)
  data
end

#get_field(request) ⇒ FieldResponse

Get field from document.

Parameters:

  • request —

    GetFieldRequest

Returns:



4201
4202
4203
4204
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4201

def get_field(request)
  data, _status_code, _headers = get_field_with_http_info(request)
  data
end

#get_fields(request) ⇒ FieldsResponse

Get fields from document.

Parameters:

  • request —

    GetFieldsRequest

Returns:



4283
4284
4285
4286
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4283

def get_fields(request)
  data, _status_code, _headers = get_fields_with_http_info(request)
  data
end

#get_footnote(request) ⇒ FootnoteResponse

Read footnote by index.

Parameters:

  • request —

    GetFootnoteRequest

Returns:



4362
4363
4364
4365
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4362

def get_footnote(request)
  data, _status_code, _headers = get_footnote_with_http_info(request)
  data
end

#get_footnotes(request) ⇒ FootnotesResponse

Get footnotes from document.

Parameters:

  • request —

    GetFootnotesRequest

Returns:



4444
4445
4446
4447
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4444

def get_footnotes(request)
  data, _status_code, _headers = get_footnotes_with_http_info(request)
  data
end

#get_form_field(request) ⇒ FormFieldResponse

Returns representation of an one of the form field.

Parameters:

  • request —

    GetFormFieldRequest

Returns:



4523
4524
4525
4526
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4523

def get_form_field(request)
  data, _status_code, _headers = get_form_field_with_http_info(request)
  data
end

#get_form_fields(request) ⇒ FormFieldsResponse

Get form fields from document.

Parameters:

  • request —

    GetFormFieldsRequest

Returns:



4605
4606
4607
4608
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4605

def get_form_fields(request)
  data, _status_code, _headers = get_form_fields_with_http_info(request)
  data
end

#get_header_footer(request) ⇒ HeaderFooterResponse

Return a header/footer that is contained in the document.

Parameters:

  • request —

    GetHeaderFooterRequest

Returns:



4684
4685
4686
4687
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4684

def get_header_footer(request)
  data, _status_code, _headers = get_header_footer_with_http_info(request)
  data
end

#get_header_footer_of_section(request) ⇒ HeaderFooterResponse

Return a header/footer that is contained in the document.

Parameters:

  • request —

    GetHeaderFooterOfSectionRequest

Returns:



4766
4767
4768
4769
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4766

def get_header_footer_of_section(request)
  data, _status_code, _headers = get_header_footer_of_section_with_http_info(request)
  data
end

#get_header_footers(request) ⇒ HeaderFootersResponse

Return a list of header/footers that are contained in the document.

Parameters:

  • request —

    GetHeaderFootersRequest

Returns:



4851
4852
4853
4854
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4851

def get_header_footers(request)
  data, _status_code, _headers = get_header_footers_with_http_info(request)
  data
end

#get_office_math_object(request) ⇒ OfficeMathObjectResponse

Read OfficeMath object by index.

Parameters:

  • request —

    GetOfficeMathObjectRequest

Returns:



4935
4936
4937
4938
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 4935

def get_office_math_object(request)
  data, _status_code, _headers = get_office_math_object_with_http_info(request)
  data
end

#get_office_math_objects(request) ⇒ OfficeMathObjectsResponse

Get OfficeMath objects from document.

Parameters:

  • request —

    GetOfficeMathObjectsRequest

Returns:



5017
5018
5019
5020
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5017

def get_office_math_objects(request)
  data, _status_code, _headers = get_office_math_objects_with_http_info(request)
  data
end

#get_section(request) ⇒ SectionResponse

Get document section by index.

Parameters:

  • request —

    GetSectionRequest

Returns:



5096
5097
5098
5099
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5096

def get_section(request)
  data, _status_code, _headers = get_section_with_http_info(request)
  data
end

#get_section_page_setup(request) ⇒ SectionPageSetupResponse

Get page setup of section.

Parameters:

  • request —

    GetSectionPageSetupRequest

Returns:



5173
5174
5175
5176
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5173

def get_section_page_setup(request)
  data, _status_code, _headers = get_section_page_setup_with_http_info(request)
  data
end

#get_sections(request) ⇒ SectionLinkCollectionResponse

Return a list of sections that are contained in the document.

Parameters:

  • request —

    GetSectionsRequest

Returns:



5250
5251
5252
5253
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5250

def get_sections(request)
  data, _status_code, _headers = get_sections_with_http_info(request)
  data
end

#get_table(request) ⇒ TableResponse

Return a table.

Parameters:

  • request —

    GetTableRequest

Returns:



5324
5325
5326
5327
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5324

def get_table(request)
  data, _status_code, _headers = get_table_with_http_info(request)
  data
end

#get_table_cell(request) ⇒ TableCellResponse

Return a table cell.

Parameters:

  • request —

    GetTableCellRequest

Returns:



5406
5407
5408
5409
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5406

def get_table_cell(request)
  data, _status_code, _headers = get_table_cell_with_http_info(request)
  data
end

#get_table_cell_format(request) ⇒ TableCellFormatResponse

Return a table cell format.

Parameters:

  • request —

    GetTableCellFormatRequest

Returns:



5486
5487
5488
5489
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5486

def get_table_cell_format(request)
  data, _status_code, _headers = get_table_cell_format_with_http_info(request)
  data
end

#get_table_properties(request) ⇒ TablePropertiesResponse

Return a table properties.

Parameters:

  • request —

    GetTablePropertiesRequest

Returns:



5566
5567
5568
5569
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5566

def get_table_properties(request)
  data, _status_code, _headers = get_table_properties_with_http_info(request)
  data
end

#get_table_row(request) ⇒ TableRowResponse

Return a table row.

Parameters:

  • request —

    GetTableRowRequest

Returns:



5648
5649
5650
5651
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5648

def get_table_row(request)
  data, _status_code, _headers = get_table_row_with_http_info(request)
  data
end

#get_table_row_format(request) ⇒ TableRowFormatResponse

Return a table row format.

Parameters:

  • request —

    GetTableRowFormatRequest

Returns:



5728
5729
5730
5731
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5728

def get_table_row_format(request)
  data, _status_code, _headers = get_table_row_format_with_http_info(request)
  data
end

#get_tables(request) ⇒ TableLinkCollectionResponse

Return a list of tables that are contained in the document.

Parameters:

  • request —

    GetTablesRequest

Returns:



5808
5809
5810
5811
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5808

def get_tables(request)
  data, _status_code, _headers = get_tables_with_http_info(request)
  data
end

#insert_table(request) ⇒ TableResponse

Adds table to document, returns added table’s data.

Parameters:

  • request —

    InsertTableRequest

Returns:



5887
5888
5889
5890
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5887

def insert_table(request)
  data, _status_code, _headers = insert_table_with_http_info(request)
  data
end

#insert_table_cell(request) ⇒ TableCellResponse

Adds table cell to table, returns added cell’s data.

Parameters:

  • request —

    InsertTableCellRequest

Returns:



5981
5982
5983
5984
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 5981

def insert_table_cell(request)
  data, _status_code, _headers = insert_table_cell_with_http_info(request)
  data
end

#insert_table_row(request) ⇒ TableRowResponse

Adds table row to table, returns added row’s data.

Parameters:

  • request —

    InsertTableRowRequest

Returns:



6073
6074
6075
6076
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6073

def insert_table_row(request)
  data, _status_code, _headers = insert_table_row_with_http_info(request)
  data
end

#post_append_document(request) ⇒ DocumentResponse

Append documents to original document.

Parameters:

  • request —

    PostAppendDocumentRequest

Returns:



6165
6166
6167
6168
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6165

def post_append_document(request)
  data, _status_code, _headers = post_append_document_with_http_info(request)
  data
end

#post_change_document_protection(request) ⇒ ProtectionDataResponse

Change document protection.

Parameters:

  • request —

    PostChangeDocumentProtectionRequest

Returns:



6256
6257
6258
6259
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6256

def post_change_document_protection(request)
  data, _status_code, _headers = post_change_document_protection_with_http_info(request)
  data
end

#post_comment(request) ⇒ CommentResponse

Updates the comment, returns updated comment’s data.

Parameters:

  • request —

    PostCommentRequest

Returns:



6337
6338
6339
6340
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6337

def post_comment(request)
  data, _status_code, _headers = post_comment_with_http_info(request)
  data
end

#post_compare_document(request) ⇒ DocumentResponse

Compare document with original document.

Parameters:

  • request —

    PostCompareDocumentRequest

Returns:



6431
6432
6433
6434
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6431

def post_compare_document(request)
  data, _status_code, _headers = post_compare_document_with_http_info(request)
  data
end

#post_document_execute_mail_merge(request) ⇒ DocumentResponse

Execute document mail merge operation.

Parameters:

  • request —

    PostDocumentExecuteMailMergeRequest

Returns:



6512
6513
6514
6515
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6512

def post_document_execute_mail_merge(request)
  data, _status_code, _headers = post_document_execute_mail_merge_with_http_info(request)
  data
end

#post_document_paragraph_run_font(request) ⇒ FontResponse

Updates font properties, returns updated font data.

Parameters:

  • request —

    PostDocumentParagraphRunFontRequest

Returns:



6612
6613
6614
6615
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6612

def post_document_paragraph_run_font(request)
  data, _status_code, _headers = post_document_paragraph_run_font_with_http_info(request)
  data
end

#post_document_save_as(request) ⇒ SaveResponse

Convert document to destination format with detailed settings and save result to storage.

Parameters:

  • request —

    PostDocumentSaveAsRequest

Returns:



6709
6710
6711
6712
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6709

def post_document_save_as(request)
  data, _status_code, _headers = post_document_save_as_with_http_info(request)
  data
end

#post_drawing_object(request) ⇒ DrawingObjectResponse

Updates drawing object, returns updated drawing object’s data.

Parameters:

  • request —

    PostDrawingObjectRequest

Returns:



6795
6796
6797
6798
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6795

def post_drawing_object(request)
  data, _status_code, _headers = post_drawing_object_with_http_info(request)
  data
end

#post_execute_template(request) ⇒ DocumentResponse

Populate document template with data.

Parameters:

  • request —

    PostExecuteTemplateRequest

Returns:



6898
6899
6900
6901
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6898

def post_execute_template(request)
  data, _status_code, _headers = post_execute_template_with_http_info(request)
  data
end

#post_field(request) ⇒ FieldResponse

Updates field’s properties, returns updated field’s data.

Parameters:

  • request —

    PostFieldRequest

Returns:



6995
6996
6997
6998
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 6995

def post_field(request)
  data, _status_code, _headers = post_field_with_http_info(request)
  data
end

#post_footnote(request) ⇒ FootnoteResponse

Updates footnote’s properties, returns updated run’s data.

Parameters:

  • request —

    PostFootnoteRequest

Returns:



7094
7095
7096
7097
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7094

def post_footnote(request)
  data, _status_code, _headers = post_footnote_with_http_info(request)
  data
end

#post_form_field(request) ⇒ FormFieldResponse

Updates properties of form field, returns updated form field.

Parameters:

  • request —

    PostFormFieldRequest

Returns:



7193
7194
7195
7196
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7193

def post_form_field(request)
  data, _status_code, _headers = post_form_field_with_http_info(request)
  data
end

#post_insert_document_watermark_image(request) ⇒ DocumentResponse

Insert document watermark image.

Parameters:

  • request —

    PostInsertDocumentWatermarkImageRequest

Returns:



7292
7293
7294
7295
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7292

def post_insert_document_watermark_image(request)
  data, _status_code, _headers = post_insert_document_watermark_image_with_http_info(request)
  data
end

#post_insert_document_watermark_text(request) ⇒ DocumentResponse

Insert document watermark text.

Parameters:

  • request —

    PostInsertDocumentWatermarkTextRequest

Returns:



7392
7393
7394
7395
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7392

def post_insert_document_watermark_text(request)
  data, _status_code, _headers = post_insert_document_watermark_text_with_http_info(request)
  data
end

#post_insert_page_numbers(request) ⇒ DocumentResponse

Insert document page numbers.

Parameters:

  • request —

    PostInsertPageNumbersRequest

Returns:



7483
7484
7485
7486
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7483

def post_insert_page_numbers(request)
  data, _status_code, _headers = post_insert_page_numbers_with_http_info(request)
  data
end

#post_load_web_document(request) ⇒ SaveResponse

Loads new document from web into the file with any supported format of data.

Parameters:

  • request —

    PostLoadWebDocumentRequest

Returns:



7574
7575
7576
7577
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7574

def post_load_web_document(request)
  data, _status_code, _headers = post_load_web_document_with_http_info(request)
  data
end

#post_replace_text(request) ⇒ ReplaceTextResponse

Replace document text.

Parameters:

  • request —

    PostReplaceTextRequest

Returns:



7632
7633
7634
7635
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7632

def post_replace_text(request)
  data, _status_code, _headers = post_replace_text_with_http_info(request)
  data
end

#post_run(request) ⇒ RunResponse

Updates run’s properties, returns updated run’s data.

Parameters:

  • request —

    PostRunRequest

Returns:



7723
7724
7725
7726
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7723

def post_run(request)
  data, _status_code, _headers = post_run_with_http_info(request)
  data
end

#post_split_document(request) ⇒ SplitDocumentResponse

Split document.

Parameters:

  • request —

    PostSplitDocumentRequest

Returns:



7820
7821
7822
7823
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7820

def post_split_document(request)
  data, _status_code, _headers = post_split_document_with_http_info(request)
  data
end

#post_update_document_bookmark(request) ⇒ BookmarkResponse

Update document bookmark.

Parameters:

  • request —

    PostUpdateDocumentBookmarkRequest

Returns:



7924
7925
7926
7927
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 7924

def post_update_document_bookmark(request)
  data, _status_code, _headers = post_update_document_bookmark_with_http_info(request)
  data
end

#post_update_document_fields(request) ⇒ DocumentResponse

Update (reevaluate) fields in document.

Parameters:

  • request —

    PostUpdateDocumentFieldsRequest

Returns:



8018
8019
8020
8021
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8018

def post_update_document_fields(request)
  data, _status_code, _headers = post_update_document_fields_with_http_info(request)
  data
end

#put_comment(request) ⇒ CommentResponse

Adds comment to document, returns inserted comment’s data.

Parameters:

  • request —

    PutCommentRequest

Returns:



8097
8098
8099
8100
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8097

def put_comment(request)
  data, _status_code, _headers = put_comment_with_http_info(request)
  data
end

#put_convert_document(request) ⇒ File

Convert document from request content to format specified.

Parameters:

  • request —

    PutConvertDocumentRequest

Returns:

  • (File) 


8188
8189
8190
8191
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8188

def put_convert_document(request)
  data, _status_code, _headers = put_convert_document_with_http_info(request)
  data
end

#put_create_document(request) ⇒ DocumentResponse

Creates new document. Document is created with format which is recognized from file extensions. Supported extentions: ".doc", ".docx", ".docm", ".dot", ".dotm", ".dotx", ".flatopc", ".fopc", ".flatopc_macro", ".fopc_macro", ".flatopc_template", ".fopc_template", ".flatopc_template_macro", ".fopc_template_macro", ".wordml", ".wml", ".rtf"

Parameters:

  • request —

    PutCreateDocumentRequest

Returns:



8266
8267
8268
8269
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8266

def put_create_document(request)
  data, _status_code, _headers = put_create_document_with_http_info(request)
  data
end

#put_document_field_names(request) ⇒ FieldNamesResponse

Read document field names.

Parameters:

  • request —

    PutDocumentFieldNamesRequest

Returns:



8332
8333
8334
8335
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8332

def put_document_field_names(request)
  data, _status_code, _headers = put_document_field_names_with_http_info(request)
  data
end

#put_document_save_as_tiff(request) ⇒ SaveResponse

Convert document to tiff with detailed settings and save result to storage.

Parameters:

  • request —

    PutDocumentSaveAsTiffRequest

Returns:



8391
8392
8393
8394
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8391

def put_document_save_as_tiff(request)
  data, _status_code, _headers = put_document_save_as_tiff_with_http_info(request)
  data
end

#put_drawing_object(request) ⇒ DrawingObjectResponse

Adds drawing object to document, returns added drawing object’s data.

Parameters:

  • request —

    PutDrawingObjectRequest

Returns:



8567
8568
8569
8570
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8567

def put_drawing_object(request)
  data, _status_code, _headers = put_drawing_object_with_http_info(request)
  data
end

#put_execute_mail_merge_online(request) ⇒ File

Execute document mail merge online.

Parameters:

  • request —

    PutExecuteMailMergeOnlineRequest

Returns:

  • (File) 


8667
8668
8669
8670
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8667

def put_execute_mail_merge_online(request)
  data, _status_code, _headers = put_execute_mail_merge_online_with_http_info(request)
  data
end

#put_execute_template_online(request) ⇒ File

Populate document template with data online.

Parameters:

  • request —

    PutExecuteTemplateOnlineRequest

Returns:

  • (File) 


8739
8740
8741
8742
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8739

def put_execute_template_online(request)
  data, _status_code, _headers = put_execute_template_online_with_http_info(request)
  data
end

#put_field(request) ⇒ FieldResponse

Adds field to document, returns inserted field’s data.

Parameters:

  • request —

    PutFieldRequest

Returns:



8816
8817
8818
8819
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8816

def put_field(request)
  data, _status_code, _headers = put_field_with_http_info(request)
  data
end

#put_footnote(request) ⇒ FootnoteResponse

Adds footnote to document, returns added footnote’s data.

Parameters:

  • request —

    PutFootnoteRequest

Returns:



8917
8918
8919
8920
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 8917

def put_footnote(request)
  data, _status_code, _headers = put_footnote_with_http_info(request)
  data
end

#put_form_field(request) ⇒ FormFieldResponse

Adds form field to paragraph, returns added form field’s data.

Parameters:

  • request —

    PutFormFieldRequest

Returns:



9013
9014
9015
9016
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9013

def put_form_field(request)
  data, _status_code, _headers = put_form_field_with_http_info(request)
  data
end

#put_header_footer(request) ⇒ HeaderFooterResponse

Insert to document header or footer.

Parameters:

  • request —

    PutHeaderFooterRequest

Returns:



9114
9115
9116
9117
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9114

def put_header_footer(request)
  data, _status_code, _headers = put_header_footer_with_http_info(request)
  data
end

#put_paragraph(request) ⇒ ParagraphResponse

Adds paragraph to document, returns added paragraph’s data.

Parameters:

  • request —

    PutParagraphRequest

Returns:



9210
9211
9212
9213
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9210

def put_paragraph(request)
  data, _status_code, _headers = put_paragraph_with_http_info(request)
  data
end

#put_protect_document(request) ⇒ ProtectionDataResponse

Protect document.

Parameters:

  • request —

    PutProtectDocumentRequest

Returns:



9311
9312
9313
9314
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9311

def put_protect_document(request)
  data, _status_code, _headers = put_protect_document_with_http_info(request)
  data
end

#put_run(request) ⇒ RunResponse

Adds run to document, returns added paragraph’s data.

Parameters:

  • request —

    PutRunRequest

Returns:



9392
9393
9394
9395
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9392

def put_run(request)
  data, _status_code, _headers = put_run_with_http_info(request)
  data
end

#reject_all_revisions(request) ⇒ RevisionsModificationResponse

Reject all revisions in document

Parameters:

  • request —

    RejectAllRevisionsRequest

Returns:



9491
9492
9493
9494
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9491

def reject_all_revisions(request)
  data, _status_code, _headers = reject_all_revisions_with_http_info(request)
  data
end

#render_drawing_object(request) ⇒ File

Renders drawing object to specified format.

Parameters:

  • request —

    RenderDrawingObjectRequest

Returns:

  • (File) 


9570
9571
9572
9573
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9570

def render_drawing_object(request)
  data, _status_code, _headers = render_drawing_object_with_http_info(request)
  data
end

#render_math_object(request) ⇒ File

Renders math object to specified format.

Parameters:

  • request —

    RenderMathObjectRequest

Returns:

  • (File) 


9661
9662
9663
9664
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9661

def render_math_object(request)
  data, _status_code, _headers = render_math_object_with_http_info(request)
  data
end

#render_page(request) ⇒ File

Renders page to specified format.

Parameters:

  • request —

    RenderPageRequest

Returns:

  • (File) 


9752
9753
9754
9755
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9752

def render_page(request)
  data, _status_code, _headers = render_page_with_http_info(request)
  data
end

#render_paragraph(request) ⇒ File

Renders paragraph to specified format.

Parameters:

  • request —

    RenderParagraphRequest

Returns:

  • (File) 


9838
9839
9840
9841
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9838

def render_paragraph(request)
  data, _status_code, _headers = render_paragraph_with_http_info(request)
  data
end

#render_table(request) ⇒ File

Renders table to specified format.

Parameters:

  • request —

    RenderTableRequest

Returns:

  • (File) 


9929
9930
9931
9932
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 9929

def render_table(request)
  data, _status_code, _headers = render_table_with_http_info(request)
  data
end

#reset_cache(request) ⇒ AsposeResponse

Resets font’s cache.

Parameters:

  • request —

    ResetCacheRequest

Returns:



10020
10021
10022
10023
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10020

def reset_cache(request)
  data, _status_code, _headers = reset_cache_with_http_info(request)
  data
end

#search(request) ⇒ SearchResponse

Search text in document.

Parameters:

  • request —

    SearchRequest

Returns:



10071
10072
10073
10074
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10071

def search(request)
  data, _status_code, _headers = search_with_http_info(request)
  data
end

#update_border(request) ⇒ BorderResponse

Updates border properties.

‘nodePath’ should refer to node with cell or row

Parameters:

  • request —

    UpdateBorderRequest

Returns:



10149
10150
10151
10152
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10149

def update_border(request)
  data, _status_code, _headers = update_border_with_http_info(request)
  data
end

#update_section_page_setup(request) ⇒ SectionPageSetupResponse

Update page setup of section.

Parameters:

  • request —

    UpdateSectionPageSetupRequest

Returns:



10246
10247
10248
10249
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10246

def update_section_page_setup(request)
  data, _status_code, _headers = update_section_page_setup_with_http_info(request)
  data
end

#update_table_cell_format(request) ⇒ TableCellFormatResponse

Updates a table cell format.

Parameters:

  • request —

    UpdateTableCellFormatRequest

Returns:



10340
10341
10342
10343
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10340

def update_table_cell_format(request)
  data, _status_code, _headers = update_table_cell_format_with_http_info(request)
  data
end

#update_table_properties(request) ⇒ TablePropertiesResponse

Updates a table properties.

Parameters:

  • request —

    UpdateTablePropertiesRequest

Returns:



10435
10436
10437
10438
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10435

def update_table_properties(request)
  data, _status_code, _headers = update_table_properties_with_http_info(request)
  data
end

#update_table_row_format(request) ⇒ TableRowFormatResponse

Updates a table row format.

Parameters:

  • request —

    UpdateTableRowFormatRequest

Returns:



10532
10533
10534
10535
 
# File 'lib/words_ruby_sdk/api/words_api.rb', line 10532

def update_table_row_format(request)
  data, _status_code, _headers = update_table_row_format_with_http_info(request)
  data
end