Event Hub JavaScript SDK

TypeScript/JavaScript client that utilizes Fetch API. The Node module can be used as:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

Usage

npm i -S byu-event-hub-sdk

ES6 imports:

import * as eventHub from 'byu-event-hub-sdk';
import {operationId} from 'byu-event-hub-sdk';

The CommonJS syntax:

import eventHub = require('byu-event-hub-sdk');

Index

Classes

Interfaces

Variables

Functions

Object literals

Variables

BASE_PATH

BASE_PATH: string = "https://api.byu.edu/domains/eventhub".replace(/\/+$/, "")

expect

expect: ExpectStatic = chai.expect

Functions

ArchivesApiFactory

ArchivesApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:594
ArchivesApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- archivesOptions: function
  - archivesOptions(options?: any): Promise<any>
  - - Defined in api.ts:600
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>
- getArchives: function
  - getArchives(params: object, options?: any): Promise<any>
  - - Defined in api.ts:613
    Retrieve Events from the Event Archive. Most events are available for 45 days.
    
    Parameters
    - params: object
      - Optional domain?: string
      - Optional entity?: string
      - eventDt: string
      - Optional eventType?: string
      - Optional pageSize?: number
      - Optional pageStart?: number
    - Optional options: any
    Returns Promise<any>

DomainsApiFactory

DomainsApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:873
DomainsApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- createDomain: function
  - createDomain(params: object, options?: any): Promise<InlineResponse2011>
  - - Defined in api.ts:880
    Defines a new Domain. We are using Internet accepted domains. Event Types are grouped in Domains and then Entities. This makes the new Domain visible on the Administrative Portal. The Administrative Portal is used by developers to manage their subscriptions.
    
    Parameters
    - params: object
      - body: Body3
    - Optional options: any
    Returns Promise<InlineResponse2011>
- deleteDomain: function
  - deleteDomain(params: object, options?: any): Promise<any>
  - - Defined in api.ts:888
    Delete a Domain
    
    Parameters
    - params: object
      - domain: string
    - Optional options: any
    Returns Promise<any>
- domainOptions: function
  - domainOptions(params: object, options?: any): Promise<any>
  - - Defined in api.ts:896
    What can this endpoint do?
    
    Parameters
    - params: object
      - domain: string
    - Optional options: any
    Returns Promise<any>
- domainsOptions: function
  - domainsOptions(options?: any): Promise<any>
  - - Defined in api.ts:903
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>
- getDomains: function
  - getDomains(options?: any): Promise<any>
  - - Defined in api.ts:910
    Lists the set of Domains visible on the Administrative Portal.
    
    Parameters
    - Optional options: any
    Returns Promise<any>

EntitiesApiFactory

EntitiesApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:1192
EntitiesApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- createEntity: function
  - createEntity(params: object, options?: any): Promise<InlineResponse2012>
  - - Defined in api.ts:1199
    Defines a new Entity.
    
    Parameters
    - params: object
      - body: Body4
    - Optional options: any
    Returns Promise<InlineResponse2012>
- deleteEntity: function
  - deleteEntity(params: object, options?: any): Promise<any>
  - - Defined in api.ts:1208
    Delete a entity
    
    Parameters
    - params: object
      - domain: string
      - entity: string
    - Optional options: any
    Returns Promise<any>
- entitiesOptions: function
  - entitiesOptions(options?: any): Promise<any>
  - - Defined in api.ts:1215
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>
- entityOptions: function
  - entityOptions(params: object, options?: any): Promise<string[]>
  - - Defined in api.ts:1224
    What can this endpoint do?
    
    Parameters
    - params: object
      - domain: string
      - entity: string
    - Optional options: any
    Returns Promise<string[]>
- getEntities: function
  - getEntities(params: object, options?: any): Promise<any>
  - - Defined in api.ts:1232
    Lists the set of entities visible on the Administrative Portal.
    
    Parameters
    - params: object
      - Optional entity?: string
    - Optional options: any
    Returns Promise<any>

