docusign_esign 2.0.0 → 2.1.0.rc1

data/lib/docusign_esign/models/event_notification.rb

@@ -32,6 +32,9 @@ module DocuSign_eSign
     # When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. 
     attr_accessor :include_envelope_void_reason
 
+    # 
+    attr_accessor :include_hmac
+
     # When set to **true**, the sender account ID is included as a envelope custom field in the data. 
     attr_accessor :include_sender_account_as_custom_field
 
@@ -69,6 +72,7 @@ module DocuSign_eSign
         :'include_document_fields' => :'includeDocumentFields',
         :'include_documents' => :'includeDocuments',
         :'include_envelope_void_reason' => :'includeEnvelopeVoidReason',
+        :'include_hmac' => :'includeHMAC',
         :'include_sender_account_as_custom_field' => :'includeSenderAccountAsCustomField',
         :'include_time_zone' => :'includeTimeZone',
         :'logging_enabled' => :'loggingEnabled',
@@ -90,6 +94,7 @@ module DocuSign_eSign
         :'include_document_fields' => :'String',
         :'include_documents' => :'String',
         :'include_envelope_void_reason' => :'String',
+        :'include_hmac' => :'String',
         :'include_sender_account_as_custom_field' => :'String',
         :'include_time_zone' => :'String',
         :'logging_enabled' => :'String',
@@ -136,6 +141,10 @@ module DocuSign_eSign
         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_account_as_custom_field = attributes[:'includeSenderAccountAsCustomField']
       end
@@ -200,6 +209,7 @@ module DocuSign_eSign
           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_account_as_custom_field == o.include_sender_account_as_custom_field &&
           include_time_zone == o.include_time_zone &&
           logging_enabled == o.logging_enabled &&
@@ -220,7 +230,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [envelope_events, include_certificate_of_completion, include_certificate_with_soap, include_document_fields, include_documents, include_envelope_void_reason, include_sender_account_as_custom_field, include_time_zone, logging_enabled, recipient_events, require_acknowledgment, sign_message_with_x509_cert, soap_name_space, url, use_soap_interface].hash
+      [envelope_events, include_certificate_of_completion, include_certificate_with_soap, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_account_as_custom_field, include_time_zone, logging_enabled, recipient_events, require_acknowledgment, sign_message_with_x509_cert, soap_name_space, url, use_soap_interface].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/payment_details.rb

@@ -23,6 +23,15 @@ module DocuSign_eSign
     # 
     attr_accessor :currency_code
 
+    # 
+    attr_accessor :customer_id
+
+    # 
+    attr_accessor :custom_metadata
+
+    # 
+    attr_accessor :custom_metadata_required
+
     # 
     attr_accessor :gateway_account_id
 
@@ -38,6 +47,9 @@ module DocuSign_eSign
     # 
     attr_accessor :payment_option
 
+    # 
+    attr_accessor :payment_source_id
+
     # Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
     attr_accessor :status
 
@@ -50,11 +62,15 @@ module DocuSign_eSign
         :'allowed_payment_methods' => :'allowedPaymentMethods',
         :'charge_id' => :'chargeId',
         :'currency_code' => :'currencyCode',
+        :'customer_id' => :'customerId',
+        :'custom_metadata' => :'customMetadata',
+        :'custom_metadata_required' => :'customMetadataRequired',
         :'gateway_account_id' => :'gatewayAccountId',
         :'gateway_display_name' => :'gatewayDisplayName',
         :'gateway_name' => :'gatewayName',
         :'line_items' => :'lineItems',
         :'payment_option' => :'paymentOption',
+        :'payment_source_id' => :'paymentSourceId',
         :'status' => :'status',
         :'total' => :'total'
       }
@@ -66,11 +82,15 @@ module DocuSign_eSign
         :'allowed_payment_methods' => :'Array<String>',
         :'charge_id' => :'String',
         :'currency_code' => :'String',
+        :'customer_id' => :'String',
+        :'custom_metadata' => :'String',
+        :'custom_metadata_required' => :'BOOLEAN',
         :'gateway_account_id' => :'String',
         :'gateway_display_name' => :'String',
         :'gateway_name' => :'String',
         :'line_items' => :'Array<PaymentLineItem>',
         :'payment_option' => :'String',
+        :'payment_source_id' => :'String',
         :'status' => :'String',
         :'total' => :'Money'
       }
@@ -98,6 +118,18 @@ module DocuSign_eSign
         self.currency_code = attributes[:'currencyCode']
       end
 
