Class Api

A limited and simplified version of an Efficy SDK build around the public API version 1. Each method immediatly invokes a request to the server and returns the received data object.

Link

https://help.efficy.cloud/api/#description/introduction

Hierarchy

  • CrmFetch
    • Api

Constructors

constructor

Properties

apiVersion crmEnv fetchOptions name requestCounter sessionId?

Accessors

lastResponseObject lastResponseStatus

Methods

apiGet apiGetData crmfetch getDocumentFile getDocumentFiles getRequestUrl initJsonFetch setFetchOptions

Constructors

constructor

  • new Api(crmEnv?, apiVersion?): Api

  • Parameters

    • Optional crmEnv: CrmEnv
    • apiVersion: string = "v1"

    Returns Api

Properties

Private apiVersion

apiVersion: string = "v1"

crmEnv

crmEnv: CrmEnv = ...

fetchOptions

fetchOptions: RequestInit = ...

Protected name

name: string = "CrmFetch"

Protected requestCounter

requestCounter: number = 0

Protected Optional sessionId

sessionId?: string

Accessors

lastResponseObject

  • get lastResponseObject(): null | object

  • Returns null | object

lastResponseStatus

  • get lastResponseStatus(): number

  • Returns number

Methods

Private apiGet

  • apiGet<R>(apiPath, queryStringArgs?): Promise<null | R>

  • Type Parameters

    • R

    Parameters

    Returns Promise<null | R>

apiGetData

Protected crmfetch

  • crmfetch(requestUrl, requestPayload?, requestOptions?, isRetry?): Promise<null | object>

  • Parameters

    • requestUrl: string
    • Optional requestPayload: ModulePostPayload
    • Optional requestOptions: RequestInit
    • isRetry: boolean = false

    Returns Promise<null | object>

getDocumentFile

  • getDocumentFile<T>(docuKey, fileKey): Promise<null | T>

  • Retrieve file linked to a specific document

    Type Parameters

    Parameters

    • docuKey: string

      ID of the documents

    • fileKey: string

      ID of the file

    Returns Promise<null | T>

getDocumentFiles

  • getDocumentFiles<T>(docuKey, queryParams?): Promise<null | T>

  • Retrieve a list of files linked to a specific document

    Type Parameters

    Parameters

    • docuKey: string

      ID of the document

    • Optional queryParams: QueryParams

    Returns Promise<null | T>

Protected getRequestUrl

  • getRequestUrl(crmPath, queryArgs?): string

  • Parameters

    Returns string

Protected initJsonFetch

  • initJsonFetch(method): void

  • Parameters

    • method: "POST" | "GET"

    Returns void

Protected setFetchOptions

  • setFetchOptions(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructorapiVersioncrmEnvfetchOptionsnamerequestCountersessionIdlastResponseObjectlastResponseStatusapiGetapiGetDatacrmfetchgetDocumentFilegetDocumentFilesgetRequestUrlinitJsonFetchsetFetchOptions