Class: Billingrails::Resources::CreditGrants

Inherits:
Object
  • Object
show all
Defined in:
lib/billingrails/resources/credit_grants.rb

Overview

Credit grants resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CreditGrants

Returns a new instance of CreditGrants.

Parameters:

  • client (Client) —

    The API client



10
11
12
 
# File 'lib/billingrails/resources/credit_grants.rb', line 10

def initialize(client)
  @client = client
end

Instance Method Details

#apply_credit_grant(id, data) ⇒ Hash

Apply credit grant

Applies a credit grant to an invoice or logs an external usage.

Parameters:

  • id (String) —

    Resource ID

  • data (Hash) —

    Request body

Returns:

  • (Hash) —

    Response data



21
22
23
24
 
# File 'lib/billingrails/resources/credit_grants.rb', line 21

def apply_credit_grant(id, data)
  path = "/credit_grants/#{id}/apply"
  @client.request(:post, path, body: data)
end

#create_credit_grant(data) ⇒ Hash

Create a credit grant

Creates a credit grant.

Parameters:

  • data (Hash) —

    Request body

Returns:

  • (Hash) —

    Response data



65
66
67
68
 
# File 'lib/billingrails/resources/credit_grants.rb', line 65

def create_credit_grant(data)
  path = "/credit_grants"
  @client.request(:post, path, body: data)
end

#expire_credit_grant(id) ⇒ Hash

Expire credit grant

Expires a credit grant.

Parameters:

  • id (String) —

    Resource ID

Returns:

  • (Hash) —

    Response data



32
33
34
35
 
# File 'lib/billingrails/resources/credit_grants.rb', line 32

def expire_credit_grant(id)
  path = "/credit_grants/#{id}/expire"
  @client.request(:post, path)
end

#list_credit_grants ⇒ Hash

List credit grants

Retrieves a list of credit grants.

Returns:

  • (Hash) —

    Response data



54
55
56
57
 
# File 'lib/billingrails/resources/credit_grants.rb', line 54

def list_credit_grants()
  path = "/credit_grants"
  @client.request(:get, path)
end

#retrieve_credit_grant(id, params: nil) ⇒ Hash

Retrieve a credit grant

Retrieves a credit grant by ID.

Parameters:

  • id (String) —

    Resource ID

  • params (Hash, nil) (defaults to: nil) —

    Query parameters

Returns:

  • (Hash) —

    Response data



44
45
46
47
 
# File 'lib/billingrails/resources/credit_grants.rb', line 44

def retrieve_credit_grant(id, params: nil)
  path = "/credit_grants/#{id}"
  @client.request(:get, path, params: params)
end

#reverse_credit_grant_transaction(id, data) ⇒ Hash

Reverse credit grant transaction

Reverses a credit grant usage.

Parameters:

  • id (String) —

    Resource ID

  • data (Hash) —

    Request body

Returns:

  • (Hash) —

    Response data



77
78
79
80
 
# File 'lib/billingrails/resources/credit_grants.rb', line 77

def reverse_credit_grant_transaction(id, data)
  path = "/credit_grants/#{id}/reverse_transaction"
  @client.request(:post, path, body: data)
end