Class: AmznSpApi::FulfillmentOutboundApiModel::CODSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/cod_settings.rb

Overview

The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CODSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 49

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentOutboundApiModel::CODSettings` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::FulfillmentOutboundApiModel::CODSettings`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.is_cod_required = attributes[:is_cod_required] if attributes.key?(:is_cod_required)

  self.cod_charge = attributes[:cod_charge] if attributes.key?(:cod_charge)

  self.cod_charge_tax = attributes[:cod_charge_tax] if attributes.key?(:cod_charge_tax)

  self.shipping_charge = attributes[:shipping_charge] if attributes.key?(:shipping_charge)

  return unless attributes.key?(:shipping_charge_tax)

  self.shipping_charge_tax = attributes[:shipping_charge_tax]
end

Instance Attribute Details

#cod_charge ⇒ Object

Returns the value of attribute cod_charge.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 18

def cod_charge
  @cod_charge
end

#cod_charge_tax ⇒ Object

Returns the value of attribute cod_charge_tax.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 18

def cod_charge_tax
  @cod_charge_tax
end

#is_cod_required ⇒ Object

When true, this fulfillment order requires a COD (Cash On Delivery) payment.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 16

def is_cod_required
  @is_cod_required
end

#shipping_charge ⇒ Object

Returns the value of attribute shipping_charge.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 18

def shipping_charge
  @shipping_charge
end

#shipping_charge_tax ⇒ Object

Returns the value of attribute shipping_charge_tax.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 18

def shipping_charge_tax
  @shipping_charge_tax
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 21

def self.attribute_map
  {
    'is_cod_required': :isCodRequired,
    'cod_charge': :codCharge,
    'cod_charge_tax': :codChargeTax,
    'shipping_charge': :shippingCharge,
    'shipping_charge_tax': :shippingChargeTax
  }
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



117
118
119
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 117

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



43
44
45
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 43

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

.openapi_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 32

def self.openapi_types
  {
    'is_cod_required': :Object,
    'cod_charge': :Object,
    'cod_charge_tax': :Object,
    'shipping_charge': :Object,
    'shipping_charge_tax': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 91

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    is_cod_required == other.is_cod_required &&
    cod_charge == other.cod_charge &&
    cod_charge_tax == other.cod_charge_tax &&
    shipping_charge == other.shipping_charge &&
    shipping_charge_tax == other.shipping_charge_tax
end

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



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
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 146

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    AmznSpApi::FulfillmentOutboundApiModel.const_get(type).build_from_hash(value)
  end
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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 215

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

#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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 124

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if 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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


104
105
106
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



110
111
112
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 110

def hash
  [is_cod_required, cod_charge, cod_charge_tax, shipping_charge, shipping_charge_tax].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



74
75
76
77
78
79
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 74

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "is_cod_required", is_cod_required cannot be nil.') if @is_cod_required.nil?

  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



191
192
193
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 191

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



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 197

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



185
186
187
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 185

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



83
84
85
86
87
 
# File 'lib/fulfillment_outbound_api_model/models/cod_settings.rb', line 83

def valid?
  return false if @is_cod_required.nil?

  true
end