Class: YousignClient::MemberOutput

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MemberOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
203
204
205
206
207
208
209
210
 
# File 'lib/yousign_client/models/member_output.rb', line 131

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

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

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

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

  if attributes.has_key?(:'comment')
    self.comment = attributes[:'comment']
  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

#comment ⇒ Object

Comment of a member when he refuses a signature



50
51
52
 
# File 'lib/yousign_client/models/member_output.rb', line 50

def comment
  @comment
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#email ⇒ Object

Email of an external member.



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

def email
  @email
end

#file_objects ⇒ Object

Returns the value of attribute file_objects.



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

def file_objects
  @file_objects
end

#firstname ⇒ Object

Firstname of an external member.



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

def firstname
  @firstname
end

#id ⇒ Object

Id of the object



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

def id
  @id
end

#lastname ⇒ Object

Lastname of an external member.



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

def lastname
  @lastname
end

#mode_sms_configuration ⇒ Object

Returns the value of attribute mode_sms_configuration.



59
60
61
 
# File 'lib/yousign_client/models/member_output.rb', line 59

def mode_sms_configuration
  @mode_sms_configuration
end

#operation_custom_modes ⇒ Object

Returns the value of attribute operation_custom_modes.



57
58
59
 
# File 'lib/yousign_client/models/member_output.rb', line 57

def operation_custom_modes
  @operation_custom_modes
end

#operation_level ⇒ Object

Returns the value of attribute operation_level.



55
56
57
 
# File 'lib/yousign_client/models/member_output.rb', line 55

def operation_level
  @operation_level
end

#phone ⇒ Object

Phone of an external member.



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

def phone
  @phone
end

#position ⇒ Object

Position of the member if ordered is set to true. Example with two members, the first one could have a position set to 1, the second one set to 2. In this case, when the procedure starts, only the first member will be notified and could validate the documents. The second one could not validate the documents, he will be notified when the first signer is notified.



39
40
41
 
# File 'lib/yousign_client/models/member_output.rb', line 39

def position
  @position
end

#procedure ⇒ Object

Procedure id reference



53
54
55
 
# File 'lib/yousign_client/models/member_output.rb', line 53

def procedure
  @procedure
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#type ⇒ Object

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



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

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#user ⇒ Object

Internal user associated with the member. In this case, informations about the member will be informations of the user (first name, last name, phone number and email).



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/yousign_client/models/member_output.rb', line 84

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

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/yousign_client/models/member_output.rb', line 107

def self.swagger_types
  {
    :'id' => :'String',
    :'user' => :'String',
    :'type' => :'String',
    :'firstname' => :'String',
    :'lastname' => :'String',
    :'email' => :'String',
    :'phone' => :'String',
    :'position' => :'Integer',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'status' => :'String',
    :'file_objects' => :'Array<FileObjectOutput>',
    :'comment' => :'String',
    :'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



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_output.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user == o.user &&
      type == o.type &&
      firstname == o.firstname &&
      lastname == o.lastname &&
      email == o.email &&
      phone == o.phone &&
      position == o.position &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      status == o.status &&
      file_objects == o.file_objects &&
      comment == o.comment &&
      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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/yousign_client/models/member_output.rb', line 336

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/yousign_client/models/member_output.rb', line 402

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/yousign_client/models/member_output.rb', line 315

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, user, type, firstname, lastname, email, phone, position, created_at, updated_at, status, file_objects, comment, 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



214
215
216
217
218
219
220
221
 
# File 'lib/yousign_client/models/member_output.rb', line 214

def list_invalid_properties
  invalid_properties = Array.new
  if !@user.nil? && @user !~ Regexp.new(/^\/users\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
    invalid_properties.push('invalid value for "user", must conform to the pattern /^\/users\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.')
  end

  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



382
383
384
 
# File 'lib/yousign_client/models/member_output.rb', line 382

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



388
389
390
391
392
393
394
395
396
 
# File 'lib/yousign_client/models/member_output.rb', line 388

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



376
377
378
 
# File 'lib/yousign_client/models/member_output.rb', line 376

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



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/yousign_client/models/member_output.rb', line 225

def valid?
  return false if !@user.nil? && @user !~ Regexp.new(/^\/users\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
  type_validator = EnumAttributeValidator.new('String', ['signer', 'validator'])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ['pending', 'processing', 'done', 'refused'])
  return false unless status_validator.valid?(@status)
  operation_level_validator = EnumAttributeValidator.new('String', ['none', 'custom', 'advanced'])
  return false unless operation_level_validator.valid?(@operation_level)
  true
end