Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

client env host token

Methods

create createVersion delete deploy execute get list logs permissions rollback setClient versions

Constructors

constructor

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

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

create

create(payload: SatelliteCreatePayload): Promise<SatelliteTemplate>
Parameters
- payload: SatelliteCreatePayload
Returns Promise<SatelliteTemplate>
- Defined in v0.10/api/satellites.ts:20

createVersion

createVersion(
id: string,
payload: SatelliteSchemaPayload,
): Promise<SatelliteSchemaVersion>
Parameters
- id: string
- payload: SatelliteSchemaPayload
Returns Promise<SatelliteSchemaVersion>
- Defined in v0.10/api/satellites.ts:38

delete

delete(id: string): Promise<{ deleted: boolean }>
Parameters
- id: string
Returns Promise<{ deleted: boolean }>
- Defined in v0.10/api/satellites.ts:33

deploy

deploy(id: string, payload: SatelliteDeployPayload): Promise<SatelliteTemplate>
Parameters
- id: string
- payload: SatelliteDeployPayload
Returns Promise<SatelliteTemplate>
- Defined in v0.10/api/satellites.ts:48

execute

execute<T = any>(
    id: string,
    command: string,
    payload?: SatelliteCommandExecutePayload,
): Promise<SatelliteCommandExecuteResponse<T>>
Type Parameters
- T = any
Parameters
- id: string
- command: string
- payload: SatelliteCommandExecutePayload = {}
Returns Promise<SatelliteCommandExecuteResponse<T>>
- Defined in v0.10/api/satellites.ts:71

get

get(id: string): Promise<SatelliteTemplate>
Parameters
- id: string
Returns Promise<SatelliteTemplate>
- Defined in v0.10/api/satellites.ts:28

list

list(): Promise<SatelliteTemplate[]>
Returns Promise<SatelliteTemplate[]>
- Defined in v0.10/api/satellites.ts:15

logs

logs(id: string, params?: SatelliteLogsParams): Promise<any>
Parameters
- id: string
- params: SatelliteLogsParams = {}
Returns Promise<any>
- Defined in v0.10/api/satellites.ts:63

permissions

permissions(id: string): Promise<SatellitePermissionExport[]>
Parameters
- id: string
Returns Promise<SatellitePermissionExport[]>
- Defined in v0.10/api/satellites.ts:58

rollback

rollback(
id: string,
payload: SatelliteDeployPayload,
): Promise<SatelliteTemplate>
Parameters
- id: string
- payload: SatelliteDeployPayload
Returns Promise<SatelliteTemplate>
- Defined in v0.10/api/satellites.ts:53

setClient

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

versions

versions(id: string): Promise<SatelliteSchemaVersion[]>
Parameters
- id: string
Returns Promise<SatelliteSchemaVersion[]>
- Defined in v0.10/api/satellites.ts:43