docusign_esign 0.0.1

data/lib/docusign_esign/models/folder.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
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+
+  class Folder
+    attr_accessor :error_details
+
+    attr_accessor :filter
+
+    # 
+    attr_accessor :folder_id
+
+    # A collection of folder objects returned in a response.
+    attr_accessor :folders
+
+    # 
+    attr_accessor :name
+
+    # 
+    attr_accessor :owner_email
+
+    # 
+    attr_accessor :owner_user_id
+
+    # 
+    attr_accessor :owner_user_name
+
+    # 
+    attr_accessor :parent_folder_id
+
+    # 
+    attr_accessor :parent_folder_uri
+
+    # 
+    attr_accessor :type
+
+    # 
+    attr_accessor :uri
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error_details' => :'errorDetails',
+        :'filter' => :'filter',
+        :'folder_id' => :'folderId',
+        :'folders' => :'folders',
+        :'name' => :'name',
+        :'owner_email' => :'ownerEmail',
+        :'owner_user_id' => :'ownerUserId',
+        :'owner_user_name' => :'ownerUserName',
+        :'parent_folder_id' => :'parentFolderId',
+        :'parent_folder_uri' => :'parentFolderUri',
+        :'type' => :'type',
+        :'uri' => :'uri'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error_details' => :'ErrorDetails',
+        :'filter' => :'Filter',
+        :'folder_id' => :'String',
+        :'folders' => :'Array<Folder>',
+        :'name' => :'String',
+        :'owner_email' => :'String',
+        :'owner_user_id' => :'String',
+        :'owner_user_name' => :'String',
+        :'parent_folder_id' => :'String',
+        :'parent_folder_uri' => :'String',
+        :'type' => :'String',
+        :'uri' => :'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?(:'errorDetails')
+        self.error_details = attributes[:'errorDetails']
+      end
+
+      if attributes.has_key?(:'filter')
+        self.filter = attributes[:'filter']
+      end
+
+      if attributes.has_key?(:'folderId')
+        self.folder_id = attributes[:'folderId']
+      end
+
+      if attributes.has_key?(:'folders')
+        if (value = attributes[:'folders']).is_a?(Array)
+          self.folders = value
+        end
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'ownerEmail')
+        self.owner_email = attributes[:'ownerEmail']
+      end
+
+      if attributes.has_key?(:'ownerUserId')
+        self.owner_user_id = attributes[:'ownerUserId']
+      end
+
+      if attributes.has_key?(:'ownerUserName')
+        self.owner_user_name = attributes[:'ownerUserName']
+      end
+
+      if attributes.has_key?(:'parentFolderId')
+        self.parent_folder_id = attributes[:'parentFolderId']
+      end
+
+      if attributes.has_key?(:'parentFolderUri')
+        self.parent_folder_uri = attributes[:'parentFolderUri']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'uri')
+        self.uri = attributes[:'uri']
+      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 &&
+          error_details == o.error_details &&
+          filter == o.filter &&
+          folder_id == o.folder_id &&
+          folders == o.folders &&
+          name == o.name &&
+          owner_email == o.owner_email &&
+          owner_user_id == o.owner_user_id &&
+          owner_user_name == o.owner_user_name &&
+          parent_folder_id == o.parent_folder_id &&
+          parent_folder_uri == o.parent_folder_uri &&
+          type == o.type &&
+          uri == o.uri
+    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
+      [error_details, filter, folder_id, folders, name, owner_email, owner_user_id, owner_user_name, parent_folder_id, parent_folder_uri, type, uri].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/folder_item.rb

