Class: Phrase::DistributionUpdateParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DistributionUpdateParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
121
122
123
124
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 70

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#fallback_locales_enabled ⇒ Object

Use fallback locale if there is no translation in the current locale.



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

def fallback_locales_enabled
  @fallback_locales_enabled
end

#fallback_to_default_locale ⇒ Object

Indicates whether to fallback to projects default locale when locale can not be found



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

def fallback_to_default_locale
  @fallback_to_default_locale
end

#fallback_to_non_regional_locale ⇒ Object

Indicates whether to fallback to non regional locale when locale can not be found



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

def fallback_to_non_regional_locale
  @fallback_to_non_regional_locale
end

#format_options ⇒ Object

Additional formatting and render options. Only enclose_in_cdata is available for platform android.



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

def format_options
  @format_options
end

#locale_ids ⇒ Object

List of locale ids that will be part of distribution releases



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

def locale_ids
  @locale_ids
end

#name ⇒ Object

Name of the distribution



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

def name
  @name
end

#platforms ⇒ Object

List of platforms the distribution should support.



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

def platforms
  @platforms
end

#project_id ⇒ Object

Project id the distribution should be assigned to.



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

def project_id
  @project_id
end

#use_last_reviewed_version ⇒ Object

Use last reviewed instead of latest translation in a project



30
31
32
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 30

def use_last_reviewed_version
  @use_last_reviewed_version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'project_id' => :'project_id',
    :'platforms' => :'platforms',
    :'locale_ids' => :'locale_ids',
    :'format_options' => :'format_options',
    :'fallback_locales_enabled' => :'fallback_locales_enabled',
    :'fallback_to_non_regional_locale' => :'fallback_to_non_regional_locale',
    :'fallback_to_default_locale' => :'fallback_to_default_locale',
    :'use_last_reviewed_version' => :'use_last_reviewed_version'
  }
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



170
171
172
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 170

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



63
64
65
66
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 63

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 48

def self.openapi_types
  {
    :'name' => :'String',
    :'project_id' => :'String',
    :'platforms' => :'Array<String>',
    :'locale_ids' => :'Array<String>',
    :'format_options' => :'Hash<String, String>',
    :'fallback_locales_enabled' => :'Boolean',
    :'fallback_to_non_regional_locale' => :'Boolean',
    :'fallback_to_default_locale' => :'Boolean',
    :'use_last_reviewed_version' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      project_id == o.project_id &&
      platforms == o.platforms &&
      locale_ids == o.locale_ids &&
      format_options == o.format_options &&
      fallback_locales_enabled == o.fallback_locales_enabled &&
      fallback_to_non_regional_locale == o.fallback_to_non_regional_locale &&
      fallback_to_default_locale == o.fallback_to_default_locale &&
      use_last_reviewed_version == o.use_last_reviewed_version
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



198
199
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
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 198

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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 269

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



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

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


157
158
159
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 163

def hash
  [name, project_id, platforms, locale_ids, format_options, fallback_locales_enabled, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].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



128
129
130
131
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 128

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



245
246
247
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 245

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 251

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



239
240
241
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 239

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



135
136
137
 
# File 'lib/phrase/models/distribution_update_parameters.rb', line 135

def valid?
  true
end