Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BoardsApi

Hierarchy

  • BoardsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BoardsApi(basePath?: string): BoardsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceBoardsCopyPost

  • serviceBoardsCopyPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Board>

  • Copy Board

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Board>

serviceBoardsCountGet

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

  • Get Boards Count

    Parameters

    • params: object
      • Optional conditions?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Count>

serviceBoardsGet

  • serviceBoardsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Board>>

  • Get Boards

    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<Board>>

serviceBoardsIdDelete

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

  • Delete Board By Id

    Parameters

    • params: object
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

serviceBoardsIdGet

  • serviceBoardsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Board>

  • Get Board By Id

    Parameters

    • params: object
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Board>

serviceBoardsIdPatch

  • serviceBoardsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Board>

  • Update Board

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Board>

serviceBoardsIdPut

  • serviceBoardsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Board>

  • Replace Board

    Parameters

    • params: object
      • board: Board
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Board>

serviceBoardsPost

  • serviceBoardsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Board>

  • Create Board

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Board>

Generated using TypeDoc