Class: UltracartClient::SfvbFileEntry

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SfvbFileEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_compiled ⇒ Object

True when this file is generated by the CJSON compiler and must not be edited directly. Its .cjson sibling is the source.



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

def auto_compiled
  @auto_compiled
end

#directory ⇒ Object

True when this entry is a directory.



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

def directory
  @directory
end

#fs_directory_oid ⇒ Object

StoreFront file system directory oid. For a directory this is its own oid; for a file it is the parent.



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

def fs_directory_oid
  @fs_directory_oid
end

#fs_file_oid ⇒ Object

StoreFront file system file oid. Absent on a directory entry, which has no file oid.



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

def fs_file_oid
  @fs_file_oid
end

#hash_sha256 ⇒ Object

SHA-256 of the content. Use as the If-Match value when writing.



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

def hash_sha256
  @hash_sha256
end

#i18n_violation ⇒ Object

True when the file has internationalization violations.



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

def i18n_violation
  @i18n_violation
end

#last_modified ⇒ Object

Last modified timestamp.



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

def last_modified
  @last_modified
end

#merge_conflict ⇒ Object

True when the file carries an unresolved theme merge conflict. Blocks theme activation.



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

def merge_conflict
  @merge_conflict
end

#mime_type ⇒ Object

Mime type. Only text/* files can be read as content or searched by text.



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

def mime_type
  @mime_type
end

#name ⇒ Object

File or directory name.



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

def name
  @name
end

#path ⇒ Object

Full path of the file or directory.



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

def path
  @path
end

#read_only ⇒ Object

True when the file is marked read only.



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

def read_only
  @read_only
end

#size ⇒ Object

Size in bytes. Zero for directories.



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

def size
  @size
end

#valid ⇒ Object

False when the file failed Velocity validation on its last write.



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

def valid
  @valid
end

#version ⇒ Object

Current version number of the file. Absent on a directory entry, which is not versioned.



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

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 64

def self.attribute_map
  {
    :'auto_compiled' => :'auto_compiled',
    :'directory' => :'directory',
    :'fs_directory_oid' => :'fs_directory_oid',
    :'fs_file_oid' => :'fs_file_oid',
    :'hash_sha256' => :'hash_sha256',
    :'i18n_violation' => :'i18n_violation',
    :'last_modified' => :'last_modified',
    :'merge_conflict' => :'merge_conflict',
    :'mime_type' => :'mime_type',
    :'name' => :'name',
    :'path' => :'path',
    :'read_only' => :'read_only',
    :'size' => :'size',
    :'valid' => :'valid',
    :'version' => :'version'
  }
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



242
243
244
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 242

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 90

def self.openapi_types
  {
    :'auto_compiled' => :'Boolean',
    :'directory' => :'Boolean',
    :'fs_directory_oid' => :'Integer',
    :'fs_file_oid' => :'Integer',
    :'hash_sha256' => :'String',
    :'i18n_violation' => :'Boolean',
    :'last_modified' => :'String',
    :'merge_conflict' => :'Boolean',
    :'mime_type' => :'String',
    :'name' => :'String',
    :'path' => :'String',
    :'read_only' => :'Boolean',
    :'size' => :'Integer',
    :'valid' => :'Boolean',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_compiled == o.auto_compiled &&
      directory == o.directory &&
      fs_directory_oid == o.fs_directory_oid &&
      fs_file_oid == o.fs_file_oid &&
      hash_sha256 == o.hash_sha256 &&
      i18n_violation == o.i18n_violation &&
      last_modified == o.last_modified &&
      merge_conflict == o.merge_conflict &&
      mime_type == o.mime_type &&
      name == o.name &&
      path == o.path &&
      read_only == o.read_only &&
      size == o.size &&
      valid == o.valid &&
      version == o.version
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



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
302
303
304
305
306
307
308
309
310
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 273

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 344

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 249

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


229
230
231
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 235

def hash
  [auto_compiled, directory, fs_directory_oid, fs_file_oid, hash_sha256, i18n_violation, last_modified, merge_conflict, mime_type, name, path, read_only, size, valid, version].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



194
195
196
197
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 194

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



320
321
322
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 326

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



314
315
316
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 314

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



201
202
203
 
# File 'lib/ultracart_api/models/sfvb_file_entry.rb', line 201

def valid?
  true
end