Class: YousignClient::OrganizationOutput

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrganizationOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/yousign_client/models/organization_output.rb', line 199

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_collection ⇒ Object

Internal usage, should not be used



44
45
46
 
# File 'lib/yousign_client/models/organization_output.rb', line 44

def auto_collection
  @auto_collection
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



49
50
51
 
# File 'lib/yousign_client/models/organization_output.rb', line 49

def billing_address
  @billing_address
end

#created_at ⇒ Object

Created date of the object



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

def created_at
  @created_at
end

#f_api ⇒ Object

Internal usage, should not be used



73
74
75
 
# File 'lib/yousign_client/models/organization_output.rb', line 73

def f_api
  @f_api
end

#f_archive ⇒ Object

Internal usage, should not be used



61
62
63
 
# File 'lib/yousign_client/models/organization_output.rb', line 61

def f_archive
  @f_archive
end

#f_checkdocument ⇒ Object

Internal usage, should not be used



76
77
78
 
# File 'lib/yousign_client/models/organization_output.rb', line 76

def f_checkdocument
  @f_checkdocument
end

#f_consent_process ⇒ Object

Internal usage, should not be used



91
92
93
 
# File 'lib/yousign_client/models/organization_output.rb', line 91

def f_consent_process
  @f_consent_process
end

#f_dynamic_fields ⇒ Object

Internal usage, should not be used



100
101
102
 
# File 'lib/yousign_client/models/organization_output.rb', line 100

def f_dynamic_fields
  @f_dynamic_fields
end

#f_operation_custom_mode_email ⇒ Object

Internal usage, should not be used



97
98
99
 
# File 'lib/yousign_client/models/organization_output.rb', line 97

def f_operation_custom_mode_email
  @f_operation_custom_mode_email
end

#f_operation_level_advanced ⇒ Object

Internal usage, should not be used



94
95
96
 
# File 'lib/yousign_client/models/organization_output.rb', line 94

def f_operation_level_advanced
  @f_operation_level_advanced
end

#f_operation_level_none ⇒ Object

Internal usage, should not be used



88
89
90
 
# File 'lib/yousign_client/models/organization_output.rb', line 88

def f_operation_level_none
  @f_operation_level_none
end

#f_procedure_create ⇒ Object

Internal usage, should not be used



79
80
81
 
# File 'lib/yousign_client/models/organization_output.rb', line 79

def f_procedure_create
  @f_procedure_create
end

#f_procedure_reminder_auto ⇒ Object

Internal usage, should not be used



70
71
72
 
# File 'lib/yousign_client/models/organization_output.rb', line 70

def f_procedure_reminder_auto
  @f_procedure_reminder_auto
end

#f_procedure_template ⇒ Object

Internal usage, should not be used



67
68
69
 
# File 'lib/yousign_client/models/organization_output.rb', line 67

def f_procedure_template
  @f_procedure_template
end

#f_procedure_template_permissions ⇒ Object

Internal usage, should not be used



115
116
117
 
# File 'lib/yousign_client/models/organization_output.rb', line 115

def f_procedure_template_permissions
  @f_procedure_template_permissions
end

#f_server_stamp ⇒ Object

Internal usage, should not be used



85
86
87
 
# File 'lib/yousign_client/models/organization_output.rb', line 85

def f_server_stamp
  @f_server_stamp
end

#f_signature_ui ⇒ Object

Internal usage, should not be used



82
83
84
 
# File 'lib/yousign_client/models/organization_output.rb', line 82

def f_signature_ui
  @f_signature_ui
end

#f_sso ⇒ Object

Internal usage, should not be used



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

def f_sso
  @f_sso
end

#f_user_permissions ⇒ Object

Internal usage, should not be used



64
65
66
 
# File 'lib/yousign_client/models/organization_output.rb', line 64

def f_user_permissions
  @f_user_permissions
end

#file_template ⇒ Object

Internal usage, should not be used



58
59
60
 
# File 'lib/yousign_client/models/organization_output.rb', line 58

def file_template
  @file_template
end

#id ⇒ Object

Organization ID



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

def id
  @id
end

#in_app_support ⇒ Object

