Class: DocuSign_eSign::ConnectCustomConfiguration

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectCustomConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 229

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#all_users ⇒ Object

When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.



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

def all_users
  @all_users
end

#all_users_except ⇒ Object

Returns the value of attribute all_users_except.



26
27
28
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 26

def all_users_except
  @all_users_except
end

#allow_envelope_publish ⇒ Object

When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.



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

def allow_envelope_publish
  @allow_envelope_publish
end

#allow_salesforce_publish ⇒ Object

Returns the value of attribute allow_salesforce_publish.



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

def allow_salesforce_publish
  @allow_salesforce_publish
end

#configuration_type ⇒ Object

If merge field’s are being used, specifies the type of the merge field. The only supported value is salesforce.



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

def configuration_type
  @configuration_type
end

#connect_id ⇒ Object

Specifies the DocuSign generated ID for the Connect configuration.



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

def connect_id
  @connect_id
end

#delivery_mode ⇒ Object

Returns the value of attribute delivery_mode.



35
36
37
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 35

def delivery_mode
  @delivery_mode
end

#enable_log ⇒ Object

This turns Connect logging on or off. When set to true, logging is turned on.



38
39
40
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 38

def enable_log
  @enable_log
end

#envelope_events ⇒ Object

A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.



41
42
43
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 41

def envelope_events
  @envelope_events
end

#event_data ⇒ Object

Returns the value of attribute event_data.



43
44
45
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 43

def event_data
  @event_data
end

#events ⇒ Object

Returns the value of attribute events.



46
47
48
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 46

def events
  @events
end

#external_folder_id ⇒ Object

Returns the value of attribute external_folder_id.



49
50
51
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 49

def external_folder_id
  @external_folder_id
end

#external_folder_label ⇒ Object

Returns the value of attribute external_folder_label.



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

def external_folder_label
  @external_folder_label
end

#group_ids ⇒ Object

Returns the value of attribute group_ids.



55
56
57
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 55

def group_ids
  @group_ids
end

#include_cert_soap_header ⇒ Object

Returns the value of attribute include_cert_soap_header.



61
62
63
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 61

def include_cert_soap_header
  @include_cert_soap_header
end

#include_certificate_of_completion ⇒ Object

When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.



58
59
60
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 58

def include_certificate_of_completion
  @include_certificate_of_completion
end

#include_document_fields ⇒ Object

When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API.



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

def include_document_fields
  @include_document_fields
end

#include_documents ⇒ Object

When set to true, Connect will send the PDF document along with the update XML.



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

def include_documents
  @include_documents
end

#include_envelope_void_reason ⇒ Object

When set to true, Connect will include the voidedReason for voided envelopes.



70
71
72
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 70

def include_envelope_void_reason
  @include_envelope_void_reason
end

#include_hmac ⇒ Object

Returns the value of attribute include_hmac.



73
74
75
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 73

def include_hmac
  @include_hmac
end

#include_sender_accountas_custom_field ⇒ Object

When set to true, Connect will include the sender account as Custom Field in the data.



76
77
78
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 76

def include_sender_accountas_custom_field
  @include_sender_accountas_custom_field
end

#include_time_zone_information ⇒ Object

When set to true, Connect will include the envelope time zone information.



79
80
81
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 79

def include_time_zone_information
  @include_time_zone_information
end

#name ⇒ Object

The name of the Connect configuration. The name helps identify the configuration in the list.



82
83
84
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 82

def name
  @name
end

#password ⇒ Object

Returns the value of attribute password.



85
86
87
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 85

def password
  @password
end

#recipient_events ⇒ Object

A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.



88
89
90
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 88

def recipient_events
  @recipient_events
end

#require_mutual_tls ⇒ Object

Returns the value of attribute require_mutual_tls.



91
92
93
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 91

def require_mutual_tls
  @require_mutual_tls
end

#requires_acknowledgement ⇒ Object

When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information.



94
95
96
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 94

def requires_acknowledgement
  @requires_acknowledgement
end

#salesforce_api_version ⇒ Object

Returns the value of attribute salesforce_api_version.



97
98
99
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 97

def salesforce_api_version
  @salesforce_api_version
end

#salesforce_authcode ⇒ Object

