Class: BrevoRuby::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/order.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
115
116
117
118
119
 
# File 'lib/brevo-ruby/models/order.rb', line 74

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'updatedAt')
    self.updated_at = attributes[:'updatedAt']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

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

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'billing')
    self.billing = attributes[:'billing']
  end

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

Instance Attribute Details

#amount ⇒ Object

Total amount of the order, including all shipping expenses, tax and the price of items.



30
31
32
 
# File 'lib/brevo-ruby/models/order.rb', line 30

def amount
  @amount
end

#billing ⇒ Object

Returns the value of attribute billing.



37
38
39
 
# File 'lib/brevo-ruby/models/order.rb', line 37

def billing
  @billing
end

#coupons ⇒ Object

Coupons applied to the order. Stored case insensitive.



40
41
42
 
# File 'lib/brevo-ruby/models/order.rb', line 40

def coupons
  @coupons
end

#created_at ⇒ Object

Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.



21
22
23
 
# File 'lib/brevo-ruby/models/order.rb', line 21

def created_at
  @created_at
end

#email ⇒ Object

Email of the contact, Mandatory if "phone" field is not passed in "billing" parameter.



35
36
37
 
# File 'lib/brevo-ruby/models/order.rb', line 35

def email
  @email
end

#id ⇒ Object

Unique ID of the order.



18
19
20
 
# File 'lib/brevo-ruby/models/order.rb', line 18

def id
  @id
end

#products ⇒ Object

Returns the value of attribute products.



32
33
34
 
# File 'lib/brevo-ruby/models/order.rb', line 32

def products
  @products
end

#status ⇒ Object

State of the order.



27
28
29
 
# File 'lib/brevo-ruby/models/order.rb', line 27

def status
  @status
end

#updated_at ⇒ Object

Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.



24
25
26
 
# File 'lib/brevo-ruby/models/order.rb', line 24

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/brevo-ruby/models/order.rb', line 43

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'status' => :'status',
    :'amount' => :'amount',
    :'products' => :'products',
    :'email' => :'email',
    :'billing' => :'billing',
    :'coupons' => :'coupons'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/brevo-ruby/models/order.rb', line 58

def self.swagger_types
  {
    :'id' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'status' => :'String',
    :'amount' => :'Float',
    :'products' => :'Array<OrderProducts>',
    :'email' => :'String',
    :'billing' => :'OrderBilling',
    :'coupons' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/brevo-ruby/models/order.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      status == o.status &&
      amount == o.amount &&
      products == o.products &&
      email == o.email &&
      billing == o.billing &&
      coupons == o.coupons
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



216
217
218
219
220
221
222
223
224
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
 
# File 'lib/brevo-ruby/models/order.rb', line 216

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
    temp_model = BrevoRuby.const_get(type).new
    temp_model.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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/brevo-ruby/models/order.rb', line 282

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/brevo-ruby/models/order.rb', line 195

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/brevo-ruby/models/order.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/brevo-ruby/models/order.rb', line 188

def hash
  [id, created_at, updated_at, status, amount, products, email, billing, coupons].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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/brevo-ruby/models/order.rb', line 123

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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



262
263
264
 
# File 'lib/brevo-ruby/models/order.rb', line 262

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



268
269
270
271
272
273
274
275
276
 
# File 'lib/brevo-ruby/models/order.rb', line 268

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



256
257
258
 
# File 'lib/brevo-ruby/models/order.rb', line 256

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



154
155
156
157
158
159
160
161
162
 
# File 'lib/brevo-ruby/models/order.rb', line 154

def valid?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @status.nil?
  return false if @amount.nil?
  return false if @products.nil?
  true
end