Module: Orders

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

Instance Method Summary collapse

Instance Method Details

#create_order(data) ⇒ Object

Create order.

Create a order with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Order",
  "order_template_id": 2
}
@data = @mints_user.create_order(data)



91
92
93
 
# File 'lib/user/ecommerce/orders.rb', line 91

def create_order(data)
    return @client.raw("post", "/ecommerce/orders", nil, data_transform(data))
end

#delete_orders(data) ⇒ Object

Delete orders.

Delete orders.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "ids": [ 18 ]
}
@data = @mints_user.delete_orders(data)



28
29
30
 
# File 'lib/user/ecommerce/orders.rb', line 28

def delete_orders(data) #TODO: Inform method should return another response like 'success'
    return @client.raw("delete", "/ecommerce/orders/delete", nil, data_transform(data))
end

#detach_order_item_from_order_item_group(orderItemId, groupId) ⇒ Object

TODO: The following two methods receive objects instead integer variable. Research use and test it.

Detach order item from order item group.

Detach an order item from an order item group.

Parameters

orderItemId

(Integer) – Order item id.

groupId

(Integer) – Order items group id.



197
198
199
 
# File 'lib/user/ecommerce/orders.rb', line 197

def detach_order_item_from_order_item_group(orderItemId, groupId) #TODO: Research use
    return @client.raw("put", "/ecommerce/order-items/detach/#{orderItemId}/order-items-groups/#{groupId}")
end

#duplicate_order(orderId, data) ⇒ Object

Duplicate order.

Duplicate an order.

Parameters

orderId

(Integer) – Order id.

data

(Hash) – Data to be submited.



13
14
15
 
# File 'lib/user/ecommerce/orders.rb', line 13

def duplicate_order(orderId, data) #FIXME: Doesnt read options from data and sale_price_cents column doesnt have to be null
    return @client.raw("post", "/ecommerce/orders/duplicate/#{orderId}", nil, data)
end

#get_order(id, options = nil) ⇒ Object

Get order.

Get a order info.

Parameters

id

(Integer) – Order id.

options

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

First Example

@data = @mints_user.get_order(1)

Second Example

options = { "fields": "title" }
@data = @mints_user.get_order(1, options)



75
76
77
 
# File 'lib/user/ecommerce/orders.rb', line 75

def get_order(id, options = nil)
    return @client.raw("get", "/ecommerce/orders/#{id}", options)
end

#get_order_item(id, options = nil) ⇒ Object

Get order item.

Get a order item info.

Parameters

id

(Integer) – Order item id.

options

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

First Example

@data = @mints_user.get_order_item(1)

Second Example

options = { "fields": "id" }
@data = @mints_user.get_order_item(1, options)



241
242
243
 
# File 'lib/user/ecommerce/orders.rb', line 241

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

#get_order_items(options = nil) ⇒ Object

Get order items.

Get a collection of order items.

Parameters

options

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

First Example

@data = @mints_user.get_order_items

Second Example

options = { "fields": "id" }
@data = @mints_user.get_order_items(options)



224
225
226
 
# File 'lib/user/ecommerce/orders.rb', line 224

def get_order_items(options = nil) #FIXME: CaliRouter POST method not supported.
    return @client.raw("get", "/ecommerce/order-items", options)
end

#get_order_items_support_data ⇒ Object

Get order items support data.

Get support data used in order items.

Example

@data = @mints_user.get_order_items_support_data



185
186
187
 
# File 'lib/user/ecommerce/orders.rb', line 185

def get_order_items_support_data
    return @client.raw("get", "/ecommerce/order-items/support-data")
end

#get_order_template(id, options = nil) ⇒ Object

Get order template.

Get a order template info.

Parameters

id

(Integer) – Order template id.

options

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

First Example

@data = @mints_user.get_order_template(1)

Second Example

options = { "fields": "title" }
@data = @mints_user.get_order_template(1, options)



156
157
158
 
# File 'lib/user/ecommerce/orders.rb', line 156

def get_order_template(id, options = nil)
    return @client.raw("get", "/ecommerce/order-templates/#{id}", options)
end

#get_order_template_support_data(id) ⇒ Object

Get order template support data.

Get support data from a order template.

Parameters

id

(Integer) – Order template id.

Example

@data = @mints_user.get_order_template_support_data(1)



123
124
125
 
# File 'lib/user/ecommerce/orders.rb', line 123

def get_order_template_support_data(id)
    return @client.raw("get", "/ecommerce/order-templates/support-data/#{id}")
end

#get_order_templates(options = nil) ⇒ Object

Get order templates.

Get a collection of order templates.

Parameters

options

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

First Example

@data = @mints_user.get_order_templates

Second Example

options = { "fields": "title" }
@data = @mints_user.get_order_templates(options)



139
140
141
 
# File 'lib/user/ecommerce/orders.rb', line 139

def get_order_templates(options = nil)
    return @client.raw("get", "/ecommerce/order-templates", options)
end

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

Get orders.

Get a collection of orders.

Parameters

options

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

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @mints_user.get_orders

Second Example

options = { "fields": "id, title" }
@data = @mints_user.get_orders(options)

Third Example

options = { "fields": "id, title" }
@data = @mints_user.get_orders(options, false)



58
59
60
 
# File 'lib/user/ecommerce/orders.rb', line 58

def get_orders(options = nil, use_post = true)
    return get_query_results("/ecommerce/orders", options, use_post)
end

#get_orders_support_data ⇒ Object

Get orders support data.

Get support data used in orders.

Example

@data = @mints_user.get_orders_support_data



37
38
39
 
# File 'lib/user/ecommerce/orders.rb', line 37

def get_orders_support_data
    return @client.raw("get", "/ecommerce/orders/support-data")
end

#update_order(id, data) ⇒ Object

Update order.

Update a order info.

Parameters

id

(Integer) – Order id.

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Order Modified"
}
@data = @mints_user.update_order(26, data)



107
108
109
 
# File 'lib/user/ecommerce/orders.rb', line 107

def update_order(id, data)
    return @client.raw("put", "/ecommerce/orders/#{id}", nil, data_transform(data))
end

#update_order_item(id, data) ⇒ Object

Update order item.

Update a order item info.

Parameters

id

(Integer) – Order item id.

data

(Hash) – Data to be submited.

Example

data = { "title": "No title in order items" }
@data = @mints_user.update_order_item(1, data)



255
256
257
 
# File 'lib/user/ecommerce/orders.rb', line 255

def update_order_item(id, data) #TODO: Research what can update
    return @client.raw("put", "/ecommerce/order-items/#{id}", nil, data_transform(data))
end

#update_order_item_from_order_item_group(orderItemId, groupId, data) ⇒ Object

Update order item from order item group.

Update an order item data from an order item group.

Parameters

orderItemId

(Integer) – Order item id.

groupId

(Integer) – Order items group id.



208
209
210
 
# File 'lib/user/ecommerce/orders.rb', line 208

def update_order_item_from_order_item_group(orderItemId, groupId, data) #TODO: Research use
    return @client.raw("put", "/ecommerce/order-items/update/#{orderItemId}/order-items-groups/#{groupId}", nil, data_transform(data))
end

#update_order_template(id, data) ⇒ Object

Update order template.

Update a order template info.

Parameters

id

(Integer) – Order template id.

data

(Hash) – Data to be submited.

Example

data = {
  "title": "Inventory Increase"
}
@data = @mints_user.update_order_template(12, data)



172
173
174
 
# File 'lib/user/ecommerce/orders.rb', line 172

def update_order_template(id, data)
    return @client.raw("put", "/ecommerce/order-templates/#{id}", nil, data_transform(data))
end