Class: Phrase::KeysSearchParameters

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeysSearchParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
51
52
53
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
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 50

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

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

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

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

Instance Attribute Details

#branch ⇒ Object

specify the branch to use



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

def branch
  @branch
end

#locale_id ⇒ Object

Locale used to determine the translation state of a key when filtering for untranslated or translated keys.



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

def locale_id
  @locale_id
end

#order ⇒ Object

Order direction. Can be one of: asc, desc.



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

def order
  @order
end

#q ⇒ Object

Specify a query to do broad search for keys by name (including wildcards).
The following qualifiers are also supported in the search term:
<ul> <li>ids:key_id,... for queries on a comma-separated list of ids</li> <li>name:key_name,... for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li>tags:tag_name,... to filter for keys with certain comma-seperated list of tags</li> <li>uploads:upload_id,... to filter for keys with certain comma-seperated list of uploads</li> <li>job:{true|false} to filter for keys mentioned in an active job</li> <li>translated:{true|false} for translation status (also requires locale_id to be specified)</li> <li>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z for date range queries</li> <li>unmentioned_in_upload:upload_id to filter keys unmentioned within upload</li> </ul> Find more examples <a href="#overview–usage-examples">here</a>. Please note: If tags are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.



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

def q
  @q
end

#sort ⇒ Object

Sort by field. Can be one of: name, created_at, updated_at.



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

def sort
  @sort
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
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 21

def self.attribute_map
  {
    :'branch' => :'branch',
    :'sort' => :'sort',
    :'order' => :'order',
    :'q' => :'q',
    :'locale_id' => :'locale_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



124
125
126
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 124

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



43
44
45
46
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 43

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

.openapi_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 32

def self.openapi_types
  {
    :'branch' => :'String',
    :'sort' => :'String',
    :'order' => :'String',
    :'q' => :'String',
    :'locale_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



99
100
101
102
103
104
105
106
107
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 99

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      branch == o.branch &&
      sort == o.sort &&
      order == o.order &&
      q == o.q &&
      locale_id == o.locale_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



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

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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 223

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 131

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


111
112
113
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 111

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



117
118
119
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 117

def hash
  [branch, sort, order, q, locale_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



86
87
88
89
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 86

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



199
200
201
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 199

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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 205

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



193
194
195
 
# File 'lib/phrase/models/keys_search_parameters.rb', line 193

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



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

def valid?
  true
end