Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

client env host token

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Overrides default.constructor
- Defined in v0.10/api/integrations.ts:16

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

activate

activate(id: string): Promise<any>
Activate an installed integration. POST /v1/integration/{id}/activate
Parameters
- id: string
Returns Promise<any>
- Defined in v0.10/api/integrations.ts:116

deactivate

deactivate(id: string): Promise<any>
Deactivate an installed integration. POST /v1/integration/{id}/deactivate
Parameters
- id: string
Returns Promise<any>
- Defined in v0.10/api/integrations.ts:126

explore

explore(): Promise<any>
List explorable integration templates (subscription/geo aware). GET /v1/integrations/explore

Returns Promise<any>
- Defined in v0.10/api/integrations.ts:156

getDMS

getDMS(): default
Returns default
- Defined in v0.10/api/integrations.ts:35

getEcommerce

getEcommerce(): default
Returns default
- Defined in v0.10/api/integrations.ts:63

getInterfaceOf

getInterfaceOf(id: string): any
Parameters
- id: string
Returns any
- Defined in v0.10/api/integrations.ts:162

getInvoicing

getInvoicing(): default
Returns default
- Defined in v0.10/api/integrations.ts:39

getMail

getMail(): default
Returns default
- Defined in v0.10/api/integrations.ts:51

getMinimax

getMinimax(): default
Returns default
- Defined in v0.10/api/integrations.ts:47

getNBS

getNBS(): default
Returns default
- Defined in v0.10/api/integrations.ts:55

getPayments

getPayments(): default
Returns default
- Defined in v0.10/api/integrations.ts:43

getSerbiaMinFin

getSerbiaMinFin(): default
Returns default
- Defined in v0.10/api/integrations.ts:59

getTimber

getTimber(): default
Returns default
- Defined in v0.10/api/integrations.ts:67

install

install(id: string, data?: Record<string, any>): Promise<any>
Install (integrate) an integration into the current project. POST /v1/integrate
Parameters
- id: string
- Optionaldata: Record<string, any>
Returns Promise<any>
- Defined in v0.10/api/integrations.ts:93

isActive

isActive(id: string): Promise<boolean>
Parameters
- id: string
Returns Promise<boolean>
- Defined in v0.10/api/integrations.ts:83

isInstalled

isInstalled(id: string): Promise<boolean>
Parameters
- id: string
Returns Promise<boolean>
- Defined in v0.10/api/integrations.ts:77

list

list(): Promise<any>
Returns Promise<any>
- Defined in v0.10/api/integrations.ts:71

marketplace

marketplace(): Promise<any>
List marketplace-available integrations (subscription/geo aware). GET /v1/marketplace/integrations

Returns Promise<any>
- Defined in v0.10/api/integrations.ts:146

onboarding

onboarding(
id: string,
data: { data?: Record<string, any>; step: string },
): Promise<any>
Advance/update the onboarding state of an installed integration. POST /v1/integration/{id}/onboarding
Parameters
- id: string
- data: { data?: Record<string, any>; step: string }
Returns Promise<any>
- Defined in v0.10/api/integrations.ts:136

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

uninstall

uninstall(id: string): Promise<any>
Uninstall (remove) an integration from the current project. PUT /v1/integrate
Parameters
- id: string
Returns Promise<any>
- Defined in v0.10/api/integrations.ts:106