Class: Phrase::JobCreateParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobCreateParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#branch ⇒ Object

specify the branch to use



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

def branch
  @branch
end

#briefing ⇒ Object

Briefing for the translators



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

def briefing
  @briefing
end

#due_date ⇒ Object

Date the job should be finished



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

def due_date
  @due_date
end

#job_template_id ⇒ Object

id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes.



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

def job_template_id
  @job_template_id
end

#name ⇒ Object

Job name



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

def name
  @name
end

#source_locale_id ⇒ Object

The API id of the source language



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

def source_locale_id
  @source_locale_id
end

#tags ⇒ Object

tags of keys that should be included within the job



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

def tags
  @tags
end

#ticket_url ⇒ Object

URL to a ticket for this job (e.g. Jira, Trello)



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

def ticket_url
  @ticket_url
end

#translation_key_ids ⇒ Object

ids of keys that should be included within the job



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

def translation_key_ids
  @translation_key_ids
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/job_create_parameters.rb', line 33

def self.attribute_map
  {
    :'branch' => :'branch',
    :'name' => :'name',
    :'source_locale_id' => :'source_locale_id',
    :'briefing' => :'briefing',
    :'due_date' => :'due_date',
    :'ticket_url' => :'ticket_url',
    :'tags' => :'tags',
    :'translation_key_ids' => :'translation_key_ids',
    :'job_template_id' => :'job_template_id'
  }
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



174
175
176
 
# File 'lib/phrase/models/job_create_parameters.rb', line 174

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
67
 
# File 'lib/phrase/models/job_create_parameters.rb', line 63

def self.openapi_nullable
  Set.new([
    :'due_date',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'branch' => :'String',
    :'name' => :'String',
    :'source_locale_id' => :'String',
    :'briefing' => :'String',
    :'due_date' => :'DateTime',
    :'ticket_url' => :'String',
    :'tags' => :'Array<String>',
    :'translation_key_ids' => :'Array<String>',
    :'job_template_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/phrase/models/job_create_parameters.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      branch == o.branch &&
      name == o.name &&
      source_locale_id == o.source_locale_id &&
      briefing == o.briefing &&
      due_date == o.due_date &&
      ticket_url == o.ticket_url &&
      tags == o.tags &&
      translation_key_ids == o.translation_key_ids &&
      job_template_id == o.job_template_id
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



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
236
237
238
239
 
# File 'lib/phrase/models/job_create_parameters.rb', line 202

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/phrase/models/job_create_parameters.rb', line 273

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/phrase/models/job_create_parameters.rb', line 181

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


161
162
163
 
# File 'lib/phrase/models/job_create_parameters.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/phrase/models/job_create_parameters.rb', line 167

def hash
  [branch, name, source_locale_id, briefing, due_date, ticket_url, tags, translation_key_ids, job_template_id].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



127
128
129
130
131
132
133
134
 
# File 'lib/phrase/models/job_create_parameters.rb', line 127

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



249
250
251
 
# File 'lib/phrase/models/job_create_parameters.rb', line 249

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/phrase/models/job_create_parameters.rb', line 255

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



243
244
245
 
# File 'lib/phrase/models/job_create_parameters.rb', line 243

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



138
139
140
141
 
# File 'lib/phrase/models/job_create_parameters.rb', line 138

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