Class: Printful::File

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

Overview

Information about the File

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ File

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/printful_client/models/file.rb', line 129

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

Instance Attribute Details

#created ⇒ Object

File creation timestamp



56
57
58
 
# File 'lib/printful_client/models/file.rb', line 56

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.



50
51
52
 
# File 'lib/printful_client/models/file.rb', line 50

def dpi
  @dpi
end

#filename ⇒ Object

File name



35
36
37
 
# File 'lib/printful_client/models/file.rb', line 35

def filename
  @filename
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



32
33
34
 
# File 'lib/printful_client/models/file.rb', line 32

def hash
  @hash
end

#height ⇒ Object

Height in pixels



47
48
49
 
# File 'lib/printful_client/models/file.rb', line 47

def height
  @height
end

#id ⇒ Object

File ID



23
24
25
 
# File 'lib/printful_client/models/file.rb', line 23

def id
  @id
end

#is_temporary ⇒ Object

Whether it is a temporary printfile.



68
69
70
 
# File 'lib/printful_client/models/file.rb', line 68

def is_temporary
  @is_temporary
end

#mime_type ⇒ Object

MIME type of the file



38
39
40
 
# File 'lib/printful_client/models/file.rb', line 38

def mime_type
  @mime_type
end

#options ⇒ Object

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



29
30
31
 
# File 'lib/printful_client/models/file.rb', line 29

def options
  @options
end

#preview_url ⇒ Object

Medium preview image URL



62
63
64
 
# File 'lib/printful_client/models/file.rb', line 62

def preview_url
  @preview_url
end

#size ⇒ Object

Size in bytes



41
42
43
 
# File 'lib/printful_client/models/file.rb', line 41

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



53
54
55
 
# File 'lib/printful_client/models/file.rb', line 53

def status
  @status
end

#thumbnail_url ⇒ Object

Small thumbnail URL



59
60
61
 
# File 'lib/printful_client/models/file.rb', line 59

def thumbnail_url
  @thumbnail_url
end

#type ⇒ Object

Role of the file



20
21
22
 
# File 'lib/printful_client/models/file.rb', line 20

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.



26
27
28
 
# File 'lib/printful_client/models/file.rb', line 26

def url
  @url
end

#visible ⇒ Object

Show file in the Printfile Library (default true)



65
66
67
 
# File 'lib/printful_client/models/file.rb', line 65

def visible
  @visible
end

#width ⇒ Object

Width in pixels



44
45
46
 
# File 'lib/printful_client/models/file.rb', line 44

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/printful_client/models/file.rb', line 298

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



94
95
96
 
# File 'lib/printful_client/models/file.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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'
  }
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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/printful_client/models/file.rb', line 274

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_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/printful_client/models/file.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/printful_client/models/file.rb', line 237

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/printful_client/models/file.rb', line 369

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


261
262
263
 
# File 'lib/printful_client/models/file.rb', line 261

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



217
218
219
220
221
222
223
224
225
 
# File 'lib/printful_client/models/file.rb', line 217

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



345
346
347
 
# File 'lib/printful_client/models/file.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/printful_client/models/file.rb', line 351

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



339
340
341
 
# File 'lib/printful_client/models/file.rb', line 339

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



229
230
231
232
233
 
# File 'lib/printful_client/models/file.rb', line 229

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