docusign_esign 3.18.0 → 3.20.0

data/lib/docusign_esign/models/connect_custom_configuration.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The `connectCustomConfiguration` object describes how Connect is configured for your account.
   class ConnectCustomConfiguration
     # 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.
     attr_accessor :allow_envelope_publish
@@ -43,6 +44,7 @@ module DocuSign_eSign
     # A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.
     attr_accessor :envelope_events
 
+    # Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)
     attr_accessor :event_data
 
     # 
@@ -75,6 +77,9 @@ module DocuSign_eSign
     # 
     attr_accessor :include_hmac
 
+    # 
+    attr_accessor :include_o_auth
+
     # When set to **true**, Connect will include the sender account as Custom Field in the data.
     attr_accessor :include_sender_accountas_custom_field
 
@@ -159,6 +164,7 @@ module DocuSign_eSign
         :'include_documents' => :'includeDocuments',
         :'include_envelope_void_reason' => :'includeEnvelopeVoidReason',
         :'include_hmac' => :'includeHMAC',
+        :'include_o_auth' => :'includeOAuth',
         :'include_sender_accountas_custom_field' => :'includeSenderAccountasCustomField',
         :'include_time_zone_information' => :'includeTimeZoneInformation',
         :'name' => :'name',
@@ -206,6 +212,7 @@ module DocuSign_eSign
         :'include_documents' => :'String',
         :'include_envelope_void_reason' => :'String',
         :'include_hmac' => :'String',
+        :'include_o_auth' => :'String',
         :'include_sender_accountas_custom_field' => :'String',
         :'include_time_zone_information' => :'String',
         :'name' => :'String',
@@ -327,6 +334,10 @@ module DocuSign_eSign
         self.include_hmac = attributes[:'includeHMAC']
       end
 
+      if attributes.has_key?(:'includeOAuth')
+        self.include_o_auth = attributes[:'includeOAuth']
+      end
+
       if attributes.has_key?(:'includeSenderAccountasCustomField')
         self.include_sender_accountas_custom_field = attributes[:'includeSenderAccountasCustomField']
       end
@@ -455,6 +466,7 @@ module DocuSign_eSign
           include_documents == o.include_documents &&
           include_envelope_void_reason == o.include_envelope_void_reason &&
           include_hmac == o.include_hmac &&
+          include_o_auth == o.include_o_auth &&
           include_sender_accountas_custom_field == o.include_sender_accountas_custom_field &&
           include_time_zone_information == o.include_time_zone_information &&
           name == o.name &&
@@ -486,7 +498,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     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
+      [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_o_auth, 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
 
     # Builds the object from hash

data/lib/docusign_esign/models/connect_debug_log.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # 
     attr_accessor :connect_config
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/connect_event_data.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object lets you choose the data format of your Connect response. For  more information about using this object, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications). 
   class ConnectEventData
     # 
     attr_accessor :format

data/lib/docusign_esign/models/connect_failure_filter.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A list of failed envelope IDs to retry.
   class ConnectFailureFilter
     # 
     attr_accessor :envelope_ids

data/lib/docusign_esign/models/connect_failure_result.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains details about a Connect failure result.
   class ConnectFailureResult
     # Reserved: TBD
     attr_accessor :config_id

data/lib/docusign_esign/models/connect_log.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains information about a Connect log entry.
   class ConnectLog
     # The account ID associated with the envelope.
     attr_accessor :account_id

data/lib/docusign_esign/models/connect_o_auth_config.rb

@@ -0,0 +1,224 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class ConnectOAuthConfig
+    # 
+    attr_accessor :authorization_server_url
+
+    # 
+    attr_accessor :client_id
+
+    # 
+    attr_accessor :client_secret
+
+    # 
+    attr_accessor :custom_parameters
+
+    # 
+    attr_accessor :scope
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'authorization_server_url' => :'authorizationServerUrl',
+        :'client_id' => :'clientId',
+        :'client_secret' => :'clientSecret',
+        :'custom_parameters' => :'customParameters',
+        :'scope' => :'scope'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'authorization_server_url' => :'String',
+        :'client_id' => :'String',
+        :'client_secret' => :'String',
+        :'custom_parameters' => :'String',
+        :'scope' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'authorizationServerUrl')
+        self.authorization_server_url = attributes[:'authorizationServerUrl']
+      end
+
+      if attributes.has_key?(:'clientId')
+        self.client_id = attributes[:'clientId']
+      end
+
+      if attributes.has_key?(:'clientSecret')
+        self.client_secret = attributes[:'clientSecret']
+      end
+
+      if attributes.has_key?(:'customParameters')
+        self.custom_parameters = attributes[:'customParameters']
+      end
+
+      if attributes.has_key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          authorization_server_url == o.authorization_server_url &&
+          client_id == o.client_id &&
+          client_secret == o.client_secret &&
+          custom_parameters == o.custom_parameters &&
+          scope == o.scope
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [authorization_server_url, client_id, client_secret, custom_parameters, scope].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+end

