groupdocs_viewer_cloud 19.3 → 20.5

data/lib/groupdocs_viewer_cloud/api/storage_api.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="storage.rb">
-#   Copyright (c) 2003-2019 Aspose Pty Ltd
+#   Copyright (c) 2003-2020 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -350,7 +350,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="get_disc_usage_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -395,7 +395,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="get_file_versions_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -444,7 +444,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="object_exists_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -497,7 +497,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="storage_exists_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_viewer_cloud/api/{viewer_api.rb → view_api.rb}

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
-# <copyright company="Aspose Pty Ltd" file="viewer.rb">
-#   Copyright (c) 2003-2019 Aspose Pty Ltd
+# <copyright company="Aspose Pty Ltd" file="view.rb">
+#   Copyright (c) 2003-2020 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -30,41 +30,41 @@ module GroupDocsViewerCloud
   #
   # GroupDocs.Viewer Cloud API
   #
-  class ViewerApi
+  class ViewApi
     attr_accessor :config
 
-    #make ViewerApi.new private 
+    #make ViewApi.new private 
     private_class_method :new
 
-    # Initializes new instance of ViewerApi
+    # Initializes new instance of ViewApi
     #
     # @param [config] Configuration 
-    # @return [ViewerApi] New instance of ViewerApi
+    # @return [ViewApi] New instance of ViewApi
     def initialize(config)
       @config = config
       @api_client = ApiClient.new(config)
       @access_token = nil
     end
 
-    # Initializes new instance of ViewerApi
+    # Initializes new instance of ViewApi
     #
     # @param [app_sid] Application identifier (App SID)
     # @param [app_key] Application private key (App Key)
-    # @return [ViewerApi] New instance of ViewerApi
+    # @return [ViewApi] New instance of ViewApi
     def self.from_keys(app_sid, app_key)
       config = Configuration.new(app_sid, app_key)
       return new(config)
     end
 
-    # Initializes new instance of ViewerApi
+    # Initializes new instance of ViewApi
     #
     # @param [config] Configuration 
-    # @return [ViewerApi] New instance of ViewerApi
+    # @return [ViewApi] New instance of ViewApi
     def self.from_config(config)
       return new(config)
     end
 
-    # Create new view if it not exists
+    # Render document pages
     # 
     # @param request create_view_request
     # @return [ViewResult]
@@ -73,7 +73,7 @@ module GroupDocsViewerCloud
       data
     end
 
-    # Create new view if it not exists
+    # Render document pages
     # 
     # @param request create_view_request
     # @return [Array<(ViewResult, Fixnum, Hash)>]
@@ -81,9 +81,9 @@ module GroupDocsViewerCloud
     def create_view_with_http_info(request)
       raise ArgumentError, 'Incorrect request type' unless request.is_a? CreateViewRequest
 
-      @api_client.config.logger.debug 'Calling API: ViewerApi.create_view ...' if @api_client.config.debugging
+      @api_client.config.logger.debug 'Calling API: ViewApi.create_view ...' if @api_client.config.debugging
       # verify the required parameter 'view_options' is set
-      raise ArgumentError, 'Missing the required parameter view_options when calling ViewerApi.create_view' if @api_client.config.client_side_validation && request.view_options.nil?
+      raise ArgumentError, 'Missing the required parameter view_options when calling ViewApi.create_view' if @api_client.config.client_side_validation && request.view_options.nil?
       # resource path
       local_var_path = '/viewer/view'
 
@@ -111,12 +111,12 @@ module GroupDocsViewerCloud
                                                         return_type: 'ViewResult')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called:
-        ViewerApi#create_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        ViewApi#create_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
 
-    # Delete view
+    # Delete rendered pages
     # 
     # @param request delete_view_request
     # @return [nil]
@@ -125,7 +125,7 @@ module GroupDocsViewerCloud
       nil
     end
 
-    # Delete view
+    # Delete rendered pages
     # 
     # @param request delete_view_request
     # @return [Array<(nil, Fixnum, Hash)>]
@@ -133,9 +133,9 @@ module GroupDocsViewerCloud
     def delete_view_with_http_info(request)
       raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteViewRequest
 
-      @api_client.config.logger.debug 'Calling API: ViewerApi.delete_view ...' if @api_client.config.debugging
+      @api_client.config.logger.debug 'Calling API: ViewApi.delete_view ...' if @api_client.config.debugging
       # verify the required parameter 'delete_view_options' is set
-      raise ArgumentError, 'Missing the required parameter delete_view_options when calling ViewerApi.delete_view' if @api_client.config.client_side_validation && request.delete_view_options.nil?
+      raise ArgumentError, 'Missing the required parameter delete_view_options when calling ViewApi.delete_view' if @api_client.config.client_side_validation && request.delete_view_options.nil?
       # resource path
       local_var_path = '/viewer/view'
 
