Class: DocuSign_eSign::Folder
- Inherits:
-
Object
- Object
- DocuSign_eSign::Folder
- Defined in:
- lib/docusign_esign/models/folder.rb
Instance Attribute Summary collapse
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#filter ⇒ Object
Returns the value of attribute filter.
-
#folder_id ⇒ Object
Returns the value of attribute folder_id.
-
#folders ⇒ Object
A collection of folder objects returned in a response.
-
#name ⇒ Object
Returns the value of attribute name.
-
#owner_email ⇒ Object
Returns the value of attribute owner_email.
-
#owner_user_id ⇒ Object
Returns the value of attribute owner_user_id.
-
#owner_user_name ⇒ Object
Returns the value of attribute owner_user_name.
-
#parent_folder_id ⇒ Object
Returns the value of attribute parent_folder_id.
-
#parent_folder_uri ⇒ Object
Returns the value of attribute parent_folder_uri.
-
#type ⇒ Object
Returns the value of attribute type.
-
#uri ⇒ Object
Returns the value of attribute uri.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Folder
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Folder
Initializes the object
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/docusign_esign/models/folder.rb', line 90 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 |
Instance Attribute Details
#error_details ⇒ Object
Returns the value of attribute error_details.
17 18 19 |
# File 'lib/docusign_esign/models/folder.rb', line 17 def error_details @error_details end |
#filter ⇒ Object
Returns the value of attribute filter.
19 20 21 |
# File 'lib/docusign_esign/models/folder.rb', line 19 def filter @filter end |
#folder_id ⇒ Object
Returns the value of attribute folder_id.
22 23 24 |
# File 'lib/docusign_esign/models/folder.rb', line 22 def folder_id @folder_id end |
#folders ⇒ Object
A collection of folder objects returned in a response.
25 26 27 |
# File 'lib/docusign_esign/models/folder.rb', line 25 def folders @folders end |
#name ⇒ Object
Returns the value of attribute name.
28 29 30 |
# File 'lib/docusign_esign/models/folder.rb', line 28 def name @name end |
#owner_email ⇒ Object
Returns the value of attribute owner_email.
31 32 33 |
# File 'lib/docusign_esign/models/folder.rb', line 31 def owner_email @owner_email end |
#owner_user_id ⇒ Object
Returns the value of attribute owner_user_id.
34 35 36 |
# File 'lib/docusign_esign/models/folder.rb', line 34 def owner_user_id @owner_user_id end |
#owner_user_name ⇒ Object
Returns the value of attribute owner_user_name.
37 38 39 |
# File 'lib/docusign_esign/models/folder.rb', line 37 def owner_user_name @owner_user_name end |
#parent_folder_id ⇒ Object
Returns the value of attribute parent_folder_id.
40 41 42 |
# File 'lib/docusign_esign/models/folder.rb', line 40 def parent_folder_id @parent_folder_id end |
#parent_folder_uri ⇒ Object
Returns the value of attribute parent_folder_uri.
43 44 45 |
# File 'lib/docusign_esign/models/folder.rb', line 43 def parent_folder_uri @parent_folder_uri end |
#type ⇒ Object
Returns the value of attribute type.
46 47 48 |
# File 'lib/docusign_esign/models/folder.rb', line 46 def type @type end |
#uri ⇒ Object
Returns the value of attribute uri.
49 50 51 |
# File 'lib/docusign_esign/models/folder.rb', line 49 def uri @uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/docusign_esign/models/folder.rb', line 53 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 |
.swagger_types ⇒ Object
Attribute type mapping.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/docusign_esign/models/folder.rb', line 71 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'lib/docusign_esign/models/folder.rb', line 163 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 |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/docusign_esign/models/folder.rb', line 216 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/docusign_esign/models/folder.rb', line 282 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/docusign_esign/models/folder.rb', line 195 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 |
#eql?(o) ⇒ Boolean
182 183 184 |
# File 'lib/docusign_esign/models/folder.rb', line 182 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
188 189 190 |
# File 'lib/docusign_esign/models/folder.rb', line 188 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 |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
150 151 152 153 |
# File 'lib/docusign_esign/models/folder.rb', line 150 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
262 263 264 |
# File 'lib/docusign_esign/models/folder.rb', line 262 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
268 269 270 271 272 273 274 275 276 |
# File 'lib/docusign_esign/models/folder.rb', line 268 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 |
#to_s ⇒ String
Returns the string representation of the object
256 257 258 |
# File 'lib/docusign_esign/models/folder.rb', line 256 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
157 158 159 |
# File 'lib/docusign_esign/models/folder.rb', line 157 def valid? return true end |