Class: Celery::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/celery/resources/order.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Order

Returns a new instance of Order.



5
6
7
 
# File 'lib/celery/resources/order.rb', line 5

def initialize(api)
  @api = api
end

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.



3
4
5
 
# File 'lib/celery/resources/order.rb', line 3

def api
  @api
end

Instance Method Details

#all(params = {}) ⇒ JSON

Returns a list of orders you have. The orders are returned in sorted order, with the most recent orders appearing first.

Examples:


orders = celery.order.all(limit: 25, skip: 2, sort: 'created', order: 'asc')
orders["total"]
=> 158

Parameters:

  • limit (Integer) —

    (optional) Limit the number of results.

  • skip (Integer) —

    (optional) Skip n results.

  • sort (String) —

    (optional) Field name to sort on.

  • order (String) —

    (optional) Either ‘asc` or `desc`.

  • since (String) —

    (optional) Based on updated. Unix time in milliseconds (ms).

  • until (String) —

    (optional) Based on updated. Unix time in milliseconds (ms).

  • status (String) —

    (optional) Once of ‘paid`, `paid_balance`, `paid_deposit`, `refunded`, `shipped`.

Returns:

  • (JSON) —

    A JSON object with the following attributes:

    • total [Integer]

    • count [Integer]

    • offset [Integer]

    • limit [Integer]

    • has_more [Boolean]

    • orders [Array]

See Also:



36
37
38
 
# File 'lib/celery/resources/order.rb', line 36

def all(params = {})
  @api.get("orders", query: params)
end

#cancel(order_id) ⇒ JSON

TODO: There is no way that this is a get request! TODO: Is “cancelled” and order status? Cancels an order.

Examples:


cancelled_order = celery.order.cancel("123abc")
cancelled_order["status"]
=> cancelled

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to be cancelled.

Returns:

  • (JSON) —

    An Order object.

See Also:



211
212
213
 
# File 'lib/celery/resources/order.rb', line 211

def cancel(order_id)
  @api.get("orders/#{order_id}/cancel")
end

#charge_balance(order_id) ⇒ JSON

Charges balance.

Examples:


charge = celery.order.charge_balance("123abc")

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to charge.

Returns:

  • (JSON) —

    An Order object.

See Also:



243
244
245
 
# File 'lib/celery/resources/order.rb', line 243

def charge_balance(order_id)
  @api.post("orders/#{order_id}/charge_balance")
end

#charge_deposit(order_id) ⇒ JSON

Charges deposit.

Examples:


charge = celery.order.charge_deposit("123abc")

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to charge.

Returns:

  • (JSON) —

    An Order object.

See Also:



227
228
229
 
# File 'lib/celery/resources/order.rb', line 227

def charge_deposit(order_id)
  @api.post("orders/#{order_id}/charge_deposit")
end

#destroy(order_id) ⇒ JSON

Deletes an existing order object.

Examples:


result = celery.order.destroy("123abc")
result["status"]
=> true

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to be deleted.

Returns:

  • (JSON) —

    A JSON object with the following attributes:

    • status [Boolean]

See Also:



191
192
193
 
# File 'lib/celery/resources/order.rb', line 191

def destroy(order_id)
  @api.delete("orders/#{order_id}")
end

#find(order_id) ⇒ JSON

Retrieves an order that has previously been created.

Examples:


order = celery.order.find("123abc")
order["_id"]
=> "51ad40901a7e9b0200000006"

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to be retrieved.

Returns:

  • (JSON) —

    An Order object.

See Also:



124
125
126
 
# File 'lib/celery/resources/order.rb', line 124

def find(order_id)
  @api.get("orders/#{order_id}")
end

#new(order) ⇒ JSON

Creates a new order object.

Examples:


order = {
  seller_id: "123abc456",
  buyer: {
    email: "[email protected]",
    ...
  },
  ...
}
new_order = celery.order.new(order)
new_order["_id"]
=> "51ad40901a7e9b0200000006"

