Class MenuEntriesApi

Hierarchy

MenuEntriesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MenuEntriesApi(basePath?: string): MenuEntriesApi

- Defined in api/api.ts:58780
Parameters
- Optional basePath: string
Returns MenuEntriesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemMenuentriesCountGet

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

- Defined in api/api.ts:58793
Get Menu Entries Count

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

systemMenuentriesGet

systemMenuentriesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<MenuEntry>>

- Defined in api/api.ts:58834
Get Menu Entries

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

systemMenuentriesIdDelete

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

- Defined in api/api.ts:58890
Delete Menu Entry By Id

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

systemMenuentriesIdGet

systemMenuentriesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MenuEntry>

- Defined in api/api.ts:58927
Get Menu Entry By Id

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

systemMenuentriesIdImageGet

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

- Defined in api/api.ts:58966
Get Menu Entry Image

Parameters
- params: object
  - id: number
  - Optional largeFlag?: boolean
  - Optional lastmodified?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

systemMenuentriesIdImagePost

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

- Defined in api/api.ts:59012
Upload Menu Entry Image

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

systemMenuentriesIdPatch

systemMenuentriesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MenuEntry>

- Defined in api/api.ts:59056
Update Menu Entry

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

systemMenuentriesIdPut

systemMenuentriesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MenuEntry>

- Defined in api/api.ts:59101
Replace Menu Entry

Parameters
- params: object
  - id: number
  - menuEntry: MenuEntry
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MenuEntry>

systemMenuentriesPost

systemMenuentriesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MenuEntry>

- Defined in api/api.ts:59145
Create Menu Entry

Parameters
- params: object
  - menuEntry: MenuEntry
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MenuEntry>

Generated using TypeDoc