Class: DocuSign_eSign::WorkspaceItem

Inherits:
Object
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkspaceItem

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
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
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 124

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.caller_authorization = 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?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'uri')
    self.uri = attributes[:'uri']
  end
end

Instance Attribute Details

#caller_authorization ⇒ Object

Returns the value of attribute caller_authorization.



18
19
20
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 18

def caller_authorization
  @caller_authorization
end

#content_type ⇒ Object

Returns the value of attribute content_type.



21
22
23
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 21

def content_type
  @content_type
end

#created ⇒ Object

The UTC DateTime when the workspace item was created.



24
25
26
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 24

def created
  @created
end

#created_by_id ⇒ Object

Returns the value of attribute created_by_id.



27
28
29
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 27

def created_by_id
  @created_by_id
end

#created_by_information ⇒ Object

Returns the value of attribute created_by_information.



29
30
31
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 29

def created_by_information
  @created_by_information
end

#extension ⇒ Object

Returns the value of attribute extension.



32
33
34
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 32

def extension
  @extension
end

#file_size ⇒ Object

Returns the value of attribute file_size.



35
36
37
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 35

def file_size
  @file_size
end

#file_uri ⇒ Object

Returns the value of attribute file_uri.



38
39
40
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 38

def file_uri
  @file_uri
end

#id ⇒ Object

Returns the value of attribute id.



41
42
43
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 41

def id
  @id
end

#is_public ⇒ Object

If true, this supersedes need for bit mask permission with workspaceUserAuthorization



44
45
46
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 44

def is_public
  @is_public
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



47
48
49
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 47

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)



50
51
52
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 50

def last_modified_by_id
  @last_modified_by_id
end

#last_modified_by_information ⇒ Object

Returns the value of attribute last_modified_by_information.



52
53
54
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 52

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.



55
56
57
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 55

def name
  @name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



58
59
60
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 58

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.



61
62
63
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 61

def parent_folder_id
  @parent_folder_id
end

#parent_folder_uri ⇒ Object

Returns the value of attribute parent_folder_uri.



64
65
66
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 64

def parent_folder_uri
  @parent_folder_uri
end

#type ⇒ Object

The type of the workspace item. Valid values are file, folder.



67
68
69
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 67

def type
  @type
end

#uri ⇒ Object

Returns the value of attribute uri.



70
71
72
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 70

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 73

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',
    :'type' => :'type',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 98

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',
    :'type' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      caller_authorization == o.caller_authorization &&
      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 &&
      type == o.type &&
      uri == o.uri
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 282

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 348

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 261

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


248
249
250
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



254
255
256
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 254

def hash
  [caller_authorization, 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, type, uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



209
210
211
212
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 209

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 328

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
337
338
339
340
341
342
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 334

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

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 322

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



216
217
218
 
# File 'lib/docusign_esign/models/workspace_item.rb', line 216

def valid?
  true
end