Class: Increase::Resources::Simulations::AccountStatements

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/simulations/account_statements.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AccountStatements

Returns a new instance of AccountStatements.



7
8
9
# File 'lib/increase/resources/simulations/account_statements.rb', line 7

def initialize(client:)
  @client = client
end

Instance Method Details

#create(params = {}, opts = {}) ⇒ Increase::Models::AccountStatement

Simulates an Account Statement being created for an account. In production, Account Statements are generated once per month.

Parameters:

  • params (Hash) (defaults to: {})

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {})

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :account_id (String)

    The identifier of the Account the statement is for.

Returns:



20
21
22
23
24
25
26
27
# File 'lib/increase/resources/simulations/account_statements.rb', line 20

def create(params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/simulations/account_statements"
  req[:body] = params
  req[:model] = Increase::Models::AccountStatement
  @client.request(req, opts)
end