class Tradenity::ShoppingCart

Attributes

__meta[RW]
created_at[RW]
items[RW]
items_tax_amount[RW]
promotions[RW]
shipping_cost[RW]
subtotal[RW]
total[RW]
total_items_discount[RW]
updated_at[RW]

Public Class Methods

add_item(item, opts = {}) click to toggle source

Add item. Add new item to the shopping cart. @param item Line item to add to cart @param [Hash] opts the optional parameters @return [ShoppingCart]

# File lib/tradenity/resources/shopping_cart.rb, line 332
def add_item(item, opts = {})
  data, _status_code, _headers = add_item_with_http_info(item, opts)
  data
end
add_item_with_http_info(item, opts = {}) click to toggle source

Add item. Add new item to the shopping cart. @param item Line item to add to cart @param [Hash] opts the optional parameters @return [Array<(ShoppingCart, Fixnum, Hash)>] ShoppingCart data, response status code and response headers

# File lib/tradenity/resources/shopping_cart.rb, line 342
def add_item_with_http_info(item, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ShoppingCart.add_item ...'
  end
  # verify the required parameter 'item' is set
  if api_client.config.client_side_validation && item.nil?
    fail ArgumentError, "Missing the required parameter 'item' when calling ShoppingCart.add_item"
  end
  # resource path
  local_var_path = '/shoppingCarts'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(item)
  auth_names = []
  data, status_code, headers = api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShoppingCart')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ShoppingCart#add_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
api_client() click to toggle source
# File lib/tradenity/resources/shopping_cart.rb, line 319
def self.api_client
  ApiClient.default
end
attribute_map() click to toggle source

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

# File lib/tradenity/resources/shopping_cart.rb, line 53
def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'items' => :'items',
    :'subtotal' => :'subtotal',
    :'total' => :'total',
    :'shipping_cost' => :'shippingCost',
    :'items_tax_amount' => :'itemsTaxAmount',
    :'total_items_discount' => :'totalItemsDiscount',
    :'promotions' => :'promotions'
  }
end
checkout(order, opts = {}) click to toggle source

Checkout cart. Checkout cart, Making an order. @param order Required order details. @param [Hash] opts the optional parameters @return [Order]

# File lib/tradenity/resources/shopping_cart.rb, line 386
def checkout(order, opts = {})
  data, _status_code, _headers = checkout_with_http_info(order, opts)
  data
end
checkout_with_http_info(order, opts = {}) click to toggle source

Checkout cart. Checkout cart, Making an order. @param order Required order details. @param [Hash] opts the optional parameters @return [Array<(Order, Fixnum, Hash)>] Order data, response status code and response headers

