Class ModelsAPI

Hierarchy

BaseResourceAPI<SimulatorModel>
- ModelsAPI

Index

Methods

Methods

aggregate

aggregate(query: SimulatorModelAggregateQuery): Promise<SimulatorModelAggregate[]>

- Defined in packages/alpha/src/api/simulators/modelsApi.ts:30
Parameters
- query: SimulatorModelAggregateQuery
Returns Promise<SimulatorModelAggregate[]>

create

create(items: SimulatorModelCreate[]): Promise<SimulatorModel[]>

- Defined in packages/alpha/src/api/simulators/modelsApi.ts:26
Parameters
- items: SimulatorModelCreate[]
Returns Promise<SimulatorModel[]>

delete

delete(ids: IdEither[]): Promise<{}>

- Defined in packages/alpha/src/api/simulators/modelsApi.ts:51
Parameters
- ids: IdEither[]
Returns Promise<{}>

list

list(filter?: SimulatorModelFilterQuery): CursorAndAsyncIterator<SimulatorModel>

- Defined in packages/alpha/src/api/simulators/modelsApi.ts:36
Parameters
- Optional filter: SimulatorModelFilterQuery
Returns CursorAndAsyncIterator<SimulatorModel>

retrieve

retrieve(items: IdEither[]): Promise<SimulatorModel[]>

- Defined in packages/alpha/src/api/simulators/modelsApi.ts:43
Parameters
- items: IdEither[]
Returns Promise<SimulatorModel[]>

update

update(changes: SimulatorModelChange[]): Promise<SimulatorModel[]>

- Defined in packages/alpha/src/api/simulators/modelsApi.ts:47
Parameters
- changes: SimulatorModelChange[]
Returns Promise<SimulatorModel[]>