docusign_esign 0.0.1

data/lib/docusign_esign/models/bulk_envelopes_response.rb

@@ -0,0 +1,250 @@
+=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 BulkEnvelopesResponse
+    # Reserved: TBD
+    attr_accessor :bulk_envelope_statuses
+
+    # The last position in the result set. 
+    attr_accessor :end_position
+
+    # The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. 
+    attr_accessor :next_uri
+
+    # The postal code for the billing address.
+    attr_accessor :previous_uri
+
+    # The number of results returned in this response. 
+    attr_accessor :result_set_size
+
+    # Starting position of the current result set.
+    attr_accessor :start_position
+
+    # The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.
+    attr_accessor :total_set_size
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bulk_envelope_statuses' => :'bulkEnvelopeStatuses',
+        :'end_position' => :'endPosition',
+        :'next_uri' => :'nextUri',
+        :'previous_uri' => :'previousUri',
+        :'result_set_size' => :'resultSetSize',
+        :'start_position' => :'startPosition',
+        :'total_set_size' => :'totalSetSize'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'bulk_envelope_statuses' => :'Array<BulkEnvelopeStatus>',
+        :'end_position' => :'String',
+        :'next_uri' => :'String',
+        :'previous_uri' => :'String',
+        :'result_set_size' => :'String',
+        :'start_position' => :'String',
+        :'total_set_size' => :'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?(:'bulkEnvelopeStatuses')
+        if (value = attributes[:'bulkEnvelopeStatuses']).is_a?(Array)
+          self.bulk_envelope_statuses = value
+        end
+      end
+
+      if attributes.has_key?(:'endPosition')
+        self.end_position = attributes[:'endPosition']
+      end
+
+      if attributes.has_key?(:'nextUri')
+        self.next_uri = attributes[:'nextUri']
+      end
+
+      if attributes.has_key?(:'previousUri')
+        self.previous_uri = attributes[:'previousUri']
+      end
+
+      if attributes.has_key?(:'resultSetSize')
+        self.result_set_size = attributes[:'resultSetSize']
+      end
+
+      if attributes.has_key?(:'startPosition')
+        self.start_position = attributes[:'startPosition']
+      end
+
+      if attributes.has_key?(:'totalSetSize')
+        self.total_set_size = attributes[:'totalSetSize']
+      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 &&
+          bulk_envelope_statuses == o.bulk_envelope_statuses &&
+          end_position == o.end_position &&
+          next_uri == o.next_uri &&
+          previous_uri == o.previous_uri &&
+          result_set_size == o.result_set_size &&
+          start_position == o.start_position &&
+          total_set_size == o.total_set_size
+    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
+      [bulk_envelope_statuses, end_position, next_uri, previous_uri, result_set_size, start_position, total_set_size].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/bulk_recipient.rb

@@ -0,0 +1,284 @@
+=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 BulkRecipient
+    # If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.   Maximum Length: 50 characters and it must conform to the account’s access code format setting.  If blank, but the signer `accessCode` property is set in the envelope, then that value is used.  If blank and the signer `accessCode` property is not set, then the access code is not required.
+    attr_accessor :access_code
+
+    # Specifies the recipient's email address.   Maximum length: 100 characters.
+    attr_accessor :email
+
+    # Array or errors.
+    attr_accessor :error_details
+
+    # Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field.  The acceptable values are:  * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.
+    attr_accessor :identification
+
+    # Specifies the recipient's name.   Maximum length: 50 characters.
+    attr_accessor :name
+
+    # Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.  Maximum Length: 1000 characters.
+    attr_accessor :note
+
+    # This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number.  If `usersupplied` is used, the signer supplies his or her own telephone number.
+    attr_accessor :phone_number
+
+    # 
+    attr_accessor :recipient_signature_provider_info
+
+    # 
+    attr_accessor :row_number
+
+    # Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file.  The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.  The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.  Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.
+    attr_accessor :tab_labels
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'access_code' => :'accessCode',
+        :'email' => :'email',
+        :'error_details' => :'errorDetails',
+        :'identification' => :'identification',
+        :'name' => :'name',
+        :'note' => :'note',
+        :'phone_number' => :'phoneNumber',
+        :'recipient_signature_provider_info' => :'recipientSignatureProviderInfo',
+        :'row_number' => :'rowNumber',
+        :'tab_labels' => :'tabLabels'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'access_code' => :'String',
+        :'email' => :'String',
+        :'error_details' => :'Array<ErrorDetails>',
+        :'identification' => :'String',
+        :'name' => :'String',
+        :'note' => :'String',
+        :'phone_number' => :'String',
+        :'recipient_signature_provider_info' => :'Array<BulkRecipientSignatureProvider>',
+        :'row_number' => :'String',
+        :'tab_labels' => :'Array<BulkRecipientTabLabel>'
+      }
+    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?(:'accessCode')
+        self.access_code = attributes[:'accessCode']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'errorDetails')
+        if (value = attributes[:'errorDetails']).is_a?(Array)
+          self.error_details = value
+        end
+      end
+
+      if attributes.has_key?(:'identification')
+        self.identification = attributes[:'identification']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'note')
+        self.note = attributes[:'note']
+      end
+
+      if attributes.has_key?(:'phoneNumber')
+        self.phone_number = attributes[:'phoneNumber']
+      end
+
+      if attributes.has_key?(:'recipientSignatureProviderInfo')
+        if (value = attributes[:'recipientSignatureProviderInfo']).is_a?(Array)
+          self.recipient_signature_provider_info = value
+        end
+      end
+
+      if attributes.has_key?(:'rowNumber')
+        self.row_number = attributes[:'rowNumber']
+      end
+
+      if attributes.has_key?(:'tabLabels')
+        if (value = attributes[:'tabLabels']).is_a?(Array)
+          self.tab_labels = value
+        end
+      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 &&
+          access_code == o.access_code &&
+          email == o.email &&
+          error_details == o.error_details &&
+          identification == o.identification &&
+          name == o.name &&
+          note == o.note &&
+          phone_number == o.phone_number &&
+          recipient_signature_provider_info == o.recipient_signature_provider_info &&
+          row_number == o.row_number &&
+          tab_labels == o.tab_labels
+    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
+      [access_code, email, error_details, identification, name, note, phone_number, recipient_signature_provider_info, row_number, tab_labels].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