Class: Phrase::TranslationKeyDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TranslationKeyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/phrase/models/translation_key_details.rb', line 112

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comments_count ⇒ Object

Returns the value of attribute comments_count.



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

def comments_count
  @comments_count
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#creator ⇒ Object

Returns the value of attribute creator.



41
42
43
 
# File 'lib/phrase/models/translation_key_details.rb', line 41

def creator
  @creator
end

#custom_metadata ⇒ Object

Returns the value of attribute custom_metadata.



43
44
45
 
# File 'lib/phrase/models/translation_key_details.rb', line 43

def custom_metadata
  @custom_metadata
end

#data_type ⇒ Object

Returns the value of attribute data_type.



19
20
21
 
# File 'lib/phrase/models/translation_key_details.rb', line 19

def data_type
  @data_type
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#format_value_type ⇒ Object

Returns the value of attribute format_value_type.



39
40
41
 
# File 'lib/phrase/models/translation_key_details.rb', line 39

def format_value_type
  @format_value_type
end

#id ⇒ Object

Returns the value of attribute id.



5
6
7
 
# File 'lib/phrase/models/translation_key_details.rb', line 5

def id
  @id
end

#max_characters_allowed ⇒ Object

Returns the value of attribute max_characters_allowed.



29
30
31
 
# File 'lib/phrase/models/translation_key_details.rb', line 29

def max_characters_allowed
  @max_characters_allowed
end

#name ⇒ Object

Returns the value of attribute name.



7
8
9
 
# File 'lib/phrase/models/translation_key_details.rb', line 7

def name
  @name
end

#name_hash ⇒ Object

Returns the value of attribute name_hash.



11
12
13
 
# File 'lib/phrase/models/translation_key_details.rb', line 11

def name_hash
  @name_hash
end

#name_plural ⇒ Object

Returns the value of attribute name_plural.



25
26
27
 
# File 'lib/phrase/models/translation_key_details.rb', line 25

def name_plural
  @name_plural
end

#original_file ⇒ Object

Returns the value of attribute original_file.



37
38
39
 
# File 'lib/phrase/models/translation_key_details.rb', line 37

def original_file
  @original_file
end

#plural ⇒ Object

Returns the value of attribute plural.



13
14
15
 
# File 'lib/phrase/models/translation_key_details.rb', line 13

def plural
  @plural
end

#screenshot_url ⇒ Object

Returns the value of attribute screenshot_url.



31
32
33
 
# File 'lib/phrase/models/translation_key_details.rb', line 31

def screenshot_url
  @screenshot_url
end

#tags ⇒ Object

Returns the value of attribute tags.



17
18
19
 
# File 'lib/phrase/models/translation_key_details.rb', line 17

def tags
  @tags
end

#unformatted ⇒ Object

Returns the value of attribute unformatted.



33
34
35
 
# File 'lib/phrase/models/translation_key_details.rb', line 33

def unformatted
  @unformatted
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



23
24
25
 
# File 'lib/phrase/models/translation_key_details.rb', line 23

def updated_at
  @updated_at
end

#use_ordinal_rules ⇒ Object

Returns the value of attribute use_ordinal_rules.



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

def use_ordinal_rules
  @use_ordinal_rules
end

#xml_space_preserve ⇒ Object

Returns the value of attribute xml_space_preserve.



35
36
37
 
# File 'lib/phrase/models/translation_key_details.rb', line 35

def xml_space_preserve
  @xml_space_preserve
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/phrase/models/translation_key_details.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'name_hash' => :'name_hash',
    :'plural' => :'plural',
    :'use_ordinal_rules' => :'use_ordinal_rules',
    :'tags' => :'tags',
    :'data_type' => :'data_type',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name_plural' => :'name_plural',
    :'comments_count' => :'comments_count',
    :'max_characters_allowed' => :'max_characters_allowed',
    :'screenshot_url' => :'screenshot_url',
    :'unformatted' => :'unformatted',
    :'xml_space_preserve' => :'xml_space_preserve',
    :'original_file' => :'original_file',
    :'format_value_type' => :'format_value_type',
    :'creator' => :'creator',
    :'custom_metadata' => :'custom_metadata'
  }
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



265
266
267
 
# File 'lib/phrase/models/translation_key_details.rb', line 265

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



104
105
106
107
108
 
# File 'lib/phrase/models/translation_key_details.rb', line 104

def self.openapi_all_of
  [
  :'TranslationKey'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/phrase/models/translation_key_details.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/phrase/models/translation_key_details.rb', line 72

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'name_hash' => :'String',
    :'plural' => :'Boolean',
    :'use_ordinal_rules' => :'Boolean',
    :'tags' => :'Array<String>',
    :'data_type' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name_plural' => :'String',
    :'comments_count' => :'Integer',
    :'max_characters_allowed' => :'Integer',
    :'screenshot_url' => :'String',
    :'unformatted' => :'Boolean',
    :'xml_space_preserve' => :'Boolean',
    :'original_file' => :'String',
    :'format_value_type' => :'String',
    :'creator' => :'UserPreview',
    :'custom_metadata' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/phrase/models/translation_key_details.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      name_hash == o.name_hash &&
      plural == o.plural &&
      use_ordinal_rules == o.use_ordinal_rules &&
      tags == o.tags &&
      data_type == o.data_type &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name_plural == o.name_plural &&
      comments_count == o.comments_count &&
      max_characters_allowed == o.max_characters_allowed &&
      screenshot_url == o.screenshot_url &&
      unformatted == o.unformatted &&
      xml_space_preserve == o.xml_space_preserve &&
      original_file == o.original_file &&
      format_value_type == o.format_value_type &&
      creator == o.creator &&
      custom_metadata == o.custom_metadata
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/phrase/models/translation_key_details.rb', line 293

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/phrase/models/translation_key_details.rb', line 364

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/phrase/models/translation_key_details.rb', line 272

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


252
253
254
 
# File 'lib/phrase/models/translation_key_details.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/phrase/models/translation_key_details.rb', line 258

def hash
  [id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at, name_plural, comments_count, max_characters_allowed, screenshot_url, unformatted, xml_space_preserve, original_file, format_value_type, creator, custom_metadata].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



212
213
214
215
 
# File 'lib/phrase/models/translation_key_details.rb', line 212

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



340
341
342
 
# File 'lib/phrase/models/translation_key_details.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/phrase/models/translation_key_details.rb', line 346

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



334
335
336
 
# File 'lib/phrase/models/translation_key_details.rb', line 334

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



219
220
221
 
# File 'lib/phrase/models/translation_key_details.rb', line 219

def valid?
  true
end