yousign_client 1.0.0

data/lib/yousign_client/api/file_objects_api.rb

@@ -0,0 +1,282 @@
+=begin
+#Yousign API Swagger
+
+#For your information, the Yousign API documentation is available at https://dev.yousign.com/
+
+OpenAPI spec version: 2.1
+Contact: support@yousign.fr
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module YousignClient
+  class FileObjectsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a File Object
+    # Delete a File Object
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def file_objects_id_delete(id, authorization, opts = {})
+      file_objects_id_delete_with_http_info(id, authorization, opts)
+      nil
+    end
+
+    # Delete a File Object
+    # Delete a File Object
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def file_objects_id_delete_with_http_info(id, authorization, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FileObjectsApi.file_objects_id_delete"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_id_delete"
+      end
+      # resource path
+      local_var_path = '/file_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # 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'])
+      header_params[:'Authorization'] = authorization
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Find a File Object by ID
+    # Get a File Object
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [FileObjectOutput]
+    def file_objects_id_get(id, authorization, opts = {})
+      data, _status_code, _headers = file_objects_id_get_with_http_info(id, authorization, opts)
+      data
+    end
+
+    # Find a File Object by ID
+    # Get a File Object
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileObjectOutput, Fixnum, Hash)>] FileObjectOutput data, response status code and response headers
+    def file_objects_id_get_with_http_info(id, authorization, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FileObjectsApi.file_objects_id_get"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_id_get"
+      end
+      # resource path
+      local_var_path = '/file_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # 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'])
+      header_params[:'Authorization'] = authorization
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      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,
+        :auth_names => auth_names,
+        :return_type => 'FileObjectOutput')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update a File Object
+    # Update a File Object
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [FileObjectOutput]
+    def file_objects_id_put(id, authorization, content_type, body, opts = {})
+      data, _status_code, _headers = file_objects_id_put_with_http_info(id, authorization, content_type, body, opts)
+      data
+    end
+
+    # Update a File Object
+    # Update a File Object
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileObjectOutput, Fixnum, Hash)>] FileObjectOutput data, response status code and response headers
+    def file_objects_id_put_with_http_info(id, authorization, content_type, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_put ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FileObjectsApi.file_objects_id_put"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_id_put"
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling FileObjectsApi.file_objects_id_put"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling FileObjectsApi.file_objects_id_put"
+      end
+      # resource path
+      local_var_path = '/file_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Authorization'] = authorization
+      header_params[:'Content-Type'] = content_type
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'FileObjectOutput')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Create a new File Object
+    # Create a new fileObject
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [FileObjectOutput]
+    def file_objects_post(authorization, content_type, body, opts = {})
+      data, _status_code, _headers = file_objects_post_with_http_info(authorization, content_type, body, opts)
+      data
+    end
+
+    # Create a new File Object
+    # Create a new fileObject
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileObjectOutput, Fixnum, Hash)>] FileObjectOutput data, response status code and response headers
+    def file_objects_post_with_http_info(authorization, content_type, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_post ...'
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_post"
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling FileObjectsApi.file_objects_post"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling FileObjectsApi.file_objects_post"
+      end
+      # resource path
+      local_var_path = '/file_objects'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Authorization'] = authorization
+      header_params[:'Content-Type'] = content_type
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = []
+      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,
+        :auth_names => auth_names,
+        :return_type => 'FileObjectOutput')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FileObjectsApi#file_objects_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/yousign_client/api/files_api.rb

@@ -0,0 +1,279 @@
+=begin
+#Yousign API Swagger
+
+#For your information, the Yousign API documentation is available at https://dev.yousign.com/
+
+OpenAPI spec version: 2.1
+Contact: support@yousign.fr
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module YousignClient
+  class FilesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Download a File
+    # Used to get the base64 content of a file
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def files_id_download_get(id, authorization, opts = {})
+      data, _status_code, _headers = files_id_download_get_with_http_info(id, authorization, opts)
+      data
+    end
+
+    # Download a File
+    # Used to get the base64 content of a file
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def files_id_download_get_with_http_info(id, authorization, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.files_id_download_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_download_get"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_download_get"
+      end
+      # resource path
+      local_var_path = '/files/{id}/download'.sub('{' + 'id' + '}', id.to_s)
+
+      # 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'])
+      header_params[:'Authorization'] = authorization
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      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,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#files_id_download_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Duplicate a File
+    # Duplicate a file. It will be create a clone of this file, with a new ID.
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param [Hash] opts the optional parameters
+    # @return [FileOutput]
+    def files_id_duplicate_post(id, authorization, content_type, opts = {})
+      data, _status_code, _headers = files_id_duplicate_post_with_http_info(id, authorization, content_type, opts)
+      data
+    end
+
+    # Duplicate a File
+    # Duplicate a file. It will be create a clone of this file, with a new ID.
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileOutput, Fixnum, Hash)>] FileOutput data, response status code and response headers
+    def files_id_duplicate_post_with_http_info(id, authorization, content_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.files_id_duplicate_post ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_duplicate_post"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_duplicate_post"
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling FilesApi.files_id_duplicate_post"
+      end
+      # resource path
+      local_var_path = '/files/{id}/duplicate'.sub('{' + 'id' + '}', id.to_s)
+
+      # 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'])
+      header_params[:'Authorization'] = authorization
+      header_params[:'Content-Type'] = content_type
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      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,
+        :auth_names => auth_names,
+        :return_type => 'FileOutput')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#files_id_duplicate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Find a File by ID
+    # Returns all the information regarding the File but without its content (for performance issue).
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [FileOutput]
+    def files_id_get(id, authorization, opts = {})
+      data, _status_code, _headers = files_id_get_with_http_info(id, authorization, opts)
+      data
+    end
+
+    # Find a File by ID
+    # Returns all the information regarding the File but without its content (for performance issue).
+    # @param id 
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileOutput, Fixnum, Hash)>] FileOutput data, response status code and response headers
+    def files_id_get_with_http_info(id, authorization, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.files_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_get"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_get"
+      end
+      # resource path
+      local_var_path = '/files/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # 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'])
+      header_params[:'Authorization'] = authorization
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      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,
+        :auth_names => auth_names,
+        :return_type => 'FileOutput')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#files_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Create a new File
+    # Used to upload a file in base64 on our platform
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [FileOutput]
+    def files_post(authorization, content_type, body, opts = {})
+      data, _status_code, _headers = files_post_with_http_info(authorization, content_type, body, opts)
+      data
+    end
+
+    # Create a new File
+    # Used to upload a file in base64 on our platform
+    # @param authorization Authentication credentials for HTTP authentication
+    # @param content_type The MIME type of the body of the request
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileOutput, Fixnum, Hash)>] FileOutput data, response status code and response headers
+    def files_post_with_http_info(authorization, content_type, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.files_post ...'
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_post"
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling FilesApi.files_post"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling FilesApi.files_post"
+      end
+      # resource path
+      local_var_path = '/files'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Authorization'] = authorization
+      header_params[:'Content-Type'] = content_type
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = []
+      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,
+        :auth_names => auth_names,
+        :return_type => 'FileOutput')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#files_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end