Class NotificationsApi

Hierarchy

NotificationsApi

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

authentications

Constructors

constructor

new NotificationsApi(basePath?: undefined | string): NotificationsApi

- Defined in lib/api/notificationsApi.ts:44
Parameters
- Optional basePath: undefined | string
Returns NotificationsApi

Properties

Protected _basePath

_basePath: string = defaultBasePath

Protected _defaultHeaders

_defaultHeaders: any

Protected _useQuerystring

_useQuerystring: boolean = false

Protected interceptors

interceptors: Interceptor[] = []

Accessors

basePath

get basePath(): string
set basePath(basePath: string): void

- Defined in lib/api/notificationsApi.ts:75
Returns string
- Defined in lib/api/notificationsApi.ts:63
Parameters
- basePath: string
Returns void

defaultHeaders

get defaultHeaders(): any
set defaultHeaders(defaultHeaders: any): void

- Defined in lib/api/notificationsApi.ts:71
Returns any
- Defined in lib/api/notificationsApi.ts:67
Parameters
- defaultHeaders: any
Returns void

useQuerystring

set useQuerystring(value: boolean): void

- Defined in lib/api/notificationsApi.ts:59
Parameters
- value: boolean
Returns void

Methods

addInterceptor

addInterceptor(interceptor: Interceptor): void

- Defined in lib/api/notificationsApi.ts:87
Parameters
- interceptor: Interceptor
Returns void

notificationsJsonGet

notificationsJsonGet(options?: { headers: {} }): Promise<{ body: InlineResponse20014; response: IncomingMessage }>

- Defined in lib/api/notificationsApi.ts:95
summary

Get the notifications that belong to the current user

Parameters
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20014; response: IncomingMessage }>

notificationsMarkReadJsonPut

notificationsMarkReadJsonPut(inlineObject8?: InlineObject8, options?: { headers: {} }): Promise<{ body: InlineResponse20015; response: IncomingMessage }>

- Defined in lib/api/notificationsApi.ts:158
summary

Mark notifications as read

Parameters
- Optional inlineObject8: InlineObject8
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20015; response: IncomingMessage }>

setApiKey

setApiKey(key: NotificationsApiApiKeys, value: string): void

- Defined in lib/api/notificationsApi.ts:83
Parameters
- key: NotificationsApiApiKeys
- value: string
Returns void

setDefaultAuthentication

setDefaultAuthentication(auth: Authentication): void

- Defined in lib/api/notificationsApi.ts:79
Parameters
- auth: Authentication
Returns void

Object literals

Protected authentications

authentications: object

default

default: Authentication = <Authentication>new VoidAuth()

Generated using TypeDoc