EventsApiFactory

EventsApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:1553
EventsApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- acknowledgeEvent: function
  - acknowledgeEvent(params: object, options?: any): Promise<any>
  - - Defined in api.ts:1561
    Acknowledge an event
    
    Parameters
    - params: object
      - eventID: string
      - Optional single?: boolean
    - Optional options: any
    Returns Promise<any>
- acknowledgeEventDelete: function
  - acknowledgeEventDelete(params: object, options?: any): Promise<any>
  - - Defined in api.ts:1569
    Acknowledge an event
    
    Parameters
    - params: object
      - eventID: string
    - Optional options: any
    Returns Promise<any>
- createEvent: function
  - createEvent(params: object, options?: any): Promise<any>
  - - Defined in api.ts:1577
    Create a new event
    
    Parameters
    - params: object
      - body: Body2
    - Optional options: any
    Returns Promise<any>
- eventOptions: function
  - eventOptions(params: object, options?: any): Promise<string[]>
  - - Defined in api.ts:1585
    What can this endpoint do?
    
    Parameters
    - params: object
      - eventID: string
    - Optional options: any
    Returns Promise<string[]>
- eventsOptions: function
  - eventsOptions(options?: any): Promise<any>
  - - Defined in api.ts:1592
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>
- getEvents: function
  - getEvents(params: object, options?: any): Promise<InlineResponse200>
  - - Defined in api.ts:1600
    Retrieve a collection of events
    
    Parameters
    - params: object
      - Optional count?: number
    - Optional options: any
    Returns Promise<InlineResponse200>

EventtypesApiFactory

EventtypesApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:1982
EventtypesApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- createEventType: function
  - createEventType(params: object, options?: any): Promise<InlineResponse201>
  - - Defined in api.ts:1989
    Defines a new event type.
    
    Parameters
    - params: object
      - body: Body
    - Optional options: any
    Returns Promise<InlineResponse201>
- deleteEventType: function
  - deleteEventType(params: object, options?: any): Promise<any>
  - - Defined in api.ts:1999
    Delete an event type
    
    Parameters
    - params: object
      - domain: string
      - entity: string
      - eventType: string
    - Optional options: any
    Returns Promise<any>
- eventTypeOptions: function
  - eventTypeOptions(params: object, options?: any): Promise<string[]>
  - - Defined in api.ts:2009
    What can this endpoint do?
    
    Parameters
    - params: object
      - domain: string
      - entity: string
      - eventType: string
    - Optional options: any
    Returns Promise<string[]>
