docusign_esign 2.11.0 → 3.0.0.rc1

data/lib/docusign_esign/models/diagnostics_settings_information.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class DiagnosticsSettingsInformation
     #  When set to **true**, enables API request logging for the user. 
     attr_accessor :api_request_logging
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # Indicates the remaining number of API requests that can be logged.
     attr_accessor :api_request_log_remaining_entries
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +48,7 @@ module DocuSign_eSign
       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 }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'apiRequestLogging')
         self.api_request_logging = attributes[:'apiRequestLogging']
@@ -59,19 +61,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'apiRequestLogRemainingEntries')
         self.api_request_log_remaining_entries = attributes[:'apiRequestLogRemainingEntries']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      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?
-      true
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -103,10 +106,10 @@ module DocuSign_eSign
       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
+          # 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) })
+            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]]))
@@ -188,7 +191,7 @@ module DocuSign_eSign
     # @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) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -201,4 +204,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/direct_debit_processor_information.rb

@@ -0,0 +1,298 @@
+=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 DirectDebitProcessorInformation
+    # 
+    attr_accessor :bank_branch_code
+
+    # 
+    attr_accessor :bank_check_digit
+
+    # 
+    attr_accessor :bank_code
+
+    # 
+    attr_accessor :bank_name
+
+    # 
+    attr_accessor :bank_transfer_account_name
+
+    # 
+    attr_accessor :bank_transfer_account_number
+
+    # 
+    attr_accessor :bank_transfer_type
+
+    # Specifies the country associated with the address.
+    attr_accessor :country
+
+    # 
+    attr_accessor :email
+
+    # The user's first name.  Maximum Length: 50 characters.
+    attr_accessor :first_name
+
+    # 
+    attr_accessor :i_ban
+
+    # 
+    attr_accessor :last_name
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bank_branch_code' => :'bankBranchCode',
+        :'bank_check_digit' => :'bankCheckDigit',
+        :'bank_code' => :'bankCode',
+        :'bank_name' => :'bankName',
+        :'bank_transfer_account_name' => :'bankTransferAccountName',
+        :'bank_transfer_account_number' => :'bankTransferAccountNumber',
+        :'bank_transfer_type' => :'bankTransferType',
+        :'country' => :'country',
+        :'email' => :'email',
+        :'first_name' => :'firstName',
+        :'i_ban' => :'iBAN',
+        :'last_name' => :'lastName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'bank_branch_code' => :'String',
+        :'bank_check_digit' => :'String',
+        :'bank_code' => :'String',
+        :'bank_name' => :'String',
+        :'bank_transfer_account_name' => :'String',
+        :'bank_transfer_account_number' => :'String',
+        :'bank_transfer_type' => :'String',
+        :'country' => :'String',
+        :'email' => :'String',
+        :'first_name' => :'String',
+        :'i_ban' => :'String',
+        :'last_name' => :'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?(:'bankBranchCode')
+        self.bank_branch_code = attributes[:'bankBranchCode']
+      end
+
+      if attributes.has_key?(:'bankCheckDigit')
+        self.bank_check_digit = attributes[:'bankCheckDigit']
+      end
+
+      if attributes.has_key?(:'bankCode')
+        self.bank_code = attributes[:'bankCode']
+      end
+
+      if attributes.has_key?(:'bankName')
+        self.bank_name = attributes[:'bankName']
+      end
+
+      if attributes.has_key?(:'bankTransferAccountName')
+        self.bank_transfer_account_name = attributes[:'bankTransferAccountName']
+      end
+
+      if attributes.has_key?(:'bankTransferAccountNumber')
+        self.bank_transfer_account_number = attributes[:'bankTransferAccountNumber']
+      end
+
+      if attributes.has_key?(:'bankTransferType')
+        self.bank_transfer_type = attributes[:'bankTransferType']
+      end
+
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'firstName')
+        self.first_name = attributes[:'firstName']
+      end
+
+      if attributes.has_key?(:'iBAN')
+        self.i_ban = attributes[:'iBAN']
+      end
+
+      if attributes.has_key?(:'lastName')
+        self.last_name = attributes[:'lastName']
+      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 &&
+          bank_branch_code == o.bank_branch_code &&
+          bank_check_digit == o.bank_check_digit &&
+          bank_code == o.bank_code &&
+          bank_name == o.bank_name &&
+          bank_transfer_account_name == o.bank_transfer_account_name &&
+          bank_transfer_account_number == o.bank_transfer_account_number &&
+          bank_transfer_type == o.bank_transfer_type &&
+          country == o.country &&
+          email == o.email &&
+          first_name == o.first_name &&
+          i_ban == o.i_ban &&
+          last_name == o.last_name
+    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
+      [bank_branch_code, bank_check_digit, bank_code, bank_name, bank_transfer_account_name, bank_transfer_account_number, bank_transfer_type, country, email, first_name, i_ban, last_name].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/display_appliance_document.rb

@@ -0,0 +1,258 @@
+=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 DisplayApplianceDocument
+    # 
+    attr_accessor :attachment_description
+
+    # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
+    attr_accessor :document_id
+
+    # 
+    attr_accessor :document_type
+
+    # The envelope ID of the envelope status that failed to post.
+    attr_accessor :envelope_id
+
+    # 
+    attr_accessor :external_document_id
+
+    # 
+    attr_accessor :latest_pdf_id
+
+    # 
+    attr_accessor :name
+
+    # 
+    attr_accessor :pages
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_description' => :'attachmentDescription',
+        :'document_id' => :'documentId',
+        :'document_type' => :'documentType',
+        :'envelope_id' => :'envelopeId',
+        :'external_document_id' => :'externalDocumentId',
+        :'latest_pdf_id' => :'latestPDFId',
+        :'name' => :'name',
+        :'pages' => :'pages'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'attachment_description' => :'String',
+        :'document_id' => :'String',
+        :'document_type' => :'String',
+        :'envelope_id' => :'String',
+        :'external_document_id' => :'String',
+        :'latest_pdf_id' => :'String',
+        :'name' => :'String',
+        :'pages' => :'Integer'
+      }
+    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?(:'attachmentDescription')
+        self.attachment_description = attributes[:'attachmentDescription']
+      end
+
+      if attributes.has_key?(:'documentId')
+        self.document_id = attributes[:'documentId']
+      end
+
+      if attributes.has_key?(:'documentType')
+        self.document_type = attributes[:'documentType']
+      end
+
+      if attributes.has_key?(:'envelopeId')
+        self.envelope_id = attributes[:'envelopeId']
+      end
+
+      if attributes.has_key?(:'externalDocumentId')
+        self.external_document_id = attributes[:'externalDocumentId']
+      end
+
+      if attributes.has_key?(:'latestPDFId')
+        self.latest_pdf_id = attributes[:'latestPDFId']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'pages')
+        self.pages = attributes[:'pages']
+      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 &&
+          attachment_description == o.attachment_description &&
+          document_id == o.document_id &&
+          document_type == o.document_type &&
+          envelope_id == o.envelope_id &&
+          external_document_id == o.external_document_id &&
+          latest_pdf_id == o.latest_pdf_id &&
+          name == o.name &&
+          pages == o.pages
+    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
+      [attachment_description, document_id, document_type, envelope_id, external_document_id, latest_pdf_id, name, pages].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