Internal usage, should not be used



52
53
54
 
# File 'lib/yousign_client/models/organization_output.rb', line 52

def in_app_support
  @in_app_support
end

#in_app_updates ⇒ Object

Internal usage, should not be used



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

def in_app_updates
  @in_app_updates
end

#max_users ⇒ Object

Internal usage, should not be used



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

def max_users
  @max_users
end

#name ⇒ Object

Organization name



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

def name
  @name
end

#password_policy_description ⇒ Object

Description for the password policy



109
110
111
 
# File 'lib/yousign_client/models/organization_output.rb', line 109

def password_policy_description
  @password_policy_description
end

#password_policy_pattern ⇒ Object

Pattern of the password policy for the organization



106
107
108
 
# File 'lib/yousign_client/models/organization_output.rb', line 106

def password_policy_pattern
  @password_policy_pattern
end

#procedure_related_files_enable ⇒ Object

Defined if the organization anable the related files



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

def procedure_related_files_enable
  @procedure_related_files_enable
end

#saml_identity_provider ⇒ Object

Internal usage, should not be used



103
104
105
 
# File 'lib/yousign_client/models/organization_output.rb', line 103

def saml_identity_provider
  @saml_identity_provider
end

#subscriptions ⇒ Object

Returns the value of attribute subscriptions.



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

def subscriptions
  @subscriptions
end

#updated_at ⇒ Object

Updated date of the object



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

def updated_at
  @updated_at
end

#url ⇒ Object

Custom URL for the Organization (internal usage only, should not be used)



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

def url
  @url
end

#user_activation ⇒ Object

Internal usage, should not be used



112
113
114
 
# File 'lib/yousign_client/models/organization_output.rb', line 112

def user_activation
  @user_activation
end

#vat_number ⇒ Object

Internal usage, should not be used



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

