Class: DigitalFemsa::CustomerShippingContacts

Inherits:
Object
  • Object
show all
Defined in:
lib/digital_femsa/models/customer_shipping_contacts.rb

Overview

[Shipping](developers.femsa.com/v2.1.0/reference/createcustomershippingcontacts) details, required in case of sending a shipping. If we do not receive a shipping_contact on the order, the default shipping_contact of the customer will be used.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerShippingContacts

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'address')
    self.address = attributes[:'address']
  else
    self.address = nil
  end

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



28
29
30
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 28

def address
  @address
end

#between_streets ⇒ Object

The street names between which the order will be delivered.



26
27
28
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 26

def between_streets
  @between_streets
end

#default ⇒ Object

Returns the value of attribute default.



32
33
34
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 32

def default
  @default
end

#deleted ⇒ Object

Returns the value of attribute deleted.



34
35
36
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 34

def deleted
  @deleted
end

#metadata ⇒ Object

Metadata associated with the shipping contact



37
38
39
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 37

def metadata
  @metadata
end

#parent_id ⇒ Object

Returns the value of attribute parent_id.



30
31
32
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 30

def parent_id
  @parent_id
end

#phone ⇒ Object

Phone contact



20
21
22
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 20

def phone
  @phone
end

#receiver ⇒ Object

Name of the person who will receive the order



23
24
25
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 23

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 225

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 = DigitalFemsa.const_get(type)
    klass.respond_to?(:openapi_any_of) || 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



54
55
56
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 40

def self.attribute_map
  {
    :'phone' => :'phone',
    :'receiver' => :'receiver',
    :'between_streets' => :'between_streets',
    :'address' => :'address',
    :'parent_id' => :'parent_id',
    :'default' => :'default',
    :'deleted' => :'deleted',
    :'metadata' => :'metadata'
  }
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 201

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



73
74
75
76
77
78
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 73

def self.openapi_nullable
  Set.new([
    :'default',
    :'deleted',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 59

def self.openapi_types
  {
    :'phone' => :'String',
    :'receiver' => :'String',
    :'between_streets' => :'String',
    :'address' => :'CustomerShippingContactsAddress',
    :'parent_id' => :'String',
    :'default' => :'Boolean',
    :'deleted' => :'Boolean',
    :'metadata' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone == o.phone &&
      receiver == o.receiver &&
      between_streets == o.between_streets &&
      address == o.address &&
      parent_id == o.parent_id &&
      default == o.default &&
      deleted == o.deleted &&
      metadata == o.metadata
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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 296

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


188
189
190
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 194

def hash
  [phone, receiver, between_streets, address, parent_id, default, deleted, metadata].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



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 134

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

  if !@metadata.nil? && @metadata.length > 100
    invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 100.')
  end

  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



272
273
274
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 272

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 278

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



266
267
268
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 266

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



150
151
152
153
154
155
 
# File 'lib/digital_femsa/models/customer_shipping_contacts.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @address.nil?
  return false if !@metadata.nil? && @metadata.length > 100
  true
end