Module: OrderItemsGroups

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

Instance Method Summary collapse

Instance Method Details

#create_order_item_group(data, options = nil) ⇒ Object

Create order item group.

Create a order item group with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  name: 'New Order Item Group',
  order_id: 1,
  quantity: 1,
  sale_price: 200
}
options = { include: 'orderItems' }
@data = @mints_user.create_order_item_group(data, options)



83
84
85
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 83

def create_order_item_group(data, options = nil)
  @client.raw('post', '/ecommerce/order-items-groups', options, data_transform(data))
end

#delete_order_item_group(id) ⇒ Object

Delete order item group.

Delete a order item group.

Parameters

id

(Integer) – Order item group id.

Example

@data = @mints_user.delete_order_item_group(147)



111
112
113
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 111

def delete_order_item_group(id)
  @client.raw('delete', "/ecommerce/order-items-groups/#{id}")
end

#get_order_item_group(id, options = nil) ⇒ Object

Get order item group.

Get a order item group info.

Parameters

id

(Integer) – Order item group id.

options

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

First Example

@data = @mints_user.get_order_item_group(1)

Second Example

options = { fields: 'name' }
@data = @mints_user.get_order_item_group(1, options)



64
65
66
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 64

def get_order_item_group(id, options = nil)
  @client.raw('get', "/ecommerce/order-items-groups/#{id}", options)
end

#get_order_item_group_support_data_by_order_id(order_id) ⇒ Object

Get order item group support data by order id.

Get support data of an order item group by an order id.

Parameters

order_id

(Integer) – Order id.

Example

@data = @mints_user.get_order_item_group_support_data_by_order_id(1)



30
31
32
33
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 30

def get_order_item_group_support_data_by_order_id(order_id)
  # FIXME: Return in OrderItemsGroupController.getTemplateSupportDataByOrderId method doesnt create data variable.
  @client.raw('get', "/ecommerce/order-items-groups/support-data/#{order_id}")
end

#get_order_item_groups(options = nil) ⇒ Object

Get order item groups.

Get a collection of order item groups.

Parameters

options

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

First Example

@data = @mints_user.get_order_item_groups

Second Example

options = { fields: 'name' }
@data = @mints_user.get_order_item_groups(options)



47
48
49
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 47

def get_order_item_groups(options = nil)
  @client.raw('get', '/ecommerce/order-items-groups', options)
end

#get_pending_order_template_from_order_item_group(parent_order_id, order_template_id) ⇒ Object

Get pending order template from order item group.

Get a pending order template from an order item group.

Parameters

parent_order_id

(Integer) – Order items group id.

order_template_id

(Integer) – Order template id.

Example

@data = @mints_user.get_pending_order_template_from_order_item_group(1, 1)



17
18
19
20
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 17

def get_pending_order_template_from_order_item_group(parent_order_id, order_template_id)
  url = "/ecommerce/order-items-groups/#{parent_order_id}/pending-items/order-template/#{order_template_id}"
  @client.raw('get', url)
end

#update_order_item_group(id, data, options = nil) ⇒ Object

Update order item group.

Update a order item group info.

Parameters

id

(Integer) – Order item group id.

data

(Hash) – Data to be submitted.

Example

data = {
  name: 'New Order Item Group Modified'
}
@data = @mints_user.update_order_item_group(147, data)



99
100
101
 
# File 'lib/user/ecommerce/order_items_groups.rb', line 99

def update_order_item_group(id, data, options = nil)
  @client.raw('put', "/ecommerce/order-items-groups/#{id}", options, data_transform(data))
end