Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccountApi

AccountApi - object-oriented interface

export
class

AccountApi

extends

{BaseAPI}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new AccountApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): AccountApi

Methods

deleteAccount

  • deleteAccount(accessId: string, accountId: string, options?: any): Promise<Response>

  • Delete the account identified by accountId

    summary

    Delete account

    throws

    {RequiredError}

    memberof

    AccountApi

    Parameters

    • accessId: string

      The accessId for the account to delete

    • accountId: string

      The id for the account to delete

    • Optional options: any

    Returns Promise<Response>

getAccount

  • getAccount(accessId: string, accountId: string, options?: any): Promise<Account>

  • Returns the account identified by accountId

    summary

    Get account

    throws

    {RequiredError}

    memberof

    AccountApi

    Parameters

    • accessId: string

      The accessId for the account to retrieve

    • accountId: string

      The id for the account to retrieve

    • Optional options: any

    Returns Promise<Account>

getAccounts

  • getAccounts(accessId: string, options?: any): Promise<Account[]>

  • Retrieve all accounts for the current user under the accessId

    summary

    List accounts

    throws

    {RequiredError}

    memberof

    AccountApi

    Parameters

    • accessId: string

      The id for the access for which to retrieve all accounts

    • Optional options: any

    Returns Promise<Account[]>

updateAccount

  • updateAccount(accessId: string, accountId: string, name: string, options?: any): Promise<Account>

  • Update the account name used in AHOI. Name must be URL encoded.

    summary

    Update account name

    throws

    {RequiredError}

    memberof

    AccountApi

    Parameters

    • accessId: string

      The accessId for which the user-defined account name should be altered

    • accountId: string

      The id for which the user-defined account name should be altered

    • name: string

      The new URL-encoded name

    • Optional options: any

    Returns Promise<Account>