class YousignClient::ProcedureInput

Attributes

archive[RW]

Defines if the files of the procedure must be archived (Organization should be allowed)

config[RW]
description[RW]

Description of procedure

expires_at[RW]

Expiration date. The procedure will be out of usage after this date.

members[RW]

List of members, REQUIRED if start field is true.

metadata[RW]
name[RW]

Name of procedure

ordered[RW]

Defines an order for the procedure process. If true, position of each member will be used to define the validation workflow.

start[RW]

Defines if the procedure has been started. If false, the procedure status will be draft.

template[RW]

Defines if the procedure is a template (if true). A template could be used by a procedure to get all properties of the template. Check parent parameter for more information.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/yousign_client/models/procedure_input.rb, line 49
def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'expires_at' => :'expiresAt',
    :'template' => :'template',
    :'ordered' => :'ordered',
    :'metadata' => :'metadata',
    :'config' => :'config',
    :'members' => :'members',
    :'start' => :'start',
    :'related_files_enable' => :'relatedFilesEnable',
    :'archive' => :'archive'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/yousign_client/models/procedure_input.rb, line 84
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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'expiresAt')
    self.expires_at = attributes[:'expiresAt']
  end

  if attributes.has_key?(:'template')
    self.template = attributes[:'template']
  end

  if attributes.has_key?(:'ordered')
    self.ordered = attributes[:'ordered']
  end

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.has_key?(:'config')
    self.config = attributes[:'config']
  end

  if attributes.has_key?(:'members')
    if (value = attributes[:'members']).is_a?(Array)
      self.members = value
    end
  end

  if attributes.has_key?(:'start')
    self.start = attributes[:'start']
  else
    self.start = true
  end

  if attributes.has_key?(:'relatedFilesEnable')
    self.related_files_enable = attributes[:'relatedFilesEnable']
  end

  if attributes.has_key?(:'archive')
    self.archive = attributes[:'archive']
  else
    self.archive = false
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/yousign_client/models/procedure_input.rb, line 66
def self.swagger_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'expires_at' => :'Date',
    :'template' => :'BOOLEAN',
    :'ordered' => :'BOOLEAN',
    :'metadata' => :'ProcedureInputMetadata',
    :'config' => :'ProcedureConfig',
    :'members' => :'Array<MemberInput>',
    :'start' => :'BOOLEAN',
    :'related_files_enable' => :'BOOLEAN',
    :'archive' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/yousign_client/models/procedure_input.rb, line 156
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      expires_at == o.expires_at &&
      template == o.template &&
      ordered == o.ordered &&
      metadata == o.metadata &&
      config == o.config &&
      members == o.members &&
      start == o.start &&
      related_files_enable == o.related_files_enable &&
      archive == o.archive
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/yousign_client/models/procedure_input.rb, line 208
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
_to_hash(value) click to toggle source

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

# File lib/yousign_client/models/procedure_input.rb, line 274
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/yousign_client/models/procedure_input.rb, line 187
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/yousign_client/models/procedure_input.rb, line 174
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/yousign_client/models/procedure_input.rb, line 180
def hash
  [name, description, expires_at, template, ordered, metadata, config, members, start, related_files_enable, archive].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/yousign_client/models/procedure_input.rb, line 143
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/yousign_client/models/procedure_input.rb, line 254
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/yousign_client/models/procedure_input.rb, line 260
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/yousign_client/models/procedure_input.rb, line 248
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/yousign_client/models/procedure_input.rb, line 150
def valid?
  true
end