Class: Phrase::StyleguideDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StyleguideDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/phrase/models/styleguide_details.rb', line 100

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audience ⇒ Object

Returns the value of attribute audience.



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

def audience
  @audience
end

#business ⇒ Object

Returns the value of attribute business.



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

def business
  @business
end

#company_branding ⇒ Object

Returns the value of attribute company_branding.



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

def company_branding
  @company_branding
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#formatting ⇒ Object

Returns the value of attribute formatting.



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

def formatting
  @formatting
end

#glossary_terms ⇒ Object

Returns the value of attribute glossary_terms.



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

def glossary_terms
  @glossary_terms
end

#grammar_consistency ⇒ Object

Returns the value of attribute grammar_consistency.



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

def grammar_consistency
  @grammar_consistency
end

#grammatical_person ⇒ Object

Returns the value of attribute grammatical_person.



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

def grammatical_person
  @grammatical_person
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#literal_translation ⇒ Object

Returns the value of attribute literal_translation.



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

def literal_translation
  @literal_translation
end

#overall_tone ⇒ Object

Returns the value of attribute overall_tone.



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

def overall_tone
  @overall_tone
end

#public_url ⇒ Object

Returns the value of attribute public_url.



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

def public_url
  @public_url
end

#samples ⇒ Object

Returns the value of attribute samples.



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

def samples
  @samples
end

#target_audience ⇒ Object

Returns the value of attribute target_audience.



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

def target_audience
  @target_audience
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#vocabulary_type ⇒ Object

Returns the value of attribute vocabulary_type.



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

def vocabulary_type
  @vocabulary_type
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/phrase/models/styleguide_details.rb', line 40

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'public_url' => :'public_url',
    :'audience' => :'audience',
    :'target_audience' => :'target_audience',
    :'grammatical_person' => :'grammatical_person',
    :'vocabulary_type' => :'vocabulary_type',
    :'business' => :'business',
    :'company_branding' => :'company_branding',
    :'formatting' => :'formatting',
    :'glossary_terms' => :'glossary_terms',
    :'grammar_consistency' => :'grammar_consistency',
    :'literal_translation' => :'literal_translation',
    :'overall_tone' => :'overall_tone',
    :'samples' => :'samples'
  }
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



234
235
236
 
# File 'lib/phrase/models/styleguide_details.rb', line 234

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



92
93
94
95
96
 
# File 'lib/phrase/models/styleguide_details.rb', line 92

def self.openapi_all_of
  [
  :'Styleguide'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/phrase/models/styleguide_details.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/phrase/models/styleguide_details.rb', line 63

def self.openapi_types
  {
    :'id' => :'String',
    :'title' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'public_url' => :'String',
    :'audience' => :'String',
    :'target_audience' => :'String',
    :'grammatical_person' => :'String',
    :'vocabulary_type' => :'String',
    :'business' => :'String',
    :'company_branding' => :'String',
    :'formatting' => :'String',
    :'glossary_terms' => :'String',
    :'grammar_consistency' => :'String',
    :'literal_translation' => :'String',
    :'overall_tone' => :'String',
    :'samples' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/phrase/models/styleguide_details.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      public_url == o.public_url &&
      audience == o.audience &&
      target_audience == o.target_audience &&
      grammatical_person == o.grammatical_person &&
      vocabulary_type == o.vocabulary_type &&
      business == o.business &&
      company_branding == o.company_branding &&
      formatting == o.formatting &&
      glossary_terms == o.glossary_terms &&
      grammar_consistency == o.grammar_consistency &&
      literal_translation == o.literal_translation &&
      overall_tone == o.overall_tone &&
      samples == o.samples
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/phrase/models/styleguide_details.rb', line 262

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/phrase/models/styleguide_details.rb', line 333

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/phrase/models/styleguide_details.rb', line 241

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


221
222
223
 
# File 'lib/phrase/models/styleguide_details.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/phrase/models/styleguide_details.rb', line 227

def hash
  [id, title, created_at, updated_at, public_url, audience, target_audience, grammatical_person, vocabulary_type, business, company_branding, formatting, glossary_terms, grammar_consistency, literal_translation, overall_tone, samples].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



184
185
186
187
 
# File 'lib/phrase/models/styleguide_details.rb', line 184

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



309
310
311
 
# File 'lib/phrase/models/styleguide_details.rb', line 309

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/phrase/models/styleguide_details.rb', line 315

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



303
304
305
 
# File 'lib/phrase/models/styleguide_details.rb', line 303

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



191
192
193
 
# File 'lib/phrase/models/styleguide_details.rb', line 191

def valid?
  true
end