@@ -162,108 +162,7 @@ module GroupDocsViewerCloud
                                                         access_token: get_access_token)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called:
-        ViewerApi#delete_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      [data, status_code, headers]
-    end
-
-    # Get information about view
-    # 
-    # @param request get_info_request
-    # @return [InfoResult]
-    def get_info(request)
-      data, _status_code, _headers = get_info_with_http_info(request)
-      data
-    end
-
-    # Get information about view
-    # 
-    # @param request get_info_request
-    # @return [Array<(InfoResult, Fixnum, Hash)>]
-    # InfoResult data, response status code and response headers
-    def get_info_with_http_info(request)
-      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetInfoRequest
-
-      @api_client.config.logger.debug 'Calling API: ViewerApi.get_info ...' if @api_client.config.debugging
-      # verify the required parameter 'view_options' is set
-      raise ArgumentError, 'Missing the required parameter view_options when calling ViewerApi.get_info' if @api_client.config.client_side_validation && request.view_options.nil?
-      # resource path
-      local_var_path = '/viewer/info'
-
-      # 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(request.view_options)
-      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,
-                                                        access_token: get_access_token,
-                                                        return_type: 'InfoResult')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called:
-        ViewerApi#get_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      [data, status_code, headers]
-    end
-
-    # Get supported file formats
-    # 
-    # @return [FormatsResult]
-    def get_supported_file_formats()
-      data, _status_code, _headers = get_supported_file_formats_with_http_info()
-      data
-    end
-
-    # Get supported file formats
-    # 
-    
-    # @return [Array<(FormatsResult, Fixnum, Hash)>]
-    # FormatsResult data, response status code and response headers
-    def get_supported_file_formats_with_http_info()
-      
-
-      @api_client.config.logger.debug 'Calling API: ViewerApi.get_supported_file_formats ...' if @api_client.config.debugging
-      # resource path
-      local_var_path = '/viewer/formats'
-
-      # 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
-      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,
-                                                        access_token: get_access_token,
-                                                        return_type: 'FormatsResult')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called:
-        ViewerApi#get_supported_file_formats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        ViewApi#delete_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
@@ -325,7 +224,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="create_view_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -370,7 +269,7 @@ end
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="delete_view_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -412,48 +311,3 @@ module GroupDocsViewerCloud
         end
   end
 end
- #
- # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose Pty Ltd" file="get_info_request.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
- # </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>
- # --------------------------------------------------------------------------------------------------------------------
- #
-
-module GroupDocsViewerCloud
-
-  #
-  # Request model for get_info operation.
-  #
-  class GetInfoRequest
-
-        # View options
-        attr_accessor :view_options
-	
-        #
-        # Initializes a new instance.
-        # @param view_options View options
-        def initialize(view_options)
-           self.view_options = view_options
-        end
-  end
-end

data/lib/groupdocs_viewer_cloud/api_client.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="api_client.rb">
-#   Copyright (c) 2003-2019 Aspose Pty Ltd
+#   Copyright (c) 2003-2020 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_viewer_cloud/api_error.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="api_error.rb">
-#   Copyright (c) 2003-2019 Aspose Pty Ltd
+#   Copyright (c) 2003-2020 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -40,9 +40,12 @@ module GroupDocsViewerCloud
         if arg.key?(:response_body) then
           data = JSON.parse(arg[:response_body], :symbolize_names => true)
           if !data.nil? && !data[:error].nil? then
-            @message = data[:error]
-          elsif !data.nil? && !data[:Error].nil? && !data[:Error][:Message].nil? then
-            @message = data[:Error][:Message]
+            error = data[:error]
+            if error.kind_of?(String) then
+              @message = error
+            else
+              @message = error[:message]
+            end
           end
         end
 

data/lib/groupdocs_viewer_cloud/configuration.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="configuration.rb">
-#   Copyright (c) 2003-2019 Aspose Pty Ltd
+#   Copyright (c) 2003-2020 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/groupdocs_viewer_cloud/models/archive_options.rb

@@ -0,0 +1,214 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="archive_options.rb">
+ #   Copyright (c) 2003-2020 Aspose Pty Ltd
+ # </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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+require 'date'
+
+module GroupDocsViewerCloud
+  # Provides options for rendering archive files
+  class ArchiveOptions
+
+    # The folder inside the archive to be rendered
+    attr_accessor :folder
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'folder' => :'Folder'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'folder' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'Folder')
+        self.folder = attributes[:'Folder']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          folder == other.folder
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [folder].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not                    
+          if value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
+          end
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        Date.parse value
+      when :Date
+        Date.parse value
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else
+      # model
+        temp_model = GroupDocsViewerCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end