aspose_words_cloud 20.10.0 → 20.11.0

data/lib/aspose_words_cloud/api_client.rb

@@ -66,12 +66,12 @@ module AsposeWordsCloud
     # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      if @config.api_key['app_sid'].nil? || @config.api_key['app_sid'] == ''
-        raise "AppSid could not be an empty string."
+      if @config.client_data['ClientId'].nil? || @config.client_data['ClientId'] == ''
+        raise "ClientId could not be an empty string."
       end
 
-      if @config.api_key['api_key'].nil? || @config.api_key['api_key'] == ''
-        raise "AppKey could not be an empty string."
+      if @config.client_data['ClientSecret'].nil? || @config.client_data['ClientSecret'] == ''
+        raise "ClientSecret could not be an empty string."
       end
 
       response = build_request(http_method, path, opts)

data/lib/aspose_words_cloud/configuration.rb

@@ -37,17 +37,17 @@ module AsposeWordsCloud
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
     #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
+    # @example parameter name is "ClientSecret", client secret is "xxx" (e.g. "ClientSecret=xxx" in query string)
+    #   config.client_data['ClientSecret'] = 'xxx'
+    attr_accessor :client_data
 
     # Defines API key prefixes used with API Key authentications.
     #
     # @return [Hash] key: parameter name, value: API key prefix
     #
     # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-    #   config.api_key_prefix['api_key'] = 'Token'
-    attr_accessor :api_key_prefix
+    #   config.client_data_prefix['client_secret'] = 'Token'
+    attr_accessor :client_data_prefix
 
     # Defines the username used with HTTP basic authentication.
     #
@@ -94,8 +94,8 @@ module AsposeWordsCloud
     def initialize
       @baseUrl = "https://api.aspose.cloud"
       @api_version = "/v4.0/"
-      @api_key = {}
-      @api_key_prefix = {}
+      @client_data = {}
+      @client_data_prefix = {}
       @client_side_validation = true
       @debugging = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -124,11 +124,11 @@ module AsposeWordsCloud
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
-      if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+    def client_data_with_prefix(param_name)
+      if @client_data_prefix[param_name]
+        "#{@client_data_prefix[param_name]} #{@client_data[param_name]}"
       else
-        @api_key[param_name]
+        @client_data[param_name]
       end
     end
 

data/lib/aspose_words_cloud/models/available_fonts_response.rb

@@ -27,18 +27,18 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # The list of fonts, available for document processing.
+  # The REST response with data on system, additional and custom fonts, available for document processing.
   class AvailableFontsResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets the list of addititional fonts, provided by aspose team.
+    # Gets or sets the list of additional fonts, provided by Aspose team.
     attr_accessor :additional_fonts
 
-    # Gets or sets custom user fonts (from user file storage). To use them, you should specify "fontsLocation" parameter in any request.
+    # Gets or sets the list of custom user fonts from user cloud storage. To use them, you should specify "fontsLocation" parameter in any request.
     attr_accessor :custom_fonts
 
-    # Gets or sets the list of system fonts, availiable on the server.
+    # Gets or sets the list of system fonts, available on the server.
     attr_accessor :system_fonts
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/bmp_save_options_data.rb

@@ -29,106 +29,103 @@ module AsposeWordsCloud
 
   # Container class for bmp save options.
   class BmpSaveOptionsData
-    # Gets or sets a value determining how 3D effects are rendered.
+    # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML effects are rendered.
+    # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
     attr_accessor :dml_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML shapes are rendered.
-    # { Fallback | DrawingML }.
+    # Gets or sets the option that controls how DrawingML shapes are rendered.
     attr_accessor :dml_rendering_mode
 
-    # Gets or sets name of destination file.
+    # Gets or sets the name of destination file.
     attr_accessor :file_name
 
-    # Gets or sets format of save.
+    # Gets or sets the format of save.
     attr_accessor :save_format
 
-    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-    # Default value for this property is. true.
+    # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
     attr_accessor :update_fields
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted
-    # property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
     attr_accessor :update_last_printed_property
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
     attr_accessor :update_last_saved_time_property
 
-    # Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
+    # Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
     attr_accessor :update_sdt_content
 
