Class: Phrase::TranslationUpdateParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TranslationUpdateParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
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
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 55

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

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

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

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

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

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

Instance Attribute Details

#autotranslate ⇒ Object

Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.



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

def autotranslate
  @autotranslate
end

#branch ⇒ Object

specify the branch to use



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

def branch
  @branch
end

#content ⇒ Object

Translation content



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

def content
  @content
end

#excluded ⇒ Object

Indicates whether translation is excluded.



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

def excluded
  @excluded
end

#plural_suffix ⇒ Object

Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.



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

def plural_suffix
  @plural_suffix
end

#unverified ⇒ Object

Indicates whether translation is unverified. Part of the <a href="support.phrase.com/hc/en-us/articles/5784094755484" target="_blank">Advanced Workflows</a> feature.



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

def unverified
  @unverified
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 24

def self.attribute_map
  {
    :'branch' => :'branch',
    :'content' => :'content',
    :'plural_suffix' => :'plural_suffix',
    :'unverified' => :'unverified',
    :'excluded' => :'excluded',
    :'autotranslate' => :'autotranslate'
  }
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



134
135
136
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 134

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
51
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 36

def self.openapi_types
  {
    :'branch' => :'String',
    :'content' => :'String',
    :'plural_suffix' => :'String',
    :'unverified' => :'Boolean',
    :'excluded' => :'Boolean',
    :'autotranslate' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 108

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      branch == o.branch &&
      content == o.content &&
      plural_suffix == o.plural_suffix &&
      unverified == o.unverified &&
      excluded == o.excluded &&
      autotranslate == o.autotranslate
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



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

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 233

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 141

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


121
122
123
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



127
128
129
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 127

def hash
  [branch, content, plural_suffix, unverified, excluded, autotranslate].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



95
96
97
98
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 95

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



209
210
211
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 209

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 215

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



203
204
205
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 203

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



102
103
104
 
# File 'lib/phrase/models/translation_update_parameters.rb', line 102

def valid?
  true
end