Class: Phrase::OrderCreateParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderCreateParameters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#branch ⇒ Object

specify the branch to use



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

def branch
  @branch
end

#category ⇒ Object

Category to use (required for orders processed by TextMaster).



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

def category
  @category
end

#include_untranslated_keys ⇒ Object

Order translations for keys with untranslated content in the selected target locales.



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

def include_untranslated_keys
  @include_untranslated_keys
end

#include_unverified_translations ⇒ Object

Order translations for keys with unverified content in the selected target locales.



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

def include_unverified_translations
  @include_unverified_translations
end

#lsp ⇒ Object

Name of the LSP that should process this order. Can be one of gengo, textmaster.



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

def lsp
  @lsp
end

#message ⇒ Object

Message that is displayed to the translators for description.



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

def message
  @message
end

#name ⇒ Object

the name of the order, default name is: Translation order from ‘current datetime’



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

def name
  @name
end

#priority ⇒ Object

Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster.



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

def priority
  @priority
end

#quality ⇒ Object

Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster.



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

def quality
  @quality
end

#source_locale_id ⇒ Object

Source locale for the order. Can be the name or id of the source locale. Preferred is id.



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

def source_locale_id
  @source_locale_id
end

#styleguide_id ⇒ Object

Style guide for translators to be sent with the order.



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

def styleguide_id
  @styleguide_id
end

#tag ⇒ Object

Tag you want to order translations for.



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

def tag
  @tag
end

#target_locale_ids ⇒ Object

List of target locales you want the source content translate to. Can be the name or id of the target locales. Preferred is id.



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

def target_locale_ids
  @target_locale_ids
end

#translation_type ⇒ Object

Name of the quality level, availability depends on the LSP. Can be one of: standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster)



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

def translation_type
  @translation_type
end

#unverify_translations_upon_delivery ⇒ Object

Unverify translations upon delivery.



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

def unverify_translations_upon_delivery
  @unverify_translations_upon_delivery
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/phrase/models/order_create_parameters.rb', line 51

def self.attribute_map
  {
    :'branch' => :'branch',
    :'name' => :'name',
    :'lsp' => :'lsp',
    :'source_locale_id' => :'source_locale_id',
    :'target_locale_ids' => :'target_locale_ids',
    :'translation_type' => :'translation_type',
    :'tag' => :'tag',
    :'message' => :'message',
    :'styleguide_id' => :'styleguide_id',
    :'unverify_translations_upon_delivery' => :'unverify_translations_upon_delivery',
    :'include_untranslated_keys' => :'include_untranslated_keys',
    :'include_unverified_translations' => :'include_unverified_translations',
    :'category' => :'category',
    :'quality' => :'quality',
    :'priority' => :'priority'
  }
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



236
237
238
 
# File 'lib/phrase/models/order_create_parameters.rb', line 236

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/phrase/models/order_create_parameters.rb', line 72

def self.openapi_types
  {
    :'branch' => :'String',
    :'name' => :'String',
    :'lsp' => :'String',
    :'source_locale_id' => :'String',
    :'target_locale_ids' => :'Array<String>',
    :'translation_type' => :'String',
    :'tag' => :'String',
    :'message' => :'String',
    :'styleguide_id' => :'String',
    :'unverify_translations_upon_delivery' => :'Boolean',
    :'include_untranslated_keys' => :'Boolean',
    :'include_unverified_translations' => :'Boolean',
    :'category' => :'String',
    :'quality' => :'Boolean',
    :'priority' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/phrase/models/order_create_parameters.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      branch == o.branch &&
      name == o.name &&
      lsp == o.lsp &&
      source_locale_id == o.source_locale_id &&
      target_locale_ids == o.target_locale_ids &&
      translation_type == o.translation_type &&
      tag == o.tag &&
      message == o.message &&
      styleguide_id == o.styleguide_id &&
      unverify_translations_upon_delivery == o.unverify_translations_upon_delivery &&
      include_untranslated_keys == o.include_untranslated_keys &&
      include_unverified_translations == o.include_unverified_translations &&
      category == o.category &&
      quality == o.quality &&
      priority == o.priority
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



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
300
301
 
# File 'lib/phrase/models/order_create_parameters.rb', line 264

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/phrase/models/order_create_parameters.rb', line 335

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



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

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


223
224
225
 
# File 'lib/phrase/models/order_create_parameters.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/phrase/models/order_create_parameters.rb', line 229

def hash
  [branch, name, lsp, source_locale_id, target_locale_ids, translation_type, tag, message, styleguide_id, unverify_translations_upon_delivery, include_untranslated_keys, include_unverified_translations, category, quality, priority].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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/phrase/models/order_create_parameters.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @lsp.nil?
    invalid_properties.push('invalid value for "lsp", lsp 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



311
312
313
 
# File 'lib/phrase/models/order_create_parameters.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/phrase/models/order_create_parameters.rb', line 317

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



305
306
307
 
# File 'lib/phrase/models/order_create_parameters.rb', line 305

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



193
194
195
196
197
 
# File 'lib/phrase/models/order_create_parameters.rb', line 193

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