Parameters:

  • order (Hash) —

    A hash of order attributes.

Returns:

  • (JSON) —

    An Order object.

See Also:



150
151
152
 
# File 'lib/celery/resources/order.rb', line 150

def new(order)
  @api.post("orders", body: {order: order})
end

Returns a list of ‘paid` orders.

Examples:


paid = celery.order.paid(limit: 25, skip: 2, sort: 'created', order: 'asc')
paid["total"]
=> 5

See Also:



49
50
51
52
 
# File 'lib/celery/resources/order.rb', line 49

def paid(params = {})
  params[:status] = 'paid'
  all(params)
end

Returns a list of ‘paid_balance` orders.

Examples:


paid = celery.order.paid_balance(limit: 25, skip: 2, sort: 'created', order: 'asc')
paid["total"]
=> 5

See Also:



63
64
65
66
 
# File 'lib/celery/resources/order.rb', line 63

def paid_balance(params = {})
  params[:status] = 'paid_balance'
  all(params)
end

Returns a list of ‘paid_deposit` orders.

Examples:


paid = celery.order.paid_deposit(limit: 25, skip: 2, sort: 'created', order: 'asc')
paid["total"]
=> 5

See Also:



77
78
79
80
 
# File 'lib/celery/resources/order.rb', line 77

def paid_deposit(params = {})
  params[:status] = 'paid_deposit'
  all(params)
end

#refund_balance(order_id) ⇒ JSON

Refunds balance.

Examples:


refund = celery.order.refund_balance("123abc")

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to charge.

Returns:

  • (JSON) —

    An Order object.

See Also:



275
276
277
 
# File 'lib/celery/resources/order.rb', line 275

def refund_balance(order_id)
  @api.post("orders/#{order_id}/refund_balance")
end

#refund_deposit(order_id) ⇒ JSON

Refunds deposit.

Examples:


refund = celery.order.refund_deposit("123abc")

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to charge.

Returns:

  • (JSON) —

    An Order object.

See Also:



259
260
261
 
# File 'lib/celery/resources/order.rb', line 259

def refund_deposit(order_id)
  @api.post("orders/#{order_id}/refund_deposit")
end

#refunded(params = {}) ⇒ Object

Returns a list of ‘refunded` orders.

Examples:


paid = celery.order.refunded(limit: 25, skip: 2, sort: 'created', order: 'asc')
paid["total"]
=> 5

See Also:



91
92
93
94
 
# File 'lib/celery/resources/order.rb', line 91

def refunded(params = {})
  params[:status] = 'refunded'
  all(params)
end

#ship(order_id) ⇒ JSON

TODO: There is no way that this is a get request! TODO: Is “cancelled” and order status? Changes order status to ‘shipped `.

Examples:


refund = celery.order.ship("123abc")

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to ship.

Returns:

  • (JSON) —

    An Order object.

See Also:



293
294
295
 
# File 'lib/celery/resources/order.rb', line 293

def ship(order_id)
  @api.get("orders/#{order_id}/ship")
end

#shipped(params = {}) ⇒ Object

Returns a list of ‘shipped` orders.

Examples:


paid = celery.order.shipped(limit: 25, skip: 2, sort: 'created', order: 'asc')
paid["total"]
=> 5

See Also:



105
106
107
108
 
# File 'lib/celery/resources/order.rb', line 105

def shipped(params = {})
  params[:status] = 'shipped'
  all(params)
end

#update(order_id, order) ⇒ JSON

Updates an existing order object.

Examples:


updated_order = {
  status: "refunded"
}
order = celery.order.update("123abc", updated_order)
order["status"]
=> "refunded"

Parameters:

  • order_id (String) —

    (required) The identifier of the Order to be updated.

  • order (Hash) —

    A hash of order attributes.

Returns:

  • (JSON) —

    An Order object.

See Also:



172
173
174
 
# File 'lib/celery/resources/order.rb', line 172

def update(order_id, order)
  @api.put("orders/#{order_id}", body: {order: order})
end