Returns the value of attribute salesforce_authcode.



100
101
102
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 100

def salesforce_authcode
  @salesforce_authcode
end

#salesforce_call_back_url ⇒ Object

Returns the value of attribute salesforce_call_back_url.



103
104
105
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 103

def salesforce_call_back_url
  @salesforce_call_back_url
end

#salesforce_documents_as_content_files ⇒ Object

Returns the value of attribute salesforce_documents_as_content_files.



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

def salesforce_documents_as_content_files
  @salesforce_documents_as_content_files
end

#sender_override ⇒ Object

Returns the value of attribute sender_override.



109
110
111
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 109

def sender_override
  @sender_override
end

#sender_selectable_items ⇒ Object

Returns the value of attribute sender_selectable_items.



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

def sender_selectable_items
  @sender_selectable_items
end

#sf_objects ⇒ Object

Returns the value of attribute sf_objects.



115
116
117
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 115

def sf_objects
  @sf_objects
end

#sign_message_with_x509_certificate ⇒ Object

When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.



118
119
120
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 118

def sign_message_with_x509_certificate
  @sign_message_with_x509_certificate
end

#soap_namespace ⇒ Object

The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.



121
122
123
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 121

def soap_namespace
  @soap_namespace
end

#url_to_publish_to ⇒ Object

This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.



124
125
126
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 124

def url_to_publish_to
  @url_to_publish_to
end

#use_soap_interface ⇒ Object