# File lib/tradenity/resources/shopping_cart.rb, line 396
def checkout_with_http_info(order, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ShoppingCart.checkout ...'
  end
  # verify the required parameter 'order' is set
  if api_client.config.client_side_validation && order.nil?
    fail ArgumentError, "Missing the required parameter 'order' when calling ShoppingCart.checkout"
  end
  # resource path
  local_var_path = '/shoppingCarts/checkout'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(order)
  auth_names = []
  data, status_code, headers = api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Order')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ShoppingCart#checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_item(item_id, opts = {}) click to toggle source

Remove item. Remove item from shopping cart @param item_id Item ID to delete. @param [Hash] opts the optional parameters @return [ShoppingCart]

# File lib/tradenity/resources/shopping_cart.rb, line 440
def delete_item(item_id, opts = {})
  data, _status_code, _headers = delete_item_with_http_info(item_id, opts)
  data
end
delete_item_with_http_info(item_id, opts = {}) click to toggle source

Remove item. Remove item from shopping cart @param item_id Item ID to delete. @param [Hash] opts the optional parameters @return [Array<(ShoppingCart, Fixnum, Hash)>] ShoppingCart data, response status code and response headers

# File lib/tradenity/resources/shopping_cart.rb, line 450
def delete_item_with_http_info(item_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ShoppingCart.delete_item ...'
  end
  # verify the required parameter 'item_id' is set
  if api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling ShoppingCart.delete_item"
  end
  # resource path
  local_var_path = '/shoppingCarts/{itemId}'.sub('{' + 'itemId' + '}', item_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShoppingCart')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ShoppingCart#delete_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
empty(opts = {}) click to toggle source

Empty cart. Empty the shopping cart. @param [Hash] opts the optional parameters @return [ShoppingCart]

# File lib/tradenity/resources/shopping_cart.rb, line 493
def empty(opts = {})
  data, _status_code, _headers = empty_with_http_info(opts)
  data
end
empty_with_http_info(opts = {}) click to toggle source

Empty cart. Empty the shopping cart. @param [Hash] opts the optional parameters @return [Array<(ShoppingCart, Fixnum, Hash)>] ShoppingCart data, response status code and response headers

# File lib/tradenity/resources/shopping_cart.rb, line 502
def empty_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ShoppingCart.empty ...'
  end
  # resource path
  local_var_path = '/shoppingCarts'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShoppingCart')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ShoppingCart#empty\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(opts = {}) click to toggle source

Get cart. Retrieve the shopping cart of the current session. @param [Hash] opts the optional parameters @return [ShoppingCart]

# File lib/tradenity/resources/shopping_cart.rb, line 541
def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end
get_with_http_info(opts = {}) click to toggle source

Get cart. Retrieve the shopping cart of the current session. @param [Hash] opts the optional parameters @return [Array<(ShoppingCart, Fixnum, Hash)>] ShoppingCart data, response status code and response headers

# File lib/tradenity/resources/shopping_cart.rb, line 550
def get_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ShoppingCart.get ...'
  end
  # resource path
  local_var_path = '/shoppingCarts'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShoppingCart')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ShoppingCart#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/tradenity/resources/shopping_cart.rb, line 88
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?(:'__meta')
    self.__meta = attributes[:'__meta']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'promotions')
    if (value = attributes[:'promotions']).is_a?(Array)
      self.promotions = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/tradenity/resources/shopping_cart.rb, line 70
def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'items' => :'Array<LineItem>',
    :'subtotal' => :'Integer',
    :'total' => :'Integer',
    :'shipping_cost' => :'Integer',
    :'items_tax_amount' => :'Integer',
    :'total_items_discount' => :'Integer',
    :'promotions' => :'Array<Promotion>'
  }
end
update_item(item_id, item, opts = {}) click to toggle source

Update cart. Update cart item. @param item_id Item ID to update. @param item Line item to update. @param [Hash] opts the optional parameters @return [ShoppingCart]

# File lib/tradenity/resources/shopping_cart.rb, line 591
def update_item(item_id, item, opts = {})
  data, _status_code, _headers = update_item_with_http_info(item_id, item, opts)
  data
end
update_item_with_http_info(item_id, item, opts = {}) click to toggle source

Update cart. Update cart item. @param item_id Item ID to update. @param item Line item to update. @param [Hash] opts the optional parameters @return [Array<(ShoppingCart, Fixnum, Hash)>] ShoppingCart data, response status code and response headers

# File lib/tradenity/resources/shopping_cart.rb, line 602
def update_item_with_http_info(item_id, item, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ShoppingCart.update_item ...'
  end
  # verify the required parameter 'item_id' is set
  if api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling ShoppingCart.update_item"
  end
  # verify the required parameter 'item' is set
  if api_client.config.client_side_validation && item.nil?
    fail ArgumentError, "Missing the required parameter 'item' when calling ShoppingCart.update_item"
  end
  # resource path
  local_var_path = '/shoppingCarts/{itemId}'.sub('{' + 'itemId' + '}', item_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(item)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShoppingCart')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ShoppingCart#update_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/tradenity/resources/shopping_cart.rb, line 187
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      items == o.items &&
      subtotal == o.subtotal &&
      total == o.total &&
      shipping_cost == o.shipping_cost &&
      items_tax_amount == o.items_tax_amount &&
      total_items_discount == o.total_items_discount &&
      promotions == o.promotions
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/tradenity/resources/shopping_cart.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 = Tradenity.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/tradenity/resources/shopping_cart.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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/tradenity/resources/shopping_cart.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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/tradenity/resources/shopping_cart.rb, line 204
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/tradenity/resources/shopping_cart.rb, line 210
def hash
  [__meta, created_at, updated_at, items, subtotal, total, shipping_cost, items_tax_amount, total_items_discount, promotions].hash
end
id() click to toggle source
# File lib/tradenity/resources/shopping_cart.rb, line 21
def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end
id=(id) click to toggle source
# File lib/tradenity/resources/shopping_cart.rb, line 17
def id=(id)
  @id = id
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/tradenity/resources/shopping_cart.rb, line 164
def list_invalid_properties
  invalid_properties = Array.new
  if @subtotal.nil?
    invalid_properties.push('invalid value for "subtotal", subtotal cannot be nil.')
  end

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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/tradenity/resources/shopping_cart.rb, line 284
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/tradenity/resources/shopping_cart.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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/tradenity/resources/shopping_cart.rb, line 278
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/tradenity/resources/shopping_cart.rb, line 179
def valid?
  return false if @subtotal.nil?
  return false if @total.nil?
  true
end