PositionStatusApi | Interfolio API

Class representing Position Status calls

Hierarchy

PositionStatusApi

Index

Constructors

constructor

Properties

apiRequest

Methods

Constructors

constructor

new PositionStatusApi(config: ApiRequest | ApiConfig): PositionStatusApi

- Defined in search/position-status-api.ts:32
Constructor for the object

Parameters
- config: ApiRequest | ApiConfig
  
  Configuration for API calls - of type either ApiConfig or ApiRequest
  
  note pass in ApiRequest to keep all errors in one object instance
Returns PositionStatusApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

getPositionStatuses

getPositionStatuses(__namedParameters: { unitId: number }): Promise<PositionStatus[]>

- Defined in search/position-status-api.ts:57
Retrieve position statuses
example
```
let statuses = await api.Search.PositionStatus.getPositionStatuses({unitId: 9999});
```
Parameters
- __namedParameters: { unitId: number }
  - unitId: number
Returns Promise<PositionStatus[]>

Static removePositionStatusNesting

removePositionStatusNesting(apiResponse: ApiResponse): PositionStatus[]

- Defined in search/position-status-api.ts:74
remove the top level nesting of position_status which is returned from the api call

Parameters
- apiResponse: ApiResponse
Returns PositionStatus[]

Generated using TypeDoc