Module: WordsRubySdk

Defined in:: lib/words_ruby_sdk/version.rb,
lib/words_ruby_sdk.rb,
lib/words_ruby_sdk/api_error.rb,
lib/words_ruby_sdk/api_client.rb,
lib/words_ruby_sdk/models/run.rb,
lib/words_ruby_sdk/models/font.rb,
lib/words_ruby_sdk/models/link.rb,
lib/words_ruby_sdk/models/runs.rb,
lib/words_ruby_sdk/models/field.rb,
lib/words_ruby_sdk/models/table.rb,
lib/words_ruby_sdk/api/words_api.rb,
lib/words_ruby_sdk/configuration.rb,
lib/words_ruby_sdk/models/border.rb,
lib/words_ruby_sdk/models/comment.rb,
lib/words_ruby_sdk/models/section.rb,
lib/words_ruby_sdk/models/bookmark.rb,
lib/words_ruby_sdk/models/document.rb,
lib/words_ruby_sdk/models/footnote.rb,
lib/words_ruby_sdk/models/run_link.rb,
lib/words_ruby_sdk/models/bookmarks.rb,
lib/words_ruby_sdk/models/file_link.rb,
lib/words_ruby_sdk/models/hyperlink.rb,
lib/words_ruby_sdk/models/node_link.rb,
lib/words_ruby_sdk/models/paragraph.rb,
lib/words_ruby_sdk/models/table_row.rb,
lib/words_ruby_sdk/models/text_item.rb,
lib/words_ruby_sdk/models/xml_color.rb,
lib/words_ruby_sdk/models/field_link.rb,
lib/words_ruby_sdk/models/form_field.rb,
lib/words_ruby_sdk/models/hyperlinks.rb,
lib/words_ruby_sdk/models/page_setup.rb,
lib/words_ruby_sdk/models/table_cell.rb,
lib/words_ruby_sdk/models/table_link.rb,
lib/words_ruby_sdk/models/text_items.rb,
lib/words_ruby_sdk/models/field_names.rb,
lib/words_ruby_sdk/models/page_number.rb,
lib/words_ruby_sdk/models/save_result.rb,
lib/words_ruby_sdk/models/comment_link.rb,
lib/words_ruby_sdk/models/compare_data.rb,
lib/words_ruby_sdk/models/link_element.rb,
lib/words_ruby_sdk/models/run_response.rb,
lib/words_ruby_sdk/models/section_link.rb,
lib/words_ruby_sdk/models/table_insert.rb,
lib/words_ruby_sdk/models/bookmark_data.rb,
lib/words_ruby_sdk/models/font_response.rb,
lib/words_ruby_sdk/models/footnote_link.rb,
lib/words_ruby_sdk/models/header_footer.rb,
lib/words_ruby_sdk/models/runs_response.rb,
lib/words_ruby_sdk/models/save_response.rb,
lib/words_ruby_sdk/models/search_result.rb,
lib/words_ruby_sdk/models/document_entry.rb,
lib/words_ruby_sdk/models/drawing_object.rb,
lib/words_ruby_sdk/models/field_response.rb,
lib/words_ruby_sdk/models/page_stat_data.rb,
lib/words_ruby_sdk/models/paragraph_link.rb,
lib/words_ruby_sdk/models/table_response.rb,
lib/words_ruby_sdk/models/watermark_text.rb,
lib/words_ruby_sdk/models/words_api_link.rb,
lib/words_ruby_sdk/models/aspose_response.rb,
lib/words_ruby_sdk/models/border_response.rb,
lib/words_ruby_sdk/models/fields_response.rb,
lib/words_ruby_sdk/models/preferred_width.rb,
lib/words_ruby_sdk/models/protection_data.rb,
lib/words_ruby_sdk/models/search_response.rb,
lib/words_ruby_sdk/models/borders_response.rb,
lib/words_ruby_sdk/models/comment_response.rb,
lib/words_ruby_sdk/models/field_collection.rb,
lib/words_ruby_sdk/models/office_math_link.rb,
lib/words_ruby_sdk/models/paragraph_insert.rb,
lib/words_ruby_sdk/models/section_response.rb,
lib/words_ruby_sdk/models/table_properties.rb,
lib/words_ruby_sdk/models/table_row_format.rb,
lib/words_ruby_sdk/models/table_row_insert.rb,
lib/words_ruby_sdk/models/bookmark_response.rb,
lib/words_ruby_sdk/models/comments_response.rb,
lib/words_ruby_sdk/models/document_position.rb,
lib/words_ruby_sdk/models/document_property.rb,
lib/words_ruby_sdk/models/document_response.rb,
lib/words_ruby_sdk/models/footnote_response.rb,
lib/words_ruby_sdk/models/save_options_data.rb,
lib/words_ruby_sdk/models/story_child_nodes.rb,
lib/words_ruby_sdk/models/table_cell_format.rb,
lib/words_ruby_sdk/models/table_cell_insert.rb,
lib/words_ruby_sdk/models/bookmarks_response.rb,
lib/words_ruby_sdk/models/borders_collection.rb,
lib/words_ruby_sdk/models/document_stat_data.rb,
lib/words_ruby_sdk/models/footnotes_response.rb,
lib/words_ruby_sdk/models/header_footer_link.rb,
lib/words_ruby_sdk/models/hyperlink_response.rb,
lib/words_ruby_sdk/models/office_math_object.rb,
lib/words_ruby_sdk/models/paragraph_response.rb,
lib/words_ruby_sdk/models/protection_request.rb,
lib/words_ruby_sdk/models/stat_data_response.rb,
lib/words_ruby_sdk/models/string_format_data.rb,
lib/words_ruby_sdk/models/table_row_response.rb,
lib/words_ruby_sdk/models/comments_collection.rb,
lib/words_ruby_sdk/models/document_entry_list.rb,
lib/words_ruby_sdk/models/document_properties.rb,
lib/words_ruby_sdk/models/drawing_object_link.rb,
lib/words_ruby_sdk/models/footnote_collection.rb,
lib/words_ruby_sdk/models/footnotes_stat_data.rb,
lib/words_ruby_sdk/models/form_field_checkbox.rb,
lib/words_ruby_sdk/models/form_field_response.rb,
lib/words_ruby_sdk/models/hyperlinks_response.rb,
lib/words_ruby_sdk/models/protection_response.rb,
lib/words_ruby_sdk/models/table_cell_response.rb,
lib/words_ruby_sdk/models/text_items_response.rb,
lib/words_ruby_sdk/models/field_names_response.rb,
lib/words_ruby_sdk/models/form_field_drop_down.rb,
lib/words_ruby_sdk/models/form_fields_response.rb,
lib/words_ruby_sdk/models/outline_options_data.rb,
lib/words_ruby_sdk/models/ps_save_options_data.rb,
lib/words_ruby_sdk/models/replace_text_request.rb,
lib/words_ruby_sdk/models/bmp_save_options_data.rb,
lib/words_ruby_sdk/models/classification_result.rb,
lib/words_ruby_sdk/models/doc_save_options_data.rb,
lib/words_ruby_sdk/models/emf_save_options_data.rb,
lib/words_ruby_sdk/models/form_field_collection.rb,
lib/words_ruby_sdk/models/form_field_text_input.rb,
lib/words_ruby_sdk/models/gif_save_options_data.rb,
lib/words_ruby_sdk/models/odt_save_options_data.rb,
lib/words_ruby_sdk/models/pcl_save_options_data.rb,
lib/words_ruby_sdk/models/pdf_save_options_data.rb,
lib/words_ruby_sdk/models/png_save_options_data.rb,
lib/words_ruby_sdk/models/replace_text_response.rb,
lib/words_ruby_sdk/models/rtf_save_options_data.rb,
lib/words_ruby_sdk/models/split_document_result.rb,
lib/words_ruby_sdk/models/svg_save_options_data.rb,
lib/words_ruby_sdk/models/table_link_collection.rb,
lib/words_ruby_sdk/models/xps_save_options_data.rb,
lib/words_ruby_sdk/models/epub_save_options_data.rb,
lib/words_ruby_sdk/models/header_footer_response.rb,
lib/words_ruby_sdk/models/html_save_options_data.rb,
lib/words_ruby_sdk/models/jpeg_save_options_data.rb,
lib/words_ruby_sdk/models/load_web_document_data.rb,
lib/words_ruby_sdk/models/requests/PutRunRequest.rb,
lib/words_ruby_sdk/models/requests/SearchRequest.rb,
lib/words_ruby_sdk/models/text_save_options_data.rb,
lib/words_ruby_sdk/models/tiff_save_options_data.rb,
lib/words_ruby_sdk/models/classification_response.rb,
lib/words_ruby_sdk/models/downsample_options_data.rb,
lib/words_ruby_sdk/models/drawing_object_response.rb,
lib/words_ruby_sdk/models/header_footers_response.rb,
lib/words_ruby_sdk/models/image_save_options_data.rb,
lib/words_ruby_sdk/models/mhtml_save_options_data.rb,
lib/words_ruby_sdk/models/ooxml_save_options_data.rb,
lib/words_ruby_sdk/models/requests/PostRunRequest.rb,
lib/words_ruby_sdk/models/section_link_collection.rb,
lib/words_ruby_sdk/models/split_document_response.rb,
lib/words_ruby_sdk/models/drawing_objects_response.rb,
lib/words_ruby_sdk/models/protection_data_response.rb,
lib/words_ruby_sdk/models/requests/ClassifyRequest.rb,
lib/words_ruby_sdk/models/requests/GetFieldRequest.rb,
lib/words_ruby_sdk/models/requests/GetTableRequest.rb,
lib/words_ruby_sdk/models/requests/PutFieldRequest.rb,
lib/words_ruby_sdk/models/words_api_error_response.rb,
lib/words_ruby_sdk/models/drawing_object_collection.rb,
lib/words_ruby_sdk/models/paragraph_link_collection.rb,
lib/words_ruby_sdk/models/requests/DeleteRunRequest.rb,
lib/words_ruby_sdk/models/requests/GetBorderRequest.rb,
lib/words_ruby_sdk/models/requests/GetFieldsRequest.rb,
lib/words_ruby_sdk/models/requests/GetTablesRequest.rb,
lib/words_ruby_sdk/models/requests/PostFieldRequest.rb,
lib/words_ruby_sdk/models/search_results_collection.rb,
lib/words_ruby_sdk/models/table_properties_response.rb,
lib/words_ruby_sdk/models/table_row_format_response.rb,
lib/words_ruby_sdk/models/word_ml_save_options_data.rb,
lib/words_ruby_sdk/models/document_property_response.rb,
lib/words_ruby_sdk/models/requests/GetBordersRequest.rb,
lib/words_ruby_sdk/models/requests/GetCommentRequest.rb,
lib/words_ruby_sdk/models/requests/GetSectionRequest.rb,
lib/words_ruby_sdk/models/requests/PutCommentRequest.rb,
lib/words_ruby_sdk/models/requests/RenderPageRequest.rb,
lib/words_ruby_sdk/models/requests/ResetCacheRequest.rb,
lib/words_ruby_sdk/models/table_cell_format_response.rb,
lib/words_ruby_sdk/models/office_math_object_response.rb,
lib/words_ruby_sdk/models/pdf_encryption_details_data.rb,
lib/words_ruby_sdk/models/requests/DeleteFieldRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteTableRequest.rb,
lib/words_ruby_sdk/models/requests/GetCommentsRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/GetFootnoteRequest.rb,
lib/words_ruby_sdk/models/requests/GetSectionsRequest.rb,
lib/words_ruby_sdk/models/requests/GetTableRowRequest.rb,
lib/words_ruby_sdk/models/requests/InsertTableRequest.rb,
lib/words_ruby_sdk/models/requests/PostCommentRequest.rb,
lib/words_ruby_sdk/models/requests/PutFootnoteRequest.rb,
lib/words_ruby_sdk/models/requests/RenderTableRequest.rb,
lib/words_ruby_sdk/models/section_page_setup_response.rb,
lib/words_ruby_sdk/models/xaml_flow_save_options_data.rb,
lib/words_ruby_sdk/models/bookmarks_outline_level_data.rb,
lib/words_ruby_sdk/models/document_properties_response.rb,
lib/words_ruby_sdk/models/fixed_page_save_options_data.rb,
lib/words_ruby_sdk/models/html_fixed_save_options_data.rb,
lib/words_ruby_sdk/models/office_math_objects_response.rb,
lib/words_ruby_sdk/models/requests/DeleteBorderRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteFieldsRequest.rb,
lib/words_ruby_sdk/models/requests/GetFootnotesRequest.rb,
lib/words_ruby_sdk/models/requests/GetFormFieldRequest.rb,
lib/words_ruby_sdk/models/requests/GetTableCellRequest.rb,
lib/words_ruby_sdk/models/requests/PostFootnoteRequest.rb,
lib/words_ruby_sdk/models/requests/PutFormFieldRequest.rb,
lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb,
lib/words_ruby_sdk/models/requests/UpdateBorderRequest.rb,
lib/words_ruby_sdk/models/xaml_fixed_save_options_data.rb,
lib/words_ruby_sdk/models/graphics_quality_options_data.rb,
lib/words_ruby_sdk/models/header_footer_link_collection.rb,
lib/words_ruby_sdk/models/modification_operation_result.rb,
lib/words_ruby_sdk/models/requests/DeleteBordersRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteCommentRequest.rb,
lib/words_ruby_sdk/models/requests/GetFormFieldsRequest.rb,
lib/words_ruby_sdk/models/requests/PostFormFieldRequest.rb,
lib/words_ruby_sdk/models/office_math_objects_collection.rb,
lib/words_ruby_sdk/models/requests/DeleteFootnoteRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteTableRowRequest.rb,
lib/words_ruby_sdk/models/requests/InsertTableRowRequest.rb,
lib/words_ruby_sdk/models/table_link_collection_response.rb,
lib/words_ruby_sdk/models/metafile_rendering_options_data.rb,
lib/words_ruby_sdk/models/requests/DeleteFormFieldRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteParagraphRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteTableCellRequest.rb,
lib/words_ruby_sdk/models/requests/GetHeaderFooterRequest.rb,
lib/words_ruby_sdk/models/requests/InsertTableCellRequest.rb,
lib/words_ruby_sdk/models/requests/PostReplaceTextRequest.rb,
lib/words_ruby_sdk/models/requests/PutHeaderFooterRequest.rb,
lib/words_ruby_sdk/models/requests/RenderParagraphRequest.rb,
lib/words_ruby_sdk/models/revisions_modification_response.rb,
lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb,
lib/words_ruby_sdk/models/requests/PutDrawingObjectRequest.rb,
lib/words_ruby_sdk/models/requests/RenderMathObjectRequest.rb,
lib/words_ruby_sdk/models/section_link_collection_response.rb,
lib/words_ruby_sdk/models/requests/GetTableRowFormatRequest.rb,
lib/words_ruby_sdk/models/requests/PostDrawingObjectRequest.rb,
lib/words_ruby_sdk/models/requests/PostSplitDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/PutCreateDocumentRequest.rb,
lib/words_ruby_sdk/models/paragraph_link_collection_response.rb,
lib/words_ruby_sdk/models/pdf_digital_signature_details_data.rb,
lib/words_ruby_sdk/models/requests/AcceptAllRevisionsRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteHeaderFooterRequest.rb,
lib/words_ruby_sdk/models/requests/GetTableCellFormatRequest.rb,
lib/words_ruby_sdk/models/requests/GetTablePropertiesRequest.rb,
lib/words_ruby_sdk/models/requests/PostAppendDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/PostDocumentSaveAsRequest.rb,
lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/PutProtectDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/RejectAllRevisionsRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteDrawingObjectRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentPropertyRequest.rb,
lib/words_ruby_sdk/models/requests/GetOfficeMathObjectRequest.rb,
lib/words_ruby_sdk/models/requests/GetSectionPageSetupRequest.rb,
lib/words_ruby_sdk/models/requests/PostCompareDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/PostExecuteTemplateRequest.rb,
lib/words_ruby_sdk/models/requests/PostLoadWebDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/RenderDrawingObjectRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteDocumentMacrosRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteHeadersFootersRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentBookmarksRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentParagraphRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentTextItemsRequest.rb,
lib/words_ruby_sdk/models/requests/GetOfficeMathObjectsRequest.rb,
lib/words_ruby_sdk/models/requests/UpdateTableRowFormatRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentFieldNamesRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentHyperlinksRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentParagraphsRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentPropertiesRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentProtectionRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentStatisticsRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentWithFormatRequest.rb,
lib/words_ruby_sdk/models/requests/PostInsertPageNumbersRequest.rb,
lib/words_ruby_sdk/models/requests/PutDocumentFieldNamesRequest.rb,
lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb,
lib/words_ruby_sdk/models/requests/UpdateTableCellFormatRequest.rb,
lib/words_ruby_sdk/models/requests/UpdateTablePropertiesRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteDocumentPropertyRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteOfficeMathObjectRequest.rb,
lib/words_ruby_sdk/models/requests/UpdateSectionPageSetupRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteDocumentWatermarkRequest.rb,
lib/words_ruby_sdk/models/requests/DeleteUnprotectDocumentRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentParagraphRunRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentParagraphRunsRequest.rb,
lib/words_ruby_sdk/models/requests/GetHeaderFooterOfSectionRequest.rb,
lib/words_ruby_sdk/models/requests/PostUpdateDocumentFieldsRequest.rb,
lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentBookmarkByNameRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentDrawingObjectsRequest.rb,
lib/words_ruby_sdk/models/requests/PutExecuteMailMergeOnlineRequest.rb,
lib/words_ruby_sdk/models/requests/PostUpdateDocumentBookmarkRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentHyperlinkByIndexRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentParagraphRunFontRequest.rb,
lib/words_ruby_sdk/models/requests/PostChangeDocumentProtectionRequest.rb,
lib/words_ruby_sdk/models/requests/PostDocumentExecuteMailMergeRequest.rb,
lib/words_ruby_sdk/models/requests/PostDocumentParagraphRunFontRequest.rb,
lib/words_ruby_sdk/models/requests/CreateOrUpdateDocumentPropertyRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentDrawingObjectByIndexRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentDrawingObjectOleDataRequest.rb,
lib/words_ruby_sdk/models/requests/PostInsertDocumentWatermarkTextRequest.rb,
lib/words_ruby_sdk/models/requests/PostInsertDocumentWatermarkImageRequest.rb,
lib/words_ruby_sdk/models/requests/GetDocumentDrawingObjectImageDataRequest.rb

Overview

Copyright (c) 2018 Aspose.Words for Cloud

</copyright> <summary>

 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

</summary>

Defined Under Namespace

Constant Summary collapse

VERSION =

"18.6".freeze

Class Method Summary collapse

.configure ⇒ Object

Configure sdk using block.

Class Method Details

.configure ⇒ `Object`

Configure sdk using block. WordsRubySdk.configure do |config|

config.username = "xxx"
config.password = "xxx"

end If no block given, return the configuration singleton instance.

# File 'lib/words_ruby_sdk.rb', line 217

def configure
  if block_given?
    yield Configuration.default
  else
    Configuration.default
  end
end

Module: WordsRubySdk

Overview

Defined Under Namespace

Constant Summary collapse

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

.configure ⇒ `Object`