Class: PlatformAPI::Credit

Inherits:

Object

• Object
• PlatformAPI::Credit

Defined in:

lib/platform-api/client.rb

Overview

A credit represents value that will be used up before further charges are assigned to an account.

Instance Method Summary

• #create(body = {}) ⇒ Object

  Create a new credit.

• #info(credit_id) ⇒ Object

  Info for existing credit.

• #initialize(client) ⇒ Credit constructor

  A new instance of Credit.

• #list ⇒ Object

  List existing credits.

Constructor Details

#initialize(client) ⇒ Credit

Returns a new instance of Credit.

# File 'lib/platform-api/client.rb', line 1660

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new credit.

Parameters:

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 1667

def create(body = {})
  @client.credit.create(body)
end

#info(credit_id) ⇒ Object

Info for existing credit.

Parameters:

• credit_id: —

  unique identifier of credit

# File 'lib/platform-api/client.rb', line 1674

def info(credit_id)
  @client.credit.info(credit_id)
end

#list ⇒ Object

List existing credits.

# File 'lib/platform-api/client.rb', line 1679

def list()
  @client.credit.list()
end