Module: PriceList

Included in:
Ecommerce
Defined in:
lib/user/ecommerce/price_lists.rb

Instance Method Summary collapse

Instance Method Details

#create_price_list(data) ⇒ Object

Create price list.

Create a price list with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Price List'
}
@data = @cxf_user.create_price_list(data)


56
57
58
# File 'lib/user/ecommerce/price_lists.rb', line 56

def create_price_list(data)
  @client.raw('post', '/ecommerce/price-list', nil, data_transform(data))
end

#get_price_list(id, options = nil) ⇒ Object

Get price list.

Get a price list info.

Parameters

id

(Integer) – Price list id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @cxf_user.get_price_list(1)

Second Example

options = {
  fields: 'title'
}
@data = @cxf_user.get_price_list(1, options)


41
42
43
# File 'lib/user/ecommerce/price_lists.rb', line 41

def get_price_list(id, options = nil)
  @client.raw('get', "/ecommerce/price-list/#{id}", options)
end

#get_price_lists(options = nil, use_post = true) ⇒ Object

Get price lists.

Get a collection of price lists.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @cxf_user.get_price_lists

Second Example

options = {
  fields: "title"
}
@data = @cxf_user.get_price_lists(options)


22
23
24
# File 'lib/user/ecommerce/price_lists.rb', line 22

def get_price_lists(options = nil, use_post = true)
  get_query_results('/ecommerce/price-list', options, use_post)
end

#update_price_list(id, data) ⇒ Object

Update price list.

Update a price list info.

Parameters

id

(Integer) – Price list id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Price List Modified'
}
@data = @cxf_user.update_price_list(8, data)


72
73
74
# File 'lib/user/ecommerce/price_lists.rb', line 72

def update_price_list(id, data)
  @client.raw('put', "/ecommerce/price-list/#{id}", nil, data_transform(data))
end