class DocuSign_eSign::ConnectCustomConfiguration

Attributes

all_users[RW]

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.

all_users_except[RW]

allow_envelope_publish[RW]

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.

allow_salesforce_publish[RW]

configuration_type[RW]

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

connect_id[RW]

Specifies the DocuSign generated ID for the Connect configuration.

delivery_mode[RW]

disabled_by[RW]

enable_log[RW]

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

envelope_events[RW]

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

event_data[RW]

events[RW]

external_folder_id[RW]

external_folder_label[RW]

group_ids[RW]

include_cert_soap_header[RW]

include_certificate_of_completion[RW]

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

include_document_fields[RW]

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.

include_documents[RW]

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

include_envelope_void_reason[RW]

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

include_hmac[RW]

include_sender_accountas_custom_field[RW]

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

include_time_zone_information[RW]

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

name[RW]

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

password[RW]

recipient_events[RW]

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.

require_mutual_tls[RW]

requires_acknowledgement[RW]

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.

salesforce_api_version[RW]

salesforce_authcode[RW]

salesforce_call_back_url[RW]

salesforce_documents_as_content_files[RW]

sender_override[RW]

sender_selectable_items[RW]

sf_objects[RW]

sign_message_with_x509_certificate[RW]

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

soap_namespace[RW]

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

url_to_publish_to[RW]

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

use_soap_interface[RW]

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

user_ids[RW]

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.

user_name[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 139
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',
    :'disabled_by' => :'disabledBy',
    :'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

new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 234
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?(:'disabledBy')
    self.disabled_by = attributes[:'disabledBy']
  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

swagger_types() click to toggle source

Attribute type mapping.

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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 434
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 &&
      disabled_by == o.disabled_by &&
      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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 516
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 582
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 495
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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 482
def eql?(o)
  self == o
end

hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 488
def hash
  [allow_envelope_publish, allow_salesforce_publish, all_users, all_users_except, configuration_type, connect_id, delivery_mode, disabled_by, 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 421
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 562
def to_body
  to_hash
end

to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 568
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 556
def to_s
  to_hash.to_s
end

valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/connect_custom_configuration.rb, line 428
def valid?
  true
end