-    # Gets or sets controls zip output or not.
-    # Default value is false.
+    # Gets or sets a value indicating whether to zip output or not.
+    # The default value is false.
     attr_accessor :zip_output
 
-    # Gets or sets a value determining how colors are rendered.
+    # Gets or sets the value determining how colors are rendered.
     # { Normal | Grayscale}.
     attr_accessor :color_mode
 
-    # Gets or sets determines the quality of the JPEG images inside PDF document.
+    # Gets or sets the quality of the JPEG images inside PDF document.
     attr_accessor :jpeg_quality
 
-    # Gets or sets allows to specify metafile rendering options.
+    # Gets or sets the metafile rendering options.
     attr_accessor :metafile_rendering_options
 
-    # Gets or sets indicates the symbol set that is used to represent numbers while rendering to fixed page formats.
+    # Gets or sets the symbol set, that is used to represent numbers while rendering to fixed page formats.
     attr_accessor :numeral_format
 
-    # Gets or sets flag indicates whether it is required to optimize output of XPS.
+    # Gets or sets a value indicating whether it is required to optimize output of XPS.
     # If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated.
-    # Note: The accuracy of the content display may be affected if this property is set to true.  Default is false.
+    # Note: The accuracy of the content display may be affected if this property is set to true.. The default value is false.
     attr_accessor :optimize_output
 
-    # Gets or sets determines number of pages to render.
+    # Gets or sets the number of pages to render.
     attr_accessor :page_count
 
-    # Gets or sets determines 0-based index of the first page to render.
+    # Gets or sets the 0-based index of the first page to render.
     attr_accessor :page_index
 
-    # Gets or sets allows to specify additional System.Drawing.Graphics quality options.
+    # Gets or sets the additional System.Drawing.Graphics quality options.
     attr_accessor :graphics_quality_options
 
-    # Gets or sets the horizontal resolution for the generated images, in dots per inch.
+    # Gets or sets the horizontal resolution in dots per inch for the generated images.
     # This property has effect only when saving to raster image formats.
     # The default value is 96.
     attr_accessor :horizontal_resolution
 
-    # Gets or sets brightness of image.
+    # Gets or sets the brightness level of the image.
     attr_accessor :image_brightness
 
-    # Gets or sets color mode of image.
+    # Gets or sets the color mode of the image.
     attr_accessor :image_color_mode
 
-    # Gets or sets contrast of image.
+    # Gets or sets the contrast level of the image.
     attr_accessor :image_contrast
 
-    # Gets or sets background (paper) color of image.
+    # Gets or sets the background (paper) color of the image.
     attr_accessor :paper_color
 
-    # Gets or sets pixel format of image.
+    # Gets or sets the pixel format of the image.
     attr_accessor :pixel_format
 
-    # Gets or sets both horizontal and vertical resolution for the generated images, in dots per inch.
+    # Gets or sets both horizontal and vertical resolution in dots per inch for the generated images.
     # This property has effect only when saving to raster image formats.
     # The default value is 96.
     attr_accessor :resolution
 
-    # Gets or sets zoom factor of image.
+    # Gets or sets the zoom factor of the image.
     attr_accessor :scale
 
-    # Gets or sets determine whether or not to use anti-aliasing for rendering.
+    # Gets or sets a value indicating whether to use anti-aliasing for rendering.
     attr_accessor :use_anti_aliasing
 
-    # Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
+    # Gets or sets a value indicating whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
     attr_accessor :use_gdi_emf_renderer
 
-    # Gets or sets determine whether or not to use high quality (i.e. slow) rendering algorithms.
+    # Gets or sets a value indicating whether to use high quality (i.e. slow) rendering algorithms.
     attr_accessor :use_high_quality_rendering
 
-    # Gets or sets the vertical resolution for the generated images, in dots per inch.
+    # Gets or sets the vertical resolution in dots per inch for the generated images.
     # This property has effect only when saving to raster image formats.
     # The default value is 96.
     attr_accessor :vertical_resolution

data/lib/aspose_words_cloud/models/bookmark.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
 
   # Represents a single bookmark.
   class Bookmark
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
     # Gets or sets the name of the bookmark.
     attr_accessor :name
 