@@ -0,0 +1,390 @@
+=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 FolderItem
+    # Specifies the date and time this item was completed.
+    attr_accessor :completed_date_time
+
+    # Indicates the date and time the item was created.
+    attr_accessor :created_date_time
+
+    # An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
+    attr_accessor :custom_fields
+
+    # 
+    attr_accessor :description
+
+    # The envelope ID of the envelope status that failed to post.
+    attr_accessor :envelope_id
+
+    # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
+    attr_accessor :envelope_uri
+
+    # When set to **true**, indicates that this module is enabled on the account.
+    attr_accessor :is21_cfr_part11
+
+    # 
+    attr_accessor :is_signature_provider_envelope
+
+    # 
+    attr_accessor :last_modified
+
+    # 
+    attr_accessor :name
+
+    # Name of the envelope owner.
+    attr_accessor :owner_name
+
+    # 
+    attr_accessor :page_count
+
+    # 
+    attr_accessor :password
+
+    # 
+    attr_accessor :sender_email
+
+    # Name of the envelope sender.
+    attr_accessor :sender_name
+
+    # The date and time the envelope was sent.
+    attr_accessor :sent_date_time
+
+    # When set to **true**, this custom tab is shared.
+    attr_accessor :shared
+
+    # 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
+
+    # 
+    attr_accessor :subject
+
+    # The unique identifier of the template. If this is not provided, DocuSign will generate a value. 
+    attr_accessor :template_id
+
+    # 
+    attr_accessor :uri
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'completed_date_time' => :'completedDateTime',
+        :'created_date_time' => :'createdDateTime',
+        :'custom_fields' => :'customFields',
+        :'description' => :'description',
+        :'envelope_id' => :'envelopeId',
+        :'envelope_uri' => :'envelopeUri',
+        :'is21_cfr_part11' => :'is21CFRPart11',
+        :'is_signature_provider_envelope' => :'isSignatureProviderEnvelope',
+        :'last_modified' => :'lastModified',
+        :'name' => :'name',
+        :'owner_name' => :'ownerName',
+        :'page_count' => :'pageCount',
+        :'password' => :'password',
+        :'sender_email' => :'senderEmail',
+        :'sender_name' => :'senderName',
+        :'sent_date_time' => :'sentDateTime',
+        :'shared' => :'shared',
+        :'status' => :'status',
+        :'subject' => :'subject',
+        :'template_id' => :'templateId',
+        :'uri' => :'uri'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'completed_date_time' => :'String',
+        :'created_date_time' => :'String',
+        :'custom_fields' => :'Array<CustomFieldV2>',
+        :'description' => :'String',
+        :'envelope_id' => :'String',
+        :'envelope_uri' => :'String',
+        :'is21_cfr_part11' => :'String',
+        :'is_signature_provider_envelope' => :'String',
+        :'last_modified' => :'String',
+        :'name' => :'String',
+        :'owner_name' => :'String',
+        :'page_count' => :'Integer',
+        :'password' => :'String',
+        :'sender_email' => :'String',
+        :'sender_name' => :'String',
+        :'sent_date_time' => :'String',
+        :'shared' => :'String',
+        :'status' => :'String',
+        :'subject' => :'String',
+        :'template_id' => :'String',
+        :'uri' => :'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?(:'completedDateTime')
+        self.completed_date_time = attributes[:'completedDateTime']
+      end
+
+      if attributes.has_key?(:'createdDateTime')
+        self.created_date_time = attributes[:'createdDateTime']
+      end
+
+      if attributes.has_key?(:'customFields')
+        if (value = attributes[:'customFields']).is_a?(Array)
+          self.custom_fields = value
+        end
+      end
+
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'envelopeId')
+        self.envelope_id = attributes[:'envelopeId']
+      end
+
+      if attributes.has_key?(:'envelopeUri')
+        self.envelope_uri = attributes[:'envelopeUri']
+      end
+
+      if attributes.has_key?(:'is21CFRPart11')
+        self.is21_cfr_part11 = attributes[:'is21CFRPart11']
+      end
+
+      if attributes.has_key?(:'isSignatureProviderEnvelope')
+        self.is_signature_provider_envelope = attributes[:'isSignatureProviderEnvelope']
+      end
+
+      if attributes.has_key?(:'lastModified')
+        self.last_modified = attributes[:'lastModified']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'ownerName')
+        self.owner_name = attributes[:'ownerName']
+      end
+
+      if attributes.has_key?(:'pageCount')
+        self.page_count = attributes[:'pageCount']
+      end
+
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      end
+
+      if attributes.has_key?(:'senderEmail')
+        self.sender_email = attributes[:'senderEmail']
+      end
+
+      if attributes.has_key?(:'senderName')
+        self.sender_name = attributes[:'senderName']
+      end
+
+      if attributes.has_key?(:'sentDateTime')
+        self.sent_date_time = attributes[:'sentDateTime']
+      end
+
+      if attributes.has_key?(:'shared')
+        self.shared = attributes[:'shared']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.has_key?(:'templateId')
+        self.template_id = attributes[:'templateId']
+      end
+
+      if attributes.has_key?(:'uri')
+        self.uri = attributes[:'uri']
+      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 &&
+          completed_date_time == o.completed_date_time &&
+          created_date_time == o.created_date_time &&
+          custom_fields == o.custom_fields &&
+          description == o.description &&
+          envelope_id == o.envelope_id &&
+          envelope_uri == o.envelope_uri &&
+          is21_cfr_part11 == o.is21_cfr_part11 &&
+          is_signature_provider_envelope == o.is_signature_provider_envelope &&
+          last_modified == o.last_modified &&
+          name == o.name &&
+          owner_name == o.owner_name &&
+          page_count == o.page_count &&
+          password == o.password &&
+          sender_email == o.sender_email &&
+          sender_name == o.sender_name &&
+          sent_date_time == o.sent_date_time &&
+          shared == o.shared &&
+          status == o.status &&
+          subject == o.subject &&
+          template_id == o.template_id &&
+          uri == o.uri
+    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
+      [completed_date_time, created_date_time, custom_fields, description, envelope_id, envelope_uri, is21_cfr_part11, is_signature_provider_envelope, last_modified, name, owner_name, page_count, password, sender_email, sender_name, sent_date_time, shared, status, subject, template_id, uri].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