When set to true, indicates that the ‘urlToPublishTo` property contains a SOAP endpoint.



133
134
135
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 133

def use_soap_interface
  @use_soap_interface
end

#user_ids ⇒ Object

A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.



127
128
129
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 127

def user_ids
  @user_ids
end

#user_name ⇒ Object

Returns the value of attribute user_name.



130
131
132
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 130

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'allow_envelope_publish' => :'allowEnvelopePublish',
    :'allow_salesforce_publish' => :'allowSalesforcePublish',
    :'all_users' => :'allUsers',
    :'all_users_except' => :'allUsersExcept',
    :'configuration_type' => :'configurationType',
    :'connect_id' => :'connectId',
    :'delivery_mode' => :'deliveryMode',
    :'enable_log' => :'enableLog',
    :'envelope_events' => :'envelopeEvents',
    :'event_data' => :'eventData',
    :'events' => :'events',
    :'external_folder_id' => :'externalFolderId',
    :'external_folder_label' => :'externalFolderLabel',
    :'group_ids' => :'groupIds',
    :'include_certificate_of_completion' => :'includeCertificateOfCompletion',
    :'include_cert_soap_header' => :'includeCertSoapHeader',
    :'include_document_fields' => :'includeDocumentFields',
    :'include_documents' => :'includeDocuments',
    :'include_envelope_void_reason' => :'includeEnvelopeVoidReason',
    :'include_hmac' => :'includeHMAC',
    :'include_sender_accountas_custom_field' => :'includeSenderAccountasCustomField',
    :'include_time_zone_information' => :'includeTimeZoneInformation',
    :'name' => :'name',
    :'password' => :'password',
    :'recipient_events' => :'recipientEvents',
    :'require_mutual_tls' => :'requireMutualTls',
    :'requires_acknowledgement' => :'requiresAcknowledgement',
    :'salesforce_api_version' => :'salesforceApiVersion',
    :'salesforce_authcode' => :'salesforceAuthcode',
    :'salesforce_call_back_url' => :'salesforceCallBackUrl',
    :'salesforce_documents_as_content_files' => :'salesforceDocumentsAsContentFiles',
    :'sender_override' => :'senderOverride',
    :'sender_selectable_items' => :'senderSelectableItems',
    :'sf_objects' => :'sfObjects',
    :'sign_message_with_x509_certificate' => :'signMessageWithX509Certificate',
    :'soap_namespace' => :'soapNamespace',
    :'url_to_publish_to' => :'urlToPublishTo',
    :'user_ids' => :'userIds',
    :'user_name' => :'userName',
    :'use_soap_interface' => :'useSoapInterface'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'allow_envelope_publish' => :'String',
    :'allow_salesforce_publish' => :'String',
    :'all_users' => :'String',
    :'all_users_except' => :'String',
    :'configuration_type' => :'String',
    :'connect_id' => :'String',
    :'delivery_mode' => :'String',
    :'enable_log' => :'String',
    :'envelope_events' => :'Array<String>',
    :'event_data' => :'ConnectEventData',
    :'events' => :'Array<String>',
    :'external_folder_id' => :'String',
    :'external_folder_label' => :'String',
    :'group_ids' => :'Array<String>',
    :'include_certificate_of_completion' => :'String',
    :'include_cert_soap_header' => :'String',
    :'include_document_fields' => :'String',
    :'include_documents' => :'String',
    :'include_envelope_void_reason' => :'String',
    :'include_hmac' => :'String',
    :'include_sender_accountas_custom_field' => :'String',
    :'include_time_zone_information' => :'String',
    :'name' => :'String',
    :'password' => :'String',
    :'recipient_events' => :'Array<String>',
    :'require_mutual_tls' => :'String',
    :'requires_acknowledgement' => :'String',
    :'salesforce_api_version' => :'String',
    :'salesforce_authcode' => :'String',
    :'salesforce_call_back_url' => :'String',
    :'salesforce_documents_as_content_files' => :'String',
    :'sender_override' => :'String',
    :'sender_selectable_items' => :'Array<String>',
    :'sf_objects' => :'Array<ConnectSalesforceObject>',
    :'sign_message_with_x509_certificate' => :'String',
    :'soap_namespace' => :'String',
    :'url_to_publish_to' => :'String',
    :'user_ids' => :'Array<String>',
    :'user_name' => :'String',
    :'use_soap_interface' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



425
426
427
428
429
430
431
432
433
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
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 425

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_envelope_publish == o.allow_envelope_publish &&
      allow_salesforce_publish == o.allow_salesforce_publish &&
      all_users == o.all_users &&
      all_users_except == o.all_users_except &&
      configuration_type == o.configuration_type &&
      connect_id == o.connect_id &&
      delivery_mode == o.delivery_mode &&
      enable_log == o.enable_log &&
      envelope_events == o.envelope_events &&
      event_data == o.event_data &&
      events == o.events &&
      external_folder_id == o.external_folder_id &&
      external_folder_label == o.external_folder_label &&
      group_ids == o.group_ids &&
      include_certificate_of_completion == o.include_certificate_of_completion &&
      include_cert_soap_header == o.include_cert_soap_header &&
      include_document_fields == o.include_document_fields &&
      include_documents == o.include_documents &&
      include_envelope_void_reason == o.include_envelope_void_reason &&
      include_hmac == o.include_hmac &&
      include_sender_accountas_custom_field == o.include_sender_accountas_custom_field &&
      include_time_zone_information == o.include_time_zone_information &&
      name == o.name &&
      password == o.password &&
      recipient_events == o.recipient_events &&
      require_mutual_tls == o.require_mutual_tls &&
      requires_acknowledgement == o.requires_acknowledgement &&
      salesforce_api_version == o.salesforce_api_version &&
      salesforce_authcode == o.salesforce_authcode &&
      salesforce_call_back_url == o.salesforce_call_back_url &&
      salesforce_documents_as_content_files == o.salesforce_documents_as_content_files &&
      sender_override == o.sender_override &&
      sender_selectable_items == o.sender_selectable_items &&
      sf_objects == o.sf_objects &&
      sign_message_with_x509_certificate == o.sign_message_with_x509_certificate &&
      soap_namespace == o.soap_namespace &&
      url_to_publish_to == o.url_to_publish_to &&
      user_ids == o.user_ids &&
      user_name == o.user_name &&
      use_soap_interface == o.use_soap_interface
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



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 506

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



572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 572

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



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 485

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


472
473
474
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 472

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



478
479
480
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 478

def hash
  [allow_envelope_publish, allow_salesforce_publish, all_users, all_users_except, configuration_type, connect_id, delivery_mode, enable_log, envelope_events, event_data, events, external_folder_id, external_folder_label, group_ids, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].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



412
413
414
415
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 412

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



552
553
554
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 552

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



558
559
560
561
562
563
564
565
566
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 558

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



546
547
548
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 546

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



419
420
421
 
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 419

def valid?
  true
end