Class: Increase::Resources::AccountStatements

Inherits:

Object

• Object
• Increase::Resources::AccountStatements

Defined in:

lib/increase/resources/account_statements.rb

Instance Method Summary

• #initialize(client:) ⇒ AccountStatements constructor private

  A new instance of AccountStatements.

• #list(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::AccountStatement>

  Some parameter documentations has been truncated, see Models::AccountStatementListParams for more details.

• #retrieve(account_statement_id, request_options: {}) ⇒ Increase::Models::AccountStatement

  Retrieve an Account Statement.

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:

• client (Increase::Client)

# File 'lib/increase/resources/account_statements.rb', line 61

def initialize(client:)
  @client = client
end

Instance Method Details

#list(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::AccountStatement>

Some parameter documentations has been truncated, see Models::AccountStatementListParams for more details.

List Account Statements

Parameters:

• account_id (String) —

  Filter Account Statements to those belonging to the specified Account.

• cursor (String) —

  Return the page of entries after this one.

• limit (Integer) —

  Limit the size of the list that is returned. The default (and maximum) is 100 ob

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

Returns:

• (Increase::Internal::Page<Increase::Models::AccountStatement>)

See Also:

• Models::AccountStatementListParams

# File 'lib/increase/resources/account_statements.rb', line 46

def list(params = {})
  parsed, options = Increase::AccountStatementListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "account_statements",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::AccountStatement,
    options: options
  )
end

#retrieve(account_statement_id, request_options: {}) ⇒ Increase::Models::AccountStatement

Retrieve an Account Statement

Parameters:

• account_statement_id (String) —

  The identifier of the Account Statement to retrieve.

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

Returns:

• (Increase::Models::AccountStatement)

See Also:

• Models::AccountStatementRetrieveParams

# File 'lib/increase/resources/account_statements.rb', line 17

def retrieve(account_statement_id, params = {})
  @client.request(
    method: :get,
    path: ["account_statements/%1$s", account_statement_id],
    model: Increase::AccountStatement,
    options: params[:request_options]
  )
end