Class: DocuSign_eSign::AccountIdentityVerificationWorkflow

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/account_identity_verification_workflow.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountIdentityVerificationWorkflow

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 64

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?(:'defaultDescription')
    self.default_description = attributes[:'defaultDescription']
  end

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

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

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

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

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

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

Instance Attribute Details

#default_descriptionObject

Returns the value of attribute default_description


17
18
19
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 17

def default_description
  @default_description
end

#default_nameObject

Returns the value of attribute default_name


20
21
22
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 20

def default_name
  @default_name
end

#input_optionsObject

Returns the value of attribute input_options


23
24
25
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 23

def input_options
  @input_options
end

#signature_providerObject

Returns the value of attribute signature_provider


25
26
27
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 25

def signature_provider
  @signature_provider
end

#stepsObject

Returns the value of attribute steps


28
29
30
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 28

def steps
  @steps
end

#workflow_idObject

Returns the value of attribute workflow_id


31
32
33
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 31

def workflow_id
  @workflow_id
end

#workflow_resource_keyObject

Returns the value of attribute workflow_resource_key


34
35
36
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 34

def workflow_resource_key
  @workflow_resource_key
end

Class Method Details

.attribute_mapObject

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


37
38
39
40
41
42
43
44
45
46
47
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 37

def self.attribute_map
  {
    :'default_description' => :'defaultDescription',
    :'default_name' => :'defaultName',
    :'input_options' => :'inputOptions',
    :'signature_provider' => :'signatureProvider',
    :'steps' => :'steps',
    :'workflow_id' => :'workflowId',
    :'workflow_resource_key' => :'workflowResourceKey'
  }
end

.swagger_typesObject

Attribute type mapping.


50
51
52
53
54
55
56
57
58
59
60
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 50

def self.swagger_types
  {
    :'default_description' => :'String',
    :'default_name' => :'String',
    :'input_options' => :'Array<AccountIdentityInputOption>',
    :'signature_provider' => :'AccountSignatureProvider',
    :'steps' => :'Array<AccountIdentityVerificationStep>',
    :'workflow_id' => :'String',
    :'workflow_resource_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


118
119
120
121
122
123
124
125
126
127
128
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 118

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_description == o.default_description &&
      default_name == o.default_name &&
      input_options == o.input_options &&
      signature_provider == o.signature_provider &&
      steps == o.steps &&
      workflow_id == o.workflow_id &&
      workflow_resource_key == o.workflow_resource_key
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 166

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 = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 232

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 145

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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

132
133
134
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 132

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


138
139
140
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 138

def hash
  [default_description, default_name, input_options, signature_provider, steps, workflow_id, workflow_resource_key].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


105
106
107
108
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 105

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


212
213
214
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 212

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


218
219
220
221
222
223
224
225
226
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 218

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


206
207
208
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 206

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


112
113
114
# File 'lib/docusign_esign/models/account_identity_verification_workflow.rb', line 112

def valid?
  true
end