PersephonyAPI/javascript-sdk

View on GitHub
docs/source/api/accounts.rst

Summary

Maintainability
Test Coverage
Accounts
=========

get(accountId)
^^^^^^^^^^^^^^

    Retrieve a single account from Persephony

    :accountId: {string} The :code:`accountId` of the desired account.

    :returns: {Promise<object>} A promise that resolves to the account matching the :code:`accountId` provided.
    :throws: Will throw an error on a failed response.


update(accountId, options)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Update the existing account associated with :code:`accountId`.

    :accountId: {string} The :code:`accountId` of the desired account.
    :options: {object} The properties to change in the target account.

    :returns: {Promise<object>} A promise that resolves to the account matching the :code:`accountId` provided.
    :throws: Will throw an error on a failed response.