Class AlertsAPI

Hierarchy

BaseResourceAPI<Alert>
- AlertsAPI

Index

Constructors

constructor

Methods

Constructors

constructor

new AlertsAPI(...args: [string, CDFHttpClient, MetadataMap]): AlertsAPI

Overrides BaseResourceAPI.__constructor
- Defined in packages/beta/src/api/alerts/alertsApi.ts:30
Parameters
- Rest ...args: [string, CDFHttpClient, MetadataMap]
Returns AlertsAPI

Methods

close

close(items: IdEither[]): Promise<object>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:62
Parameters
- items: IdEither[]
Returns Promise<object>

create

create(items: AlertCreate[]): Promise<Alert[]>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:54
Parameters
- items: AlertCreate[]
Returns Promise<Alert[]>

createChannels

createChannels(items: ChannelCreate[]): Promise<Channel[]>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:75
Parameters
- items: ChannelCreate[]
Returns Promise<Channel[]>

createSubscribers

createSubscribers(items: SubscriberCreate[]): Promise<Subscriber[]>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:87
Parameters
- items: SubscriberCreate[]
Returns Promise<Subscriber[]>

createSubscriptions

createSubscriptions(items: SubscriptionCreate[]): Promise<Subscription[]>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:99
Parameters
- items: SubscriptionCreate[]
Returns Promise<Subscription[]>

deleteChannels

deleteChannels(items: IdEither[]): Promise<{}>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:79
Parameters
- items: IdEither[]
Returns Promise<{}>

deleteSubscribers

deleteSubscribers(items: IdEither[]): Promise<{}>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:95
Parameters
- items: IdEither[]
Returns Promise<{}>

deleteSubscription

deleteSubscription(items: SubscriptionDelete[]): Promise<{}>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:107
Parameters
- items: SubscriptionDelete[]
Returns Promise<{}>

list

list(query?: AlertFilterQuery): CursorAndAsyncIterator<Alert>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:58
Parameters
- Optional query: AlertFilterQuery
Returns CursorAndAsyncIterator<Alert>

listChannels

listChannels(filter?: ChannelFilterQuery): Promise<ListResponse<Channel[]>>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:71
Parameters
- Optional filter: ChannelFilterQuery
Returns Promise<ListResponse<Channel[]>>

listSubscribers

listSubscribers(filter?: SubscriberFilterQuery): Promise<ListResponse<Subscriber[]>>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:91
Parameters
- Optional filter: SubscriberFilterQuery
Returns Promise<ListResponse<Subscriber[]>>

listSubscriptions

listSubscriptions(filter?: SubscriptionFilterQuery): Promise<ListResponse<Subscription[]>>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:103
Parameters
- Optional filter: SubscriptionFilterQuery
Returns Promise<ListResponse<Subscription[]>>

updateChannels

updateChannels(items: ChannelChange[]): Promise<Channel[]>

- Defined in packages/beta/src/api/alerts/alertsApi.ts:83
Parameters
- items: ChannelChange[]
Returns Promise<Channel[]>