- eventTypesOptions: function
  - eventTypesOptions(options?: any): Promise<any>
  - - Defined in api.ts:2016
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>
- getEventTypes: function
  - getEventTypes(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2026
    Lists the set of event-types visible on the Administrative Portal.
    
    Parameters
    - params: object
      - Optional domain?: string
      - Optional entity?: string
      - Optional eventType?: string
    - Optional options: any
    Returns Promise<any>
- modifyEventType: function
  - modifyEventType(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2037
    Modify an event type
    
    Parameters
    - params: object
      - body: Body1
      - domain: string
      - entity: string
      - eventType: string
    - Optional options: any
    Returns Promise<any>

SubscriptionsApiFactory

SubscriptionsApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:2351
SubscriptionsApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- createSubscription: function
  - createSubscription(params: object, options?: any): Promise<InlineResponse2013>
  - - Defined in api.ts:2358
    Defines a new subscription.
    
    Parameters
    - params: object
      - body: Body5
    - Optional options: any
    Returns Promise<InlineResponse2013>
- deleteSubscription: function
  - deleteSubscription(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2368
    Delete a subscription
    
    Parameters
    - params: object
      - domain: string
      - entity: string
      - eventType: string
    - Optional options: any
    Returns Promise<any>
- getSubscriptions: function
  - getSubscriptions(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2379
    Lists the set of subscriptions visible on the Administrative Portal.
    
    Parameters
    - params: object
      - Optional domain?: string
      - ecaIdentityId: string
      - Optional entity?: string
      - Optional eventType?: string
    - Optional options: any
    Returns Promise<any>
- subscriptionOptions: function
  - subscriptionOptions(params: object, options?: any): Promise<string[]>
  - - Defined in api.ts:2389
    What can this endpoint do?
    
    Parameters
    - params: object
      - domain: string
      - entity: string
      - eventType: string
    - Optional options: any
    Returns Promise<string[]>
- subscriptionsOptions: function
  - subscriptionsOptions(options?: any): Promise<any>
  - - Defined in api.ts:2396
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>

SummariesApiFactory

SummariesApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:2532
SummariesApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- getSummaries: function
  - getSummaries(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2544
    Lists the set of summaries visible on the Administrative Portal.
    
    Parameters
    - params: object
      - Optional domain?: string
      - Optional entity?: string
      - Optional eventDate?: string
      - Optional eventType?: string
      - Optional pageSize?: number
      - Optional pageStart?: number
    - Optional options: any
    Returns Promise<any>
- summariesOptions: function
  - summariesOptions(options?: any): Promise<any>
  - - Defined in api.ts:2551
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<any>

WebhooksApiFactory

WebhooksApiFactory(fetch?: FetchAPI, basePath?: string): object

- Defined in api.ts:2828
WebhooksApi - factory interface

Parameters
- Optional fetch: FetchAPI
- Optional basePath: string
Returns object
- deleteWebhook: function
  - deleteWebhook(options?: any): Promise<any>
  - - Defined in api.ts:2834
    Delete a webhook
    
    Parameters
    - Optional options: any
    Returns Promise<any>
- getWebhooks: function
  - getWebhooks(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2845
    Retrieve a collection of webhooks
    
    Parameters
    - params: object
      - Optional endpoint?: string
      - identityId: string
      - Optional identityName?: string
      - Optional pushOption?: string
    - Optional options: any
    Returns Promise<any>
- modifyWebhook: function
  - modifyWebhook(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2853
    Modify a webhook
    
    Parameters
    - params: object
      - body: Body6
    - Optional options: any
    Returns Promise<any>
- registerWebhook: function
  - registerWebhook(params: object, options?: any): Promise<any>
  - - Defined in api.ts:2861
    Register webhook Register webhook
    
    Parameters
    - params: object
      - body: Body7
    - Optional options: any
    Returns Promise<any>
- webhooksOptions: function
  - webhooksOptions(options?: any): Promise<string[]>
  - - Defined in api.ts:2868
    What can this endpoint do?
    
    Parameters
    - Optional options: any
    Returns Promise<string[]>

Object literals

ArchivesApiFetchParamCreator

ArchivesApiFetchParamCreator: object

ArchivesApi - fetch parameter creator

archivesOptions

archivesOptions(options?: any): FetchArgs

- Defined in api.ts:469
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

getArchives

getArchives(params: object, options?: any): FetchArgs

- Defined in api.ts:493
Retrieve Events from the Event Archive. Most events are available for 45 days.

Parameters
- params: object
  - Optional domain?: string
  - Optional entity?: string
  - eventDt: string
  - Optional eventType?: string
  - Optional pageSize?: number
  - Optional pageStart?: number
- Optional options: any
Returns FetchArgs

ArchivesApiFp

ArchivesApiFp: object

ArchivesApi - functional programming interface

archivesOptions

archivesOptions(options?: any): function

- Defined in api.ts:529
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

getArchives

getArchives(params: object, options?: any): function

- Defined in api.ts:551
Retrieve Events from the Event Archive. Most events are available for 45 days.

Parameters
- params: object
  - Optional domain?: string
  - Optional entity?: string
  - eventDt: string
  - Optional eventType?: string
  - Optional pageSize?: number
  - Optional pageStart?: number
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

DomainsApiFetchParamCreator

DomainsApiFetchParamCreator: object

DomainsApi - fetch parameter creator

createDomain

createDomain(params: object, options?: any): FetchArgs

- Defined in api.ts:629
Defines a new Domain. We are using Internet accepted domains. Event Types are grouped in Domains and then Entities. This makes the new Domain visible on the Administrative Portal. The Administrative Portal is used by developers to manage their subscriptions.

Parameters
- params: object
  - body: Body3
- Optional options: any
Returns FetchArgs

deleteDomain

deleteDomain(params: object, options?: any): FetchArgs

- Defined in api.ts:656
Delete a Domain

Parameters
- params: object
  - domain: string
- Optional options: any
Returns FetchArgs

domainOptions

domainOptions(params: object, options?: any): FetchArgs

- Defined in api.ts:680
What can this endpoint do?

Parameters
- params: object
  - domain: string
- Optional options: any
Returns FetchArgs

domainsOptions

domainsOptions(options?: any): FetchArgs

- Defined in api.ts:703
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

getDomains

getDomains(options?: any): FetchArgs

- Defined in api.ts:721
Lists the set of Domains visible on the Administrative Portal.

Parameters
- Optional options: any
Returns FetchArgs

DomainsApiFp

DomainsApiFp: object

DomainsApi - functional programming interface

createDomain

createDomain(params: object, options?: any): function

- Defined in api.ts:746
Defines a new Domain. We are using Internet accepted domains. Event Types are grouped in Domains and then Entities. This makes the new Domain visible on the Administrative Portal. The Administrative Portal is used by developers to manage their subscriptions.

Parameters
- params: object
  - body: Body3
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<InlineResponse2011>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<InlineResponse2011>

deleteDomain

deleteDomain(params: object, options?: any): function

- Defined in api.ts:763
Delete a Domain

Parameters
- params: object
  - domain: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

domainOptions

domainOptions(params: object, options?: any): function

- Defined in api.ts:780
What can this endpoint do?

Parameters
- params: object
  - domain: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

domainsOptions

domainsOptions(options?: any): function

- Defined in api.ts:796
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

getDomains

getDomains(options?: any): function

- Defined in api.ts:812
Lists the set of Domains visible on the Administrative Portal.

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

EntitiesApiFetchParamCreator

EntitiesApiFetchParamCreator: object

EntitiesApi - fetch parameter creator

createEntity

createEntity(params: object, options?: any): FetchArgs

- Defined in api.ts:926
Defines a new Entity.

Parameters
- params: object
  - body: Body4
- Optional options: any
Returns FetchArgs

deleteEntity

deleteEntity(params: object, options?: any): FetchArgs

- Defined in api.ts:954
Delete a entity

Parameters
- params: object
  - domain: string
  - entity: string
- Optional options: any
Returns FetchArgs

entitiesOptions

entitiesOptions(options?: any): FetchArgs

- Defined in api.ts:982
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

entityOptions

entityOptions(params: object, options?: any): FetchArgs

- Defined in api.ts:1002
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
- Optional options: any
Returns FetchArgs

getEntities

getEntities(params: object, options?: any): FetchArgs

- Defined in api.ts:1031
Lists the set of entities visible on the Administrative Portal.

Parameters
- params: object
  - Optional entity?: string
- Optional options: any
Returns FetchArgs

EntitiesApiFp

EntitiesApiFp: object

EntitiesApi - functional programming interface

createEntity

createEntity(params: object, options?: any): function

- Defined in api.ts:1059
Defines a new Entity.

Parameters
- params: object
  - body: Body4
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<InlineResponse2012>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<InlineResponse2012>

deleteEntity

deleteEntity(params: object, options?: any): function

- Defined in api.ts:1077
Delete a entity

Parameters
- params: object
  - domain: string
  - entity: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

entitiesOptions

entitiesOptions(options?: any): function

- Defined in api.ts:1093
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

entityOptions

entityOptions(params: object, options?: any): function

- Defined in api.ts:1111
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<Array<string>>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<Array<string>>

getEntities

getEntities(params: object, options?: any): function

- Defined in api.ts:1128
Lists the set of entities visible on the Administrative Portal.

Parameters
- params: object
  - Optional entity?: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

EventsApiFetchParamCreator

EventsApiFetchParamCreator: object

EventsApi - fetch parameter creator

acknowledgeEvent

acknowledgeEvent(params: object, options?: any): FetchArgs

- Defined in api.ts:1249
Acknowledge an event

Parameters
- params: object
  - eventID: string
  - Optional single?: boolean
- Optional options: any
Returns FetchArgs

acknowledgeEventDelete

acknowledgeEventDelete(params: object, options?: any): FetchArgs

- Defined in api.ts:1276
Acknowledge an event

Parameters
- params: object
  - eventID: string
- Optional options: any
Returns FetchArgs

createEvent

createEvent(params: object, options?: any): FetchArgs

- Defined in api.ts:1300
Create a new event

Parameters
- params: object
  - body: Body2
- Optional options: any
Returns FetchArgs

eventOptions

eventOptions(params: object, options?: any): FetchArgs

- Defined in api.ts:1327
What can this endpoint do?

Parameters
- params: object
  - eventID: string
- Optional options: any
Returns FetchArgs

eventsOptions

eventsOptions(options?: any): FetchArgs

- Defined in api.ts:1350
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

getEvents

getEvents(params: object, options?: any): FetchArgs

- Defined in api.ts:1369
Retrieve a collection of events

Parameters
- params: object
  - Optional count?: number
- Optional options: any
Returns FetchArgs

EventsApiFp

EventsApiFp: object

EventsApi - functional programming interface

acknowledgeEvent

acknowledgeEvent(params: object, options?: any): function

- Defined in api.ts:1398
Acknowledge an event

Parameters
- params: object
  - eventID: string
  - Optional single?: boolean
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

acknowledgeEventDelete

acknowledgeEventDelete(params: object, options?: any): function

- Defined in api.ts:1415
Acknowledge an event

Parameters
- params: object
  - eventID: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

createEvent

createEvent(params: object, options?: any): function

- Defined in api.ts:1432
Create a new event

Parameters
- params: object
  - body: Body2
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

eventOptions

eventOptions(params: object, options?: any): function

- Defined in api.ts:1449
What can this endpoint do?

Parameters
- params: object
  - eventID: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<Array<string>>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<Array<string>>

eventsOptions

eventsOptions(options?: any): function

- Defined in api.ts:1465
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

getEvents

getEvents(params: object, options?: any): function

- Defined in api.ts:1482
Retrieve a collection of events

Parameters
- params: object
  - Optional count?: number
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<InlineResponse200>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<InlineResponse200>

EventtypesApiFetchParamCreator

EventtypesApiFetchParamCreator: object

EventtypesApi - fetch parameter creator

createEventType

createEventType(params: object, options?: any): FetchArgs

- Defined in api.ts:1616
Defines a new event type.

Parameters
- params: object
  - body: Body
- Optional options: any
Returns FetchArgs

deleteEventType

deleteEventType(params: object, options?: any): FetchArgs

- Defined in api.ts:1645
Delete an event type

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns FetchArgs

eventTypeOptions

eventTypeOptions(params: object, options?: any): FetchArgs

- Defined in api.ts:1681
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns FetchArgs

eventTypesOptions

eventTypesOptions(options?: any): FetchArgs

- Defined in api.ts:1714
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

getEventTypes

getEventTypes(params: object, options?: any): FetchArgs

- Defined in api.ts:1735
Lists the set of event-types visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - Optional entity?: string
  - Optional eventType?: string
- Optional options: any
Returns FetchArgs

modifyEventType

modifyEventType(params: object, options?: any): FetchArgs

- Defined in api.ts:1762
Modify an event type

Parameters
- params: object
  - body: Body1
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns FetchArgs

EventtypesApiFp

EventtypesApiFp: object

EventtypesApi - functional programming interface

createEventType

createEventType(params: object, options?: any): function

- Defined in api.ts:1810
Defines a new event type.

Parameters
- params: object
  - body: Body
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<InlineResponse201>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<InlineResponse201>

deleteEventType

deleteEventType(params: object, options?: any): function

- Defined in api.ts:1829
Delete an event type

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

eventTypeOptions

eventTypeOptions(params: object, options?: any): function

- Defined in api.ts:1848
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<Array<string>>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<Array<string>>

eventTypesOptions

eventTypesOptions(options?: any): function

- Defined in api.ts:1864
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

getEventTypes

getEventTypes(params: object, options?: any): function

- Defined in api.ts:1883
Lists the set of event-types visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - Optional entity?: string
  - Optional eventType?: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

modifyEventType

modifyEventType(params: object, options?: any): function

- Defined in api.ts:1903
Modify an event type

Parameters
- params: object
  - body: Body1
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

SubscriptionsApiFetchParamCreator

SubscriptionsApiFetchParamCreator: object

SubscriptionsApi - fetch parameter creator

createSubscription

createSubscription(params: object, options?: any): FetchArgs

- Defined in api.ts:2053
Defines a new subscription.

Parameters
- params: object
  - body: Body5
- Optional options: any
Returns FetchArgs

deleteSubscription

deleteSubscription(params: object, options?: any): FetchArgs

- Defined in api.ts:2082
Delete a subscription

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns FetchArgs

getSubscriptions

getSubscriptions(params: object, options?: any): FetchArgs

- Defined in api.ts:2119
Lists the set of subscriptions visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - ecaIdentityId: string
  - Optional entity?: string
  - Optional eventType?: string
- Optional options: any
Returns FetchArgs

subscriptionOptions

subscriptionOptions(params: object, options?: any): FetchArgs

- Defined in api.ts:2150
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns FetchArgs

subscriptionsOptions

subscriptionsOptions(options?: any): FetchArgs

- Defined in api.ts:2183
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

SubscriptionsApiFp

SubscriptionsApiFp: object

SubscriptionsApi - functional programming interface

createSubscription

createSubscription(params: object, options?: any): function

- Defined in api.ts:2208
Defines a new subscription.

Parameters
- params: object
  - body: Body5
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<InlineResponse2013>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<InlineResponse2013>

deleteSubscription

deleteSubscription(params: object, options?: any): function

- Defined in api.ts:2227
Delete a subscription

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

getSubscriptions

getSubscriptions(params: object, options?: any): function

- Defined in api.ts:2247
Lists the set of subscriptions visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - ecaIdentityId: string
  - Optional entity?: string
  - Optional eventType?: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

subscriptionOptions

subscriptionOptions(params: object, options?: any): function

- Defined in api.ts:2266
What can this endpoint do?

Parameters
- params: object
  - domain: string
  - entity: string
  - eventType: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<Array<string>>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<Array<string>>

subscriptionsOptions

subscriptionsOptions(options?: any): function

- Defined in api.ts:2282
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

SummariesApiFetchParamCreator

SummariesApiFetchParamCreator: object

SummariesApi - fetch parameter creator

getSummaries

getSummaries(params: object, options?: any): FetchArgs

- Defined in api.ts:2417
Lists the set of summaries visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - Optional entity?: string
  - Optional eventDate?: string
  - Optional eventType?: string
  - Optional pageSize?: number
  - Optional pageStart?: number
- Optional options: any
Returns FetchArgs

summariesOptions

summariesOptions(options?: any): FetchArgs

- Defined in api.ts:2443
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

SummariesApiFp

SummariesApiFp: object

SummariesApi - functional programming interface

getSummaries

getSummaries(params: object, options?: any): function

- Defined in api.ts:2473
Lists the set of summaries visible on the Administrative Portal.

Parameters
- params: object
  - Optional domain?: string
  - Optional entity?: string
  - Optional eventDate?: string
  - Optional eventType?: string
  - Optional pageSize?: number
  - Optional pageStart?: number
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

summariesOptions

summariesOptions(options?: any): function

- Defined in api.ts:2489
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

WebhooksApiFetchParamCreator

WebhooksApiFetchParamCreator: object

WebhooksApi - fetch parameter creator

deleteWebhook

deleteWebhook(options?: any): FetchArgs

- Defined in api.ts:2566
Delete a webhook

Parameters
- Optional options: any
Returns FetchArgs

getWebhooks

getWebhooks(params: object, options?: any): FetchArgs

- Defined in api.ts:2588
Retrieve a collection of webhooks

Parameters
- params: object
  - Optional endpoint?: string
  - identityId: string
  - Optional identityName?: string
  - Optional pushOption?: string
- Optional options: any
Returns FetchArgs

modifyWebhook

modifyWebhook(params: object, options?: any): FetchArgs

- Defined in api.ts:2617
Modify a webhook

Parameters
- params: object
  - body: Body6
- Optional options: any
Returns FetchArgs

registerWebhook

registerWebhook(params: object, options?: any): FetchArgs

- Defined in api.ts:2644
Register webhook Register webhook

Parameters
- params: object
  - body: Body7
- Optional options: any
Returns FetchArgs

webhooksOptions

webhooksOptions(options?: any): FetchArgs

- Defined in api.ts:2670
What can this endpoint do?

Parameters
- Optional options: any
Returns FetchArgs

WebhooksApiFp

WebhooksApiFp: object

WebhooksApi - functional programming interface

deleteWebhook

deleteWebhook(options?: any): function

- Defined in api.ts:2694
Delete a webhook

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

getWebhooks

getWebhooks(params: object, options?: any): function

- Defined in api.ts:2714
Retrieve a collection of webhooks

Parameters
- params: object
  - Optional endpoint?: string
  - identityId: string
  - Optional identityName?: string
  - Optional pushOption?: string
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

modifyWebhook

modifyWebhook(params: object, options?: any): function

- Defined in api.ts:2731
Modify a webhook

Parameters
- params: object
  - body: Body6
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

registerWebhook

registerWebhook(params: object, options?: any): function

- Defined in api.ts:2748
Register webhook Register webhook

Parameters
- params: object
  - body: Body7
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<any>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<any>

webhooksOptions

webhooksOptions(options?: any): function

- Defined in api.ts:2764
What can this endpoint do?

Parameters
- Optional options: any
Returns function
- - (fetch?: FetchAPI, basePath?: string): Promise<Array<string>>
  - Parameters
    - Optional fetch: FetchAPI
    - Optional basePath: string
    Returns Promise<Array<string>>

Event Hub JavaScript SDK

Usage

Index

Classes

Interfaces

Variables

Functions

Object literals

Variables

BASE_PATH

expect

Functions

ArchivesApiFactory

Parameters

Optional fetch: FetchAPI

Optional basePath: string

Returns object

archivesOptions: function

Parameters

Optional options: any

Returns Promise<any>

getArchives: function

Parameters

params: object

Optional domain?: string

Optional entity?: string

eventDt: string

Optional eventType?: string

Optional pageSize?: number

Optional pageStart?: number

Optional options: any

Returns Promise<any>

DomainsApiFactory

Parameters

Optional fetch: FetchAPI

Optional basePath: string

Returns object

createDomain: function

Parameters

params: object

body: Body3

Optional options: any

Returns Promise<InlineResponse2011>

deleteDomain: function

Parameters

params: object

domain: string

Optional options: any

Returns Promise<any>

domainOptions: function

Parameters

params: object

domain: string

Optional options: any

Returns Promise<any>

domainsOptions: function

Parameters

Optional options: any

Returns Promise<any>

getDomains: function

Parameters

Optional options: any

Returns Promise<any>

EntitiesApiFactory

Parameters

Optional fetch: FetchAPI

Optional basePath: string

Returns object

createEntity: function

Parameters

params: object

body: Body4

Optional options: any

Returns Promise<InlineResponse2012>

deleteEntity: function

Parameters

params: object

domain: string

entity: string

Optional options: any