Class ViewsApi

Hierarchy

BaseResourceAPI<View>
- ViewsApi

Index

Methods

create delete list resolve upsert

Methods

create

create(items): Promise<View[]>
Parameters
- items: ExternalView[]
Returns Promise<View[]>
- Defined in packages/stable/src/api/templates/viewsApi.ts:15

delete

delete(ids, options?): Promise<{}>
Parameters
- ids: ExternalId[]
- Optionaloptions: {
  ignoreUnknownIds: boolean;
  }
  - ignoreUnknownIds: boolean
Returns Promise<{}>
- Defined in packages/stable/src/api/templates/viewsApi.ts:46

list

list(query?): CursorAndAsyncIterator<View>
Parameters
- Optionalquery: FilterQuery
Returns CursorAndAsyncIterator<View>
- Defined in packages/stable/src/api/templates/viewsApi.ts:23

resolve

resolve<T>(resolveRequest): CursorAndAsyncIterator<T>
Type Parameters
- T
Parameters
- resolveRequest: ViewResolveRequest
Returns CursorAndAsyncIterator<T>
- Defined in packages/stable/src/api/templates/viewsApi.ts:27

upsert

upsert(items): Promise<View[]>
Parameters
- items: ExternalView[]
Returns Promise<View[]>
- Defined in packages/stable/src/api/templates/viewsApi.ts:19