Class: Printful::ShippingInfo

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

Overview

Shipping information

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShippingInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/printful_client/models/shipping_info.rb', line 84

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

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

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

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

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

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

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

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

Instance Attribute Details

#currency ⇒ Object

Currency code in which the rate is returned



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

def currency
  @currency
end

#id ⇒ Object

Shipping method ID



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

def id
  @id
end

#max_delivery_date ⇒ Object

Estimated maximum delivery date. <span style="color:orange">Warning! This value may not be present in response.</span>



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

def max_delivery_date
  @max_delivery_date
end

#max_delivery_days ⇒ Object

Estimated maximum delivery days. <span style="color:orange">Warning! This value may not be present in response.</span>



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

def max_delivery_days
  @max_delivery_days
end

#min_delivery_date ⇒ Object

Estimated minimum delivery date. <span style="color:orange">Warning! This value may not be present in response.</span>



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

def min_delivery_date
  @min_delivery_date
end

#min_delivery_days ⇒ Object

Estimated minimum delivery days. <span style="color:orange">Warning! This value may not be present in response.</span>



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

def min_delivery_days
  @min_delivery_days
end

#name ⇒ Object

Shipping method name



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

def name
  @name
end

#rate ⇒ Object

Shipping rate



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

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



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
228
229
230
231
232
233
234
235
236
 
# File 'lib/printful_client/models/shipping_info.rb', line 199

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/printful_client/models/shipping_info.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'rate' => :'rate',
    :'currency' => :'currency',
    :'min_delivery_days' => :'minDeliveryDays',
    :'max_delivery_days' => :'maxDeliveryDays',
    :'min_delivery_date' => :'minDeliveryDate',
    :'max_delivery_date' => :'maxDeliveryDate'
  }
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/printful_client/models/shipping_info.rb', line 175

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



77
78
79
80
 
# File 'lib/printful_client/models/shipping_info.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/printful_client/models/shipping_info.rb', line 63

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'rate' => :'String',
    :'currency' => :'String',
    :'min_delivery_days' => :'Integer',
    :'max_delivery_days' => :'Integer',
    :'min_delivery_date' => :'Integer',
    :'max_delivery_date' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/printful_client/models/shipping_info.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      rate == o.rate &&
      currency == o.currency &&
      min_delivery_days == o.min_delivery_days &&
      max_delivery_days == o.max_delivery_days &&
      min_delivery_date == o.min_delivery_date &&
      max_delivery_date == o.max_delivery_date
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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/printful_client/models/shipping_info.rb', line 270

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


162
163
164
 
# File 'lib/printful_client/models/shipping_info.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/printful_client/models/shipping_info.rb', line 168

def hash
  [id, name, rate, currency, min_delivery_days, max_delivery_days, min_delivery_date, max_delivery_date].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



132
133
134
135
136
 
# File 'lib/printful_client/models/shipping_info.rb', line 132

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



246
247
248
 
# File 'lib/printful_client/models/shipping_info.rb', line 246

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/printful_client/models/shipping_info.rb', line 252

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



240
241
242
 
# File 'lib/printful_client/models/shipping_info.rb', line 240

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



140
141
142
143
 
# File 'lib/printful_client/models/shipping_info.rb', line 140

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