Class: DocuSign_eSign::AccountUISettings

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountUISettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 138

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#admin_messageObject

Returns the value of attribute admin_message


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

def admin_message
  @admin_message
end

#ask_an_adminObject

Returns the value of attribute ask_an_admin


19
20
21
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 19

def ask_an_admin
  @ask_an_admin
end

#enable_admin_messageObject

Returns the value of attribute enable_admin_message


22
23
24
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 22

def enable_admin_message
  @enable_admin_message
end

#enable_admin_message_metadataObject

Returns the value of attribute enable_admin_message_metadata


24
25
26
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 24

def 
  @enable_admin_message_metadata
end

#enable_easy_sign_can_use_multi_template_applyObject

Returns the value of attribute enable_easy_sign_can_use_multi_template_apply


27
28
29
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 27

def enable_easy_sign_can_use_multi_template_apply
  @enable_easy_sign_can_use_multi_template_apply
end

#enable_easy_sign_can_use_multi_template_apply_metadataObject

Returns the value of attribute enable_easy_sign_can_use_multi_template_apply_metadata


29
30
31
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 29

def 
  @enable_easy_sign_can_use_multi_template_apply_metadata
end

#enable_easy_sign_template_uploadObject

Returns the value of attribute enable_easy_sign_template_upload


32
33
34
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 32

def enable_easy_sign_template_upload
  @enable_easy_sign_template_upload
end

#enable_easy_sign_template_upload_metadataObject

Returns the value of attribute enable_easy_sign_template_upload_metadata


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

def 
  @enable_easy_sign_template_upload_metadata
end

#enable_envelope_copy_with_dataObject

Returns the value of attribute enable_envelope_copy_with_data


37
38
39
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 37

def enable_envelope_copy_with_data
  @enable_envelope_copy_with_data
end

#enable_envelope_copy_with_data_metadataObject

Returns the value of attribute enable_envelope_copy_with_data_metadata


39
40
41
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 39

def 
  @enable_envelope_copy_with_data_metadata
end

#hide_send_an_envelopeObject

Returns the value of attribute hide_send_an_envelope


42
43
44
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 42

def hide_send_an_envelope
  @hide_send_an_envelope
end

#hide_send_an_envelope_metadataObject

Returns the value of attribute hide_send_an_envelope_metadata


44
45
46
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 44

def 
  @hide_send_an_envelope_metadata
end

#hide_use_a_templateObject

Returns the value of attribute hide_use_a_template


47
48
49
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 47

def hide_use_a_template
  @hide_use_a_template
end

#hide_use_a_template_in_prepareObject

Returns the value of attribute hide_use_a_template_in_prepare


50
51
52
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 50

def hide_use_a_template_in_prepare
  @hide_use_a_template_in_prepare
end

#hide_use_a_template_in_prepare_metadataObject

Returns the value of attribute hide_use_a_template_in_prepare_metadata


52
53
54
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 52

def 
  @hide_use_a_template_in_prepare_metadata
end

#hide_use_a_template_metadataObject

Returns the value of attribute hide_use_a_template_metadata


54
55
56
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 54

def 
  @hide_use_a_template_metadata
end

#order_based_recipient_id_generationObject

Returns the value of attribute order_based_recipient_id_generation


57
58
59
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 57

def order_based_recipient_id_generation
  @order_based_recipient_id_generation
end

#order_based_recipient_id_generation_metadataObject

Returns the value of attribute order_based_recipient_id_generation_metadata


59
60
61
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 59

def 
  @order_based_recipient_id_generation_metadata
end

#remove_envelope_forwardingObject

Returns the value of attribute remove_envelope_forwarding


62
63
64
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 62

def remove_envelope_forwarding
  @remove_envelope_forwarding
end

#remove_envelope_forwarding_metadataObject

Returns the value of attribute remove_envelope_forwarding_metadata


64
65
66
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 64

def 
  @remove_envelope_forwarding_metadata
end

#should_redact_access_codeObject

Returns the value of attribute should_redact_access_code


67
68
69
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 67

def should_redact_access_code
  @should_redact_access_code
end

#should_redact_access_code_metadataObject

Returns the value of attribute should_redact_access_code_metadata


69
70
71
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 69

def 
  @should_redact_access_code_metadata
end

#upload_new_image_to_sign_or_initialObject

Returns the value of attribute upload_new_image_to_sign_or_initial


72
73
74
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 72

def upload_new_image_to_sign_or_initial
  @upload_new_image_to_sign_or_initial
end

#upload_new_image_to_sign_or_initial_metadataObject

Returns the value of attribute upload_new_image_to_sign_or_initial_metadata


74
75
76
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 74

def 
  @upload_new_image_to_sign_or_initial_metadata
end

Class Method Details

.attribute_mapObject

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


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
102
103
104
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 77

