Class BoardNotificationsApi

Hierarchy

BoardNotificationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BoardNotificationsApi(basePath?: string): BoardNotificationsApi

- Defined in api/api.ts:22184
Parameters
- Optional basePath: string
Returns BoardNotificationsApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

serviceBoardsIdNotificationsCountGet

serviceBoardsIdNotificationsCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:22198
Get Board Notifications Count

Parameters
- params: object
  - Optional conditions?: string
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

serviceBoardsIdNotificationsGet

serviceBoardsIdNotificationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<BoardNotification>>

- Defined in api/api.ts:22245
Get Board Notifications

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - id: number
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<BoardNotification>>

serviceBoardsIdNotificationsNotificationIdDelete

serviceBoardsIdNotificationsNotificationIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:22307
Delete Board Notification By Id

Parameters
- params: object
  - id: number
  - notificationId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

serviceBoardsIdNotificationsNotificationIdGet

serviceBoardsIdNotificationsNotificationIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardNotification>

- Defined in api/api.ts:22350
Get Board Notification By Id

Parameters
- params: object
  - id: number
  - notificationId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BoardNotification>

serviceBoardsIdNotificationsNotificationIdPatch

serviceBoardsIdNotificationsNotificationIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardNotification>

- Defined in api/api.ts:22394
Update Board Notification

Parameters
- params: object
  - id: number
  - notificationId: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BoardNotification>

serviceBoardsIdNotificationsNotificationIdPut

serviceBoardsIdNotificationsNotificationIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardNotification>

- Defined in api/api.ts:22445
Replace Board Notification

Parameters
- params: object
  - boardNotification: BoardNotification
  - id: number
  - notificationId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BoardNotification>

serviceBoardsIdNotificationsPost

serviceBoardsIdNotificationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BoardNotification>

- Defined in api/api.ts:22495
Create Board Notification

Parameters
- params: object
  - boardNotification: BoardNotification
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BoardNotification>

Generated using TypeDoc