Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StatesApi

Hierarchy

  • StatesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new StatesApi(basePath?: string): StatesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

systemStatesCountGet

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

  • Get States Count

    Parameters

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

    Returns Promise<Count>

systemStatesGet

  • systemStatesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<State>>

  • Get States

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

systemStatesIdGet

  • systemStatesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<State>

  • Get State By Id

    Parameters

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

    Returns Promise<State>

systemStatesPost

  • systemStatesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<State>

  • Create State

    Parameters

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

    Returns Promise<State>

Generated using TypeDoc