Class: Printful::PrintfileInfo

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

Overview

Printfile info

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrintfileInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/printful_client/models/printfile_info.rb', line 70

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

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

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

  if attributes.key?(:'variant_printfiles')
    if (value = attributes[:'variant_printfiles']).is_a?(Array)
      self.variant_printfiles = 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
end

Instance Attribute Details

#available_placementsObject

List of available placements. Key is placement identifier, value is display name. (e.g. Front, ..).


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

def available_placements
  @available_placements
end

#option_groupsObject

Returns the value of attribute option_groups.


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

def option_groups
  @option_groups
end

#optionsObject

Returns the value of attribute options.


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

def options
  @options
end

#printfilesObject

Returns the value of attribute printfiles.


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

def printfiles
  @printfiles
end

#product_idObject

Requested product id.


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

def product_id
  @product_id
end

#variant_printfilesObject

Returns the value of attribute variant_printfiles.


27
28
29
# File 'lib/printful_client/models/printfile_info.rb', line 27

def variant_printfiles
  @variant_printfiles
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


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

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_attributesObject

Returns all the JSON keys this model knows about


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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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


34
35
36
37
38
39
40
41
42
43
# File 'lib/printful_client/models/printfile_info.rb', line 34

def self.attribute_map
  {
    :'product_id' => :'product_id',
    :'available_placements' => :'available_placements',
    :'printfiles' => :'printfiles',
    :'variant_printfiles' => :'variant_printfiles',
    :'option_groups' => :'option_groups',
    :'options' => :'options'
  }
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


159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/printful_client/models/printfile_info.rb', line 159

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_nullableObject

List of attributes with nullable: true


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

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

.openapi_typesObject

Attribute type mapping.


51
52
53
54
55
56
57
58
59
60
# File 'lib/printful_client/models/printfile_info.rb', line 51

def self.openapi_types
  {
    :'product_id' => :'Integer',
    :'available_placements' => :'Object',
    :'printfiles' => :'Array<Printfile>',
    :'variant_printfiles' => :'Array<VariantPrintfile>',
    :'option_groups' => :'Array<String>',
    :'options' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


133
134
135
136
137
138
139
140
141
142
# File 'lib/printful_client/models/printfile_info.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_id == o.product_id &&
      available_placements == o.available_placements &&
      printfiles == o.printfiles &&
      variant_printfiles == o.variant_printfiles &&
      option_groups == o.option_groups &&
      options == o.options
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


254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/printful_client/models/printfile_info.rb', line 254

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

146
147
148
# File 'lib/printful_client/models/printfile_info.rb', line 146

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


152
153
154
# File 'lib/printful_client/models/printfile_info.rb', line 152

def hash
  [product_id, available_placements, printfiles, variant_printfiles, option_groups, options].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


118
119
120
121
122
# File 'lib/printful_client/models/printfile_info.rb', line 118

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


230
231
232
# File 'lib/printful_client/models/printfile_info.rb', line 230

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/printful_client/models/printfile_info.rb', line 236

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


224
225
226
# File 'lib/printful_client/models/printfile_info.rb', line 224

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


126
127
128
129
# File 'lib/printful_client/models/printfile_info.rb', line 126

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end