Class: Phrase::InvitationCreateParameters

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/models/invitation_create_parameters.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvitationCreateParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 65

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::InvitationCreateParameters` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::InvitationCreateParameters`. 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')
    self.email = attributes[:'email']
  end

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

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

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

  if attributes.key?(:'space_ids')
    if (value = attributes[:'space_ids']).is_a?(Array)
      self.space_ids = value
    end
  end

  if attributes.key?(:'team_ids')
    if (value = attributes[:'team_ids']).is_a?(Array)
      self.team_ids = value
    end
  end

  if attributes.key?(:'default_locale_codes')
    if (value = attributes[:'default_locale_codes']).is_a?(Array)
      self.default_locale_codes = value
    end
  end

  if attributes.key?(:'permissions')
    if (value = attributes[:'permissions']).is_a?(Hash)
      self.permissions = value
    end
  end
end

Instance Attribute Details

#default_locale_codes ⇒ Object

List of default locales for the user.



24
25
26
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 24

def default_locale_codes
  @default_locale_codes
end

#email ⇒ Object

The email of the invited user. The email can not be updated once created. Create a new invitation for each unique email.



6
7
8
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 6

def email
  @email
end

#locale_ids ⇒ Object

List of locale ids the invited user has access to.



15
16
17
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 15

def locale_ids
  @locale_ids
end

#permissions ⇒ Object

Additional permissions depending on invitation role. Available permissions are create_upload and review_translations



27
28
29
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 27

def permissions
  @permissions
end

#project_ids ⇒ Object

List of project ids the invited user has access to.



12
13
14
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 12

def project_ids
  @project_ids
end

#role ⇒ Object

Invitiation role, can be any of Manager, Developer, Translator.



9
10
11
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 9

def role
  @role
end

#space_ids ⇒ Object

List of spaces the user is assigned to.



18
19
20
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 18

def space_ids
  @space_ids
end

#team_ids ⇒ Object

List of teams the user is assigned to.



21
22
23
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 21

def team_ids
  @team_ids
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 30

def self.attribute_map
  {
    :'email' => :'email',
    :'role' => :'role',
    :'project_ids' => :'project_ids',
    :'locale_ids' => :'locale_ids',
    :'space_ids' => :'space_ids',
    :'team_ids' => :'team_ids',
    :'default_locale_codes' => :'default_locale_codes',
    :'permissions' => :'permissions'
  }
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



172
173
174
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 172

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



58
59
60
61
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 58

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

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 44

def self.openapi_types
  {
    :'email' => :'String',
    :'role' => :'String',
    :'project_ids' => :'String',
    :'locale_ids' => :'String',
    :'space_ids' => :'Array<String>',
    :'team_ids' => :'Array<String>',
    :'default_locale_codes' => :'Array<String>',
    :'permissions' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      role == o.role &&
      project_ids == o.project_ids &&
      locale_ids == o.locale_ids &&
      space_ids == o.space_ids &&
      team_ids == o.team_ids &&
      default_locale_codes == o.default_locale_codes &&
      permissions == o.permissions
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



200
201
202
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
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 200

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :Time
    Time.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
    Phrase.const_get(type).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/phrase/models/invitation_create_parameters.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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 179

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


159
160
161
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



165
166
167
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 165

def hash
  [email, role, project_ids, locale_ids, space_ids, team_ids, default_locale_codes, permissions].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



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 121

def list_invalid_properties
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @role.nil?
    invalid_properties.push('invalid value for "role", role cannot be nil.')
  end

  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



247
248
249
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 247

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 253

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

    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



241
242
243
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 241

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



136
137
138
139
140
 
# File 'lib/phrase/models/invitation_create_parameters.rb', line 136

def valid?
  return false if @email.nil?
  return false if @role.nil?
  true
end