View Source ExChargebee.VirtualBankAccount (ex_chargebee v0.4.5)

An interface for Interacting with virtual_bank_accounts

For More information see Chargebee virtual_bank_account Documentation

Summary

Functions

Creates a virtual_bank_account.

Perform a virtual_bank_account create_using_permanent_token.

Perform a delete on individual virtual_bank_account.

Perform a delete_local on individual virtual_bank_account.

Returns a list of virtual_bank_accounts. Pagination is handled automatically unless the opt paginate is set to false.

Returns a stream of virtual_bank_accounts. Pagination is handled automatically as the stream is consumed.

Functions

Link to this function

create(params, opts \\ [])

View Source
@spec create(
  map(),
  keyword()
) :: map() | nil

Creates a virtual_bank_account.

Find more information in the Chargebee Documentation

Link to this function

create_using_permanent_token(params, opts \\ [])

View Source
@spec create_using_permanent_token(
  map(),
  keyword()
) :: map() | nil

Perform a virtual_bank_account create_using_permanent_token.

Find more information in the Chargebee Documentation

Link to this function

delete(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete(String.t(), map(), keyword()) :: map() | nil

Perform a delete on individual virtual_bank_account.

Find more information in the Chargebee Documentation

Link to this function

delete_local(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete_local(String.t(), map(), keyword()) :: map() | nil

Perform a delete_local on individual virtual_bank_account.

Find more information in the Chargebee Documentation

Link to this function

list(params \\ %{}, opts \\ [])

View Source
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of virtual_bank_accounts. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
@spec operations() :: Keyword.t()
Link to this function

retrieve(resource_id, opts \\ [])

View Source
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of virtual_bank_accounts. Pagination is handled automatically as the stream is consumed.