def vat_number
  @vat_number
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/yousign_client/models/organization_output.rb', line 118

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'url' => :'url',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'f_sso' => :'fSso',
    :'max_users' => :'maxUsers',
    :'procedure_related_files_enable' => :'procedureRelatedFilesEnable',
    :'subscriptions' => :'subscriptions',
    :'auto_collection' => :'autoCollection',
    :'vat_number' => :'vatNumber',
    :'billing_address' => :'billingAddress',
    :'in_app_support' => :'inAppSupport',
    :'in_app_updates' => :'inAppUpdates',
    :'file_template' => :'fileTemplate',
    :'f_archive' => :'fArchive',
    :'f_user_permissions' => :'fUserPermissions',
    :'f_procedure_template' => :'fProcedureTemplate',
    :'f_procedure_reminder_auto' => :'fProcedureReminderAuto',
    :'f_api' => :'fApi',
    :'f_checkdocument' => :'fCheckdocument',
    :'f_procedure_create' => :'fProcedureCreate',
    :'f_signature_ui' => :'fSignatureUi',
    :'f_server_stamp' => :'fServerStamp',
    :'f_operation_level_none' => :'fOperationLevelNone',
    :'f_consent_process' => :'fConsentProcess',
    :'f_operation_level_advanced' => :'fOperationLevelAdvanced',
    :'f_operation_custom_mode_email' => :'fOperationCustomModeEmail',
    :'f_dynamic_fields' => :'fDynamicFields',
    :'saml_identity_provider' => :'samlIdentityProvider',
    :'password_policy_pattern' => :'passwordPolicyPattern',
    :'password_policy_description' => :'passwordPolicyDescription',
    :'user_activation' => :'userActivation',
    :'f_procedure_template_permissions' => :'fProcedureTemplatePermissions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/yousign_client/models/organization_output.rb', line 158

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'url' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'f_sso' => :'BOOLEAN',
    :'max_users' => :'Float',
    :'procedure_related_files_enable' => :'BOOLEAN',
    :'subscriptions' => :'Array<String>',
    :'auto_collection' => :'BOOLEAN',
    :'vat_number' => :'String',
    :'billing_address' => :'OrganizationBillingAddress',
    :'in_app_support' => :'BOOLEAN',
    :'in_app_updates' => :'String',
    :'file_template' => :'BOOLEAN',
    :'f_archive' => :'BOOLEAN',
    :'f_user_permissions' => :'BOOLEAN',
    :'f_procedure_template' => :'BOOLEAN',
    :'f_procedure_reminder_auto' => :'BOOLEAN',
    :'f_api' => :'BOOLEAN',
    :'f_checkdocument' => :'BOOLEAN',
    :'f_procedure_create' => :'BOOLEAN',
    :'f_signature_ui' => :'BOOLEAN',
    :'f_server_stamp' => :'BOOLEAN',
    :'f_operation_level_none' => :'BOOLEAN',
    :'f_consent_process' => :'BOOLEAN',
    :'f_operation_level_advanced' => :'BOOLEAN',
    :'f_operation_custom_mode_email' => :'BOOLEAN',
    :'f_dynamic_fields' => :'BOOLEAN',
    :'saml_identity_provider' => :'String',
    :'password_policy_pattern' => :'String',
    :'password_policy_description' => :'String',
    :'user_activation' => :'BOOLEAN',
    :'f_procedure_template_permissions' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/yousign_client/models/organization_output.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      url == o.url &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      f_sso == o.f_sso &&
      max_users == o.max_users &&
      procedure_related_files_enable == o.procedure_related_files_enable &&
      subscriptions == o.subscriptions &&
      auto_collection == o.auto_collection &&
      vat_number == o.vat_number &&
      billing_address == o.billing_address &&
      in_app_support == o.in_app_support &&
      in_app_updates == o.in_app_updates &&
      file_template == o.file_template &&
      f_archive == o.f_archive &&
      f_user_permissions == o.f_user_permissions &&
      f_procedure_template == o.f_procedure_template &&
      f_procedure_reminder_auto == o.f_procedure_reminder_auto &&
      f_api == o.f_api &&
      f_checkdocument == o.f_checkdocument &&
      f_procedure_create == o.f_procedure_create &&
      f_signature_ui == o.f_signature_ui &&
      f_server_stamp == o.f_server_stamp &&
      f_operation_level_none == o.f_operation_level_none &&
      f_consent_process == o.f_consent_process &&
      f_operation_level_advanced == o.f_operation_level_advanced &&
      f_operation_custom_mode_email == o.f_operation_custom_mode_email &&
      f_dynamic_fields == o.f_dynamic_fields &&
      saml_identity_provider == o.saml_identity_provider &&
      password_policy_pattern == o.password_policy_pattern &&
      password_policy_description == o.password_policy_description &&
      user_activation == o.user_activation &&
      f_procedure_template_permissions == o.f_procedure_template_permissions
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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/yousign_client/models/organization_output.rb', line 434

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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/yousign_client/models/organization_output.rb', line 500

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/yousign_client/models/organization_output.rb', line 413

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


400
401
402
 
# File 'lib/yousign_client/models/organization_output.rb', line 400

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



406
407
408
 
# File 'lib/yousign_client/models/organization_output.rb', line 406

def hash
  [id, name, url, created_at, updated_at, f_sso, max_users, procedure_related_files_enable, subscriptions, auto_collection, vat_number, billing_address, in_app_support, in_app_updates, file_template, f_archive, f_user_permissions, f_procedure_template, f_procedure_reminder_auto, f_api, f_checkdocument, f_procedure_create, f_signature_ui, f_server_stamp, f_operation_level_none, f_consent_process, f_operation_level_advanced, f_operation_custom_mode_email, f_dynamic_fields, saml_identity_provider, password_policy_pattern, password_policy_description, user_activation, f_procedure_template_permissions].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



346
347
348
349
 
# File 'lib/yousign_client/models/organization_output.rb', line 346

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



480
481
482
 
# File 'lib/yousign_client/models/organization_output.rb', line 480

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



486
487
488
489
490
491
492
493
494
 
# File 'lib/yousign_client/models/organization_output.rb', line 486

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



474
475
476
 
# File 'lib/yousign_client/models/organization_output.rb', line 474

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



353
354
355
 
# File 'lib/yousign_client/models/organization_output.rb', line 353

def valid?
  true
end