Class: SwaggerClient::CheckoutShoppingCartRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/checkout_shopping_cart_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckoutShoppingCartRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
131
132
133
134
135
136
137
138
139
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 86

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?(:'CartId')
    self.cart_id = attributes[:'CartId']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cart_id ⇒ Object

The unique ID of the shopping cart to be processed. You can use this value to maintain a persistent cart. If you do not specify a cart ID, the MINDBODY software generates one.



18
19
20
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 18

def cart_id
  @cart_id
end

#client_id ⇒ Object

The RSSID of the client making the purchase. A cart can be validated without a client ID, but a client ID must be specified to complete a sale.



21
22
23
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 21

def client_id
  @client_id
end

#image ⇒ Object

The byte array data of the signature image.



45
46
47
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 45

def image
  @image
end

#image_file_name ⇒ Object

The name of the signature image being uploaded.



48
49
50
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 48

def image_file_name
  @image_file_name
end

#in_store ⇒ Object

When ‘true`, indicates that the cart is to be completed by a staff member and is to take place at one of the business’ physical locations.<br /> When `false`, indicates that the cart is to be completed by a client from the business’ online store.<br /> Default: false



30
31
32
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 30

def in_store
  @in_store
end

#items ⇒ Object

A list of the items in the cart.



27
28
29
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 27

def items
  @items
end

#location_id ⇒ Object

The location ID to be used for pulling business mode prices and taxes. If no location ID is supplied, it defaults to the online store, represented by a null value. Default: null (the online store)



42
43
44
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 42

def location_id
  @location_id
end

#payments ⇒ Object

A list of payment information objects to be applied to payment against the items in the cart.



36
37
38
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 36

def payments
  @payments
end

#promotion_code ⇒ Object

Promotion code to be applied to the cart.



33
34
35
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 33

def promotion_code
  @promotion_code
end

#send_email ⇒ Object

When ‘true`, sends a purchase receipt email to the client. Note that all appropriate permissions and settings must be enabled for the client to receive an email.<br /> Default: false



39
40
41
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 39

def send_email
  @send_email
end

#test ⇒ Object

When ‘true`, indicates that the contents of the cart are validated, but the transaction does not take place. You should use this parameter during testing and when checking the calculated totals of the items in the cart.<br /> When `false`, the transaction takes place and the database is affected.<br /> Default: false



24
25
26
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 24

def test
  @test
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 51

def self.attribute_map
  {
    :'cart_id' => :'CartId',
    :'client_id' => :'ClientId',
    :'test' => :'Test',
    :'items' => :'Items',
    :'in_store' => :'InStore',
    :'promotion_code' => :'PromotionCode',
    :'payments' => :'Payments',
    :'send_email' => :'SendEmail',
    :'location_id' => :'LocationId',
    :'image' => :'Image',
    :'image_file_name' => :'ImageFileName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 68

def self.swagger_types
  {
    :'cart_id' => :'String',
    :'client_id' => :'String',
    :'test' => :'BOOLEAN',
    :'items' => :'Array<CheckoutItemWrapper>',
    :'in_store' => :'BOOLEAN',
    :'promotion_code' => :'String',
    :'payments' => :'Array<CheckoutPaymentInfo>',
    :'send_email' => :'BOOLEAN',
    :'location_id' => :'Integer',
    :'image' => :'String',
    :'image_file_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cart_id == o.cart_id &&
      client_id == o.client_id &&
      test == o.test &&
      items == o.items &&
      in_store == o.in_store &&
      promotion_code == o.promotion_code &&
      payments == o.payments &&
      send_email == o.send_email &&
      location_id == o.location_id &&
      image == o.image &&
      image_file_name == o.image_file_name
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



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
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 238

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 = SwaggerClient.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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 304

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 217

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


204
205
206
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 210

def hash
  [cart_id, client_id, test, items, in_store, promotion_code, payments, send_email, location_id, image, image_file_name].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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 143

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

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

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

  if !@image.nil? && @image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
    invalid_properties.push('invalid value for "image", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
  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



284
285
286
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 284

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



290
291
292
293
294
295
296
297
298
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 290

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



278
279
280
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 278

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



166
167
168
169
170
171
172
 
# File 'lib/swagger_client/models/checkout_shopping_cart_request.rb', line 166

def valid?
  return false if @client_id.nil?
  return false if @items.nil?
  return false if @payments.nil?
  return false if !@image.nil? && @image !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
  true
end