Module: OrderItemsGroups
- Included in:
- Ecommerce
- Defined in:
- lib/user/ecommerce/order_items_groups.rb,
lib/contact/ecommerce/order_items_groups.rb
Instance Method Summary collapse
-
#create_order_item_group(data) ⇒ Object
Create Order Item Group.
-
#delete_order_item_group(id) ⇒ Object
Delete Order Item Group.
-
#get_order_item_group(id, options = nil) ⇒ Object
Get Order Item Group.
-
#get_order_item_group_support_data_by_order_id(order_id) ⇒ Object
Get order item group support data by order id.
-
#get_order_item_groups(options = nil) ⇒ Object
Get Order Item Groups.
-
#get_pending_order_template_from_order_item_group(parent_order_id, order_template_id) ⇒ Object
Get pending order template from order item group.
-
#update_order_item_group(id, data) ⇒ Object
Update Order Item Group.
Instance Method Details
#create_order_item_group(data) ⇒ Object
Create Order Item Group.
Create an order item group with data if you are related to that order.
Parameters
- data
-
(Hash) – Data to be submitted.
First Example
data = {
name: 'New Order Item Group',
quantity: 1,
order_id: 1,
on_sale_price: 100
}
@data = @mints_contact.create_order_item_group(data)
Second Example
data = {
name: "",
quantity: 1,
order_id: 1,
sku_id: 1
}
@data = @mints_contact.create_order_item_group(data)
83 84 85 |
# File 'lib/user/ecommerce/order_items_groups.rb', line 83 def create_order_item_group(data, = nil) @client.raw('post', '/ecommerce/order-items-groups', , data_transform(data)) end |
#delete_order_item_group(id) ⇒ Object
Delete Order Item Group.
Delete an order item group. FIXME: This method doesn’t work. Throw no action error.
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 an 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_contact.get_order_item_group(130)
Second Example
= {
fields: 'id'
}
@data = @mints_contact.get_order_item_group(130, )
64 65 66 |
# File 'lib/user/ecommerce/order_items_groups.rb', line 64 def get_order_item_group(id, = nil) @client.raw('get', "/ecommerce/order-items-groups/#{id}", ) 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_contact.get_order_item_groups
Second Example
= {
fields: 'id'
}
@data = @mints_contact.get_order_item_groups()
47 48 49 |
# File 'lib/user/ecommerce/order_items_groups.rb', line 47 def get_order_item_groups( = nil) @client.raw('get', '/ecommerce/order-items-groups', ) 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) ⇒ Object
Update Order Item Group.
Update an order item group info if you are related to that order.
Parameters
- id
-
(Integer) – Order Item Group Id.
- data
-
(Hash) – Data to be submitted.
First Example
data = {
name: 'New Order Item Group Name Updated'
}
@data = @mints_contact.update_order_item_group(130, data)
99 100 101 |
# File 'lib/user/ecommerce/order_items_groups.rb', line 99 def update_order_item_group(id, data) @client.raw('put', "/ecommerce/order-items-groups/#{id}", nil, data_transform(data)) end |