@reactor/connect — connectclient
@reactor/connect / ConnectClient
Class: ConnectClient
Section titled “Class: ConnectClient”Defined in: index.ts:226
Connect client for managing connectors and integrations.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ConnectClient(
ctx):ConnectClient
Defined in: index.ts:227
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”ConnectClient
Accessors
Section titled “Accessors”catalog
Section titled “catalog”Get Signature
Section titled “Get Signature”get catalog():
object
Defined in: index.ts:234
Access the connector catalog.
Returns
Section titled “Returns”get: (
connectorType) =>Promise<Result<ConnectorDescriptor>>
Get connector details.
Parameters
Section titled “Parameters”connectorType
Section titled “connectorType”string
Returns
Section titled “Returns”Promise<Result<ConnectorDescriptor>>
list: () =>
Promise<Result<ConnectorDescriptor[]>>
List available connectors.
Returns
Section titled “Returns”Promise<Result<ConnectorDescriptor[]>>
instances
Section titled “instances”Get Signature
Section titled “Get Signature”get instances():
object
Defined in: index.ts:251
Manage connector instances.
Returns
Section titled “Returns”check: (
instanceId) =>Promise<Result<ConnectionStatus>>
Test instance credentials.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
Returns
Section titled “Returns”Promise<Result<ConnectionStatus>>
create
Section titled “create”create: (
connectorType,options) =>Promise<Result<Instance>>
Create a new instance.
Parameters
Section titled “Parameters”connectorType
Section titled “connectorType”string
options
Section titled “options”Returns
Section titled “Returns”Promise<Result<Instance>>
delete
Section titled “delete”delete: (
instanceId) =>Promise<Result<void>>
Delete an instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
Returns
Section titled “Returns”Promise<Result<void>>
get: (
instanceId) =>Promise<Result<Instance>>
Get instance details.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
Returns
Section titled “Returns”Promise<Result<Instance>>
list: (
options?) =>Promise<Result<Instance[]>>
List instances.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Result<Instance[]>>
setCredentials
Section titled “setCredentials”setCredentials: (
instanceId,credentials) =>Promise<Result<void>>
Set credentials for an instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
credentials
Section titled “credentials”Record<string, unknown>
Returns
Section titled “Returns”Promise<Result<void>>
update
Section titled “update”update: (
instanceId,options) =>Promise<Result<Instance>>
Update an instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
options
Section titled “options”Returns
Section titled “Returns”Promise<Result<Instance>>
receivers
Section titled “receivers”Get Signature
Section titled “Get Signature”get receivers():
object
Defined in: index.ts:348
Manage webhook receivers.
Returns
Section titled “Returns”create
Section titled “create”create: (
options) =>Promise<Result<ReceiverWithToken>>
Create a new receiver.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<ReceiverWithToken>>
delete
Section titled “delete”delete: (
receiverId) =>Promise<Result<void>>
Delete a receiver.
Parameters
Section titled “Parameters”receiverId
Section titled “receiverId”string
Returns
Section titled “Returns”Promise<Result<void>>
get: (
receiverId) =>Promise<Result<Receiver>>
Get receiver details.
Parameters
Section titled “Parameters”receiverId
Section titled “receiverId”string
Returns
Section titled “Returns”Promise<Result<Receiver>>
list: () =>
Promise<Result<Receiver[]>>
List receivers.
Returns
Section titled “Returns”Promise<Result<Receiver[]>>
rotate
Section titled “rotate”rotate: (
receiverId,graceSeconds?) =>Promise<Result<RotateTokenResponse>>
Rotate receiver token.
Parameters
Section titled “Parameters”receiverId
Section titled “receiverId”string
graceSeconds?
Section titled “graceSeconds?”number
Returns
Section titled “Returns”Promise<Result<RotateTokenResponse>>
Methods
Section titled “Methods”invoke()
Section titled “invoke()”invoke(
instanceId,action,options?):Promise<Result<ActionResult>>
Defined in: index.ts:322
Invoke an action on a connector instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
action
Section titled “action”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Result<ActionResult>>
Example
Section titled “Example”const result = await connect.invoke('stripe-prod', 'createCustomer', { input: { email: 'user@example.com', name: 'Test User' }, dryRun: true,});