Class: Phrase::LocaleDownloadParams

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

Overview

The parameters of the download request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocaleDownloadParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
 
# File 'lib/phrase/models/locale_download_params.rb', line 54

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

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

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

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

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

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

Instance Attribute Details

#branch ⇒ Object

Returns the value of attribute branch.



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

def branch
  @branch
end

#file_format ⇒ Object

Returns the value of attribute file_format.



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

def file_format
  @file_format
end

#include_empty_translations ⇒ Object

Returns the value of attribute include_empty_translations.



14
15
16
 
# File 'lib/phrase/models/locale_download_params.rb', line 14

def include_empty_translations
  @include_empty_translations
end

#include_translated_keys ⇒ Object

Returns the value of attribute include_translated_keys.



16
17
18
 
# File 'lib/phrase/models/locale_download_params.rb', line 16

def include_translated_keys
  @include_translated_keys
end

#include_unverified_translations ⇒ Object

Returns the value of attribute include_unverified_translations.



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

def include_unverified_translations
  @include_unverified_translations
end

#locale_id ⇒ Object

Returns the value of attribute locale_id.



8
9
10
 
# File 'lib/phrase/models/locale_download_params.rb', line 8

def locale_id
  @locale_id
end

#tags ⇒ Object

Returns the value of attribute tags.



10
11
12
 
# File 'lib/phrase/models/locale_download_params.rb', line 10

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/phrase/models/locale_download_params.rb', line 21

def self.attribute_map
  {
    :'file_format' => :'file_format',
    :'locale_id' => :'locale_id',
    :'tags' => :'tags',
    :'branch' => :'branch',
    :'include_empty_translations' => :'include_empty_translations',
    :'include_translated_keys' => :'include_translated_keys',
    :'include_unverified_translations' => :'include_unverified_translations'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'file_format' => :'String',
    :'locale_id' => :'String',
    :'tags' => :'String',
    :'branch' => :'String',
    :'include_empty_translations' => :'Boolean',
    :'include_translated_keys' => :'Boolean',
    :'include_unverified_translations' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/phrase/models/locale_download_params.rb', line 111

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_format == o.file_format &&
      locale_id == o.locale_id &&
      tags == o.tags &&
      branch == o.branch &&
      include_empty_translations == o.include_empty_translations &&
      include_translated_keys == o.include_translated_keys &&
      include_unverified_translations == o.include_unverified_translations
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



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
200
201
202
203
 
# File 'lib/phrase/models/locale_download_params.rb', line 166

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/phrase/models/locale_download_params.rb', line 237

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



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

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


125
126
127
 
# File 'lib/phrase/models/locale_download_params.rb', line 125

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



131
132
133
 
# File 'lib/phrase/models/locale_download_params.rb', line 131

def hash
  [file_format, locale_id, tags, branch, include_empty_translations, include_translated_keys, include_unverified_translations].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



98
99
100
101
 
# File 'lib/phrase/models/locale_download_params.rb', line 98

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



213
214
215
 
# File 'lib/phrase/models/locale_download_params.rb', line 213

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/phrase/models/locale_download_params.rb', line 219

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



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

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



105
106
107
 
# File 'lib/phrase/models/locale_download_params.rb', line 105

def valid?
  true
end