Class: Increase::Resources::Accounts

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Accounts

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 Accounts.

Parameters:



169
170
171
 
# File 'lib/increase/resources/accounts.rb', line 169

def initialize(client:)
  @client = client
end

Instance Method Details

#balance(account_id, at_time: nil, request_options: {}) ⇒ Increase::Models::BalanceLookup

Retrieve the current and available balances for an account in minor units of the account’s currency. Learn more about [account balances](/documentation/balance).

Parameters:

  • account_id (String) —

    The identifier of the Account to retrieve.

  • at_time (Time) —

    The moment to query the balance at. If not set, returns the current balances.

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

Returns:

See Also:



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/increase/resources/accounts.rb', line 135

def balance(, params = {})
  parsed, options = Increase::AccountBalanceParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["accounts/%1$s/balance", ],
    query: parsed,
    model: Increase::BalanceLookup,
    options: options
  )
end

#close(account_id, request_options: {}) ⇒ Increase::Models::Account

Close an Account

Parameters:

  • account_id (String) —

    The identifier of the Account to close. The account must have a zero balance.

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

Returns:

See Also:



157
158
159
160
161
162
163
164
 
# File 'lib/increase/resources/accounts.rb', line 157

def close(, params = {})
  @client.request(
    method: :post,
    path: ["accounts/%1$s/close", ],
    model: Increase::Account,
    options: params[:request_options]
  )
end

#create(name: , entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) ⇒ Increase::Models::Account

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

Create an Account

Parameters:

  • name (String) —

    The name you choose for the Account.

  • entity_id (String) —

    The identifier for the Entity that will own the Account.

  • informational_entity_id (String) —

    The identifier of an Entity that, while not owning the Account, is associated wi

  • program_id (String) —

    The identifier for the Program that this Account falls under. Required if you op

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

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/increase/resources/accounts.rb', line 26

def create(params)
  parsed, options = Increase::AccountCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "accounts",
    body: parsed,
    model: Increase::Account,
    options: options
  )
end

#list(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Account>

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

List Accounts

Parameters:

  • created_at (Increase::Models::AccountListParams::CreatedAt)
  • cursor (String) —

    Return the page of entries after this one.

  • entity_id (String) —

    Filter Accounts for those belonging to the specified Entity.

  • idempotency_key (String) —

    Filter records to the one with the specified ‘idempotency_key` you chose for tha

  • informational_entity_id (String) —

    Filter Accounts for those belonging to the specified Entity as informational.

  • limit (Integer) —

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

  • program_id (String) —

    Filter Accounts for those in a specific Program.

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

Returns:

See Also:



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/increase/resources/accounts.rb', line 109

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

#retrieve(account_id, request_options: {}) ⇒ Increase::Models::Account

Retrieve an Account

Parameters:

  • account_id (String) —

    The identifier of the Account to retrieve.

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

Returns:

See Also:



48
49
50
51
52
53
54
55
 
# File 'lib/increase/resources/accounts.rb', line 48

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

#update(account_id, name: nil, request_options: {}) ⇒ Increase::Models::Account

Update an Account

Parameters:

  • account_id (String) —

    The identifier of the Account to update.

  • name (String) —

    The new name of the Account.

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

Returns:

See Also:



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/increase/resources/accounts.rb', line 70

def update(, params = {})
  parsed, options = Increase::AccountUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["accounts/%1$s", ],
    body: parsed,
    model: Increase::Account,
    options: options
  )
end