-    # Gets or sets the text enclosed in the bookmark.
+    # Gets or sets text, enclosed in the bookmark.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/bookmark_data.rb

@@ -32,7 +32,7 @@ module AsposeWordsCloud
     # Gets or sets the name of the bookmark.
     attr_accessor :name
 
-    # Gets or sets the text enclosed in the bookmark.
+    # Gets or sets text, enclosed in the bookmark.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/bookmark_response.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:  GET bookmarks/{bookmarkName}.
+  # The REST response with a bookmark.
   class BookmarkResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets bookmark.
+    # Gets or sets the bookmark.
     attr_accessor :bookmark
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/bookmarks.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
 
   # Represents an array of bookmarks.
   class Bookmarks
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets array of bookmarks.
+    # Gets or sets the array of bookmarks.
     attr_accessor :bookmark_list
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/bookmarks_outline_level_data.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # container class for individual bookmarks outline level.
+  # Container class for individual bookmarks outline level.
   class BookmarksOutlineLevelData
-    # Gets or sets specify the bookmark's level.
+    # Gets or sets the bookmark's level.
     attr_accessor :bookmarks_outline_level
 
-    # Gets or sets specify the bookmark's name.
+    # Gets or sets the bookmark's name.
     attr_accessor :name
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/bookmarks_response.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:  GET bookmarks.
+  # The REST response with a collection of bookmarks.
   class BookmarksResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets bookmarks which are contained in document.
+    # Gets or sets the collection of bookmarks.
     attr_accessor :bookmarks
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/border.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
 
   # Represents a border of an object.
   class Border
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
     # Gets or sets the border type.
@@ -38,7 +38,7 @@ module AsposeWordsCloud
     # Gets or sets the border color.
     attr_accessor :color
 
-    # Gets or sets distance of the border from text or from the page edge in points.
+    # Gets or sets the distance of the border from text or from the page edge in points.
     attr_accessor :distance_from_text
 
     # Gets or sets the border style.

data/lib/aspose_words_cloud/models/border_response.rb

@@ -27,13 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # GET {nodeWithBorders}/borders.
+  # The REST response with a border.
   class BorderResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets table.
+    # Gets or sets the border.
     attr_accessor :border
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/borders_collection.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Collection of borders.
+  # The collection of borders.
   class BordersCollection
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets collection of comments.
+    # Gets or sets the collection of comments.
     attr_accessor :list
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/borders_response.rb

@@ -27,13 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # GET {nodeWithBorders}/borders.
+  # The REST response with a collection of borders.
   class BordersResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets table.
+    # Gets or sets the collection of borders.
     attr_accessor :borders
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/classification_response.rb

@@ -27,19 +27,18 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # PUT https://api.aspose.cloud/v4.0/words/classify.
+  # The REST response with data on multi-class text classification.
   class ClassificationResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets best class name.
+    # Gets or sets the best class name.
     attr_accessor :best_class_name
 
-    # Gets or sets best class probability.
+    # Gets or sets the best class probability.
     attr_accessor :best_class_probability
 
-    # Gets or sets array of best classes results.
+    # Gets or sets the array of best classes results.
     attr_accessor :best_results
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/comment.rb

@@ -27,30 +27,30 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Comment.
+  # DTO container with a comment.
   class Comment
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets returns or sets the author name for a comment.
+    # Gets or sets the author name for a comment.
     attr_accessor :author
 
-    # Gets or sets content of comment.
+    # Gets or sets the content of the comment.
     attr_accessor :content
 
     # Gets or sets the date and time that the comment was made.
     attr_accessor :date_time
 
-    # Gets or sets returns or sets the initials of the user associated with a specific comment.
+    # Gets or sets the initials of the user associated with a specific comment.
     attr_accessor :initial
 
-    # Gets or sets link to comment range end node.
+    # Gets or sets the link to comment range end node.
     attr_accessor :range_end
 
-    # Gets or sets link to comment range start node.
+    # Gets or sets the link to comment range start node.
     attr_accessor :range_start
 
-    # Gets or sets this is a convenience property that allows to easily get or set text of the comment.
+    # Gets or sets text of the comment.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map