Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigurationsApi

Hierarchy

  • ConfigurationsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyConfigurationsCountGet

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

  • Get Configurations Count

    Parameters

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

    Returns Promise<Count>

companyConfigurationsGet

  • companyConfigurationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Configuration>>

  • Get Configurations

    Parameters

    • params: object
      • Optional childconditions?: string
      • Optional conditions?: string
      • Optional customfieldconditions?: string
      • Optional managedIdentifier?: string
      • Optional orderBy?: string
      • Optional page?: number
      • Optional pageSize?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Array<Configuration>>

companyConfigurationsIdDelete

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

  • Delete Configuration By Id

    Parameters

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

    Returns Promise<__type>

companyConfigurationsIdGet

  • companyConfigurationsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Configuration>

  • Get Configuration By Id

    Parameters

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

    Returns Promise<Configuration>

companyConfigurationsIdPatch

  • companyConfigurationsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Configuration>

  • Update Configuration

    Parameters

    • params: object
      • Optional childConfigurationsMatchingOn?: string
      • id: number
      • Optional inactivateConfigurationsMatchingOn?: string
      • Optional inactiveConfigurationStatusId?: number
      • Optional level?: string
      • Optional managedIdentifier?: string
      • Optional managementSolutionName?: string
      • operations: Array<PatchOperation>
      • Optional type?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Configuration>

companyConfigurationsIdPut

  • companyConfigurationsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Configuration>

  • Replace Configuration

    Parameters

    • params: object
      • Optional childConfigurationsMatchingOn?: string
      • configuration: Configuration
      • id: number
      • Optional inactivateConfigurationsMatchingOn?: string
      • Optional inactiveConfigurationStatusId?: number
      • Optional level?: string
      • Optional managedIdentifier?: string
      • Optional managementSolutionName?: string
      • Optional type?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Configuration>

companyConfigurationsPost

  • companyConfigurationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Configuration>

  • Create Configuration

    Parameters

    • params: object
      • Optional childConfigurationsMatchingOn?: string
      • configuration: Configuration
      • Optional inactivateConfigurationsMatchingOn?: string
      • Optional inactiveConfigurationStatusId?: number
      • Optional level?: string
      • Optional managedIdentifier?: string
      • Optional managementSolutionName?: string
      • Optional type?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Configuration>

Generated using TypeDoc