Class ConnectedSystems

Class providing methods for Make on-prem connected systems.

Index

Constructors

Methods

create delete get list update

Constructors

constructor

new ConnectedSystems(fetch: FetchFunction): ConnectedSystems
Parameters
- fetch: FetchFunction
Returns ConnectedSystems
- Defined in src/endpoints/connected-systems.ts:86

Methods

create

create(
organizationId: number,
body: CreateConnectedSystemBody,
): Promise<ConnectedSystem>
Create a connected system on an on-prem agent.
Parameters
- organizationId: number
  The organization ID
- body: CreateConnectedSystemBody
  Creation parameters including app-specific inputs
Returns Promise<ConnectedSystem>
- Defined in src/endpoints/connected-systems.ts:121

delete

delete(organizationId: number, connectedSystemId: string): Promise<string>
Delete a connected system.
Parameters
- organizationId: number
  The organization ID
- connectedSystemId: string
  The connected system UUID
Returns Promise<string>
The deleted connected system ID
- Defined in src/endpoints/connected-systems.ts:157

get

get(organizationId: number, connectedSystemId: string): Promise<ConnectedSystem>
Get details of a connected system.
Parameters
- organizationId: number
  The organization ID
- connectedSystemId: string
  The connected system UUID
Returns Promise<ConnectedSystem>
- Defined in src/endpoints/connected-systems.ts:108

list

list(organizationId: number, agentId: string): Promise<ConnectedSystem[]>
List connected systems for an on-prem agent.
Parameters
- organizationId: number
  The organization ID
- agentId: string
  The on-prem agent UUID
Returns Promise<ConnectedSystem[]>
- Defined in src/endpoints/connected-systems.ts:95

update

update(
    organizationId: number,
    connectedSystemId: string,
    body: UpdateConnectedSystemBody,
): Promise<ConnectedSystem>
Update a connected system.
Parameters
- organizationId: number
  The organization ID
- connectedSystemId: string
  The connected system UUID
- body: UpdateConnectedSystemBody
  Fields to update
Returns Promise<ConnectedSystem>
- Defined in src/endpoints/connected-systems.ts:137