Class: YousignClient::MemberInput

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/models/member_input.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MemberInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/yousign_client/models/member_input.rb', line 109

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'signer'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#email ⇒ Object

Email of an external member. Required if user field is blank



30
31
32
 
# File 'lib/yousign_client/models/member_input.rb', line 30

def email
  @email
end

#file_objects ⇒ Object

Returns the value of attribute file_objects.



38
39
40
 
# File 'lib/yousign_client/models/member_input.rb', line 38

def file_objects
  @file_objects
end

#firstname ⇒ Object

Firstname of an external member. Required if user field is blank



24
25
26
 
# File 'lib/yousign_client/models/member_input.rb', line 24

def firstname
  @firstname
end

#lastname ⇒ Object

Lastname of an external member. Required if user field is blank



27
28
29
 
# File 'lib/yousign_client/models/member_input.rb', line 27

def lastname
  @lastname
end

#mode_sms_configuration ⇒ Object

Returns the value of attribute mode_sms_configuration.



47
48
49
 
# File 'lib/yousign_client/models/member_input.rb', line 47

def mode_sms_configuration
  @mode_sms_configuration
end

#operation_custom_modes ⇒ Object

Returns the value of attribute operation_custom_modes.



45
46
47
 
# File 'lib/yousign_client/models/member_input.rb', line 45

def operation_custom_modes
  @operation_custom_modes
end

#operation_level ⇒ Object

Returns the value of attribute operation_level.



43
44
45
 
# File 'lib/yousign_client/models/member_input.rb', line 43

def operation_level
  @operation_level
end

#phone ⇒ Object

Phone of an external member. Required if user field is blank



33
34
35
 
# File 'lib/yousign_client/models/member_input.rb', line 33

def phone
  @phone
end

#position ⇒ Object

If the procedure have the boolean "ordered" at true, you can define position of the order to invite your members to sign. Only the first member will be invited to sign. When the first member have signed, the second will be invited, etc…



36
37
38
 
# File 'lib/yousign_client/models/member_input.rb', line 36

def position
  @position
end

#procedure ⇒ Object

Procedure id reference



41
42
43
 
# File 'lib/yousign_client/models/member_input.rb', line 41

def procedure
  @procedure
end

#type ⇒ Object

Type of a member. "signer" to sign documents (legally) and "validator" to validate documents.



21
22
23
 
# File 'lib/yousign_client/models/member_input.rb', line 21

def type
  @type
end

#user ⇒ Object

ID of the user in your companies. Informations about the member will be duplicate (first name, last name, email and phone number). Required if none of fields above are specified.



18
19
20
 
# File 'lib/yousign_client/models/member_input.rb', line 18

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/yousign_client/models/member_input.rb', line 72

def self.attribute_map
  {
    :'user' => :'user',
    :'type' => :'type',
    :'firstname' => :'firstname',
    :'lastname' => :'lastname',
    :'email' => :'email',
    :'phone' => :'phone',
    :'position' => :'position',
    :'file_objects' => :'fileObjects',
    :'procedure' => :'procedure',
    :'operation_level' => :'operationLevel',
    :'operation_custom_modes' => :'operationCustomModes',
    :'mode_sms_configuration' => :'modeSmsConfiguration'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/yousign_client/models/member_input.rb', line 90

def self.swagger_types
  {
    :'user' => :'String',
    :'type' => :'String',
    :'firstname' => :'String',
    :'lastname' => :'String',
    :'email' => :'String',
    :'phone' => :'String',
    :'position' => :'Integer',
    :'file_objects' => :'Array<FileObjectInput>',
    :'procedure' => :'String',
    :'operation_level' => :'String',
    :'operation_custom_modes' => :'Array<String>',
    :'mode_sms_configuration' => :'ModeSmsConfiguration'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/yousign_client/models/member_input.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user == o.user &&
      type == o.type &&
      firstname == o.firstname &&
      lastname == o.lastname &&
      email == o.email &&
      phone == o.phone &&
      position == o.position &&
      file_objects == o.file_objects &&
      procedure == o.procedure &&
      operation_level == o.operation_level &&
      operation_custom_modes == o.operation_custom_modes &&
      mode_sms_configuration == o.mode_sms_configuration
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/yousign_client/models/member_input.rb', line 262

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/yousign_client/models/member_input.rb', line 328

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/yousign_client/models/member_input.rb', line 241

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


228
229
230
 
# File 'lib/yousign_client/models/member_input.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/yousign_client/models/member_input.rb', line 234

def hash
  [user, type, firstname, lastname, email, phone, position, file_objects, procedure, operation_level, operation_custom_modes, mode_sms_configuration].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



172
173
174
175
 
# File 'lib/yousign_client/models/member_input.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



308
309
310
 
# File 'lib/yousign_client/models/member_input.rb', line 308

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
 
# File 'lib/yousign_client/models/member_input.rb', line 314

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



302
303
304
 
# File 'lib/yousign_client/models/member_input.rb', line 302

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



179
180
181
182
183
184
185
 
# File 'lib/yousign_client/models/member_input.rb', line 179

def valid?
  type_validator = EnumAttributeValidator.new('String', ['signer', 'validator'])
  return false unless type_validator.valid?(@type)
  operation_level_validator = EnumAttributeValidator.new('String', ['none', 'custom', 'advanced'])
  return false unless operation_level_validator.valid?(@operation_level)
  true
end