Class: Printful::ItemFilesInner

Inherits:
Object
  • Object
show all
Defined in:
lib/printful_client/models/item_files_inner.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemFilesInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
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
 
# File 'lib/printful_client/models/item_files_inner.rb', line 139

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

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

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  else
    self.url = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

File creation timestamp



55
56
57
 
# File 'lib/printful_client/models/item_files_inner.rb', line 55

def created
  @created
end

#dpi ⇒ Object

Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn’t affect print quality since the vector files are resolution independent.



49
50
51
 
# File 'lib/printful_client/models/item_files_inner.rb', line 49

def dpi
  @dpi
end

#filename ⇒ Object

File name



34
35
36
 
# File 'lib/printful_client/models/item_files_inner.rb', line 34

def filename
  @filename
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



31
32
33
 
# File 'lib/printful_client/models/item_files_inner.rb', line 31

def hash
  @hash
end

#height ⇒ Object

Height in pixels



46
47
48
 
# File 'lib/printful_client/models/item_files_inner.rb', line 46

def height
  @height
end

#id ⇒ Object

File ID



22
23
24
 
# File 'lib/printful_client/models/item_files_inner.rb', line 22

def id
  @id
end

#is_temporary ⇒ Object

Whether it is a temporary printfile.



67
68
69
 
# File 'lib/printful_client/models/item_files_inner.rb', line 67

def is_temporary
  @is_temporary
end

#mime_type ⇒ Object

MIME type of the file



37
38
39
 
# File 'lib/printful_client/models/item_files_inner.rb', line 37

def mime_type
  @mime_type
end

#options ⇒ Object

Array of additional options for this file [See examples](#section/Options)



28
29
30
 
# File 'lib/printful_client/models/item_files_inner.rb', line 28

def options
  @options
end

#position ⇒ Object

Returns the value of attribute position.



69
70
71
 
# File 'lib/printful_client/models/item_files_inner.rb', line 69

def position
  @position
end

#preview_url ⇒ Object

Medium preview image URL



61
62
63
 
# File 'lib/printful_client/models/item_files_inner.rb', line 61

def preview_url
  @preview_url
end

#size ⇒ Object

Size in bytes



40
41
42
 
# File 'lib/printful_client/models/item_files_inner.rb', line 40

def size
  @size
end

#status ⇒ Object

File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed



52
53
54
 
# File 'lib/printful_client/models/item_files_inner.rb', line 52

def status
  @status
end

#thumbnail_url ⇒ Object

Small thumbnail URL



58
59
60
 
# File 'lib/printful_client/models/item_files_inner.rb', line 58

def thumbnail_url
  @thumbnail_url
end

#type ⇒ Object

Role of the file



19
20
21
 
# File 'lib/printful_client/models/item_files_inner.rb', line 19

def type
  @type
end

#url ⇒ Object

Source URL where the file is downloaded from. The use of .ai .psd and .tiff files have been depreciated, if your application uses these file types or accepts these types from users you will need to add validation.



25
26
27
 
# File 'lib/printful_client/models/item_files_inner.rb', line 25

def url
  @url
end

#visible ⇒ Object

Show file in the Printfile Library (default true)



64
65
66
 
# File 'lib/printful_client/models/item_files_inner.rb', line 64

def visible
  @visible
end

#width ⇒ Object

Width in pixels



43
44
45
 
# File 'lib/printful_client/models/item_files_inner.rb', line 43

def width
  @width
end

Class Method Details

._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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/printful_client/models/item_files_inner.rb', line 313

def self._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 = Printful.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/printful_client/models/item_files_inner.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/printful_client/models/item_files_inner.rb', line 72

def self.attribute_map
  {
    :'type' => :'type',
    :'id' => :'id',
    :'url' => :'url',
    :'options' => :'options',
    :'hash' => :'hash',
    :'filename' => :'filename',
    :'mime_type' => :'mime_type',
    :'size' => :'size',
    :'width' => :'width',
    :'height' => :'height',
    :'dpi' => :'dpi',
    :'status' => :'status',
    :'created' => :'created',
    :'thumbnail_url' => :'thumbnail_url',
    :'preview_url' => :'preview_url',
    :'visible' => :'visible',
    :'is_temporary' => :'is_temporary',
    :'position' => :'position'
  }
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/printful_client/models/item_files_inner.rb', line 289

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



131
132
133
134
135
 
# File 'lib/printful_client/models/item_files_inner.rb', line 131

def self.openapi_all_of
  [
  :'File'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
 
# File 'lib/printful_client/models/item_files_inner.rb', line 125

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/printful_client/models/item_files_inner.rb', line 101

def self.openapi_types
  {
    :'type' => :'String',
    :'id' => :'Integer',
    :'url' => :'String',
    :'options' => :'Array<FileOption>',
    :'hash' => :'String',
    :'filename' => :'String',
    :'mime_type' => :'String',
    :'size' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'dpi' => :'Integer',
    :'status' => :'String',
    :'created' => :'Integer',
    :'thumbnail_url' => :'String',
    :'preview_url' => :'String',
    :'visible' => :'Boolean',
    :'is_temporary' => :'Boolean',
    :'position' => :'ItemFilesInnerAllOfPosition'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/printful_client/models/item_files_inner.rb', line 251

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      id == o.id &&
      url == o.url &&
      options == o.options &&
      hash == o.hash &&
      filename == o.filename &&
      mime_type == o.mime_type &&
      size == o.size &&
      width == o.width &&
      height == o.height &&
      dpi == o.dpi &&
      status == o.status &&
      created == o.created &&
      thumbnail_url == o.thumbnail_url &&
      preview_url == o.preview_url &&
      visible == o.visible &&
      is_temporary == o.is_temporary &&
      position == o.position
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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/printful_client/models/item_files_inner.rb', line 384

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


276
277
278
 
# File 'lib/printful_client/models/item_files_inner.rb', line 276

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



231
232
233
234
235
236
237
238
239
 
# File 'lib/printful_client/models/item_files_inner.rb', line 231

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @url.nil?
    invalid_properties.push('invalid value for "url", url 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



360
361
362
 
# File 'lib/printful_client/models/item_files_inner.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/printful_client/models/item_files_inner.rb', line 366

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



354
355
356
 
# File 'lib/printful_client/models/item_files_inner.rb', line 354

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



243
244
245
246
247
 
# File 'lib/printful_client/models/item_files_inner.rb', line 243

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @url.nil?
  true
end