Class: AmznSpApi::MerchantFulfillmentApiModel::RejectedShippingService

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb

Overview

Information about a rejected shipping service

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RejectedShippingService

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 58

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::MerchantFulfillmentApiModel::RejectedShippingService` 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::MerchantFulfillmentApiModel::RejectedShippingService`. 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.carrier_name = attributes[:carrier_name] if attributes.key?(:carrier_name)

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

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

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

  return unless attributes.key?(:rejection_reason_message)

  self.rejection_reason_message = attributes[:rejection_reason_message]
end

Instance Attribute Details

#carrier_name ⇒ Object

The rejected shipping carrier name. e.g. USPS



16
17
18
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 16

def carrier_name
  @carrier_name
end

#rejection_reason_code ⇒ Object

A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX



24
25
26
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 24

def rejection_reason_code
  @rejection_reason_code
end

#rejection_reason_message ⇒ Object

A localized human readable description of the rejected reason.



27
28
29
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 27

def rejection_reason_message
  @rejection_reason_message
end

#shipping_service_id ⇒ Object

Returns the value of attribute shipping_service_id.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 21

def shipping_service_id
  @shipping_service_id
end

#shipping_service_name ⇒ Object

The rejected shipping service localized name. e.g. FedEx Standard Overnight



19
20
21
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 19

def shipping_service_name
  @shipping_service_name
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 30

def self.attribute_map
  {
    'carrier_name': :CarrierName,
    'shipping_service_name': :ShippingServiceName,
    'shipping_service_id': :ShippingServiceId,
    'rejection_reason_code': :RejectionReasonCode,
    'rejection_reason_message': :RejectionReasonMessage
  }
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



135
136
137
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 135

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



52
53
54
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 52

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

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 41

def self.openapi_types
  {
    'carrier_name': :Object,
    'shipping_service_name': :Object,
    'shipping_service_id': :Object,
    'rejection_reason_code': :Object,
    'rejection_reason_message': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 109

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

  self.class == other.class &&
    carrier_name == other.carrier_name &&
    shipping_service_name == other.shipping_service_name &&
    shipping_service_id == other.shipping_service_id &&
    rejection_reason_code == other.rejection_reason_code &&
    rejection_reason_message == other.rejection_reason_message
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



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
198
199
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 164

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::MerchantFulfillmentApiModel.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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 233

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 142

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


122
123
124
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



128
129
130
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 128

def hash
  [carrier_name, shipping_service_name, shipping_service_id, rejection_reason_code, rejection_reason_message].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



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 83

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

  invalid_properties.push('invalid value for "shipping_service_name", shipping_service_name cannot be nil.') if @shipping_service_name.nil?

  invalid_properties.push('invalid value for "shipping_service_id", shipping_service_id cannot be nil.') if @shipping_service_id.nil?

  invalid_properties.push('invalid value for "rejection_reason_code", rejection_reason_code cannot be nil.') if @rejection_reason_code.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



209
210
211
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 209

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



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

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



203
204
205
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 203

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



98
99
100
101
102
103
104
105
 
# File 'lib/merchant_fulfillment_api_model/models/rejected_shipping_service.rb', line 98

def valid?
  return false if @carrier_name.nil?
  return false if @shipping_service_name.nil?
  return false if @shipping_service_id.nil?
  return false if @rejection_reason_code.nil?

  true
end