Class: Phrase::LocaleDownloadCreateParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocaleDownloadCreateParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#branch ⇒ Object

specify the branch to use



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

def branch
  @branch
end

#custom_metadata_filters ⇒ Object

Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.



51
52
53
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 51

def custom_metadata_filters
  @custom_metadata_filters
end

#encoding ⇒ Object

Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1".



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

def encoding
  @encoding
end

#exclude_empty_zero_forms ⇒ Object

Indicates whether zero forms should be included when empty in pluralized keys.



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

def exclude_empty_zero_forms
  @exclude_empty_zero_forms
end

#fallback_locale_id ⇒ Object

If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true. Mutually exclusive with use_locale_fallback.



42
43
44
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 42

def fallback_locale_id
  @fallback_locale_id
end

#file_format ⇒ Object

File format name. See the [format guide](support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats.



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

def file_format
  @file_format
end

#format_options ⇒ Object

Additional formatting and render options. See the [format guide](support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: ‘…&format_options=bar`



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

def format_options
  @format_options
end

#include_empty_translations ⇒ Object

Indicates whether keys without translations should be included in the output as well.



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

def include_empty_translations
  @include_empty_translations
end

#include_translated_keys ⇒ Object

Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.



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

def include_translated_keys
  @include_translated_keys
end

#include_unverified_translations ⇒ Object

if set to false unverified translations are excluded



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

def include_unverified_translations
  @include_unverified_translations
end

#keep_notranslate_tags ⇒ Object

Indicates whether [NOTRANSLATE] tags should be kept.



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

def keep_notranslate_tags
  @keep_notranslate_tags
end

#locale_ids ⇒ Object

Locale IDs or locale names



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

def locale_ids
  @locale_ids
end

#source_locale_id ⇒ Object

Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a tag parameter indicating a specific job.



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

def source_locale_id
  @source_locale_id
end

#tags ⇒ Object

Limit results to keys tagged with a list of comma separated tag names.



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

def tags
  @tags
end

#updated_since ⇒ Object

Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., 2023-01-01T00:00:00Z).



54
55
56
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 54

def updated_since
  @updated_since
end

#use_last_reviewed_version ⇒ Object

If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.



36
37
38
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 36

def use_last_reviewed_version
  @use_last_reviewed_version
end

#use_locale_fallback ⇒ Object

If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in [locale’s settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id). Requires include_empty_translations to be set to true. Mutually exclusive with fallback_locale_id.



45
46
47
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 45

def use_locale_fallback
  @use_locale_fallback
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 57

def self.attribute_map
  {
    :'file_format' => :'file_format',
    :'branch' => :'branch',
    :'tags' => :'tags',
    :'include_empty_translations' => :'include_empty_translations',
    :'exclude_empty_zero_forms' => :'exclude_empty_zero_forms',
    :'include_translated_keys' => :'include_translated_keys',
    :'keep_notranslate_tags' => :'keep_notranslate_tags',
    :'format_options' => :'format_options',
    :'encoding' => :'encoding',
    :'include_unverified_translations' => :'include_unverified_translations',
    :'use_last_reviewed_version' => :'use_last_reviewed_version',
    :'locale_ids' => :'locale_ids',
    :'fallback_locale_id' => :'fallback_locale_id',
    :'use_locale_fallback' => :'use_locale_fallback',
    :'source_locale_id' => :'source_locale_id',
    :'custom_metadata_filters' => :'custom_metadata_filters',
    :'updated_since' => :'updated_since'
  }
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



251
252
253
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 80

def self.openapi_types
  {
    :'file_format' => :'String',
    :'branch' => :'String',
    :'tags' => :'String',
    :'include_empty_translations' => :'Boolean',
    :'exclude_empty_zero_forms' => :'Boolean',
    :'include_translated_keys' => :'Boolean',
    :'keep_notranslate_tags' => :'Boolean',
    :'format_options' => :'Object',
    :'encoding' => :'String',
    :'include_unverified_translations' => :'Boolean',
    :'use_last_reviewed_version' => :'Boolean',
    :'locale_ids' => :'Array<String>',
    :'fallback_locale_id' => :'String',
    :'use_locale_fallback' => :'Boolean',
    :'source_locale_id' => :'String',
    :'custom_metadata_filters' => :'Object',
    :'updated_since' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_format == o.file_format &&
      branch == o.branch &&
      tags == o.tags &&
      include_empty_translations == o.include_empty_translations &&
      exclude_empty_zero_forms == o.exclude_empty_zero_forms &&
      include_translated_keys == o.include_translated_keys &&
      keep_notranslate_tags == o.keep_notranslate_tags &&
      format_options == o.format_options &&
      encoding == o.encoding &&
      include_unverified_translations == o.include_unverified_translations &&
      use_last_reviewed_version == o.use_last_reviewed_version &&
      locale_ids == o.locale_ids &&
      fallback_locale_id == o.fallback_locale_id &&
      use_locale_fallback == o.use_locale_fallback &&
      source_locale_id == o.source_locale_id &&
      custom_metadata_filters == o.custom_metadata_filters &&
      updated_since == o.updated_since
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 279

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 350

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 258

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


238
239
240
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 244

def hash
  [file_format, branch, tags, include_empty_translations, exclude_empty_zero_forms, include_translated_keys, keep_notranslate_tags, format_options, encoding, include_unverified_translations, use_last_reviewed_version, locale_ids, fallback_locale_id, use_locale_fallback, source_locale_id, custom_metadata_filters, updated_since].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



196
197
198
199
200
201
202
203
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 196

def list_invalid_properties
  invalid_properties = Array.new
  if @file_format.nil?
    invalid_properties.push('invalid value for "file_format", file_format 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



326
327
328
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 326

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



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

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



320
321
322
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 320

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



207
208
209
210
 
# File 'lib/phrase/models/locale_download_create_parameters.rb', line 207

def valid?
  return false if @file_format.nil?
  true
end