Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CodesApi

Hierarchy

  • CodesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new CodesApi(basePath?: string): CodesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

serviceCodesCountGet

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

  • Create Codes Count

    Parameters

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

    Returns Promise<Count>

serviceCodesGet

  • serviceCodesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Code>>

  • Get Codes

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

serviceCodesIdDelete

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

  • Delete Code By Id

    Parameters

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

    Returns Promise<__type>

serviceCodesIdGet

  • serviceCodesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

  • Get Code By Id

    Parameters

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

    Returns Promise<Code>

serviceCodesIdPatch

  • serviceCodesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

  • Update Code

    Parameters

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

    Returns Promise<Code>

serviceCodesIdPut

  • serviceCodesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

  • Replace Code

    Parameters

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

    Returns Promise<Code>

serviceCodesPost

  • serviceCodesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Code>

  • Create Codes

    Parameters

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

    Returns Promise<Code>

Generated using TypeDoc