Class: Squall::Payment

Inherits:
Base
  • Object
show all
Defined in:
lib/squall/payment.rb

Overview

OnApp Payment

Instance Attribute Summary

Attributes inherited from Base

#result, #success

Instance Method Summary (collapse)

Methods inherited from Base

#check_config, #default_params, #key_for_class, #request

Instance Method Details

- (Object) create(user_id, options = {})

Create a payment for a user.

Examples:

create amount: 500, invoice_number: "01234"

Parameters:

  • user_id —

    ID of the user

  • options (defaults to: {}) —

    Params for creating the User:

Options Hash (options):

  • :amount (Object) —

    Amount of the payment

  • :invoice_number (Object) —

    Number of the invoice

Returns:

  • a Hash.



24
25
26
 
# File 'lib/squall/payment.rb', line 24

def create(user_id, options = {})
  request(:post, "/users/#{user_id}/payments.json", default_params(options))
end

- (Object) delete(user_id, id)

Delete a payment

Parameters:

  • user_id —

    ID of the user

  • id —

    ID of the payment

Returns:

  • a Hash.



45
46
47
 
# File 'lib/squall/payment.rb', line 45

def delete(user_id, id)
  request(:delete, "/users/#{user_id}/payments/#{id}.json")
end

- (Object) edit(user_id, id, options = {})

Edit a payment

Parameters:

  • user_id —

    ID of the user

  • id —

    ID of the payment

  • options (defaults to: {}) —

    Params for editing the payment, see `#create`

Returns:

  • a Hash.



35
36
37
 
# File 'lib/squall/payment.rb', line 35

def edit(user_id, id, options = {})
  request(:put, "/users/#{user_id}/payments/#{id}.json", default_params(options))
end

- (Object) list(user_id)

Lists all payments.

Returns:

  • an Array.



7
8
9
10
 
# File 'lib/squall/payment.rb', line 7

def list(user_id)
  response = request(:get, "/users/#{user_id}/payments.json")
  response.collect { |user| user['payment'] }
end