def self.attribute_map
  {
    :'admin_message' => :'adminMessage',
    :'ask_an_admin' => :'askAnAdmin',
    :'enable_admin_message' => :'enableAdminMessage',
    :'enable_admin_message_metadata' => :'enableAdminMessageMetadata',
    :'enable_easy_sign_can_use_multi_template_apply' => :'enableEasySignCanUseMultiTemplateApply',
    :'enable_easy_sign_can_use_multi_template_apply_metadata' => :'enableEasySignCanUseMultiTemplateApplyMetadata',
    :'enable_easy_sign_template_upload' => :'enableEasySignTemplateUpload',
    :'enable_easy_sign_template_upload_metadata' => :'enableEasySignTemplateUploadMetadata',
    :'enable_envelope_copy_with_data' => :'enableEnvelopeCopyWithData',
    :'enable_envelope_copy_with_data_metadata' => :'enableEnvelopeCopyWithDataMetadata',
    :'hide_send_an_envelope' => :'hideSendAnEnvelope',
    :'hide_send_an_envelope_metadata' => :'hideSendAnEnvelopeMetadata',
    :'hide_use_a_template' => :'hideUseATemplate',
    :'hide_use_a_template_in_prepare' => :'hideUseATemplateInPrepare',
    :'hide_use_a_template_in_prepare_metadata' => :'hideUseATemplateInPrepareMetadata',
    :'hide_use_a_template_metadata' => :'hideUseATemplateMetadata',
    :'order_based_recipient_id_generation' => :'orderBasedRecipientIdGeneration',
    :'order_based_recipient_id_generation_metadata' => :'orderBasedRecipientIdGenerationMetadata',
    :'remove_envelope_forwarding' => :'removeEnvelopeForwarding',
    :'remove_envelope_forwarding_metadata' => :'removeEnvelopeForwardingMetadata',
    :'should_redact_access_code' => :'shouldRedactAccessCode',
    :'should_redact_access_code_metadata' => :'shouldRedactAccessCodeMetadata',
    :'upload_new_image_to_sign_or_initial' => :'uploadNewImageToSignOrInitial',
    :'upload_new_image_to_sign_or_initial_metadata' => :'uploadNewImageToSignOrInitialMetadata'
  }
end

.swagger_typesObject

Attribute type mapping.


107
108
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
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 107

def self.swagger_types
  {
    :'admin_message' => :'AdminMessage',
    :'ask_an_admin' => :'AskAnAdmin',
    :'enable_admin_message' => :'String',
    :'enable_admin_message_metadata' => :'SettingsMetadata',
    :'enable_easy_sign_can_use_multi_template_apply' => :'String',
    :'enable_easy_sign_can_use_multi_template_apply_metadata' => :'SettingsMetadata',
    :'enable_easy_sign_template_upload' => :'String',
    :'enable_easy_sign_template_upload_metadata' => :'SettingsMetadata',
    :'enable_envelope_copy_with_data' => :'String',
    :'enable_envelope_copy_with_data_metadata' => :'SettingsMetadata',
    :'hide_send_an_envelope' => :'String',
    :'hide_send_an_envelope_metadata' => :'SettingsMetadata',
    :'hide_use_a_template' => :'String',
    :'hide_use_a_template_in_prepare' => :'String',
    :'hide_use_a_template_in_prepare_metadata' => :'SettingsMetadata',
    :'hide_use_a_template_metadata' => :'SettingsMetadata',
    :'order_based_recipient_id_generation' => :'String',
    :'order_based_recipient_id_generation_metadata' => :'SettingsMetadata',
    :'remove_envelope_forwarding' => :'String',
    :'remove_envelope_forwarding_metadata' => :'SettingsMetadata',
    :'should_redact_access_code' => :'String',
    :'should_redact_access_code_metadata' => :'SettingsMetadata',
    :'upload_new_image_to_sign_or_initial' => :'String',
    :'upload_new_image_to_sign_or_initial_metadata' => :'SettingsMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      admin_message == o.admin_message &&
      ask_an_admin == o.ask_an_admin &&
      enable_admin_message == o.enable_admin_message &&
       == o. &&
      enable_easy_sign_can_use_multi_template_apply == o.enable_easy_sign_can_use_multi_template_apply &&
       == o. &&
      enable_easy_sign_template_upload == o.enable_easy_sign_template_upload &&
       == o. &&
      enable_envelope_copy_with_data == o.enable_envelope_copy_with_data &&
       == o. &&
      hide_send_an_envelope == o.hide_send_an_envelope &&
       == o. &&
      hide_use_a_template == o.hide_use_a_template &&
      hide_use_a_template_in_prepare == o.hide_use_a_template_in_prepare &&
       == o. &&
       == o. &&
      order_based_recipient_id_generation == o.order_based_recipient_id_generation &&
       == o. &&
      remove_envelope_forwarding == o.remove_envelope_forwarding &&
       == o. &&
      should_redact_access_code == o.should_redact_access_code &&
       == o. &&
      upload_new_image_to_sign_or_initial == o.upload_new_image_to_sign_or_initial &&
       == o.
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


321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 321

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


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 387

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


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 300

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

287
288
289
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 287

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


293
294
295
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 293

def hash
  [admin_message, ask_an_admin, enable_admin_message, , enable_easy_sign_can_use_multi_template_apply, , enable_easy_sign_template_upload, , enable_envelope_copy_with_data, , hide_send_an_envelope, , hide_use_a_template, hide_use_a_template_in_prepare, , , order_based_recipient_id_generation, , remove_envelope_forwarding, , should_redact_access_code, , upload_new_image_to_sign_or_initial, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


243
244
245
246
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 243

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


367
368
369
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 367

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


373
374
375
376
377
378
379
380
381
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 373

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


361
362
363
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 361

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


250
251
252
# File 'lib/docusign_esign/models/account_ui_settings.rb', line 250

def valid?
  true
end