Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentsApi

Hierarchy

  • DocumentsApi

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

systemDocumentsCountGet

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

  • Get Documents Info Count

    Parameters

    • params: object
      • Optional recordId?: number
      • Optional recordType?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Count>

systemDocumentsGet

  • systemDocumentsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<DocumentInfo>>

  • Get Documents Info

    Parameters

    • params: object
      • Optional page?: number
      • Optional pageSize?: number
      • Optional recordId?: number
      • Optional recordType?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Array<DocumentInfo>>

systemDocumentsIdDelete

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

  • Delete Document Info By Id

    Parameters

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

    Returns Promise<__type>

systemDocumentsIdDownloadGet

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

  • Download Document

    Parameters

    • params: object
      • id: number
      • Optional lastModified?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

systemDocumentsIdGet

  • systemDocumentsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<DocumentInfo>

  • Get Document Info By Id

    Parameters

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

    Returns Promise<DocumentInfo>

systemDocumentsIdPost

  • systemDocumentsIdPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<DocumentInfo>

  • Update Document By Id

    Parameters

    • params: object
      • Optional file?: any
      • id: number
      • Optional isAvatar?: boolean
      • Optional privateFlag?: boolean
      • Optional readOnlyFlag?: boolean
      • recordId: number
      • recordType: string
      • title: string
      • Optional url?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<DocumentInfo>

systemDocumentsPost

  • systemDocumentsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<DocumentInfo>

  • Insert Document

    Parameters

    • params: object
      • Optional file?: any
      • Optional isAvatar?: boolean
      • Optional privateFlag?: boolean
      • Optional readOnlyFlag?: boolean
      • Optional recordId?: number
      • recordType: string
      • title: string
      • Optional url?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<DocumentInfo>

systemDocumentsUploadsampleGet

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

  • Get Upload Sample Page

    Parameters

    • params: __type
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

Generated using TypeDoc