yousign_client 1.0.0

data/lib/yousign_client/models/workspace_output.rb

@@ -0,0 +1,275 @@
+=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 'date'
+
+module YousignClient
+  class WorkspaceOutput
+    # Object's ID
+    attr_accessor :id
+
+    # Workspace name
+    attr_accessor :name
+
+    attr_accessor :config
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :email_procedure_from_name
+
+    attr_accessor :contact_field_visibility
+
+    attr_accessor :slug
+
+    attr_accessor :has_custom_logo
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'config' => :'config',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'email_procedure_from_name' => :'emailProcedureFromName',
+        :'contact_field_visibility' => :'contactFieldVisibility',
+        :'slug' => :'slug',
+        :'has_custom_logo' => :'hasCustomLogo'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'config' => :'WorkspaceConfig',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'email_procedure_from_name' => :'String',
+        :'contact_field_visibility' => :'Array<String>',
+        :'slug' => :'String',
+        :'has_custom_logo' => :'BOOLEAN'
+      }
+    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.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
+      end
+
+      if attributes.has_key?(:'emailProcedureFromName')
+        self.email_procedure_from_name = attributes[:'emailProcedureFromName']
+      end
+
+      if attributes.has_key?(:'contactFieldVisibility')
+        if (value = attributes[:'contactFieldVisibility']).is_a?(Array)
+          self.contact_field_visibility = value
+        end
+      end
+
+      if attributes.has_key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
+      if attributes.has_key?(:'hasCustomLogo')
+        self.has_custom_logo = attributes[:'hasCustomLogo']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@id.nil? && @id !~ Regexp.new(/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
+        invalid_properties.push('invalid value for "id", must conform to the pattern /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.')
+      end
+
+      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 false if !@id.nil? && @id !~ Regexp.new(/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if !id.nil? && id !~ Regexp.new(/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
+        fail ArgumentError, 'invalid value for "id", must conform to the pattern /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.'
+      end
+
+      @id = id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          config == o.config &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          email_procedure_from_name == o.email_procedure_from_name &&
+          contact_field_visibility == o.contact_field_visibility &&
+          slug == o.slug &&
+          has_custom_logo == o.has_custom_logo
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, name, config, created_at, updated_at, email_procedure_from_name, contact_field_visibility, slug, has_custom_logo].hash
+    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|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        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
+        DateTime.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 = YousignClient.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

data/lib/yousign_client/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module YousignClient
+  VERSION = '1.0.0'
+end

data/spec/api/authentications_api_spec.rb

@@ -0,0 +1,113 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for YousignClient::AuthenticationsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AuthenticationsApi' do
+  before do
+    # run before each test
+    @instance = YousignClient::AuthenticationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthenticationsApi' do
+    it 'should create an instance of AuthenticationsApi' do
+      expect(@instance).to be_instance_of(YousignClient::AuthenticationsApi)
+    end
+  end
+
+  # unit tests for authentications_email_id_get
+  # Find an Authentication by ID
+  # @param id 
+  # @param authorization Authentication credentials for HTTP authentication
+  # @param [Hash] opts the optional parameters
+  # @return [AuthenticationEmailOutput]
+  describe 'authentications_email_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for authentications_email_id_put
+  # Update an Email Authentication
+  # @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 [AuthenticationEmailOutput]
+  describe 'authentications_email_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for authentications_inwebo_id_get
+  # Get an Authentication
+  # @param id 
+  # @param authorization Authentication credentials for HTTP authentication
+  # @param [Hash] opts the optional parameters
+  # @return [AuthenticationInweboOutput]
+  describe 'authentications_inwebo_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for authentications_inwebo_id_put
+  # Update an inwebo Authentication
+  # @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 [AuthenticationInweboOutput]
+  describe 'authentications_inwebo_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for authentications_sms_id_get
+  # Find an Authentication by ID
+  # @param id 
+  # @param authorization Authentication credentials for HTTP authentication
+  # @param [Hash] opts the optional parameters
+  # @return [AuthenticationSmsOutput]
+  describe 'authentications_sms_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for authentications_sms_id_put
+  # Update an SMS Authentication
+  # @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 [AuthenticationSmsOutput]
+  describe 'authentications_sms_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/check_documents_api_spec.rb

@@ -0,0 +1,85 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for YousignClient::CheckDocumentsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CheckDocumentsApi' do
+  before do
+    # run before each test
+    @instance = YousignClient::CheckDocumentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CheckDocumentsApi' do
+    it 'should create an instance of CheckDocumentsApi' do
+      expect(@instance).to be_instance_of(YousignClient::CheckDocumentsApi)
+    end
+  end
+
+  # unit tests for check_document_bank_accounts_id_get
+  # Get informations about a bank document (RIB)
+  # @param id 
+  # @param authorization Authentication credentials for HTTP authentication
+  # @param [Hash] opts the optional parameters
+  # @return [CheckDocumentBankAccountsOutput]
+  describe 'check_document_bank_accounts_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for check_document_bank_accounts_post
+  # Verify a bank document (RIB)
+  # @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 [CheckDocumentBankAccountsOutput]
+  describe 'check_document_bank_accounts_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for check_document_identities_id_get
+  # Get informations about an identity document (passport, id cards)
+  # @param id 
+  # @param authorization Authentication credentials for HTTP authentication
+  # @param [Hash] opts the optional parameters
+  # @return [CheckDocumentIdentitiesOutput]
+  describe 'check_document_identities_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for check_document_identities_post
+  # Verify an identity document (passport, id cards)
+  # @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 [CheckDocumentIdentitiesOutput]
+  describe 'check_document_identities_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end