Class: DocuSign_eSign::FolderSharedItem

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/folder_shared_item.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FolderSharedItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash


83
84
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 83

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

Instance Attribute Details

#error_detailsObject

Returns the value of attribute error_details


17
18
19
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 17

def error_details
  @error_details
end

#folder_idObject

Returns the value of attribute folder_id


20
21
22
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 20

def folder_id
  @folder_id
end

#nameObject

Returns the value of attribute name


23
24
25
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 23

def name
  @name
end

#ownerObject

Returns the value of attribute owner


25
26
27
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 25

def owner
  @owner
end

#parent_folder_idObject

Returns the value of attribute parent_folder_id


28
29
30
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 28

def parent_folder_id
  @parent_folder_id
end

#parent_folder_uriObject

Returns the value of attribute parent_folder_uri


31
32
33
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 31

def parent_folder_uri
  @parent_folder_uri
end

#sharedObject

When set to *true*, this custom tab is shared.


34
35
36
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 34

def shared
  @shared
end

#shared_groupsObject

Returns the value of attribute shared_groups


37
38
39
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 37

def shared_groups
  @shared_groups
end

#shared_usersObject

Returns the value of attribute shared_users


40
41
42
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 40

def shared_users
  @shared_users
end

#uriObject

Returns the value of attribute uri


43
44
45
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 43

def uri
  @uri
end

#userObject

Returns the value of attribute user


45
46
47
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 45

def user
  @user
end

Class Method Details

.attribute_mapObject

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


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 48

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

.swagger_typesObject

Attribute type mapping.


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 65

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 153

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

#_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


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
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 205

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


271
272
273
274
275
276
277
278
279
280
281
282
283
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 271

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


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 184

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

171
172
173
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 171

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


177
178
179
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 177

def hash
  [error_details, folder_id, name, owner, parent_folder_id, parent_folder_uri, shared, shared_groups, shared_users, uri, user].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


140
141
142
143
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


251
252
253
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 251

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


257
258
259
260
261
262
263
264
265
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 257

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


245
246
247
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 245

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


147
148
149
# File 'lib/docusign_esign/models/folder_shared_item.rb', line 147

def valid?
  true
end