wrappers/CustomerAccounts

The CustomerAccounts wrapper module.

Members

inner account_number :String

The Account Number to get details of.

inner CustomerAccount

inner from_index :String

The id of the object before which the previous set of objects are to be retrieved.

inner has_more_results :String

true if there are more results or pages

inner ID_CUSTOMER :String

The unique identifier assigned by EBPP to the customer.

inner page_size :String

The maximum number of objects returned in the query.

inner query_id :String

The query id of the object.

inner String

The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2....

inner to_index :String

The id of the object after which the next set of objects are to be retrieved.

inner total_results_count :String

total number of Customer accounts of customer available with matching criteria

inner url :String

This URL fetches the next or previous set of customer accounts, based on the presence of after_object or before_object parameter.

Methods

findBy(account_number, Stringopt, page_size, query_id, from_index, to_index) → {module:wrappers/CustomerAccounts}

Parameters:
Name Type Attributes Description
account_number String

The account_number of CustomerAccounts.

String <optional>

status - The status of CustomerAccounts.

page_size String

The page_size of CustomerAccounts.

query_id String

The query_id of CustomerAccounts.

from_index String

The from_index of CustomerAccounts.

to_index String

The to_index of CustomerAccounts.

Returns:
module:wrappers/CustomerAccounts -

The instance of CustomerAccounts.

forClient(client_key) → {module:wrappers/CustomerAccounts}

Parameters:
Name Type Description
client_key String

The client_key of CustomerAccounts.

Returns:
module:wrappers/CustomerAccounts -

The instance of CustomerAccounts.

forCustomer(ID_CUSTOMER) → {module:wrappers/CustomerAccounts}

Parameters:
Name Type Description
ID_CUSTOMER String

The ID_CUSTOMER of CustomerAccounts.

Returns:
module:wrappers/CustomerAccounts -

The instance of CustomerAccounts.

setList(CustomerAccountopt) → {module:wrappers/CustomerAccounts}

Parameters:
Name Type Attributes Description
CustomerAccount <optional>

list - The list of CustomerAccounts.

Returns:
module:wrappers/CustomerAccounts -

The instance of CustomerAccounts.

videChannel(channel) → {module:wrappers/CustomerAccounts}

Parameters:
Name Type Description
channel String

The channel of CustomerAccounts.

Returns:
module:wrappers/CustomerAccounts -

The instance of CustomerAccounts.