docusign_esign 2.11.0 → 3.0.0.rc1

data/lib/docusign_esign/models/folder_items_response.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,12 +12,16 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class FolderItemsResponse
     # The last position in the result set. 
     attr_accessor :end_position
 
-    # A list of the envelopes in the specified folder or folders. 
-    attr_accessor :folder_items
+    # 
+    attr_accessor :envelopes
+
+    # 
+    attr_accessor :folders
 
     # 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
@@ -34,11 +38,13 @@ module DocuSign_eSign
     # 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
       {
         :'end_position' => :'endPosition',
-        :'folder_items' => :'folderItems',
+        :'envelopes' => :'envelopes',
+        :'folders' => :'folders',
         :'next_uri' => :'nextUri',
         :'previous_uri' => :'previousUri',
         :'result_set_size' => :'resultSetSize',
@@ -51,7 +57,8 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'end_position' => :'String',
-        :'folder_items' => :'Array<FolderItem>',
+        :'envelopes' => :'Array<EnvelopeSummary>',
+        :'folders' => :'Array<Folder>',
         :'next_uri' => :'String',
         :'previous_uri' => :'String',
         :'result_set_size' => :'String',
@@ -66,15 +73,21 @@ 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?(:'endPosition')
         self.end_position = attributes[:'endPosition']
       end
 
-      if attributes.has_key?(:'folderItems')
-        if (value = attributes[:'folderItems']).is_a?(Array)
-          self.folder_items = value
+      if attributes.has_key?(:'envelopes')
+        if (value = attributes[:'envelopes']).is_a?(Array)
+          self.envelopes = value
+        end
+      end
+
+      if attributes.has_key?(:'folders')
+        if (value = attributes[:'folders']).is_a?(Array)
+          self.folders = value
         end
       end
 
@@ -97,19 +110,20 @@ module DocuSign_eSign
       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 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.
@@ -118,7 +132,8 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           end_position == o.end_position &&
-          folder_items == o.folder_items &&
+          envelopes == o.envelopes &&
+          folders == o.folders &&
           next_uri == o.next_uri &&
           previous_uri == o.previous_uri &&
           result_set_size == o.result_set_size &&
@@ -135,7 +150,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [end_position, folder_items, next_uri, previous_uri, result_set_size, start_position, total_set_size].hash
+      [end_position, envelopes, folders, next_uri, previous_uri, result_set_size, start_position, total_set_size].hash
     end
 
     # Builds the object from hash
@@ -145,10 +160,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]]))
@@ -230,7 +245,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) }
@@ -243,4 +258,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/folder_shared_item.rb

@@ -0,0 +1,289 @@
+=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 FolderSharedItem
+    attr_accessor :error_details
+
+    # 
+    attr_accessor :folder_id
+
+    # 
+    attr_accessor :name
+
+    attr_accessor :owner
+
+    # 
+    attr_accessor :parent_folder_id
+
+    # 
+    attr_accessor :parent_folder_uri
+
+    # When set to **true**, this custom tab is shared.
+    attr_accessor :shared
+
+    # 
+    attr_accessor :shared_groups
+
+    # 
+    attr_accessor :shared_users
+
+    # 
+    attr_accessor :uri
+
+    attr_accessor :user
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error_details' => :'errorDetails',
+        :'folder_id' => :'folderId',
+        :'name' => :'name',
+        :'owner' => :'owner',
+        :'parent_folder_id' => :'parentFolderId',
+        :'parent_folder_uri' => :'parentFolderUri',
+        :'shared' => :'shared',
+        :'shared_groups' => :'sharedGroups',
+        :'shared_users' => :'sharedUsers',
+        :'uri' => :'uri',
+        :'user' => :'user'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error_details' => :'ErrorDetails',
+        :'folder_id' => :'String',
+        :'name' => :'String',
+        :'owner' => :'UserInfo',
+        :'parent_folder_id' => :'String',
+        :'parent_folder_uri' => :'String',
+        :'shared' => :'String',
+        :'shared_groups' => :'Array<MemberGroupSharedItem>',
+        :'shared_users' => :'Array<UserSharedItem>',
+        :'uri' => :'String',
+        :'user' => :'UserInfo'
+      }
+    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?(:'folderId')
+        self.folder_id = attributes[:'folderId']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'owner')
+        self.owner = attributes[:'owner']
+      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?(:'shared')
+        self.shared = attributes[:'shared']
+      end
+
+      if attributes.has_key?(:'sharedGroups')
+        if (value = attributes[:'sharedGroups']).is_a?(Array)
+          self.shared_groups = value
+        end
+      end
+
+      if attributes.has_key?(:'sharedUsers')
+        if (value = attributes[:'sharedUsers']).is_a?(Array)
+          self.shared_users = value
+        end
+      end
+
+      if attributes.has_key?(:'uri')
+        self.uri = attributes[:'uri']
+      end
+
+      if attributes.has_key?(:'user')
+        self.user = attributes[:'user']
+      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 &&
+          folder_id == o.folder_id &&
+          name == o.name &&
+          owner == o.owner &&
+          parent_folder_id == o.parent_folder_id &&
+          parent_folder_uri == o.parent_folder_uri &&
+          shared == o.shared &&
+          shared_groups == o.shared_groups &&
+          shared_users == o.shared_users &&
+          uri == o.uri &&
+          user == o.user
+    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, folder_id, name, owner, parent_folder_id, parent_folder_uri, shared, shared_groups, shared_users, uri, user].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/folders_request.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,17 +12,23 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class FoldersRequest
     # 
     attr_accessor :envelope_ids
 
+    # 
+    attr_accessor :folders
+
     #  The folder ID the envelope is being moved from.
     attr_accessor :from_folder_id
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'envelope_ids' => :'envelopeIds',
+        :'folders' => :'folders',
         :'from_folder_id' => :'fromFolderId'
       }
     end
@@ -31,6 +37,7 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'envelope_ids' => :'Array<String>',
+        :'folders' => :'Array<Folder>',
         :'from_folder_id' => :'String'
       }
     end
@@ -41,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?(:'envelopeIds')
         if (value = attributes[:'envelopeIds']).is_a?(Array)
@@ -49,22 +56,29 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'folders')
+        if (value = attributes[:'folders']).is_a?(Array)
+          self.folders = value
+        end
+      end
+
       if attributes.has_key?(:'fromFolderId')
         self.from_folder_id = attributes[:'fromFolderId']
       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.
@@ -73,6 +87,7 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           envelope_ids == o.envelope_ids &&
+          folders == o.folders &&
           from_folder_id == o.from_folder_id
     end
 
@@ -85,7 +100,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [envelope_ids, from_folder_id].hash
+      [envelope_ids, folders, from_folder_id].hash
     end
 
     # Builds the object from hash
@@ -95,10 +110,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]]))
@@ -180,7 +195,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) }
@@ -193,4 +208,5 @@ module DocuSign_eSign
     end
 
   end
+
 end