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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AccountStatements.

Parameters:



33
34
35
 
# File 'lib/increase/resources/simulations/account_statements.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_id: , request_options: {}) ⇒ Increase::Models::AccountStatement

Simulates an [Account Statement](#account-statements) being created for an account. In production, Account Statements are generated once per month.

Parameters:

  • account_id (String) —

    The identifier of the Account the statement is for.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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

def create(params)
  parsed, options = Increase::Simulations::AccountStatementCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "simulations/account_statements",
    body: parsed,
    model: Increase::AccountStatement,
    options: options
  )
end