@archastro/sdk 0.5.2 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -0
- package/dist/auth.d.ts +143 -0
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +187 -1
- package/dist/auth.js.map +1 -1
- package/dist/client.d.ts +26 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +27 -1
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/types/ai.d.ts +150 -12
- package/dist/types/ai.d.ts.map +1 -1
- package/dist/types/ai.js +71 -41
- package/dist/types/ai.js.map +1 -1
- package/dist/types/artifacts.d.ts +81 -24
- package/dist/types/artifacts.d.ts.map +1 -1
- package/dist/types/artifacts.js +39 -21
- package/dist/types/artifacts.js.map +1 -1
- package/dist/types/automations.d.ts +41 -9
- package/dist/types/automations.d.ts.map +1 -1
- package/dist/types/automations.js +25 -17
- package/dist/types/automations.js.map +1 -1
- package/dist/types/chat.d.ts +21418 -0
- package/dist/types/chat.d.ts.map +1 -0
- package/dist/types/chat.js +70 -0
- package/dist/types/chat.js.map +1 -0
- package/dist/types/common.d.ts +16970 -2136
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/common.js +1695 -332
- package/dist/types/common.js.map +1 -1
- package/dist/types/config.d.ts +239 -31
- package/dist/types/config.d.ts.map +1 -1
- package/dist/types/config.js +86 -34
- package/dist/types/config.js.map +1 -1
- package/dist/types/image.d.ts +27 -4
- package/dist/types/image.d.ts.map +1 -1
- package/dist/types/image.js +17 -10
- package/dist/types/image.js.map +1 -1
- package/dist/types/index.d.ts +2 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +3 -2
- package/dist/types/index.js.map +1 -1
- package/dist/types/invites.d.ts +20 -11
- package/dist/types/invites.d.ts.map +1 -1
- package/dist/types/invites.js +9 -12
- package/dist/types/invites.js.map +1 -1
- package/dist/types/notifications.d.ts +163 -0
- package/dist/types/notifications.d.ts.map +1 -0
- package/dist/types/notifications.js +44 -0
- package/dist/types/notifications.js.map +1 -0
- package/dist/types/teams.d.ts +1628 -231
- package/dist/types/teams.d.ts.map +1 -1
- package/dist/types/teams.js +76 -45
- package/dist/types/teams.js.map +1 -1
- package/dist/types/threads.d.ts +997 -243
- package/dist/types/threads.d.ts.map +1 -1
- package/dist/types/threads.js +84 -51
- package/dist/types/threads.js.map +1 -1
- package/dist/types/users.d.ts +98 -18
- package/dist/types/users.d.ts.map +1 -1
- package/dist/types/users.js +43 -18
- package/dist/types/users.js.map +1 -1
- package/dist/v1/resources/activity_feed.d.ts +89 -0
- package/dist/v1/resources/activity_feed.d.ts.map +1 -1
- package/dist/v1/resources/activity_feed.js +56 -2
- package/dist/v1/resources/activity_feed.js.map +1 -1
- package/dist/v1/resources/agent_computers.d.ts +48 -2
- package/dist/v1/resources/agent_computers.d.ts.map +1 -1
- package/dist/v1/resources/agent_computers.js +48 -1
- package/dist/v1/resources/agent_computers.js.map +1 -1
- package/dist/v1/resources/agent_env_vars.d.ts +50 -0
- package/dist/v1/resources/agent_env_vars.d.ts.map +1 -0
- package/dist/v1/resources/agent_env_vars.js +56 -0
- package/dist/v1/resources/agent_env_vars.js.map +1 -0
- package/dist/v1/resources/agent_health_actions.d.ts +43 -0
- package/dist/v1/resources/agent_health_actions.d.ts.map +1 -0
- package/dist/v1/resources/agent_health_actions.js +50 -0
- package/dist/v1/resources/agent_health_actions.js.map +1 -0
- package/dist/v1/resources/agent_installations.d.ts +100 -0
- package/dist/v1/resources/agent_installations.d.ts.map +1 -1
- package/dist/v1/resources/agent_installations.js +106 -2
- package/dist/v1/resources/agent_installations.js.map +1 -1
- package/dist/v1/resources/agent_routine_runs.d.ts +33 -0
- package/dist/v1/resources/agent_routine_runs.d.ts.map +1 -0
- package/dist/v1/resources/agent_routine_runs.js +48 -0
- package/dist/v1/resources/agent_routine_runs.js.map +1 -0
- package/dist/v1/resources/agent_routines.d.ts +148 -2
- package/dist/v1/resources/agent_routines.d.ts.map +1 -1
- package/dist/v1/resources/agent_routines.js +168 -3
- package/dist/v1/resources/agent_routines.js.map +1 -1
- package/dist/v1/resources/agent_sessions.d.ts +118 -1
- package/dist/v1/resources/agent_sessions.d.ts.map +1 -1
- package/dist/v1/resources/agent_sessions.js +134 -2
- package/dist/v1/resources/agent_sessions.js.map +1 -1
- package/dist/v1/resources/agent_skills.d.ts +83 -1
- package/dist/v1/resources/agent_skills.d.ts.map +1 -1
- package/dist/v1/resources/agent_skills.js +87 -2
- package/dist/v1/resources/agent_skills.js.map +1 -1
- package/dist/v1/resources/agent_tools.d.ts +109 -2
- package/dist/v1/resources/agent_tools.d.ts.map +1 -1
- package/dist/v1/resources/agent_tools.js +114 -2
- package/dist/v1/resources/agent_tools.js.map +1 -1
- package/dist/v1/resources/agents.d.ts +517 -9
- package/dist/v1/resources/agents.d.ts.map +1 -1
- package/dist/v1/resources/agents.js +515 -12
- package/dist/v1/resources/agents.js.map +1 -1
- package/dist/v1/resources/ai.d.ts +93 -0
- package/dist/v1/resources/ai.d.ts.map +1 -1
- package/dist/v1/resources/ai.js +89 -1
- package/dist/v1/resources/ai.js.map +1 -1
- package/dist/v1/resources/artifacts.d.ts +73 -0
- package/dist/v1/resources/artifacts.d.ts.map +1 -1
- package/dist/v1/resources/artifacts.js +74 -2
- package/dist/v1/resources/artifacts.js.map +1 -1
- package/dist/v1/resources/automation_runs.d.ts +8 -4
- package/dist/v1/resources/automation_runs.d.ts.map +1 -1
- package/dist/v1/resources/automation_runs.js +9 -5
- package/dist/v1/resources/automation_runs.js.map +1 -1
- package/dist/v1/resources/automations.d.ts +20 -0
- package/dist/v1/resources/automations.d.ts.map +1 -1
- package/dist/v1/resources/automations.js +21 -1
- package/dist/v1/resources/automations.js.map +1 -1
- package/dist/v1/resources/bug_reports.d.ts +29 -0
- package/dist/v1/resources/bug_reports.d.ts.map +1 -0
- package/dist/v1/resources/bug_reports.js +29 -0
- package/dist/v1/resources/bug_reports.js.map +1 -0
- package/dist/v1/resources/config.d.ts +429 -4
- package/dist/v1/resources/config.d.ts.map +1 -1
- package/dist/v1/resources/config.js +493 -9
- package/dist/v1/resources/config.js.map +1 -1
- package/dist/v1/resources/custom_objects.d.ts +117 -2
- package/dist/v1/resources/custom_objects.d.ts.map +1 -1
- package/dist/v1/resources/custom_objects.js +132 -3
- package/dist/v1/resources/custom_objects.js.map +1 -1
- package/dist/v1/resources/files.d.ts +62 -0
- package/dist/v1/resources/files.d.ts.map +1 -0
- package/dist/v1/resources/files.js +58 -0
- package/dist/v1/resources/files.js.map +1 -0
- package/dist/v1/resources/index.d.ts +13 -0
- package/dist/v1/resources/index.d.ts.map +1 -1
- package/dist/v1/resources/index.js +14 -1
- package/dist/v1/resources/index.js.map +1 -1
- package/dist/v1/resources/installation_sources.d.ts +12 -0
- package/dist/v1/resources/installation_sources.d.ts.map +1 -1
- package/dist/v1/resources/installation_sources.js +13 -1
- package/dist/v1/resources/installation_sources.js.map +1 -1
- package/dist/v1/resources/invites.d.ts +15 -0
- package/dist/v1/resources/invites.d.ts.map +1 -1
- package/dist/v1/resources/invites.js +16 -1
- package/dist/v1/resources/invites.js.map +1 -1
- package/dist/v1/resources/knowledge_documents.d.ts +104 -0
- package/dist/v1/resources/knowledge_documents.d.ts.map +1 -0
- package/dist/v1/resources/knowledge_documents.js +112 -0
- package/dist/v1/resources/knowledge_documents.js.map +1 -0
- package/dist/v1/resources/knowledge_sources.d.ts +190 -0
- package/dist/v1/resources/knowledge_sources.d.ts.map +1 -0
- package/dist/v1/resources/knowledge_sources.js +176 -0
- package/dist/v1/resources/knowledge_sources.js.map +1 -0
- package/dist/v1/resources/kv.d.ts +73 -0
- package/dist/v1/resources/kv.d.ts.map +1 -1
- package/dist/v1/resources/kv.js +96 -3
- package/dist/v1/resources/kv.js.map +1 -1
- package/dist/v1/resources/notification_preferences.d.ts +61 -0
- package/dist/v1/resources/notification_preferences.d.ts.map +1 -0
- package/dist/v1/resources/notification_preferences.js +65 -0
- package/dist/v1/resources/notification_preferences.js.map +1 -0
- package/dist/v1/resources/notifications.d.ts +133 -0
- package/dist/v1/resources/notifications.d.ts.map +1 -0
- package/dist/v1/resources/notifications.js +136 -0
- package/dist/v1/resources/notifications.js.map +1 -0
- package/dist/v1/resources/orgs.d.ts +18 -0
- package/dist/v1/resources/orgs.d.ts.map +1 -1
- package/dist/v1/resources/orgs.js +30 -2
- package/dist/v1/resources/orgs.js.map +1 -1
- package/dist/v1/resources/slack_channel_bindings.d.ts +101 -0
- package/dist/v1/resources/slack_channel_bindings.d.ts.map +1 -0
- package/dist/v1/resources/slack_channel_bindings.js +114 -0
- package/dist/v1/resources/slack_channel_bindings.js.map +1 -0
- package/dist/v1/resources/solution_categories.d.ts +36 -0
- package/dist/v1/resources/solution_categories.d.ts.map +1 -0
- package/dist/v1/resources/solution_categories.js +55 -0
- package/dist/v1/resources/solution_categories.js.map +1 -0
- package/dist/v1/resources/solution_tags.d.ts +37 -0
- package/dist/v1/resources/solution_tags.d.ts.map +1 -0
- package/dist/v1/resources/solution_tags.js +54 -0
- package/dist/v1/resources/solution_tags.js.map +1 -0
- package/dist/v1/resources/solutions.d.ts +309 -0
- package/dist/v1/resources/solutions.d.ts.map +1 -0
- package/dist/v1/resources/solutions.js +214 -0
- package/dist/v1/resources/solutions.js.map +1 -0
- package/dist/v1/resources/team_memberships.d.ts +31 -0
- package/dist/v1/resources/team_memberships.d.ts.map +1 -1
- package/dist/v1/resources/team_memberships.js +49 -2
- package/dist/v1/resources/team_memberships.js.map +1 -1
- package/dist/v1/resources/teams.d.ts +458 -49
- package/dist/v1/resources/teams.d.ts.map +1 -1
- package/dist/v1/resources/teams.js +319 -27
- package/dist/v1/resources/teams.js.map +1 -1
- package/dist/v1/resources/thread_messages.d.ts +70 -0
- package/dist/v1/resources/thread_messages.d.ts.map +1 -1
- package/dist/v1/resources/thread_messages.js +85 -2
- package/dist/v1/resources/thread_messages.js.map +1 -1
- package/dist/v1/resources/threads.d.ts +201 -0
- package/dist/v1/resources/threads.d.ts.map +1 -1
- package/dist/v1/resources/threads.js +220 -4
- package/dist/v1/resources/threads.js.map +1 -1
- package/dist/v1/resources/users.d.ts +213 -39
- package/dist/v1/resources/users.d.ts.map +1 -1
- package/dist/v1/resources/users.js +121 -16
- package/dist/v1/resources/users.js.map +1 -1
- package/dist/v1.d.ts +26 -0
- package/dist/v1.d.ts.map +1 -1
- package/dist/v1.js +40 -1
- package/dist/v1.js.map +1 -1
- package/package.json +3 -1
- package/dist/types/agents.d.ts +0 -2084
- package/dist/types/agents.d.ts.map +0 -1
- package/dist/types/agents.js +0 -203
- package/dist/types/agents.js.map +0 -1
|
@@ -3,7 +3,33 @@ import type { Installation, InstallationListResponse, InstallationSource, Instal
|
|
|
3
3
|
export declare class AgentInstallationInstallationSourceResource {
|
|
4
4
|
private http;
|
|
5
5
|
constructor(http: HttpClient);
|
|
6
|
+
/**
|
|
7
|
+
* List sources for an installation
|
|
8
|
+
* Returns all sources attached to the specified installation. Sources represent
|
|
9
|
+
* the content units (documents, links, and other typed payloads) that the
|
|
10
|
+
* installation's agent can access as context.
|
|
11
|
+
* This endpoint requires an app-scoped token. Results include sources in all
|
|
12
|
+
* states, including those still being ingested. Inspect each source's `state`
|
|
13
|
+
* field to determine whether its content is ready.
|
|
14
|
+
* @param installation - Installation ID (`cin_...`) whose sources to retrieve.
|
|
15
|
+
* @returns Object containing the list of sources attached to the installation.
|
|
16
|
+
*/
|
|
6
17
|
list(installation: string): Promise<InstallationSourceListResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Add a source to an installation
|
|
20
|
+
* Attaches a new source to an existing installation, making its content available
|
|
21
|
+
* to the installation's agent as context. The source type and payload must be valid
|
|
22
|
+
* for the installation's kind; invalid combinations return 422.
|
|
23
|
+
* This endpoint requires an app-scoped token. The installation must belong to an
|
|
24
|
+
* agent accessible by the authenticated caller. Once created, the source begins
|
|
25
|
+
* processing asynchronously — its `state` will transition from `"pending"` as
|
|
26
|
+
* ingestion progresses.
|
|
27
|
+
* @param installation - Installation ID (`cin_...`) whose sources to retrieve.
|
|
28
|
+
* @param input - Request body.
|
|
29
|
+
* @param input.payload - Type-specific payload for the source. The accepted keys depend on the `type` value; invalid or missing payload fields return 422.
|
|
30
|
+
* @param input.type - Source type slug identifying the kind of content being attached, e.g. `"file/document"` or `"web/link"`.
|
|
31
|
+
* @returns The newly created installation source.
|
|
32
|
+
*/
|
|
7
33
|
create(installation: string, input: {
|
|
8
34
|
payload: Record<string, unknown>;
|
|
9
35
|
type: string;
|
|
@@ -13,13 +39,87 @@ export declare class AgentInstallationResource {
|
|
|
13
39
|
private http;
|
|
14
40
|
readonly installation_sources: AgentInstallationInstallationSourceResource;
|
|
15
41
|
constructor(http: HttpClient);
|
|
42
|
+
/**
|
|
43
|
+
* List installations for an app
|
|
44
|
+
* Returns all installations across every agent in the authenticated app. Use this
|
|
45
|
+
* endpoint to get a global view of all external service and enablement channel
|
|
46
|
+
* connections for the app.
|
|
47
|
+
* Optionally narrow results to a single agent by passing the `agent` parameter. To
|
|
48
|
+
* list installations scoped to a specific agent, you may also use the per-agent List
|
|
49
|
+
* Installations endpoint. Results are returned as an unordered array with no
|
|
50
|
+
* pagination. The caller must have app scope.
|
|
51
|
+
* @param params - Query parameters.
|
|
52
|
+
* @param params.agent - Agent ID (`agt_...`) to filter results by. When omitted, installations for all agents in the app are returned.
|
|
53
|
+
* @returns The list of installations for the app, optionally filtered by agent.
|
|
54
|
+
*/
|
|
16
55
|
list(params?: {
|
|
17
56
|
agent?: string;
|
|
18
57
|
}): Promise<InstallationListResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Delete an installation
|
|
60
|
+
* Permanently deletes an installation and severs the connection between the agent
|
|
61
|
+
* and the external service or enablement channel. Any backing context sources
|
|
62
|
+
* associated with the installation are also removed.
|
|
63
|
+
* This action is irreversible. If you want to temporarily stop an installation from
|
|
64
|
+
* processing events, use the Pause or Suspend endpoints instead. The caller must have
|
|
65
|
+
* app scope for the app that owns the installation.
|
|
66
|
+
* @param installation - Installation ID (`cin_...`) to delete.
|
|
67
|
+
* @returns Empty response with HTTP 204 status on successful deletion.
|
|
68
|
+
*/
|
|
19
69
|
delete(installation: string): Promise<void>;
|
|
70
|
+
/**
|
|
71
|
+
* Retrieve an installation
|
|
72
|
+
* Returns a single installation by ID. Use this endpoint to check the current
|
|
73
|
+
* `state`, `kind`, `config`, and bound integration of an installation.
|
|
74
|
+
* The installation must belong to an agent that is accessible within the
|
|
75
|
+
* authenticated app's scope. The caller must have app scope for the app that
|
|
76
|
+
* owns the installation.
|
|
77
|
+
* @param installation - Installation ID (`cin_...`) to retrieve.
|
|
78
|
+
* @returns The requested installation.
|
|
79
|
+
*/
|
|
20
80
|
get(installation: string): Promise<Installation>;
|
|
81
|
+
/**
|
|
82
|
+
* Activate an installation
|
|
83
|
+
* Transitions an installation from a pending or paused state to `active`, enabling
|
|
84
|
+
* the agent to receive events and process work through the installed integration or
|
|
85
|
+
* enablement channel.
|
|
86
|
+
* Activation requires that the installation already has a bound integration (either
|
|
87
|
+
* via `shared_integration` or an inline `integration` created at install time). If no
|
|
88
|
+
* integration is bound, the request returns 422. The caller must have app scope for
|
|
89
|
+
* the app that owns the installation.
|
|
90
|
+
* @param installation - Installation ID (`cin_...`) to activate.
|
|
91
|
+
* @returns The updated installation with `state` reflecting the new active status.
|
|
92
|
+
*/
|
|
21
93
|
activate(installation: string): Promise<Installation>;
|
|
94
|
+
/**
|
|
95
|
+
* Pause an installation
|
|
96
|
+
* Transitions an active installation to the `paused` state, temporarily stopping
|
|
97
|
+
* the agent from receiving events through this installation. The installation and
|
|
98
|
+
* its integration binding are preserved and can be resumed by calling the Activate
|
|
99
|
+
* endpoint.
|
|
100
|
+
* Only installations in the `active` state can be paused. Attempting to pause an
|
|
101
|
+
* installation in any other state returns 422. The caller must have app scope for
|
|
102
|
+
* the app that owns the installation.
|
|
103
|
+
* @param installation - Installation ID (`cin_...`) to pause.
|
|
104
|
+
* @returns The updated installation with `state` set to `"paused"`.
|
|
105
|
+
*/
|
|
22
106
|
pause(installation: string): Promise<Installation>;
|
|
107
|
+
/**
|
|
108
|
+
* Suspend an installation
|
|
109
|
+
* Transitions an installation to the `suspended` state, disabling event processing
|
|
110
|
+
* and signaling that the installation requires administrative attention. Unlike
|
|
111
|
+
* pausing, suspension typically indicates a policy or compliance hold rather than a
|
|
112
|
+
* temporary operational stop.
|
|
113
|
+
* An optional `reason` string can be supplied to record why the installation was
|
|
114
|
+
* suspended; this is stored on the installation and visible when you retrieve it.
|
|
115
|
+
* Only installations that are not already suspended can be suspended — sending this
|
|
116
|
+
* request for an already-suspended installation returns 422. The caller must have
|
|
117
|
+
* app scope for the app that owns the installation.
|
|
118
|
+
* @param installation - Installation ID (`cin_...`) to suspend.
|
|
119
|
+
* @param input - Request body.
|
|
120
|
+
* @param input.reason - Human-readable explanation for the suspension. Stored on the installation and visible when you retrieve it. Omit to suspend without recording a reason.
|
|
121
|
+
* @returns The updated installation with `state` set to `"suspended"`.
|
|
122
|
+
*/
|
|
23
123
|
suspend(installation: string, input: {
|
|
24
124
|
reason?: string | undefined;
|
|
25
125
|
}): Promise<Installation>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent_installations.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/agent_installations.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAExI,qBAAa,2CAA2C;IAC1C,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;
|
|
1
|
+
{"version":3,"file":"agent_installations.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/agent_installations.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAExI,qBAAa,2CAA2C;IAC1C,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;OAUG;IACG,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAG3H;AAED,qBAAa,yBAAyB;IAGxB,OAAO,CAAC,IAAI;IAFxB,QAAQ,CAAC,oBAAoB,EAAE,2CAA2C,CAAC;gBAEvD,IAAI,EAAE,UAAU;IAIpC;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAS1E;;;;;;;;;;OAUG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD;;;;;;;;;OASG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAItD;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAI3D;;;;;;;;;;;OAWG;IACG,KAAK,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;CAGnG"}
|
|
@@ -1,14 +1,40 @@
|
|
|
1
1
|
// Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
|
|
2
2
|
// This file is auto-generated by @archastro/sdk-generator. Do not edit.
|
|
3
|
-
// Content hash:
|
|
3
|
+
// Content hash: dcaf6a97c697
|
|
4
4
|
export class AgentInstallationInstallationSourceResource {
|
|
5
5
|
http;
|
|
6
6
|
constructor(http) {
|
|
7
7
|
this.http = http;
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* List sources for an installation
|
|
11
|
+
* Returns all sources attached to the specified installation. Sources represent
|
|
12
|
+
* the content units (documents, links, and other typed payloads) that the
|
|
13
|
+
* installation's agent can access as context.
|
|
14
|
+
* This endpoint requires an app-scoped token. Results include sources in all
|
|
15
|
+
* states, including those still being ingested. Inspect each source's `state`
|
|
16
|
+
* field to determine whether its content is ready.
|
|
17
|
+
* @param installation - Installation ID (`cin_...`) whose sources to retrieve.
|
|
18
|
+
* @returns Object containing the list of sources attached to the installation.
|
|
19
|
+
*/
|
|
9
20
|
async list(installation) {
|
|
10
21
|
return this.http.request(`/api/v1/agent_installations/${installation}/installation_sources`);
|
|
11
22
|
}
|
|
23
|
+
/**
|
|
24
|
+
* Add a source to an installation
|
|
25
|
+
* Attaches a new source to an existing installation, making its content available
|
|
26
|
+
* to the installation's agent as context. The source type and payload must be valid
|
|
27
|
+
* for the installation's kind; invalid combinations return 422.
|
|
28
|
+
* This endpoint requires an app-scoped token. The installation must belong to an
|
|
29
|
+
* agent accessible by the authenticated caller. Once created, the source begins
|
|
30
|
+
* processing asynchronously — its `state` will transition from `"pending"` as
|
|
31
|
+
* ingestion progresses.
|
|
32
|
+
* @param installation - Installation ID (`cin_...`) whose sources to retrieve.
|
|
33
|
+
* @param input - Request body.
|
|
34
|
+
* @param input.payload - Type-specific payload for the source. The accepted keys depend on the `type` value; invalid or missing payload fields return 422.
|
|
35
|
+
* @param input.type - Source type slug identifying the kind of content being attached, e.g. `"file/document"` or `"web/link"`.
|
|
36
|
+
* @returns The newly created installation source.
|
|
37
|
+
*/
|
|
12
38
|
async create(installation, input) {
|
|
13
39
|
return this.http.request(`/api/v1/agent_installations/${installation}/installation_sources`, { method: "POST", body: input });
|
|
14
40
|
}
|
|
@@ -20,21 +46,99 @@ export class AgentInstallationResource {
|
|
|
20
46
|
this.http = http;
|
|
21
47
|
this.installation_sources = new AgentInstallationInstallationSourceResource(http);
|
|
22
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* List installations for an app
|
|
51
|
+
* Returns all installations across every agent in the authenticated app. Use this
|
|
52
|
+
* endpoint to get a global view of all external service and enablement channel
|
|
53
|
+
* connections for the app.
|
|
54
|
+
* Optionally narrow results to a single agent by passing the `agent` parameter. To
|
|
55
|
+
* list installations scoped to a specific agent, you may also use the per-agent List
|
|
56
|
+
* Installations endpoint. Results are returned as an unordered array with no
|
|
57
|
+
* pagination. The caller must have app scope.
|
|
58
|
+
* @param params - Query parameters.
|
|
59
|
+
* @param params.agent - Agent ID (`agt_...`) to filter results by. When omitted, installations for all agents in the app are returned.
|
|
60
|
+
* @returns The list of installations for the app, optionally filtered by agent.
|
|
61
|
+
*/
|
|
23
62
|
async list(params) {
|
|
24
|
-
|
|
63
|
+
const query = {};
|
|
64
|
+
if (params?.agent !== undefined) {
|
|
65
|
+
query["agent"] = params?.agent;
|
|
66
|
+
}
|
|
67
|
+
return this.http.request(`/api/v1/agent_installations`, { query });
|
|
25
68
|
}
|
|
69
|
+
/**
|
|
70
|
+
* Delete an installation
|
|
71
|
+
* Permanently deletes an installation and severs the connection between the agent
|
|
72
|
+
* and the external service or enablement channel. Any backing context sources
|
|
73
|
+
* associated with the installation are also removed.
|
|
74
|
+
* This action is irreversible. If you want to temporarily stop an installation from
|
|
75
|
+
* processing events, use the Pause or Suspend endpoints instead. The caller must have
|
|
76
|
+
* app scope for the app that owns the installation.
|
|
77
|
+
* @param installation - Installation ID (`cin_...`) to delete.
|
|
78
|
+
* @returns Empty response with HTTP 204 status on successful deletion.
|
|
79
|
+
*/
|
|
26
80
|
async delete(installation) {
|
|
27
81
|
await this.http.request(`/api/v1/agent_installations/${installation}`, { method: "DELETE" });
|
|
28
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* Retrieve an installation
|
|
85
|
+
* Returns a single installation by ID. Use this endpoint to check the current
|
|
86
|
+
* `state`, `kind`, `config`, and bound integration of an installation.
|
|
87
|
+
* The installation must belong to an agent that is accessible within the
|
|
88
|
+
* authenticated app's scope. The caller must have app scope for the app that
|
|
89
|
+
* owns the installation.
|
|
90
|
+
* @param installation - Installation ID (`cin_...`) to retrieve.
|
|
91
|
+
* @returns The requested installation.
|
|
92
|
+
*/
|
|
29
93
|
async get(installation) {
|
|
30
94
|
return this.http.request(`/api/v1/agent_installations/${installation}`);
|
|
31
95
|
}
|
|
96
|
+
/**
|
|
97
|
+
* Activate an installation
|
|
98
|
+
* Transitions an installation from a pending or paused state to `active`, enabling
|
|
99
|
+
* the agent to receive events and process work through the installed integration or
|
|
100
|
+
* enablement channel.
|
|
101
|
+
* Activation requires that the installation already has a bound integration (either
|
|
102
|
+
* via `shared_integration` or an inline `integration` created at install time). If no
|
|
103
|
+
* integration is bound, the request returns 422. The caller must have app scope for
|
|
104
|
+
* the app that owns the installation.
|
|
105
|
+
* @param installation - Installation ID (`cin_...`) to activate.
|
|
106
|
+
* @returns The updated installation with `state` reflecting the new active status.
|
|
107
|
+
*/
|
|
32
108
|
async activate(installation) {
|
|
33
109
|
return this.http.request(`/api/v1/agent_installations/${installation}/activate`, { method: "POST" });
|
|
34
110
|
}
|
|
111
|
+
/**
|
|
112
|
+
* Pause an installation
|
|
113
|
+
* Transitions an active installation to the `paused` state, temporarily stopping
|
|
114
|
+
* the agent from receiving events through this installation. The installation and
|
|
115
|
+
* its integration binding are preserved and can be resumed by calling the Activate
|
|
116
|
+
* endpoint.
|
|
117
|
+
* Only installations in the `active` state can be paused. Attempting to pause an
|
|
118
|
+
* installation in any other state returns 422. The caller must have app scope for
|
|
119
|
+
* the app that owns the installation.
|
|
120
|
+
* @param installation - Installation ID (`cin_...`) to pause.
|
|
121
|
+
* @returns The updated installation with `state` set to `"paused"`.
|
|
122
|
+
*/
|
|
35
123
|
async pause(installation) {
|
|
36
124
|
return this.http.request(`/api/v1/agent_installations/${installation}/pause`, { method: "POST" });
|
|
37
125
|
}
|
|
126
|
+
/**
|
|
127
|
+
* Suspend an installation
|
|
128
|
+
* Transitions an installation to the `suspended` state, disabling event processing
|
|
129
|
+
* and signaling that the installation requires administrative attention. Unlike
|
|
130
|
+
* pausing, suspension typically indicates a policy or compliance hold rather than a
|
|
131
|
+
* temporary operational stop.
|
|
132
|
+
* An optional `reason` string can be supplied to record why the installation was
|
|
133
|
+
* suspended; this is stored on the installation and visible when you retrieve it.
|
|
134
|
+
* Only installations that are not already suspended can be suspended — sending this
|
|
135
|
+
* request for an already-suspended installation returns 422. The caller must have
|
|
136
|
+
* app scope for the app that owns the installation.
|
|
137
|
+
* @param installation - Installation ID (`cin_...`) to suspend.
|
|
138
|
+
* @param input - Request body.
|
|
139
|
+
* @param input.reason - Human-readable explanation for the suspension. Stored on the installation and visible when you retrieve it. Omit to suspend without recording a reason.
|
|
140
|
+
* @returns The updated installation with `state` set to `"suspended"`.
|
|
141
|
+
*/
|
|
38
142
|
async suspend(installation, input) {
|
|
39
143
|
return this.http.request(`/api/v1/agent_installations/${installation}/suspend`, { method: "POST", body: input });
|
|
40
144
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent_installations.js","sourceRoot":"","sources":["../../../src/v1/resources/agent_installations.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wEAAwE;AACxE,6BAA6B;AAK7B,MAAM,OAAO,2CAA2C;IAClC;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC,KAAK,CAAC,IAAI,CAAC,YAAoB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,uBAAuB,CAAC,CAAC;IAC/F,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,KAAyD;QAC1F,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,uBAAuB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChI,CAAC;CACF;AAED,MAAM,OAAO,yBAAyB;IAGhB;IAFX,oBAAoB,CAA8C;IAE3E,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,2CAA2C,CAAC,IAAI,CAAC,CAAC;IACpF,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAA2B;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"agent_installations.js","sourceRoot":"","sources":["../../../src/v1/resources/agent_installations.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wEAAwE;AACxE,6BAA6B;AAK7B,MAAM,OAAO,2CAA2C;IAClC;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CAAC,YAAoB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,uBAAuB,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,KAAyD;QAC1F,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,uBAAuB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChI,CAAC;CACF;AAED,MAAM,OAAO,yBAAyB;IAGhB;IAFX,oBAAoB,CAA8C;IAE3E,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,2CAA2C,CAAC,IAAI,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,IAAI,CAAC,MAA2B;QACpC,MAAM,KAAK,GAA6F,EAAE,CAAC;QAC3G,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC;QACjC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,YAAoB;QAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,CAAC,YAAoB;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CAAC,YAAoB;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,WAAW,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,KAAK,CAAC,YAAoB;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CAAC,YAAoB,EAAE,KAAsC;QACxE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,+BAA+B,YAAY,UAAU,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACnH,CAAC;CACF"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { HttpClient } from "../../runtime/http-client.js";
|
|
2
|
+
import type { AgentRoutineRunListResponse } from "../../types/common.js";
|
|
3
|
+
export declare class AgentRoutineRunResource {
|
|
4
|
+
private http;
|
|
5
|
+
constructor(http: HttpClient);
|
|
6
|
+
/**
|
|
7
|
+
* List agent routine runs
|
|
8
|
+
* Returns a paginated list of agent routine runs across all routines visible to
|
|
9
|
+
* the authenticated app scope. Results are ordered by creation time descending
|
|
10
|
+
* (most recent first).
|
|
11
|
+
* Use the `agent` parameter to filter runs to one or more specific agents. Use
|
|
12
|
+
* `status` to narrow results to runs in a particular state. Pagination is
|
|
13
|
+
* bidirectional: supply `after_cursor` to page forward through newer runs or
|
|
14
|
+
* `before_cursor` to page backward through older runs.
|
|
15
|
+
* This endpoint requires an app scope. Requests without a valid app credential
|
|
16
|
+
* return 403.
|
|
17
|
+
* @param params - Query parameters.
|
|
18
|
+
* @param params.agent - Filter by one or more agent IDs (`agi_...`) or `lookup_key` values. Repeat the parameter (e.g. `?agent[]=agi_a&agent[]=agi_b`) to OR multiple agents. Omit to return runs for all agents.
|
|
19
|
+
* @param params.status - Filter by run status. One of `"pending"`, `"running"`, `"completed"`, `"failed"`, `"skipped"`, or `"cancelled"`. Omit to return runs in any status.
|
|
20
|
+
* @param params.limit - Maximum number of runs to return. Defaults to 50; maximum is 100.
|
|
21
|
+
* @param params.beforeCursor - Opaque cursor from a previous response's `before_cursor` field. Returns the page of runs older than that cursor position.
|
|
22
|
+
* @param params.afterCursor - Opaque cursor from a previous response's `after_cursor` field. Returns the page of runs newer than that cursor position.
|
|
23
|
+
* @returns Paginated list of agent routine runs.
|
|
24
|
+
*/
|
|
25
|
+
list(params?: {
|
|
26
|
+
agent?: string[];
|
|
27
|
+
status?: string;
|
|
28
|
+
limit?: number;
|
|
29
|
+
beforeCursor?: string;
|
|
30
|
+
afterCursor?: string;
|
|
31
|
+
}): Promise<AgentRoutineRunListResponse>;
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=agent_routine_runs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agent_routine_runs.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/agent_routine_runs.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AAEzE,qBAAa,uBAAuB;IACtB,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAoB9J"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
// Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
|
|
2
|
+
// This file is auto-generated by @archastro/sdk-generator. Do not edit.
|
|
3
|
+
// Content hash: 9413aa039472
|
|
4
|
+
export class AgentRoutineRunResource {
|
|
5
|
+
http;
|
|
6
|
+
constructor(http) {
|
|
7
|
+
this.http = http;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* List agent routine runs
|
|
11
|
+
* Returns a paginated list of agent routine runs across all routines visible to
|
|
12
|
+
* the authenticated app scope. Results are ordered by creation time descending
|
|
13
|
+
* (most recent first).
|
|
14
|
+
* Use the `agent` parameter to filter runs to one or more specific agents. Use
|
|
15
|
+
* `status` to narrow results to runs in a particular state. Pagination is
|
|
16
|
+
* bidirectional: supply `after_cursor` to page forward through newer runs or
|
|
17
|
+
* `before_cursor` to page backward through older runs.
|
|
18
|
+
* This endpoint requires an app scope. Requests without a valid app credential
|
|
19
|
+
* return 403.
|
|
20
|
+
* @param params - Query parameters.
|
|
21
|
+
* @param params.agent - Filter by one or more agent IDs (`agi_...`) or `lookup_key` values. Repeat the parameter (e.g. `?agent[]=agi_a&agent[]=agi_b`) to OR multiple agents. Omit to return runs for all agents.
|
|
22
|
+
* @param params.status - Filter by run status. One of `"pending"`, `"running"`, `"completed"`, `"failed"`, `"skipped"`, or `"cancelled"`. Omit to return runs in any status.
|
|
23
|
+
* @param params.limit - Maximum number of runs to return. Defaults to 50; maximum is 100.
|
|
24
|
+
* @param params.beforeCursor - Opaque cursor from a previous response's `before_cursor` field. Returns the page of runs older than that cursor position.
|
|
25
|
+
* @param params.afterCursor - Opaque cursor from a previous response's `after_cursor` field. Returns the page of runs newer than that cursor position.
|
|
26
|
+
* @returns Paginated list of agent routine runs.
|
|
27
|
+
*/
|
|
28
|
+
async list(params) {
|
|
29
|
+
const query = {};
|
|
30
|
+
if (params?.agent !== undefined) {
|
|
31
|
+
query["agent"] = params?.agent;
|
|
32
|
+
}
|
|
33
|
+
if (params?.status !== undefined) {
|
|
34
|
+
query["status"] = params?.status;
|
|
35
|
+
}
|
|
36
|
+
if (params?.limit !== undefined) {
|
|
37
|
+
query["limit"] = params?.limit;
|
|
38
|
+
}
|
|
39
|
+
if (params?.beforeCursor !== undefined) {
|
|
40
|
+
query["before_cursor"] = params?.beforeCursor;
|
|
41
|
+
}
|
|
42
|
+
if (params?.afterCursor !== undefined) {
|
|
43
|
+
query["after_cursor"] = params?.afterCursor;
|
|
44
|
+
}
|
|
45
|
+
return this.http.request(`/api/v1/agent_routine_runs`, { query });
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=agent_routine_runs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"agent_routine_runs.js","sourceRoot":"","sources":["../../../src/v1/resources/agent_routine_runs.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wEAAwE;AACxE,6BAA6B;AAK7B,MAAM,OAAO,uBAAuB;IACd;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CAAC,MAA2G;QACpH,MAAM,KAAK,GAA6F,EAAE,CAAC;QAC3G,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC;QACjC,CAAC;QACD,IAAI,MAAM,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,QAAQ,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC;QACnC,CAAC;QACD,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC;QACjC,CAAC;QACD,IAAI,MAAM,EAAE,YAAY,KAAK,SAAS,EAAE,CAAC;YACvC,KAAK,CAAC,eAAe,CAAC,GAAG,MAAM,EAAE,YAAY,CAAC;QAChD,CAAC;QACD,IAAI,MAAM,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;YACtC,KAAK,CAAC,cAAc,CAAC,GAAG,MAAM,EAAE,WAAW,CAAC;QAC9C,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC;CACF"}
|
|
@@ -1,22 +1,104 @@
|
|
|
1
1
|
import { HttpClient } from "../../runtime/http-client.js";
|
|
2
|
-
import type { AgentRoutine, AgentRoutineListResponse, AgentRoutineRun, AgentRoutineRunListResponse } from "../../types/
|
|
3
|
-
import type { RoutinePreset } from "../../types/common.js";
|
|
2
|
+
import type { AgentRoutine, AgentRoutineListResponse, AgentRoutineRun, AgentRoutineRunListResponse, RoutinePreset } from "../../types/common.js";
|
|
4
3
|
export declare class AgentRoutineRunResource {
|
|
5
4
|
private http;
|
|
6
5
|
constructor(http: HttpClient);
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve a routine run
|
|
8
|
+
* Returns a single routine run by its ID. The run includes status, payload,
|
|
9
|
+
* result, duration, and any structured response produced by the routine's agent.
|
|
10
|
+
* The authenticated principal must have access to the app that owns the run.
|
|
11
|
+
* When your API key is scoped to an app, the run must belong to that app or
|
|
12
|
+
* a 403 is returned.
|
|
13
|
+
* @param run - Routine run ID (`arr_...`) to retrieve.
|
|
14
|
+
* @returns The requested routine run.
|
|
15
|
+
*/
|
|
7
16
|
get(run: string): Promise<AgentRoutineRun>;
|
|
8
17
|
}
|
|
9
18
|
export declare class AgentRoutineResource {
|
|
10
19
|
private http;
|
|
11
20
|
readonly agent_routine_runs: AgentRoutineRunResource;
|
|
12
21
|
constructor(http: HttpClient);
|
|
22
|
+
/**
|
|
23
|
+
* List routines
|
|
24
|
+
* Returns all routines within the authenticated app scope. Optionally filter by
|
|
25
|
+
* agent or event type. When `agent` is omitted, all routines accessible to the
|
|
26
|
+
* caller are returned regardless of which agent they belong to.
|
|
27
|
+
* If `agent` is provided but does not exist or is not accessible, the endpoint
|
|
28
|
+
* returns 404 rather than an empty list. Results are not paginated; all matching
|
|
29
|
+
* routines are returned in a single response. Requires app scope.
|
|
30
|
+
* @param params - Query parameters.
|
|
31
|
+
* @param params.agent - Agent ID (`agt_...`) to filter routines by. Omit to return routines across all agents.
|
|
32
|
+
* @param params.eventType - Event type string to filter by (e.g. `"agentroutine.invoked"`). Omit to return routines for all event types.
|
|
33
|
+
* @returns Object containing a `data` array of matching routines.
|
|
34
|
+
*/
|
|
13
35
|
list(params?: {
|
|
14
36
|
agent?: string;
|
|
15
37
|
eventType?: string;
|
|
16
38
|
}): Promise<AgentRoutineListResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* List routine presets
|
|
41
|
+
* Returns all registered routine presets available to the authenticated app,
|
|
42
|
+
* including each preset's name, display metadata, and accepted configuration
|
|
43
|
+
* schema. Use this endpoint to discover which presets can be referenced when
|
|
44
|
+
* creating or updating a routine with `handler_type: "preset"`.
|
|
45
|
+
* The list reflects presets registered at server start time and does not change
|
|
46
|
+
* at runtime. Requires app scope.
|
|
47
|
+
* @returns Array of available routine preset objects.
|
|
48
|
+
*/
|
|
17
49
|
presets(): Promise<RoutinePreset[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Delete a routine
|
|
52
|
+
* Permanently deletes the specified routine. This action is irreversible — the
|
|
53
|
+
* routine and its configuration are removed immediately. Any in-flight event
|
|
54
|
+
* processing initiated by this routine before deletion may still complete.
|
|
55
|
+
* Requires app scope. Returns 204 No Content on success.
|
|
56
|
+
* @param routine - Routine ID (`arn_...`) of the routine to delete.
|
|
57
|
+
* @returns Empty response on successful deletion (HTTP 204 No Content).
|
|
58
|
+
*/
|
|
18
59
|
delete(routine: string): Promise<void>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieve a routine
|
|
62
|
+
* Returns the full routine record for the given routine ID. Use this endpoint to
|
|
63
|
+
* inspect a routine's current configuration, handler type, event config, schedule,
|
|
64
|
+
* and lifecycle status.
|
|
65
|
+
* Requires app scope. Returns 404 if the routine does not exist or is not
|
|
66
|
+
* accessible to the caller.
|
|
67
|
+
* @param routine - Routine ID (`arn_...`) of the routine to retrieve.
|
|
68
|
+
* @returns The requested routine.
|
|
69
|
+
*/
|
|
19
70
|
get(routine: string): Promise<AgentRoutine>;
|
|
71
|
+
/**
|
|
72
|
+
* Update a routine
|
|
73
|
+
* Updates one or more fields of the specified routine. Only the fields you
|
|
74
|
+
* include are changed; omitted fields retain their current values. To change the
|
|
75
|
+
* execution model, supply a new `handler_type` along with its required handler
|
|
76
|
+
* body field (`config`, `script`, or `preset_name`).
|
|
77
|
+
* When `template` is supplied, the routine's configuration is re-resolved from
|
|
78
|
+
* the template before applying any additional field overrides. The routine's
|
|
79
|
+
* `status`, `lookup_key`, and agent attachment are always preserved regardless
|
|
80
|
+
* of template content. Updating `steps` replaces the entire step list — send
|
|
81
|
+
* the full desired list, not a partial diff. Requires app scope.
|
|
82
|
+
* @param routine - Routine ID (`arn_...`) of the routine to update.
|
|
83
|
+
* @param input - Request body.
|
|
84
|
+
* @param input.acl - Updated access control list. Replaces the existing ACL entirely.
|
|
85
|
+
* @param input.config - Workflow config ID (`cfg_...`). Used when `handler_type` is `"workflow_graph"`.
|
|
86
|
+
* @param input.description - New human-readable description of what this routine does.
|
|
87
|
+
* @param input.event_config - Mapping of event types to trigger configuration. Each key is an event type string; each value is an object with a `"filters"` map and an optional `"dedupe_key_path"` (a JSON path used to deduplicate events, e.g. `"$.thread.id"`).
|
|
88
|
+
* @param input.event_type - Event type that triggers this routine. Deprecated — use `event_config` instead.
|
|
89
|
+
* @param input.handler_type - New execution model. One of `"workflow_graph"`, `"script"`, `"preset"`, or `"chain"`.
|
|
90
|
+
* @param input.lookup_key - New stable, unique key for deterministic lookup. Must be unique within the app.
|
|
91
|
+
* @param input.metadata - Updated arbitrary key-value metadata. Replaces the existing metadata entirely.
|
|
92
|
+
* @param input.name - New human-readable display name for the routine.
|
|
93
|
+
* @param input.preset_config - Updated configuration passed to the preset at runtime.
|
|
94
|
+
* @param input.preset_name - Name of the registered preset to use. Used when `handler_type` is `"preset"`.
|
|
95
|
+
* @param input.schedule - New cron expression for time-triggered routines (e.g. `"0 9 * * 1"`). Must not be more frequent than once per hour.
|
|
96
|
+
* @param input.script - New inline script source. Used when `handler_type` is `"script"`.
|
|
97
|
+
* @param input.steps - Updated ordered list of steps for a chain handler. Required when `handler_type` is `"chain"`; must be omitted or empty otherwise. Replaces the entire existing step list — send the full desired list, not a partial diff.
|
|
98
|
+
* @param input.template - AgentRoutineTemplate config ID (`cfg_...`) or lookup key. When provided, the routine's configuration is re-resolved from the template before applying other param overrides. The routine's `status`, `lookup_key`, and agent attachment are always preserved.
|
|
99
|
+
* @param input.trigger_context - Updated trigger context. One of `"chat_session"` or `"event"`.
|
|
100
|
+
* @returns The updated routine.
|
|
101
|
+
*/
|
|
20
102
|
update(routine: string, input: {
|
|
21
103
|
acl?: {
|
|
22
104
|
add?: {
|
|
@@ -73,17 +155,81 @@ export declare class AgentRoutineResource {
|
|
|
73
155
|
preset_name?: string | undefined;
|
|
74
156
|
script?: string | undefined;
|
|
75
157
|
}[] | undefined;
|
|
158
|
+
template?: string | undefined;
|
|
76
159
|
trigger_context?: string | undefined;
|
|
77
160
|
}): Promise<AgentRoutine>;
|
|
161
|
+
/**
|
|
162
|
+
* Activate a routine
|
|
163
|
+
* Sets the routine's status to `"active"`, enabling it to process events or run
|
|
164
|
+
* on its configured schedule. Only routines that have a workflow config attached
|
|
165
|
+
* can be activated; attempting to activate a routine with no config returns 422.
|
|
166
|
+
* Scheduled routines must be configured to run no more frequently than once per
|
|
167
|
+
* hour. Activation fails with 422 if the cron schedule is more frequent than
|
|
168
|
+
* that limit. Requires app scope.
|
|
169
|
+
* @param routine - Routine ID (`arn_...`) of the routine to activate.
|
|
170
|
+
* @returns The updated routine with `status` set to `"active"`.
|
|
171
|
+
*/
|
|
78
172
|
activate(routine: string): Promise<AgentRoutine>;
|
|
173
|
+
/**
|
|
174
|
+
* Invoke a routine
|
|
175
|
+
* Triggers an on-demand invocation of the specified routine, dispatching an
|
|
176
|
+
* asynchronous agent run and returning a run record immediately. The routine must
|
|
177
|
+
* be active and must have `event_type` set to `"agentroutine.invoked"`.
|
|
178
|
+
* The routine's `preset_config.session_mode` determines session behavior: each
|
|
179
|
+
* call may create a new session (`"stateless"`) or reuse an existing one
|
|
180
|
+
* (`"session"`). When `session_scope` is `"per_user"`, the `user` param is
|
|
181
|
+
* required for S2S and developer callers; authenticated client callers always
|
|
182
|
+
* use their own identity. When `session_scope` is `"per_key"`, `session_key`
|
|
183
|
+
* is required.
|
|
184
|
+
* Supply `idempotency_key` to safely retry invocations — if a completed run
|
|
185
|
+
* already exists for that key a 409 Conflict is returned rather than creating
|
|
186
|
+
* a duplicate run. Entitlement for LLM calls is checked at request time;
|
|
187
|
+
* customers on plans that do not include this feature receive 402.
|
|
188
|
+
* @param routine - Routine ID (`arn_...`) or `lookup_key` of the routine to invoke.
|
|
189
|
+
* @param input - Request body.
|
|
190
|
+
* @param input.idempotency_key - Unique key used to deduplicate invocations. Resubmitting the same key returns 409 if a completed run already exists.
|
|
191
|
+
* @param input.message - The user message to send to the agent for this invocation.
|
|
192
|
+
* @param input.metadata - Arbitrary key-value metadata attached to this invocation. Not interpreted by the platform.
|
|
193
|
+
* @param input.session_key - Arbitrary key used to identify and resume a session when `session_scope` is `"per_key"`. Required in that mode.
|
|
194
|
+
* @param input.thread_id - Thread ID (`thr_...`) to post the preset output into. Omit to skip thread posting.
|
|
195
|
+
* @param input.user - User ID to associate with the session. For S2S and developer callers only; authenticated client callers always use their own identity.
|
|
196
|
+
* @returns The agent routine run created by this invocation.
|
|
197
|
+
*/
|
|
79
198
|
invoke(routine: string, input: {
|
|
80
199
|
idempotency_key?: string | undefined;
|
|
81
200
|
message: string;
|
|
82
201
|
metadata?: Record<string, unknown> | undefined;
|
|
83
202
|
session_key?: string | undefined;
|
|
203
|
+
thread_id?: string | undefined;
|
|
84
204
|
user?: string | undefined;
|
|
85
205
|
}): Promise<AgentRoutineRun>;
|
|
206
|
+
/**
|
|
207
|
+
* Pause a routine
|
|
208
|
+
* Sets the routine's status to `"paused"`, suspending event processing and
|
|
209
|
+
* scheduled execution without deleting the routine or its configuration. A
|
|
210
|
+
* paused routine can be resumed at any time by calling the activate endpoint.
|
|
211
|
+
* Requires app scope.
|
|
212
|
+
* @param routine - Routine ID (`arn_...`) of the routine to pause.
|
|
213
|
+
* @returns The updated routine with `status` set to `"paused"`.
|
|
214
|
+
*/
|
|
86
215
|
pause(routine: string): Promise<AgentRoutine>;
|
|
216
|
+
/**
|
|
217
|
+
* List runs for a routine
|
|
218
|
+
* Returns a cursor-paginated list of runs for the specified routine, ordered
|
|
219
|
+
* from most recent to oldest by default. Use `before_cursor` and `after_cursor`
|
|
220
|
+
* to page through results in either direction.
|
|
221
|
+
* You can filter runs by status to monitor a specific lifecycle phase. The
|
|
222
|
+
* authenticated principal must have access to the routine's parent app. When
|
|
223
|
+
* your API key is scoped to an app, only runs belonging to that app are
|
|
224
|
+
* returned.
|
|
225
|
+
* @param routine - Routine ID (`rtn_...`) whose runs you want to list.
|
|
226
|
+
* @param params - Query parameters.
|
|
227
|
+
* @param params.status - Filter runs by status. One of `"pending"`, `"running"`, `"completed"`, `"failed"`, or `"skipped"`. Omit to return runs in all statuses.
|
|
228
|
+
* @param params.limit - Maximum number of runs to return per page. Defaults to 50; maximum is 100.
|
|
229
|
+
* @param params.beforeCursor - Opaque cursor from a previous response's `before_cursor` field. Returns the page of runs older than this cursor.
|
|
230
|
+
* @param params.afterCursor - Opaque cursor from a previous response's `after_cursor` field. Returns the page of runs newer than this cursor.
|
|
231
|
+
* @returns Paginated list of routine runs.
|
|
232
|
+
*/
|
|
87
233
|
runs(routine: string, params?: {
|
|
88
234
|
status?: string;
|
|
89
235
|
limit?: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent_routines.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/agent_routines.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB,EAAE,eAAe,EAAE,2BAA2B,EAAE,
|
|
1
|
+
{"version":3,"file":"agent_routines.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/agent_routines.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,wBAAwB,EAAE,eAAe,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEjJ,qBAAa,uBAAuB;IACtB,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;OASG;IACG,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;CAGjD;AAED,qBAAa,oBAAoB;IAGnB,OAAO,CAAC,IAAI;IAFxB,QAAQ,CAAC,kBAAkB,EAAE,uBAAuB,CAAC;gBAEjC,IAAI,EAAE,UAAU;IAIpC;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAY9F;;;;;;;;;OASG;IACG,OAAO,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAIzC;;;;;;;;OAQG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,GAAG,CAAC,EAAE;YAAE,GAAG,CAAC,EAAE;gBAAE,OAAO,EAAE,MAAM,EAAE,CAAC;gBAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAAC,cAAc,EAAE,MAAM,CAAA;aAAE,EAAE,GAAG,SAAS,CAAC;YAAC,MAAM,CAAC,EAAE;gBAAE,OAAO,EAAE,MAAM,EAAE,CAAC;gBAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAAC,cAAc,EAAE,MAAM,CAAA;aAAE,EAAE,GAAG,SAAS,CAAC;YAAC,MAAM,CAAC,EAAE;gBAAE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAAC,cAAc,EAAE,MAAM,CAAA;aAAE,EAAE,GAAG,SAAS,CAAA;SAAE,GAAG,SAAS,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,aAAa,CAAC,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,GAAG,CAAC,EAAE;gBAAE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;aAAE,GAAG,SAAS,CAAC;YAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,+BAA+B,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;SAAE,GAAG,SAAS,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,YAAY,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,aAAa,CAAC,EAAE;gBAAE,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAAC,GAAG,CAAC,EAAE;oBAAE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;iBAAE,GAAG,SAAS,CAAC;gBAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAAC,+BAA+B,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;aAAE,GAAG,SAAS,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;SAAE,EAAE,GAAG,SAAS,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAIpjD;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAItD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,eAAe,CAAC;IAItQ;;;;;;;;OAQG;IACG,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAInD;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAiB7J"}
|