Class: DocuSign_eSign::ConnectCustomConfiguration
- Inherits:
-
Object
- Object
- DocuSign_eSign::ConnectCustomConfiguration
- Defined in:
- lib/docusign_esign/models/connect_custom_configuration.rb
Instance Attribute Summary collapse
-
#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.
-
#allow_envelope_publish ⇒ Object
When set to true, data is sent to the urlToPublishTo web address.
-
#configuration_type ⇒ Object
If merge field’s are being used, specifies the type of the merge field.
-
#connect_id ⇒ Object
Specifies the DocuSign generated ID for the Connect configuration.
-
#enable_log ⇒ Object
This turns Connect logging on or off.
-
#envelope_events ⇒ Object
A comma separated list of �Envelope� related events that are tracked through Connect.
-
#include_cert_soap_header ⇒ Object
Returns the value of attribute include_cert_soap_header.
-
#include_certificate_of_completion ⇒ Object
When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.
-
#include_document_fields ⇒ Object
When set to true, the Document Fields associated with envelope documents are included in the data.
-
#include_documents ⇒ Object
When set to true, Connect will send the PDF document along with the update XML.
-
#include_envelope_void_reason ⇒ Object
When set to true, Connect will include the voidedReason for voided envelopes.
-
#include_hmac ⇒ Object
Returns the value of attribute include_hmac.
-
#include_sender_accountas_custom_field ⇒ Object
When set to true, Connect will include the sender account as Custom Field in the data.
-
#include_time_zone_information ⇒ Object
When set to true, Connect will include the envelope time zone information.
-
#name ⇒ Object
The name of the Connect configuration.
-
#recipient_events ⇒ Object
A comma separated list of �Recipient� related events that are tracked through Connect.
-
#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.
-
#sign_message_with_x509_certificate ⇒ Object
When set to true, Connect messages are signed with an X509 certificate.
-
#soap_namespace ⇒ Object
The namespace of the SOAP interface.
-
#url_to_publish_to ⇒ Object
This is the web address and name of your listener or Retrieving Service endpoint.
-
#use_soap_interface ⇒ Object
When set to true, indicates that the ‘urlToPublishTo` property contains a SOAP endpoint.
-
#user_ids ⇒ Object
A comma separated list of userIds.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ConnectCustomConfiguration
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ConnectCustomConfiguration
Initializes the object
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 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 142 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?(:'allUsers') self.all_users = attributes[:'allUsers'] 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?(:'enableLog') self.enable_log = attributes[:'enableLog'] end if attributes.has_key?(:'envelopeEvents') self.envelope_events = attributes[:'envelopeEvents'] 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?(:'recipientEvents') self.recipient_events = attributes[:'recipientEvents'] end if attributes.has_key?(:'requiresAcknowledgement') self.requires_acknowledgement = attributes[:'requiresAcknowledgement'] end if attributes.has_key?(:'signMessageWithX509Certificate') self. = 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') self.user_ids = attributes[:'userIds'] 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.
21 22 23 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 21 def all_users @all_users 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.
18 19 20 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 18 def allow_envelope_publish @allow_envelope_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.
24 25 26 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 24 def configuration_type @configuration_type end |
#connect_id ⇒ Object
Specifies the DocuSign generated ID for the Connect configuration.
27 28 29 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 27 def connect_id @connect_id end |
#enable_log ⇒ Object
This turns Connect logging on or off. When set to true, logging is turned on.
30 31 32 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 30 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.
33 34 35 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 33 def envelope_events @envelope_events end |
#include_cert_soap_header ⇒ Object
Returns the value of attribute include_cert_soap_header.
39 40 41 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 39 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.
36 37 38 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 36 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.
42 43 44 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 42 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.
45 46 47 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 45 def include_documents @include_documents end |
#include_envelope_void_reason ⇒ Object
When set to true, Connect will include the voidedReason for voided envelopes.
48 49 50 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 48 def include_envelope_void_reason @include_envelope_void_reason end |
#include_hmac ⇒ Object
Returns the value of attribute include_hmac.
51 52 53 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 51 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.
54 55 56 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 54 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.
57 58 59 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 57 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.
60 61 62 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 60 def name @name 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.
63 64 65 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 63 def recipient_events @recipient_events 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.
66 67 68 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 66 def requires_acknowledgement @requires_acknowledgement 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.
69 70 71 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 69 def @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.
72 73 74 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 72 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.
75 76 77 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 75 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.
81 82 83 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 81 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.
78 79 80 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 78 def user_ids @user_ids end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 85 def self.attribute_map { :'allow_envelope_publish' => :'allowEnvelopePublish', :'all_users' => :'allUsers', :'configuration_type' => :'configurationType', :'connect_id' => :'connectId', :'enable_log' => :'enableLog', :'envelope_events' => :'envelopeEvents', :'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', :'recipient_events' => :'recipientEvents', :'requires_acknowledgement' => :'requiresAcknowledgement', :'sign_message_with_x509_certificate' => :'signMessageWithX509Certificate', :'soap_namespace' => :'soapNamespace', :'url_to_publish_to' => :'urlToPublishTo', :'user_ids' => :'userIds', :'use_soap_interface' => :'useSoapInterface' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 113 def self.swagger_types { :'allow_envelope_publish' => :'String', :'all_users' => :'String', :'configuration_type' => :'String', :'connect_id' => :'String', :'enable_log' => :'String', :'envelope_events' => :'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', :'recipient_events' => :'String', :'requires_acknowledgement' => :'String', :'sign_message_with_x509_certificate' => :'String', :'soap_namespace' => :'String', :'url_to_publish_to' => :'String', :'user_ids' => :'String', :'use_soap_interface' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
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 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 253 def ==(o) return true if self.equal?(o) self.class == o.class && allow_envelope_publish == o.allow_envelope_publish && all_users == o.all_users && configuration_type == o.configuration_type && connect_id == o.connect_id && enable_log == o.enable_log && envelope_events == o.envelope_events && 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 && recipient_events == o.recipient_events && requires_acknowledgement == o.requires_acknowledgement && == o. && soap_namespace == o.soap_namespace && url_to_publish_to == o.url_to_publish_to && user_ids == o.user_ids && use_soap_interface == o.use_soap_interface end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 316 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
382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 382 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
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 295 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 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
282 283 284 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 282 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
288 289 290 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 288 def hash [allow_envelope_publish, all_users, configuration_type, connect_id, enable_log, envelope_events, 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, recipient_events, requires_acknowledgement, , soap_namespace, url_to_publish_to, user_ids, use_soap_interface].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
240 241 242 243 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 240 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
362 363 364 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 362 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
368 369 370 371 372 373 374 375 376 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 368 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
356 357 358 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 356 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
247 248 249 |
# File 'lib/docusign_esign/models/connect_custom_configuration.rb', line 247 def valid? return true end |