Class: Phrase::KeyCreateParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeyCreateParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'autotranslate')
    self.autotranslate = attributes[:'autotranslate']
  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?(:'localized_format_string')
    self.localized_format_string = attributes[:'localized_format_string']
  end

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

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

Instance Attribute Details

#autotranslate ⇒ Object

Indicates whether the key should be autotranslated to other locales based on the copy provided in ‘default_translation_content`.



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

def autotranslate
  @autotranslate
end

#branch ⇒ Object

specify the branch to use



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

def branch
  @branch
end

#custom_metadata ⇒ Object

Custom metadata property name and value pairs to be associated with key.



57
58
59
 
# File 'lib/phrase/models/key_create_parameters.rb', line 57

def custom_metadata
  @custom_metadata
end

#data_type ⇒ Object

Type of the key. Can be one of the following: string, number, boolean, array, markdown.



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

def data_type
  @data_type
end

#default_translation_content ⇒ Object

Creates a translation in the default locale with the specified content



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

def default_translation_content
  @default_translation_content
end

#description ⇒ Object

Key description (usually includes contextual information for translators)



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

def description
  @description
end

#localized_format_key ⇒ Object

NSStringLocalizedFormatKey attribute. Used in .stringsdict format.



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

def localized_format_key
  @localized_format_key
end

#localized_format_string ⇒ Object

NSStringLocalizedFormatKey attribute. Used in .stringsdict format.



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

def localized_format_string
  @localized_format_string
end

#max_characters_allowed ⇒ Object

Max. number of characters translations for this key can have.



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

def max_characters_allowed
  @max_characters_allowed
end

#name ⇒ Object

Key name



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

def name
  @name
end

#name_plural ⇒ Object

Plural name for the key (used in some file formats, e.g. Gettext)



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

def name_plural
  @name_plural
end

#original_file ⇒ Object

Original file attribute. Used in some formats, e.g. XLIFF.



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

def original_file
  @original_file
end

#plural ⇒ Object

Indicates whether key supports pluralization



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

def plural
  @plural
end

#remove_screenshot ⇒ Object

Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead.



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

def remove_screenshot
  @remove_screenshot
end

#screenshot ⇒ Object

Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead.



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

def screenshot
  @screenshot
end

#tags ⇒ Object

List of tags separated by comma to be associated with the key.



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

def tags
  @tags
end

#unformatted ⇒ Object

Indicates whether the key should be exported as "unformatted". Supported by Android XML and other formats.



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

def unformatted
  @unformatted
end

#xml_space_preserve ⇒ Object

Indicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats.



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

def xml_space_preserve
  @xml_space_preserve
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'branch' => :'branch',
    :'name' => :'name',
    :'description' => :'description',
    :'plural' => :'plural',
    :'name_plural' => :'name_plural',
    :'data_type' => :'data_type',
    :'tags' => :'tags',
    :'max_characters_allowed' => :'max_characters_allowed',
    :'screenshot' => :'screenshot',
    :'remove_screenshot' => :'remove_screenshot',
    :'unformatted' => :'unformatted',
    :'default_translation_content' => :'default_translation_content',
    :'autotranslate' => :'autotranslate',
    :'xml_space_preserve' => :'xml_space_preserve',
    :'original_file' => :'original_file',
    :'localized_format_string' => :'localized_format_string',
    :'localized_format_key' => :'localized_format_key',
    :'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



259
260
261
 
# File 'lib/phrase/models/key_create_parameters.rb', line 259

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/phrase/models/key_create_parameters.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/phrase/models/key_create_parameters.rb', line 84

def self.openapi_types
  {
    :'branch' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'plural' => :'Boolean',
    :'name_plural' => :'String',
    :'data_type' => :'String',
    :'tags' => :'String',
    :'max_characters_allowed' => :'Integer',
    :'screenshot' => :'File',
    :'remove_screenshot' => :'Boolean',
    :'unformatted' => :'Boolean',
    :'default_translation_content' => :'String',
    :'autotranslate' => :'Boolean',
    :'xml_space_preserve' => :'Boolean',
    :'original_file' => :'String',
    :'localized_format_string' => :'String',
    :'localized_format_key' => :'String',
    :'custom_metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/phrase/models/key_create_parameters.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      branch == o.branch &&
      name == o.name &&
      description == o.description &&
      plural == o.plural &&
      name_plural == o.name_plural &&
      data_type == o.data_type &&
      tags == o.tags &&
      max_characters_allowed == o.max_characters_allowed &&
      screenshot == o.screenshot &&
      remove_screenshot == o.remove_screenshot &&
      unformatted == o.unformatted &&
      default_translation_content == o.default_translation_content &&
      autotranslate == o.autotranslate &&
      xml_space_preserve == o.xml_space_preserve &&
      original_file == o.original_file &&
      localized_format_string == o.localized_format_string &&
      localized_format_key == o.localized_format_key &&
      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



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
317
318
319
320
321
322
323
324
 
# File 'lib/phrase/models/key_create_parameters.rb', line 287

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/phrase/models/key_create_parameters.rb', line 358

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



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

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


246
247
248
 
# File 'lib/phrase/models/key_create_parameters.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, default_translation_content, autotranslate, xml_space_preserve, original_file, localized_format_string, localized_format_key, 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



203
204
205
206
207
208
209
210
 
# File 'lib/phrase/models/key_create_parameters.rb', line 203

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



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

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/phrase/models/key_create_parameters.rb', line 340

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



328
329
330
 
# File 'lib/phrase/models/key_create_parameters.rb', line 328

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



214
215
216
217
 
# File 'lib/phrase/models/key_create_parameters.rb', line 214

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