+      if attributes.has_key?(:'customerId')
+        self.customer_id = attributes[:'customerId']
+      end
+
+      if attributes.has_key?(:'customMetadata')
+        self.custom_metadata = attributes[:'customMetadata']
+      end
+
+      if attributes.has_key?(:'customMetadataRequired')
+        self.custom_metadata_required = attributes[:'customMetadataRequired']
+      end
+
       if attributes.has_key?(:'gatewayAccountId')
         self.gateway_account_id = attributes[:'gatewayAccountId']
       end
@@ -120,6 +152,10 @@ module DocuSign_eSign
         self.payment_option = attributes[:'paymentOption']
       end
 
+      if attributes.has_key?(:'paymentSourceId')
+        self.payment_source_id = attributes[:'paymentSourceId']
+      end
+
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
@@ -151,11 +187,15 @@ module DocuSign_eSign
           allowed_payment_methods == o.allowed_payment_methods &&
           charge_id == o.charge_id &&
           currency_code == o.currency_code &&
+          customer_id == o.customer_id &&
+          custom_metadata == o.custom_metadata &&
+          custom_metadata_required == o.custom_metadata_required &&
           gateway_account_id == o.gateway_account_id &&
           gateway_display_name == o.gateway_display_name &&
           gateway_name == o.gateway_name &&
           line_items == o.line_items &&
           payment_option == o.payment_option &&
+          payment_source_id == o.payment_source_id &&
           status == o.status &&
           total == o.total
     end
@@ -169,7 +209,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allowed_payment_methods, charge_id, currency_code, gateway_account_id, gateway_display_name, gateway_name, line_items, payment_option, status, total].hash
+      [allowed_payment_methods, charge_id, currency_code, customer_id, custom_metadata, custom_metadata_required, gateway_account_id, gateway_display_name, gateway_name, line_items, payment_option, payment_source_id, status, total].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/recipient_identity_verification.rb

@@ -0,0 +1,188 @@
+=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
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+
+  class RecipientIdentityVerification
+    # 
+    attr_accessor :workflow_id
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'workflow_id' => :'workflowId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'workflow_id' => :'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?(:'workflowId')
+        self.workflow_id = attributes[:'workflowId']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          workflow_id == o.workflow_id
+    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
+      [workflow_id].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 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/signer.rb

@@ -92,6 +92,8 @@ module DocuSign_eSign
 
     attr_accessor :id_check_information_input
 
+    attr_accessor :identity_verification
+
     # When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. 
     attr_accessor :inherit_email_notification_configuration
 
@@ -218,6 +220,7 @@ module DocuSign_eSign
         :'full_name' => :'fullName',
         :'id_check_configuration_name' => :'idCheckConfigurationName',
         :'id_check_information_input' => :'idCheckInformationInput',
+        :'identity_verification' => :'identityVerification',
         :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
         :'is_bulk_recipient' => :'isBulkRecipient',
         :'last_name' => :'lastName',
@@ -285,6 +288,7 @@ module DocuSign_eSign
         :'full_name' => :'String',
         :'id_check_configuration_name' => :'String',
         :'id_check_information_input' => :'IdCheckInformationInput',
+        :'identity_verification' => :'RecipientIdentityVerification',
         :'inherit_email_notification_configuration' => :'String',
         :'is_bulk_recipient' => :'String',
         :'last_name' => :'String',
@@ -444,6 +448,10 @@ module DocuSign_eSign
         self.id_check_information_input = attributes[:'idCheckInformationInput']
       end
 
+      if attributes.has_key?(:'identityVerification')
+        self.identity_verification = attributes[:'identityVerification']
+      end
+
       if attributes.has_key?(:'inheritEmailNotificationConfiguration')
         self.inherit_email_notification_configuration = attributes[:'inheritEmailNotificationConfiguration']
       end
@@ -635,6 +643,7 @@ module DocuSign_eSign
           full_name == o.full_name &&
           id_check_configuration_name == o.id_check_configuration_name &&
           id_check_information_input == o.id_check_information_input &&
+          identity_verification == o.identity_verification &&
           inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
           is_bulk_recipient == o.is_bulk_recipient &&
           last_name == o.last_name &&
