Class SecurityApi

SecurityApi - object-oriented interface

export
class: SecurityApi
extends: {BaseAPI}

Hierarchy

BaseAPI
- SecurityApi

Index

Constructors

constructor

Methods

Constructors

constructor

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

Inherited from BaseAPI.constructor
- Defined in api.ts:58
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value fetch: FetchAPI = portableFetch
Returns SecurityApi

Methods

getSecurity

getSecurity(accessId: string, accountId: string, securityId: string, options?: any): Promise<Security>

- Defined in api.ts:3877
api.resource.accesses.accessId.accounts.accountId.securities.securityId.getSecurity.description

summary

Get security

throws

{RequiredError}

memberof

SecurityApi

Parameters
- accessId: string
  
  api.resource.accesses.accessId.accounts.accountId.securities.securityId.getSecurity.parameter.accessId.description
- accountId: string
  
  The accountId for which to retrieve securities
- securityId: string
  
  The securityId for the security to retrieve
- Optional options: any
Returns Promise<Security>

listSecurities

listSecurities(accessId: string, accountId: string, maxAge?: number, options?: any): Promise<Security[]>

- Defined in api.ts:3891
api.resource.accesses.accessId.accounts.accountId.securities.listSecurities.description

summary

List securities for account

throws

{RequiredError}

memberof

SecurityApi

Parameters
- accessId: string
  
  api.resource.accesses.accessId.accounts.accountId.securities.listSecurities.parameter.accessId.description
- accountId: string
  
  The accountId for which to retrieve securities
- Optional maxAge: number
- Optional options: any
Returns Promise<Security[]>