Class: Printful::CreateGenerationTask

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

Overview

Mockup generation data.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGenerationTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/printful_client/models/create_generation_task.rb', line 105

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

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

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

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

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

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

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

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

Instance Attribute Details

#files ⇒ Object

Returns the value of attribute files.



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

def files
  @files
end

#format ⇒ Object

Generated file format. PNG will have a transparent background, JPG will have a smaller file size.



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

def format
  @format
end

#option_groups ⇒ Object

List of option group names you want to generate. Product’s option groups can be found in printfile API request.



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

def option_groups
  @option_groups
end

#options ⇒ Object

List of option names you want to generate. Product’s options can be found in printfile API request.



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

def options
  @options
end

#product_options ⇒ Object

Key-value list of product options (embroidery thread, stitch colors). Product options can be found in Catalog API endpoint. [See examples](#section/Options)



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

def product_options
  @product_options
end

#product_template_id ⇒ Object

Product template ID. Use instead of files parameter.



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

def product_template_id
  @product_template_id
end

#variant_ids ⇒ Object

List of variant ids you want to generate.



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

def variant_ids
  @variant_ids
end

#width ⇒ Object

Width of the resulting mockup images (min 50, max 2000, default is 1000)



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

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/printful_client/models/create_generation_task.rb', line 242

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



79
80
81
 
# File 'lib/printful_client/models/create_generation_task.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/printful_client/models/create_generation_task.rb', line 65

def self.attribute_map
  {
    :'variant_ids' => :'variant_ids',
    :'format' => :'format',
    :'width' => :'width',
    :'product_options' => :'product_options',
    :'option_groups' => :'option_groups',
    :'options' => :'options',
    :'files' => :'files',
    :'product_template_id' => :'product_template_id'
  }
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



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

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



98
99
100
101
 
# File 'lib/printful_client/models/create_generation_task.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/printful_client/models/create_generation_task.rb', line 84

def self.openapi_types
  {
    :'variant_ids' => :'Array<Integer>',
    :'format' => :'String',
    :'width' => :'Integer',
    :'product_options' => :'Hash<String, Object>',
    :'option_groups' => :'Hash<String>',
    :'options' => :'Array<String>',
    :'files' => :'Array<GenerationTaskFile>',
    :'product_template_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/printful_client/models/create_generation_task.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      variant_ids == o.variant_ids &&
      format == o.format &&
      width == o.width &&
      product_options == o.product_options &&
      option_groups == o.option_groups &&
      options == o.options &&
      files == o.files &&
      product_template_id == o.product_template_id
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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/printful_client/models/create_generation_task.rb', line 313

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


205
206
207
 
# File 'lib/printful_client/models/create_generation_task.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/printful_client/models/create_generation_task.rb', line 211

def hash
  [variant_ids, format, width, product_options, option_groups, options, files, product_template_id].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



163
164
165
166
167
 
# File 'lib/printful_client/models/create_generation_task.rb', line 163

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



289
290
291
 
# File 'lib/printful_client/models/create_generation_task.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/printful_client/models/create_generation_task.rb', line 295

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



283
284
285
 
# File 'lib/printful_client/models/create_generation_task.rb', line 283

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



171
172
173
174
175
176
 
# File 'lib/printful_client/models/create_generation_task.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  format_validator = EnumAttributeValidator.new('String', ["jpg", "png"])
  return false unless format_validator.valid?(@format)
  true
end