groupdocs_metadata_cloud 26.1

data/lib/groupdocs_metadata_cloud/api/metadata_api.rb

@@ -0,0 +1,508 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="metadata.rb">
+#   Copyright (c) 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 'uri'
+require 'date'
+
+module GroupDocsMetadataCloud
+  #
+  # GroupDocs.Metadata Cloud API
+  #
+  class MetadataApi
+    attr_accessor :config
+
+    #make MetadataApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of MetadataApi
+    #
+    # @param [config] Configuration 
+    # @return [MetadataApi] New instance of MetadataApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of MetadataApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [MetadataApi] New instance of MetadataApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of MetadataApi
+    #
+    # @param [config] Configuration 
+    # @return [MetadataApi] New instance of MetadataApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Add new metadata fields to a file.
+    # 
+    # @param request add_request
+    # @return [AddResult]
+    def add(request)
+      data, _status_code, _headers = add_with_http_info(request)
+      data
+    end
+
+    # Add new metadata fields to a file.
+    # 
+    # @param request add_request
+    # @return [Array<(AddResult, Fixnum, Hash)>]
+    # AddResult data, response status code and response headers
+    def add_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? AddRequest
+
+      @api_client.config.logger.debug 'Calling API: MetadataApi.add ...' if @api_client.config.debugging
+      # verify the required parameter 'options' is set
+      raise ArgumentError, 'Missing the required parameter options when calling MetadataApi.add' if @api_client.config.client_side_validation && request.options.nil?
+      # resource path
+      local_var_path = '/metadata/add'
+
+      # 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.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: 'AddResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        MetadataApi#add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Retrieve document metadata.
+    # 
+    # @param request extract_request
+    # @return [ExtractResult]
+    def extract(request)
+      data, _status_code, _headers = extract_with_http_info(request)
+      data
+    end
+
+    # Retrieve document metadata.
+    # 
+    # @param request extract_request
+    # @return [Array<(ExtractResult, Fixnum, Hash)>]
+    # ExtractResult data, response status code and response headers
+    def extract_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? ExtractRequest
+
+      @api_client.config.logger.debug 'Calling API: MetadataApi.extract ...' if @api_client.config.debugging
+      # verify the required parameter 'options' is set
+      raise ArgumentError, 'Missing the required parameter options when calling MetadataApi.extract' if @api_client.config.client_side_validation && request.options.nil?
+      # resource path
+      local_var_path = '/metadata'
+
+      # 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.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: 'ExtractResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        MetadataApi#extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Remove metadata from document using search criteria.
+    # 
+    # @param request remove_request
+    # @return [RemoveResult]
+    def remove(request)
+      data, _status_code, _headers = remove_with_http_info(request)
+      data
+    end
+
+    # Remove metadata from document using search criteria.
+    # 
+    # @param request remove_request
+    # @return [Array<(RemoveResult, Fixnum, Hash)>]
+    # RemoveResult data, response status code and response headers
+    def remove_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? RemoveRequest
+
+      @api_client.config.logger.debug 'Calling API: MetadataApi.remove ...' if @api_client.config.debugging
+      # verify the required parameter 'options' is set
+      raise ArgumentError, 'Missing the required parameter options when calling MetadataApi.remove' if @api_client.config.client_side_validation && request.options.nil?
+      # resource path
+      local_var_path = '/metadata/remove'
+
+      # 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.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: 'RemoveResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        MetadataApi#remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Set existing metadata fields with new values.
+    # 
+    # @param request set_request
+    # @return [SetResult]
+    def set(request)
+      data, _status_code, _headers = set_with_http_info(request)
+      data
+    end
+
+    # Set existing metadata fields with new values.
+    # 
+    # @param request set_request
+    # @return [Array<(SetResult, Fixnum, Hash)>]
+    # SetResult data, response status code and response headers
+    def set_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? SetRequest
+
+      @api_client.config.logger.debug 'Calling API: MetadataApi.set ...' if @api_client.config.debugging
+      # verify the required parameter 'options' is set
+      raise ArgumentError, 'Missing the required parameter options when calling MetadataApi.set' if @api_client.config.client_side_validation && request.options.nil?
+      # resource path
+      local_var_path = '/metadata/set'
+
+      # 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.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: 'SetResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        MetadataApi#set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    #
+    # Helper method to convert first letter to downcase
+    #
+    private def downcase_first_letter(str)
+      value = str[0].downcase + str[1..-1]
+      value
+    end
+                 
+    #
+    # Retrieves access token
+    #
+    private def get_access_token
+        if @access_token.nil? then
+          request_access_token
+        end
+        
+        @access_token  
+    end
+
+    #
+    # Gets a access token from server
+    #
+    private def request_access_token
+        auth_config = Configuration.new(@config.app_sid, @config.app_key)
+        auth_config.api_base_url = @config.api_base_url
+        auth_config.debugging = @config.debugging
+        auth_config.logger = @config.logger
+        auth_config.temp_folder_path = @config.temp_folder_path
+        auth_config.client_side_validation = @config.client_side_validation
+        auth_config.api_version = ''
+
+        auth_api_client = ApiClient.new(auth_config)
+
+        request_url = "/connect/token"
+        post_data = "grant_type=client_credentials&client_id=#{@config.app_sid}&client_secret=#{@config.app_key}"
+
+        data, _status_code, _header = auth_api_client.call_api(:POST, request_url, :body => post_data, :return_type => 'Object')
+        
+        @access_token = data[:access_token]
+
+        expires_in_seconds = data[:expires_in].to_i - 5 * 60 
+        expires_in_days = Rational(expires_in_seconds, 60 * 60 * 24)
+        @access_token_expires_at = DateTime.now + expires_in_days
+    end
+    
+    # requires all files inside a directory from current dir
+    # @param _dir can be relative path like '/lib' or "../lib"
+    private def require_all(_dir)
+      Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), _dir)) + "/*.rb"].each do |file|
+        require file
+      end
+    end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="add_request.rb">
+ #   Copyright (c) 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 GroupDocsMetadataCloud
+
+  #
+  # Request model for add operation.
+  #
+  class AddRequest
+
+        # Add options.
+        attr_accessor :options
+	
+        #
+        # Initializes a new instance.
+        # @param options Add options.
+        def initialize(options)
+           self.options = options
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="extract_request.rb">
+ #   Copyright (c) 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 GroupDocsMetadataCloud
+
+  #
+  # Request model for extract operation.
+  #
+  class ExtractRequest
+
+        # Extract options.
+        attr_accessor :options
+	
+        #
+        # Initializes a new instance.
+        # @param options Extract options.
+        def initialize(options)
+           self.options = options
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="remove_request.rb">
+ #   Copyright (c) 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 GroupDocsMetadataCloud
+
+  #
+  # Request model for remove operation.
+  #
+  class RemoveRequest
+
+        # Remove options.
+        attr_accessor :options
+	
+        #
+        # Initializes a new instance.
+        # @param options Remove options.
+        def initialize(options)
+           self.options = options
+        end
+  end
+end
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="set_request.rb">
+ #   Copyright (c) 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 GroupDocsMetadataCloud
+
+  #
+  # Request model for set operation.
+  #
+  class SetRequest
+
+        # Set options.
+        attr_accessor :options
+	
+        #
+        # Initializes a new instance.
+        # @param options Set options.
+        def initialize(options)
+           self.options = options
+        end
+  end
+end