Class: UltracartClient::SfvbFileSearchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/sfvb_file_search_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SfvbFileSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/ultracart_api/models/sfvb_file_search_request.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#case_sensitive ⇒ Object

Whether the text search is case sensitive. Defaults to false.



19
20
21
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 19

def case_sensitive
  @case_sensitive
end

#dynamic_html ⇒ Object

Only dynamic HTML (arbitrary) files.



22
23
24
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 22

def dynamic_html
  @dynamic_html
end

#file_name ⇒ Object

Comma separated file name patterns, matched case insensitively with wildcards.



25
26
27
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 25

def file_name
  @file_name
end

#i18n_violations ⇒ Object

Only files with internationalization violations.



28
29
30
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 28

def i18n_violations
  @i18n_violations
end

#invalid ⇒ Object

Only files that failed Velocity validation.



31
32
33
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 31

def invalid
  @invalid
end

#max_results ⇒ Object

Maximum results to return. Clamped to the server maximum.



34
35
36
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 34

def max_results
  @max_results
end

#merge_conflicts ⇒ Object

Only files with unresolved theme merge conflicts.



37
38
39
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 37

def merge_conflicts
  @merge_conflicts
end

#mime_type ⇒ Object

Restrict to a mime type.



40
41
42
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 40

def mime_type
  @mime_type
end

#modified_max ⇒ Object

Only files modified at or before this ISO-8601 timestamp.



43
44
45
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 43

def modified_max
  @modified_max
end

#modified_min ⇒ Object

Only files modified at or after this ISO-8601 timestamp.



46
47
48
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 46

def modified_min
  @modified_min
end

#offset ⇒ Object

Results to skip. Send the next_offset from a truncated response to continue. Ordering is by path with the file oid as a tie breaker, so pages do not overlap or skip entries between calls.



49
50
51
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 49

def offset
  @offset
end

#path ⇒ Object

Restrict to a directory path. Strongly recommended alongside text.



52
53
54
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 52

def path
  @path
end

#size_max ⇒ Object

Maximum size in bytes.



55
56
57
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 55

def size_max
  @size_max
end

#size_min ⇒ Object

Minimum size in bytes.



58
59
60
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 58

def size_min
  @size_min
end

#sub_directories ⇒ Object

Recurse below path. Defaults to true.



61
62
63
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 61

def sub_directories
  @sub_directories
end

#text ⇒ Object

Text to find inside files. Only text/* files are searched. This is the expensive filter; narrow with path or file_name where possible.



64
65
66
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 64

def text
  @text
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 67

def self.attribute_map
  {
    :'case_sensitive' => :'case_sensitive',
    :'dynamic_html' => :'dynamic_html',
    :'file_name' => :'file_name',
    :'i18n_violations' => :'i18n_violations',
    :'invalid' => :'invalid',
    :'max_results' => :'max_results',
    :'merge_conflicts' => :'merge_conflicts',
    :'mime_type' => :'mime_type',
    :'modified_max' => :'modified_max',
    :'modified_min' => :'modified_min',
    :'offset' => :'offset',
    :'path' => :'path',
    :'size_max' => :'size_max',
    :'size_min' => :'size_min',
    :'sub_directories' => :'sub_directories',
    :'text' => :'text'
  }
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



252
253
254
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 94

def self.openapi_types
  {
    :'case_sensitive' => :'Boolean',
    :'dynamic_html' => :'Boolean',
    :'file_name' => :'String',
    :'i18n_violations' => :'Boolean',
    :'invalid' => :'Boolean',
    :'max_results' => :'Integer',
    :'merge_conflicts' => :'Boolean',
    :'mime_type' => :'String',
    :'modified_max' => :'String',
    :'modified_min' => :'String',
    :'offset' => :'Integer',
    :'path' => :'String',
    :'size_max' => :'Integer',
    :'size_min' => :'Integer',
    :'sub_directories' => :'Boolean',
    :'text' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      case_sensitive == o.case_sensitive &&
      dynamic_html == o.dynamic_html &&
      file_name == o.file_name &&
      i18n_violations == o.i18n_violations &&
      invalid == o.invalid &&
      max_results == o.max_results &&
      merge_conflicts == o.merge_conflicts &&
      mime_type == o.mime_type &&
      modified_max == o.modified_max &&
      modified_min == o.modified_min &&
      offset == o.offset &&
      path == o.path &&
      size_max == o.size_max &&
      size_min == o.size_min &&
      sub_directories == o.sub_directories &&
      text == o.text
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



283
284
285
286
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
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 283

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 354

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 259

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 245

def hash
  [case_sensitive, dynamic_html, file_name, i18n_violations, invalid, max_results, merge_conflicts, mime_type, modified_max, modified_min, offset, path, size_max, size_min, sub_directories, text].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
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 203

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



330
331
332
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 336

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



324
325
326
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 324

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



210
211
212
 
# File 'lib/ultracart_api/models/sfvb_file_search_request.rb', line 210

def valid?
  true
end