Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupsApi

Hierarchy

  • GroupsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GroupsApi(basePath?: string): GroupsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

marketingGroupsCountGet

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

  • Get Groups Count

    Parameters

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

    Returns Promise<Count>

marketingGroupsGet

  • marketingGroupsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Group>>

  • Get Groups

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

marketingGroupsIdDelete

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

  • Delete Group By Id

    Parameters

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

    Returns Promise<__type>

marketingGroupsIdGet

  • marketingGroupsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Group>

  • Get Group By Id

    Parameters

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

    Returns Promise<Group>

marketingGroupsIdPatch

  • marketingGroupsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Group>

  • Update Group

    Parameters

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

    Returns Promise<Group>

marketingGroupsIdPut

  • marketingGroupsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Group>

  • Replace Group

    Parameters

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

    Returns Promise<Group>

marketingGroupsPost

  • marketingGroupsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Group>

  • Create Group

    Parameters

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

    Returns Promise<Group>

Generated using TypeDoc