Class: Printful::Template

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

Overview

Template variant mapping

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Template

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/printful_client/models/template.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#background_color ⇒ Object

HEX color code that should be used as a background color.



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

def background_color
  @background_color
end

#background_url ⇒ Object

Background image URL (optional).



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

def background_url
  @background_url
end

#image_url ⇒ Object

Main template image URL.



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

def image_url
  @image_url
end

#is_template_on_front ⇒ Object

Should the main template image (image_url) be used as an overlay or as a background.



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

def is_template_on_front
  @is_template_on_front
end

#orientation ⇒ Object

Wall art product orientation. Possible values: horizontal, vertical, any



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

def orientation
  @orientation
end

#print_area_height ⇒ Object

Print area height (image is positioned in this area).



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

def print_area_height
  @print_area_height
end

#print_area_left ⇒ Object

Print area left offset (offset in template).



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

def print_area_left
  @print_area_left
end

#print_area_top ⇒ Object

Print area top offset (offset in template).



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

def print_area_top
  @print_area_top
end

#print_area_width ⇒ Object

Print area width (image is positioned in this area).



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

def print_area_width
  @print_area_width
end

#printfile_id ⇒ Object

Printfile ID that should be generated for this template. See [printfile API endpoint](#operation/getPrintfiles) for list of Printfiles.



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

def printfile_id
  @printfile_id
end

#template_height ⇒ Object

Height of the whole template in pixels.



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

def template_height
  @template_height
end

#template_id ⇒ Object

Template ID.



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

def template_id
  @template_id
end

#template_width ⇒ Object

Width of the whole template in pixels.



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

def template_width
  @template_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



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
321
322
 
# File 'lib/printful_client/models/template.rb', line 285

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



100
101
102
 
# File 'lib/printful_client/models/template.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/printful_client/models/template.rb', line 81

def self.attribute_map
  {
    :'template_id' => :'template_id',
    :'image_url' => :'image_url',
    :'background_url' => :'background_url',
    :'background_color' => :'background_color',
    :'printfile_id' => :'printfile_id',
    :'template_width' => :'template_width',
    :'template_height' => :'template_height',
    :'print_area_width' => :'print_area_width',
    :'print_area_height' => :'print_area_height',
    :'print_area_top' => :'print_area_top',
    :'print_area_left' => :'print_area_left',
    :'is_template_on_front' => :'is_template_on_front',
    :'orientation' => :'orientation'
  }
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/printful_client/models/template.rb', line 261

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



124
125
126
127
128
129
 
# File 'lib/printful_client/models/template.rb', line 124

def self.openapi_nullable
  Set.new([
    :'background_url',
    :'background_color',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'template_id' => :'Integer',
    :'image_url' => :'String',
    :'background_url' => :'String',
    :'background_color' => :'Integer',
    :'printfile_id' => :'Integer',
    :'template_width' => :'Integer',
    :'template_height' => :'Integer',
    :'print_area_width' => :'Integer',
    :'print_area_height' => :'Integer',
    :'print_area_top' => :'Integer',
    :'print_area_left' => :'Integer',
    :'is_template_on_front' => :'Boolean',
    :'orientation' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/printful_client/models/template.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template_id == o.template_id &&
      image_url == o.image_url &&
      background_url == o.background_url &&
      background_color == o.background_color &&
      printfile_id == o.printfile_id &&
      template_width == o.template_width &&
      template_height == o.template_height &&
      print_area_width == o.print_area_width &&
      print_area_height == o.print_area_height &&
      print_area_top == o.print_area_top &&
      print_area_left == o.print_area_left &&
      is_template_on_front == o.is_template_on_front &&
      orientation == o.orientation
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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/printful_client/models/template.rb', line 356

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


248
249
250
 
# File 'lib/printful_client/models/template.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/printful_client/models/template.rb', line 254

def hash
  [template_id, image_url, background_url, background_color, printfile_id, template_width, template_height, print_area_width, print_area_height, print_area_top, print_area_left, is_template_on_front, orientation].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



201
202
203
204
205
 
# File 'lib/printful_client/models/template.rb', line 201

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



332
333
334
 
# File 'lib/printful_client/models/template.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/printful_client/models/template.rb', line 338

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



326
327
328
 
# File 'lib/printful_client/models/template.rb', line 326

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



209
210
211
212
213
214
 
# File 'lib/printful_client/models/template.rb', line 209

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  orientation_validator = EnumAttributeValidator.new('String', ["horizontal", "vertical", "any"])
  return false unless orientation_validator.valid?(@orientation)
  true
end