Class: DocuSign_eSign::WorkspaceUserAuthorization

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

Overview

Provides properties that describe user authorization to a workspace.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkspaceUserAuthorization

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

  if attributes.has_key?(:'canView')
    self.can_view = attributes[:'canView']
  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?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

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

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

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

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

Instance Attribute Details

#can_deleteObject

Returns the value of attribute can_delete


19
20
21
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 19

def can_delete
  @can_delete
end

#can_moveObject

Returns the value of attribute can_move


22
23
24
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 22

def can_move
  @can_move
end

#can_transactObject

Returns the value of attribute can_transact


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

def can_transact
  @can_transact
end

#can_viewObject

Returns the value of attribute can_view


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

def can_view
  @can_view
end

#createdObject

The UTC DateTime when the workspace user authorization was created.


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

def created
  @created
end

#created_by_idObject

Returns the value of attribute created_by_id


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

def created_by_id
  @created_by_id
end

#error_detailsObject

Returns the value of attribute error_details


36
37
38
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 36

def error_details
  @error_details
end

#modifiedObject

Returns the value of attribute modified


39
40
41
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 39

def modified
  @modified
end

#modified_by_idObject

Returns the value of attribute modified_by_id


42
43
44
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 42

def modified_by_id
  @modified_by_id
end

#workspace_user_idObject

Returns the value of attribute workspace_user_id


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

def workspace_user_id
  @workspace_user_id
end

#workspace_user_informationObject

Returns the value of attribute workspace_user_information


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

def workspace_user_information
  @workspace_user_information
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'can_delete' => :'canDelete',
    :'can_move' => :'canMove',
    :'can_transact' => :'canTransact',
    :'can_view' => :'canView',
    :'created' => :'created',
    :'created_by_id' => :'createdById',
    :'error_details' => :'errorDetails',
    :'modified' => :'modified',
    :'modified_by_id' => :'modifiedById',
    :'workspace_user_id' => :'workspaceUserId',
    :'workspace_user_information' => :'workspaceUserInformation'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'can_delete' => :'String',
    :'can_move' => :'String',
    :'can_transact' => :'String',
    :'can_view' => :'String',
    :'created' => :'String',
    :'created_by_id' => :'String',
    :'error_details' => :'ErrorDetails',
    :'modified' => :'String',
    :'modified_by_id' => :'String',
    :'workspace_user_id' => :'String',
    :'workspace_user_information' => :'WorkspaceUser'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      can_delete == o.can_delete &&
      can_move == o.can_move &&
      can_transact == o.can_transact &&
      can_view == o.can_view &&
      created == o.created &&
      created_by_id == o.created_by_id &&
      error_details == o.error_details &&
      modified == o.modified &&
      modified_by_id == o.modified_by_id &&
      workspace_user_id == o.workspace_user_id &&
      workspace_user_information == o.workspace_user_information
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


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

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


269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 269

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


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

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

169
170
171
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 169

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


175
176
177
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 175

def hash
  [can_delete, can_move, can_transact, can_view, created, created_by_id, error_details, modified, modified_by_id, workspace_user_id, workspace_user_information].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


138
139
140
141
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 138

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


249
250
251
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 249

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


255
256
257
258
259
260
261
262
263
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 255

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


243
244
245
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 243

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


145
146
147
# File 'lib/docusign_esign/models/workspace_user_authorization.rb', line 145

def valid?
  true
end