EntitiesApi | byu-event-hub-sdk

EntitiesApi - object-oriented interface

Hierarchy

BaseAPI
- EntitiesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EntitiesApi(fetch?: FetchAPI, basePath?: string): EntitiesApi

Inherited from BaseAPI.constructor
- Defined in api.ts:31
Parameters
- Default value fetch: FetchAPI = isomorphicFetch
- Default value basePath: string = BASE_PATH
Returns EntitiesApi

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

createEntity

createEntity(params: object, options?: any): Promise<InlineResponse2012>

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

Parameters
- params: object
  - body: Body4
- Optional options: any
Returns Promise<InlineResponse2012>

deleteEntity

deleteEntity(params: object, options?: any): Promise<any>

- Defined in api.ts:1160
Delete a entity

Parameters
- params: object
  - domain: string
  - entity: string
- Optional options: any
Returns Promise<any>

entitiesOptions

entitiesOptions(options?: any): Promise<any>

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

Parameters
- Optional options: any
Returns Promise<any>

entityOptions

entityOptions(params: object, options?: any): Promise<string[]>

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

Parameters
- params: object
  - domain: string
  - entity: string
- Optional options: any
Returns Promise<string[]>

getEntities

getEntities(params: object, options?: any): Promise<any>

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

Parameters
- params: object
  - Optional entity?: string
- Optional options: any
Returns Promise<any>