yousign_client 1.0.0

data/lib/yousign_client/models/file_input_metadata.rb

@@ -0,0 +1,194 @@
+=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
+  # Metadata of the file
+  class FileInputMetadata
+    attr_accessor :key1
+
+    attr_accessor :key2
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'key1' => :'key1',
+        :'key2' => :'key2'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'key1' => :'String',
+        :'key2' => :'Integer'
+      }
+    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?(:'key1')
+        self.key1 = attributes[:'key1']
+      end
+
+      if attributes.has_key?(:'key2')
+        self.key2 = attributes[:'key2']
+      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
+      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?
+      true
+    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 &&
+          key1 == o.key1 &&
+          key2 == o.key2
+    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
+      [key1, key2].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/models/file_object_input.rb

@@ -0,0 +1,445 @@
+=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 FileObjectInput
+    # File id reference
+    attr_accessor :file
+
+    # Page of the visible signature. This property is ignored if fieldName is set.  If you want a visible signature, you must set page, position and fieldName.
+    attr_accessor :page
+
+    # Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr
+    attr_accessor :position
+
+    # [type=signature] Name of the signature field existing in the document, it will be not used on the signature image.
+    attr_accessor :field_name
+
+    # [type=signature] Text associated above the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature.
+    attr_accessor :mention
+
+    # [type=signature] Text associated below the signature image. (internal usage only, should not be used).  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature.
+    attr_accessor :mention2
+
+    # Member id reference
+    attr_accessor :member
+
+    # [type=signature] The reason they are signing the agreement
+    attr_accessor :reason
+
+    # The type of the file object
+    attr_accessor :type
+
+    # [type=text] Indicate if the member must fill or not the field
+    attr_accessor :content_required
+
+    # [type=text] The content of the field. Could be used for placeholder
+    attr_accessor :content
+
+    # [type=text] The font familly used to render the TextField. Currently only the default value will be used.
+    attr_accessor :font_family
+
+    # [type=text] The font size used to render the field. Currently only the default value will be used.
+    attr_accessor :font_size
+
+    # [type=text] The font color used to render the field.
+    attr_accessor :font_color
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'file' => :'file',
+        :'page' => :'page',
+        :'position' => :'position',
+        :'field_name' => :'fieldName',
+        :'mention' => :'mention',
+        :'mention2' => :'mention2',
+        :'member' => :'member',
+        :'reason' => :'reason',
+        :'type' => :'type',
+        :'content_required' => :'contentRequired',
+        :'content' => :'content',
+        :'font_family' => :'fontFamily',
+        :'font_size' => :'fontSize',
+        :'font_color' => :'fontColor'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'file' => :'String',
+        :'page' => :'Integer',
+        :'position' => :'String',
+        :'field_name' => :'String',
+        :'mention' => :'String',
+        :'mention2' => :'String',
+        :'member' => :'String',
+        :'reason' => :'String',
+        :'type' => :'String',
+        :'content_required' => :'BOOLEAN',
+        :'content' => :'String',
+        :'font_family' => :'String',
+        :'font_size' => :'Integer',
+        :'font_color' => :'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.has_key?(:'file')
+        self.file = attributes[:'file']
+      end
+
+      if attributes.has_key?(:'page')
+        self.page = attributes[:'page']
+      end
+
+      if attributes.has_key?(:'position')
+        self.position = attributes[:'position']
+      end
+
+      if attributes.has_key?(:'fieldName')
+        self.field_name = attributes[:'fieldName']
+      end
+
+      if attributes.has_key?(:'mention')
+        self.mention = attributes[:'mention']
+      end
+
+      if attributes.has_key?(:'mention2')
+        self.mention2 = attributes[:'mention2']
+      end
+
+      if attributes.has_key?(:'member')
+        self.member = attributes[:'member']
+      end
+
+      if attributes.has_key?(:'reason')
+        self.reason = attributes[:'reason']
+      else
+        self.reason = 'Signed by Yousign'
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'signature'
+      end
+
+      if attributes.has_key?(:'contentRequired')
+        self.content_required = attributes[:'contentRequired']
+      else
+        self.content_required = false
+      end
+
+      if attributes.has_key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.has_key?(:'fontFamily')
+        self.font_family = attributes[:'fontFamily']
+      else
+        self.font_family = 'raleway'
+      end
+
+      if attributes.has_key?(:'fontSize')
+        self.font_size = attributes[:'fontSize']
+      else
+        self.font_size = 12
+      end
+
+      if attributes.has_key?(:'fontColor')
+        self.font_color = attributes[:'fontColor']
+      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 @file.nil?
+        invalid_properties.push('invalid value for "file", file cannot be nil.')
+      end
+
+      if !@position.nil? && @position !~ Regexp.new(/^\\d+(,\\d+){3}$/)
+        invalid_properties.push('invalid value for "position", must conform to the pattern /^\\d+(,\\d+){3}$/.')
+      end
+
+      if !@content.nil? && @content.to_s.length > 255
+        invalid_properties.push('invalid value for "content", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@font_size.nil? && @font_size > 20
+        invalid_properties.push('invalid value for "font_size", must be smaller than or equal to 20.')
+      end
+
+      if !@font_size.nil? && @font_size < 6
+        invalid_properties.push('invalid value for "font_size", must be greater than or equal to 6.')
+      end
+
+      if !@font_color.nil? && @font_color !~ Regexp.new(/^(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d)$/)
+        invalid_properties.push('invalid value for "font_color", must conform to the pattern /^(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d)$/.')
+      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 @file.nil?
+      return false if !@position.nil? && @position !~ Regexp.new(/^\\d+(,\\d+){3}$/)
+      type_validator = EnumAttributeValidator.new('String', ['signature', 'text'])
+      return false unless type_validator.valid?(@type)
+      return false if !@content.nil? && @content.to_s.length > 255
+      font_family_validator = EnumAttributeValidator.new('String', ['raleway'])
+      return false unless font_family_validator.valid?(@font_family)
+      return false if !@font_size.nil? && @font_size > 20
+      return false if !@font_size.nil? && @font_size < 6
+      return false if !@font_color.nil? && @font_color !~ Regexp.new(/^(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d)$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] position Value to be assigned
+    def position=(position)
+      if !position.nil? && position !~ Regexp.new(/^\\d+(,\\d+){3}$/)
+        fail ArgumentError, 'invalid value for "position", must conform to the pattern /^\\d+(,\\d+){3}$/.'
+      end
+
+      @position = position
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ['signature', 'text'])
+      unless validator.valid?(type)
+        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content Value to be assigned
+    def content=(content)
+      if !content.nil? && content.to_s.length > 255
+        fail ArgumentError, 'invalid value for "content", the character length must be smaller than or equal to 255.'
+      end
+
+      @content = content
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] font_family Object to be assigned
+    def font_family=(font_family)
+      validator = EnumAttributeValidator.new('String', ['raleway'])
+      unless validator.valid?(font_family)
+        fail ArgumentError, 'invalid value for "font_family", must be one of #{validator.allowable_values}.'
+      end
+      @font_family = font_family
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] font_size Value to be assigned
+    def font_size=(font_size)
+      if !font_size.nil? && font_size > 20
+        fail ArgumentError, 'invalid value for "font_size", must be smaller than or equal to 20.'
+      end
+
+      if !font_size.nil? && font_size < 6
+        fail ArgumentError, 'invalid value for "font_size", must be greater than or equal to 6.'
+      end
+
+      @font_size = font_size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] font_color Value to be assigned
+    def font_color=(font_color)
+      if !font_color.nil? && font_color !~ Regexp.new(/^(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d)$/)
+        fail ArgumentError, 'invalid value for "font_color", must conform to the pattern /^(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d),(0|255|25[0-4]|2[0-4]\\d|1\\d\\d|0?\\d?\\d)$/.'
+      end
+
+      @font_color = font_color
+    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 &&
+          file == o.file &&
+          page == o.page &&
+          position == o.position &&
+          field_name == o.field_name &&
+          mention == o.mention &&
+          mention2 == o.mention2 &&
+          member == o.member &&
+          reason == o.reason &&
+          type == o.type &&
+          content_required == o.content_required &&
+          content == o.content &&
+          font_family == o.font_family &&
+          font_size == o.font_size &&
+          font_color == o.font_color
+    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
+      [file, page, position, field_name, mention, mention2, member, reason, type, content_required, content, font_family, font_size, font_color].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