Class: Dropbox::Sign::TeamRemoveMemberRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TeamRemoveMemberRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TeamRemoveMemberRequest` 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::TeamRemoveMemberRequest`. 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?(:'account_id')
    self. = attributes[:'account_id']
  end

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

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

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

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

Instance Attribute Details

#account_id ⇒ String

account_id or email_address is required. If both are provided, the account id prevails. Account id to remove from your Team.

Returns:

  • (String) 


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

def 
  @account_id
end

#email_address ⇒ String

account_id or email_address is required. If both are provided, the account id prevails. Email address of the Account to remove from your Team.

Returns:

  • (String) 


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

def email_address
  @email_address
end

#new_owner_email_address ⇒ String

The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account. NOTE: Only available for Enterprise plans.

Returns:

  • (String) 


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

def new_owner_email_address
  @new_owner_email_address
end

#new_role ⇒ String

A new role member will take in a new Team. NOTE: This parameter is used only if ‘new_team_id` is provided.

Returns:

  • (String) 


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

def new_role
  @new_role
end

#new_team_id ⇒ String

Id of the new Team.

Returns:

  • (String) 


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

def new_team_id
  @new_team_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'email_address' => :'email_address',
    :'new_owner_email_address' => :'new_owner_email_address',
    :'new_team_id' => :'new_team_id',
    :'new_role' => :'new_role'
  }
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



209
210
211
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 209

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

.init(data) ⇒ TeamRemoveMemberRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



114
115
116
117
118
119
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 114

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



97
98
99
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 97

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



107
108
109
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 107

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



102
103
104
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 102

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 80

def self.openapi_types
  {
    :'account_id' => :'String',
    :'email_address' => :'String',
    :'new_owner_email_address' => :'String',
    :'new_team_id' => :'String',
    :'new_role' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      email_address == o.email_address &&
      new_owner_email_address == o.new_owner_email_address &&
      new_team_id == o.new_team_id &&
      new_role == o.new_role
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 239

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 310

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 216

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


196
197
198
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 202

def hash
  [, email_address, new_owner_email_address, new_team_id, new_role].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



159
160
161
162
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 159

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



285
286
287
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 285

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 291

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



279
280
281
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 279

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



166
167
168
169
170
 
# File 'lib/dropbox-sign/models/team_remove_member_request.rb', line 166

def valid?
  new_role_validator = EnumAttributeValidator.new('String', ["Member", "Developer", "Team Manager", "Admin"])
  return false unless new_role_validator.valid?(@new_role)
  true
end