data/lib/docusign_esign/models/connect_salesforce_field.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account.
   class ConnectSalesforceField
     # 
     attr_accessor :ds_attribute

data/lib/docusign_esign/models/connect_salesforce_object.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.  When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see  [DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).
   class ConnectSalesforceObject
     # 
     attr_accessor :active

data/lib/docusign_esign/models/console_view_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request object for the [EnvelopeViews: createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) method.
   class ConsoleViewRequest
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id

data/lib/docusign_esign/models/consumer_disclosure.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Details about consumer disclosures.
   class ConsumerDisclosure
     # A GUID identifying the account associated with the consumer disclosure
     attr_accessor :account_esign_id
@@ -19,6 +20,7 @@ module DocuSign_eSign
     # Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
     attr_accessor :allow_cd_withdraw
 
+    # Metadata that indicates whether the `allowCDWithdraw` property is editable. 
     attr_accessor :allow_cd_withdraw_metadata
 
     # 
@@ -69,6 +71,7 @@ module DocuSign_eSign
     # 
     attr_accessor :use_consumer_disclosure_within_account
 
+    # Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. 
     attr_accessor :use_consumer_disclosure_within_account_metadata
 
     # Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.  Maximum length: 100 characters. 

data/lib/docusign_esign/models/contact.rb

@@ -31,6 +31,7 @@ module DocuSign_eSign
     # 
     attr_accessor :emails
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/contact_get_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This response object contains information about the contacts associated with an account.
   class ContactGetResponse
     # 
     attr_accessor :contacts

data/lib/docusign_esign/models/contact_mod_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request object containing the new information for the contacts.
   class ContactModRequest
     # 
     attr_accessor :contact_list

data/lib/docusign_esign/models/contact_phone_number.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Details about the phone numbers associated with a specific contact.
   class ContactPhoneNumber
     # 
     attr_accessor :phone_number

data/lib/docusign_esign/models/contact_update_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This response objects shows the updated details for the contacts.
   class ContactUpdateResponse
     # 
     attr_accessor :contacts

data/lib/docusign_esign/models/correct_view_request.rb

@@ -12,7 +12,11 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method.
   class CorrectViewRequest
+    # 
+    attr_accessor :begin_on_tagger
+
     # The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are:   * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action)  ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. 
     attr_accessor :return_url
 
@@ -25,6 +29,7 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'begin_on_tagger' => :'beginOnTagger',
         :'return_url' => :'returnUrl',
         :'suppress_navigation' => :'suppressNavigation',
         :'view_url' => :'viewUrl'
@@ -34,6 +39,7 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'begin_on_tagger' => :'String',
         :'return_url' => :'String',
         :'suppress_navigation' => :'String',
         :'view_url' => :'String'
@@ -48,6 +54,10 @@ module DocuSign_eSign
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'beginOnTagger')
+        self.begin_on_tagger = attributes[:'beginOnTagger']
+      end
+
       if attributes.has_key?(:'returnUrl')
         self.return_url = attributes[:'returnUrl']
       end
@@ -79,6 +89,7 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          begin_on_tagger == o.begin_on_tagger &&
           return_url == o.return_url &&
           suppress_navigation == o.suppress_navigation &&
           view_url == o.view_url
@@ -93,7 +104,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [return_url, suppress_navigation, view_url].hash
+      [begin_on_tagger, return_url, suppress_navigation, view_url].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/credit_card_information.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains information about a credit card that is associated with an account.
   class CreditCardInformation
+    # A complex element containing the credit card billing address information.
     attr_accessor :address
 
     #