DomainsApi | byu-event-hub-sdk

DomainsApi - object-oriented interface

Hierarchy

BaseAPI
- DomainsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

createDomain

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

- Defined in api.ts:835
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

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

- Defined in api.ts:843
Delete a Domain

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

domainOptions

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

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

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

domainsOptions

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

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

Parameters
- Optional options: any
Returns Promise<any>

getDomains

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

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

Parameters
- Optional options: any
Returns Promise<any>