@@ -680,7 +689,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, first_name, full_name, id_check_configuration_name, id_check_information_input, inherit_email_notification_configuration, is_bulk_recipient, last_name, name, note, offline_attributes, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, require_id_lookup, require_signer_certificate, require_sign_on_paper, role_name, routing_order, saml_authentication, sent_date_time, signature_info, signed_date_time, sign_in_each_location, signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, tabs, template_locked, template_required, total_tab_count, user_id].hash
+      [access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, first_name, full_name, id_check_configuration_name, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, last_name, name, note, offline_attributes, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, require_id_lookup, require_signer_certificate, require_sign_on_paper, role_name, routing_order, saml_authentication, sent_date_time, signature_info, signed_date_time, sign_in_each_location, signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, tabs, template_locked, template_required, total_tab_count, user_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/tabs.rb

@@ -136,7 +136,7 @@ module DocuSign_eSign
         :'checkbox_tabs' => :'Array<Checkbox>',
         :'company_tabs' => :'Array<Company>',
         :'date_signed_tabs' => :'Array<DateSigned>',
-        :'date_tabs' => :'Array<Date>',
+        :'date_tabs' => :'Array<DocuSign_eSign::Date>',
         :'decline_tabs' => :'Array<Decline>',
         :'email_address_tabs' => :'Array<EmailAddress>',
         :'email_tabs' => :'Array<Email>',

data/lib/docusign_esign/models/template_tabs.rb

@@ -136,7 +136,7 @@ module DocuSign_eSign
         :'checkbox_tabs' => :'Array<Checkbox>',
         :'company_tabs' => :'Array<Company>',
         :'date_signed_tabs' => :'Array<DateSigned>',
-        :'date_tabs' => :'Array<Date>',
+        :'date_tabs' => :'Array<DocuSign_eSign::Date>',
         :'decline_tabs' => :'Array<Decline>',
         :'email_address_tabs' => :'Array<EmailAddress>',
         :'email_tabs' => :'Array<Email>',

data/lib/docusign_esign/models/witness.rb

@@ -92,6 +92,8 @@ module DocuSign_eSign
 
     attr_accessor :id_check_information_input
 
+    attr_accessor :identity_verification
+
     # When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. 
     attr_accessor :inherit_email_notification_configuration
 
@@ -224,6 +226,7 @@ module DocuSign_eSign
         :'full_name' => :'fullName',
         :'id_check_configuration_name' => :'idCheckConfigurationName',
         :'id_check_information_input' => :'idCheckInformationInput',
+        :'identity_verification' => :'identityVerification',
         :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
         :'is_bulk_recipient' => :'isBulkRecipient',
         :'last_name' => :'lastName',
@@ -293,6 +296,7 @@ module DocuSign_eSign
         :'full_name' => :'String',
         :'id_check_configuration_name' => :'String',
         :'id_check_information_input' => :'IdCheckInformationInput',
+        :'identity_verification' => :'RecipientIdentityVerification',
         :'inherit_email_notification_configuration' => :'String',
         :'is_bulk_recipient' => :'String',
         :'last_name' => :'String',
@@ -454,6 +458,10 @@ module DocuSign_eSign
         self.id_check_information_input = attributes[:'idCheckInformationInput']
       end
 
+      if attributes.has_key?(:'identityVerification')
+        self.identity_verification = attributes[:'identityVerification']
+      end
+
       if attributes.has_key?(:'inheritEmailNotificationConfiguration')
         self.inherit_email_notification_configuration = attributes[:'inheritEmailNotificationConfiguration']
       end
@@ -653,6 +661,7 @@ module DocuSign_eSign
           full_name == o.full_name &&
           id_check_configuration_name == o.id_check_configuration_name &&
           id_check_information_input == o.id_check_information_input &&
+          identity_verification == o.identity_verification &&
           inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
           is_bulk_recipient == o.is_bulk_recipient &&
           last_name == o.last_name &&
@@ -700,7 +709,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, first_name, full_name, id_check_configuration_name, id_check_information_input, inherit_email_notification_configuration, is_bulk_recipient, last_name, name, note, offline_attributes, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, require_id_lookup, require_signer_certificate, require_sign_on_paper, role_name, routing_order, saml_authentication, sent_date_time, signature_info, signed_date_time, sign_in_each_location, signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
+      [access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, first_name, full_name, id_check_configuration_name, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, last_name, name, note, offline_attributes, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, require_id_lookup, require_signer_certificate, require_sign_on_paper, role_name, routing_order, saml_authentication, sent_date_time, signature_info, signed_date_time, sign_in_each_location, signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
     end
 
     # Builds the object from hash