Class: Dropbox::Sign::TeamInviteResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/team_invite_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TeamInviteResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TeamInviteResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInviteResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'email_address')
    self.email_address = attributes[:'email_address']
  end

  if attributes.key?(:'team_id')
    self.team_id = attributes[:'team_id']
  end

  if attributes.key?(:'role')
    self.role = attributes[:'role']
  end

  if attributes.key?(:'sent_at')
    self.sent_at = attributes[:'sent_at']
  end

  if attributes.key?(:'redeemed_at')
    self.redeemed_at = attributes[:'redeemed_at']
  end

  if attributes.key?(:'expires_at')
    self.expires_at = attributes[:'expires_at']
  end
end

Instance Attribute Details

#email_address ⇒ String

Email address of the user invited to this team.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 23

def email_address
  @email_address
end

#expires_at ⇒ Integer

Timestamp when the invitation is expiring.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 43

def expires_at
  @expires_at
end

#redeemed_at ⇒ Integer

Timestamp when the invitation was redeemed.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 39

def redeemed_at
  @redeemed_at
end

#role ⇒ String

Role of the user invited to this team.

Returns:

  • (String) 


31
32
33
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 31

def role
  @role
end

#sent_at ⇒ Integer

Timestamp when the invitation was sent.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 35

def sent_at
  @sent_at
end

#team_id ⇒ String

Id of the team.

Returns:

  • (String) 


27
28
29
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 27

def team_id
  @team_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 46

def self.attribute_map
  {
    :'email_address' => :'email_address',
    :'team_id' => :'team_id',
    :'role' => :'role',
    :'sent_at' => :'sent_at',
    :'redeemed_at' => :'redeemed_at',
    :'expires_at' => :'expires_at'
  }
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



186
187
188
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 186

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ TeamInviteResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



98
99
100
101
102
103
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 98

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "TeamInviteResponse"
  ) || TeamInviteResponse.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



81
82
83
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 81

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



91
92
93
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 91

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



86
87
88
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 86

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 75

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 63

def self.openapi_types
  {
    :'email_address' => :'String',
    :'team_id' => :'String',
    :'role' => :'String',
    :'sent_at' => :'Integer',
    :'redeemed_at' => :'Integer',
    :'expires_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_address == o.email_address &&
      team_id == o.team_id &&
      role == o.role &&
      sent_at == o.sent_at &&
      redeemed_at == o.redeemed_at &&
      expires_at == o.expires_at
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



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/dropbox-sign/models/team_invite_response.rb', line 216

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ 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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 287

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 193

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 179

def hash
  [email_address, team_id, role, sent_at, redeemed_at, expires_at].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



147
148
149
150
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 147

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



262
263
264
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 262

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 268

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



256
257
258
 
# File 'lib/dropbox-sign/models/team_invite_response.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

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
 
# File 'lib/dropbox-sign/models/team_invite_response.rb', line 154

def valid?
  true
end