Class: DocuSign_eSign::WorkspaceItem
- Inherits:
-
Object
- Object
- DocuSign_eSign::WorkspaceItem
- Defined in:
- lib/docusign_esign/models/workspace_item.rb
Overview
A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call.
Instance Attribute Summary collapse
-
#caller_authorization ⇒ Object
Returns the value of attribute caller_authorization.
-
#content_type ⇒ Object
Returns the value of attribute content_type.
-
#created ⇒ Object
The UTC DateTime when the workspace item was created.
-
#created_by_id ⇒ Object
Returns the value of attribute created_by_id.
-
#created_by_information ⇒ Object
Returns the value of attribute created_by_information.
-
#extension ⇒ Object
Returns the value of attribute extension.
-
#file_size ⇒ Object
Returns the value of attribute file_size.
-
#file_uri ⇒ Object
Returns the value of attribute file_uri.
-
#id ⇒ Object
Returns the value of attribute id.
-
#is_public ⇒ Object
If true, this supersedes need for bit mask permission with workspaceUserAuthorization.
-
#last_modified ⇒ Object
Returns the value of attribute last_modified.
-
#last_modified_by_id ⇒ Object
Utc date and time the comment was last updated (can only be done by creator).
-
#last_modified_by_information ⇒ Object
Returns the value of attribute last_modified_by_information.
-
#name ⇒ Object
A simple string description of the item, such as a file name or a folder name.
-
#page_count ⇒ Object
Returns the value of attribute page_count.
-
#parent_folder_id ⇒ Object
The ID of the parent folder.
-
#parent_folder_uri ⇒ Object
Returns the value of attribute parent_folder_uri.
-
#sha256 ⇒ Object
Returns the value of attribute sha256.
-
#thumb_height ⇒ Object
Returns the value of attribute thumb_height.
-
#thumb_width ⇒ Object
Returns the value of attribute thumb_width.
-
#thumbnail ⇒ Object
Returns the value of attribute thumbnail.
-
#type ⇒ Object
The type of the workspace item.
-
#uri ⇒ Object
Returns the value of attribute uri.
-
#user_authorization ⇒ Object
Returns the value of attribute user_authorization.
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 = {}) ⇒ WorkspaceItem
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 = {}) ⇒ WorkspaceItem
Initializes the object
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 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 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 146 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?(:'callerAuthorization') self. = attributes[:'callerAuthorization'] end if attributes.has_key?(:'contentType') self.content_type = attributes[:'contentType'] end if attributes.has_key?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'createdById') self.created_by_id = attributes[:'createdById'] end if attributes.has_key?(:'createdByInformation') self.created_by_information = attributes[:'createdByInformation'] end if attributes.has_key?(:'extension') self.extension = attributes[:'extension'] end if attributes.has_key?(:'fileSize') self.file_size = attributes[:'fileSize'] end if attributes.has_key?(:'fileUri') self.file_uri = attributes[:'fileUri'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'isPublic') self.is_public = attributes[:'isPublic'] end if attributes.has_key?(:'lastModified') self.last_modified = attributes[:'lastModified'] end if attributes.has_key?(:'lastModifiedById') self.last_modified_by_id = attributes[:'lastModifiedById'] end if attributes.has_key?(:'lastModifiedByInformation') self.last_modified_by_information = attributes[:'lastModifiedByInformation'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'pageCount') self.page_count = attributes[:'pageCount'] 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?(:'sha256') self.sha256 = attributes[:'sha256'] end if attributes.has_key?(:'thumbHeight') self.thumb_height = attributes[:'thumbHeight'] end if attributes.has_key?(:'thumbnail') self.thumbnail = attributes[:'thumbnail'] end if attributes.has_key?(:'thumbWidth') self.thumb_width = attributes[:'thumbWidth'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'uri') self.uri = attributes[:'uri'] end if attributes.has_key?(:'userAuthorization') self. = attributes[:'userAuthorization'] end end |
Instance Attribute Details
#caller_authorization ⇒ Object
Returns the value of attribute caller_authorization.
17 18 19 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 17 def @caller_authorization end |
#content_type ⇒ Object
Returns the value of attribute content_type.
20 21 22 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 20 def content_type @content_type end |
#created ⇒ Object
The UTC DateTime when the workspace item was created.
23 24 25 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 23 def created @created end |
#created_by_id ⇒ Object
Returns the value of attribute created_by_id.
26 27 28 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 26 def created_by_id @created_by_id end |
#created_by_information ⇒ Object
Returns the value of attribute created_by_information.
28 29 30 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 28 def created_by_information @created_by_information end |
#extension ⇒ Object
Returns the value of attribute extension.
31 32 33 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 31 def extension @extension end |
#file_size ⇒ Object
Returns the value of attribute file_size.
34 35 36 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 34 def file_size @file_size end |
#file_uri ⇒ Object
Returns the value of attribute file_uri.
37 38 39 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 37 def file_uri @file_uri end |
#id ⇒ Object
Returns the value of attribute id.
40 41 42 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 40 def id @id end |
#is_public ⇒ Object
If true, this supersedes need for bit mask permission with workspaceUserAuthorization
43 44 45 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 43 def is_public @is_public end |
#last_modified ⇒ Object
Returns the value of attribute last_modified.
46 47 48 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 46 def last_modified @last_modified end |
#last_modified_by_id ⇒ Object
Utc date and time the comment was last updated (can only be done by creator)
49 50 51 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 49 def last_modified_by_id @last_modified_by_id end |
#last_modified_by_information ⇒ Object
Returns the value of attribute last_modified_by_information.
51 52 53 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 51 def last_modified_by_information @last_modified_by_information end |
#name ⇒ Object
A simple string description of the item, such as a file name or a folder name.
54 55 56 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 54 def name @name end |
#page_count ⇒ Object
Returns the value of attribute page_count.
57 58 59 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 57 def page_count @page_count end |
#parent_folder_id ⇒ Object
The ID of the parent folder. This is the GUID of the parent folder, or the special value ‘root’ for the root folder.
60 61 62 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 60 def parent_folder_id @parent_folder_id end |
#parent_folder_uri ⇒ Object
Returns the value of attribute parent_folder_uri.
63 64 65 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 63 def parent_folder_uri @parent_folder_uri end |
#sha256 ⇒ Object
Returns the value of attribute sha256.
66 67 68 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 66 def sha256 @sha256 end |
#thumb_height ⇒ Object
Returns the value of attribute thumb_height.
69 70 71 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 69 def thumb_height @thumb_height end |
#thumb_width ⇒ Object
Returns the value of attribute thumb_width.
74 75 76 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 74 def thumb_width @thumb_width end |
#thumbnail ⇒ Object
Returns the value of attribute thumbnail.
71 72 73 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 71 def thumbnail @thumbnail end |
#type ⇒ Object
The type of the workspace item. Valid values are file, folder.
77 78 79 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 77 def type @type end |
#uri ⇒ Object
Returns the value of attribute uri.
80 81 82 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 80 def uri @uri end |
#user_authorization ⇒ Object
Returns the value of attribute user_authorization.
82 83 84 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 82 def @user_authorization end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 85 def self.attribute_map { :'caller_authorization' => :'callerAuthorization', :'content_type' => :'contentType', :'created' => :'created', :'created_by_id' => :'createdById', :'created_by_information' => :'createdByInformation', :'extension' => :'extension', :'file_size' => :'fileSize', :'file_uri' => :'fileUri', :'id' => :'id', :'is_public' => :'isPublic', :'last_modified' => :'lastModified', :'last_modified_by_id' => :'lastModifiedById', :'last_modified_by_information' => :'lastModifiedByInformation', :'name' => :'name', :'page_count' => :'pageCount', :'parent_folder_id' => :'parentFolderId', :'parent_folder_uri' => :'parentFolderUri', :'sha256' => :'sha256', :'thumb_height' => :'thumbHeight', :'thumbnail' => :'thumbnail', :'thumb_width' => :'thumbWidth', :'type' => :'type', :'uri' => :'uri', :'user_authorization' => :'userAuthorization' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 115 def self.swagger_types { :'caller_authorization' => :'WorkspaceUserAuthorization', :'content_type' => :'String', :'created' => :'String', :'created_by_id' => :'String', :'created_by_information' => :'WorkspaceUser', :'extension' => :'String', :'file_size' => :'String', :'file_uri' => :'String', :'id' => :'String', :'is_public' => :'String', :'last_modified' => :'String', :'last_modified_by_id' => :'String', :'last_modified_by_information' => :'WorkspaceUser', :'name' => :'String', :'page_count' => :'String', :'parent_folder_id' => :'String', :'parent_folder_uri' => :'String', :'sha256' => :'String', :'thumb_height' => :'String', :'thumbnail' => :'Page', :'thumb_width' => :'String', :'type' => :'String', :'uri' => :'String', :'user_authorization' => :'WorkspaceUserAuthorization' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 264 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && content_type == o.content_type && created == o.created && created_by_id == o.created_by_id && created_by_information == o.created_by_information && extension == o.extension && file_size == o.file_size && file_uri == o.file_uri && id == o.id && is_public == o.is_public && last_modified == o.last_modified && last_modified_by_id == o.last_modified_by_id && last_modified_by_information == o.last_modified_by_information && name == o.name && page_count == o.page_count && parent_folder_id == o.parent_folder_id && parent_folder_uri == o.parent_folder_uri && sha256 == o.sha256 && thumb_height == o.thumb_height && thumbnail == o.thumbnail && thumb_width == o.thumb_width && type == o.type && uri == o.uri && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 329 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
395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 395 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
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 308 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 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
295 296 297 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 295 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
301 302 303 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 301 def hash [, content_type, created, created_by_id, created_by_information, extension, file_size, file_uri, id, is_public, last_modified, last_modified_by_id, last_modified_by_information, name, page_count, parent_folder_id, parent_folder_uri, sha256, thumb_height, thumbnail, thumb_width, type, uri, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
251 252 253 254 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 251 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
375 376 377 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 375 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
381 382 383 384 385 386 387 388 389 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 381 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
369 370 371 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 369 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
258 259 260 |
# File 'lib/docusign_esign/models/workspace_item.rb', line 258 def valid? true end |