@deepraxis/sdk 0.1.0-dev.fa57968 → 0.1.0-dev.ff6425a

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/METHODS.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SDK methods
2
2
 
3
- Generated by `bun run generate`. 348 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
3
+ Generated by `bun run generate`. 422 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
4
4
 
5
5
  `always` returns an AsyncIterable; `optional` streams with `{ stream: true }`; `yes` pagination returns a Page. Only `{ data, next_cursor }` + `cursor` query contracts are automatically paginated.
6
6
 
@@ -18,10 +18,44 @@ Multipart request bodies expand plain objects into bracketed fields (for example
18
18
  | retrieve | GET | `/agent/v1/agents/{agent_id}` | no | no |
19
19
  | update | POST | `/agent/v1/agents/{agent_id}` | no | no |
20
20
 
21
+ ### agent.agents.endUsers
22
+
23
+ | Method | HTTP | Path | Streaming | Pagination |
24
+ |---|---|---|---|---|
25
+ | delete | DELETE | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | no | no |
26
+ | list | GET | `/agent/v1/agents/{agent_id}/end_users` | no | no |
27
+ | retrieve | GET | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | no | no |
28
+ | retrieveDeletion | GET | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion` | no | no |
29
+
30
+ ### agent.agents.endUsers.block
31
+
32
+ | Method | HTTP | Path | Streaming | Pagination |
33
+ |---|---|---|---|---|
34
+ | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block` | no | no |
35
+
36
+ ### agent.agents.endUsers.revokeTokens
37
+
38
+ | Method | HTTP | Path | Streaming | Pagination |
39
+ |---|---|---|---|---|
40
+ | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens` | no | no |
41
+
42
+ ### agent.agents.endUsers.unblock
43
+
44
+ | Method | HTTP | Path | Streaming | Pagination |
45
+ |---|---|---|---|---|
46
+ | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock` | no | no |
47
+
48
+ ### agent.agents.unarchive
49
+
50
+ | Method | HTTP | Path | Streaming | Pagination |
51
+ |---|---|---|---|---|
52
+ | create | POST | `/agent/v1/agents/{agent_id}/unarchive` | no | no |
53
+
21
54
  ### agent.agents.versions
22
55
 
23
56
  | Method | HTTP | Path | Streaming | Pagination |
24
57
  |---|---|---|---|---|
58
+ | apply | POST | `/agent/v1/agents/{agent_id}/versions/{version}/apply` | no | no |
25
59
  | list | GET | `/agent/v1/agents/{agent_id}/versions` | no | no |
26
60
 
27
61
  ### agent.computers
@@ -49,6 +83,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
49
83
  | list | GET | `/agent/v1/computers/{computer_id}/files` | no | no |
50
84
  | retrieveContent | GET | `/agent/v1/computers/{computer_id}/files/content` | no | no |
51
85
 
86
+ ### agent.computers.leases
87
+
88
+ | Method | HTTP | Path | Streaming | Pagination |
89
+ |---|---|---|---|---|
90
+ | delete | DELETE | `/agent/v1/computers/{computer_id}/leases/{lease_id}` | no | no |
91
+
92
+ ### agent.computers.leases.renew
93
+
94
+ | Method | HTTP | Path | Streaming | Pagination |
95
+ |---|---|---|---|---|
96
+ | create | POST | `/agent/v1/computers/{computer_id}/leases/{lease_id}/renew` | no | no |
97
+
52
98
  ### agent.deploymentRuns
53
99
 
54
100
  | Method | HTTP | Path | Streaming | Pagination |
@@ -79,6 +125,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
79
125
  |---|---|---|---|---|
80
126
  | create | POST | `/agent/v1/deployments/{deployment_id}/unpause` | no | no |
81
127
 
128
+ ### agent.embed
129
+
130
+ | Method | HTTP | Path | Streaming | Pagination |
131
+ |---|---|---|---|---|
132
+ | retrieveAppearance | GET | `/agent/v1/embed/appearance` | no | no |
133
+
134
+ ### agent.embed.exchange
135
+
136
+ | Method | HTTP | Path | Streaming | Pagination |
137
+ |---|---|---|---|---|
138
+ | create | POST | `/agent/v1/embed/exchange` | no | no |
139
+
82
140
  ### agent.embedTokens
83
141
 
84
142
  | Method | HTTP | Path | Streaming | Pagination |
@@ -86,6 +144,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
86
144
  | create | POST | `/agent/v1/embed_tokens` | no | no |
87
145
  | list | GET | `/agent/v1/embed_tokens` | no | no |
88
146
 
147
+ ### agent.embedTokens.anonymous
148
+
149
+ | Method | HTTP | Path | Streaming | Pagination |
150
+ |---|---|---|---|---|
151
+ | create | POST | `/agent/v1/embed_tokens/anonymous` | no | no |
152
+
89
153
  ### agent.embedTokens.revoke
90
154
 
91
155
  | Method | HTTP | Path | Streaming | Pagination |
@@ -109,6 +173,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
109
173
  | archive | POST | `/agent/v1/sessions/{session_id}/archive` | no | no |
110
174
  | compact | POST | `/agent/v1/sessions/{session_id}/compact` | no | no |
111
175
  | create | POST | `/agent/v1/sessions` | no | no |
176
+ | delete | DELETE | `/agent/v1/sessions/{session_id}` | no | no |
112
177
  | fork | POST | `/agent/v1/sessions/{session_id}/fork` | no | no |
113
178
  | list | GET | `/agent/v1/sessions` | no | no |
114
179
  | retrieve | GET | `/agent/v1/sessions/{session_id}` | no | no |
@@ -174,6 +239,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
174
239
  |---|---|---|---|---|
175
240
  | list | GET | `/agent/v1/sessions/{session_id}/threads/{thread_id}/events` | no | no |
176
241
 
242
+ ### agent.skills
243
+
244
+ | Method | HTTP | Path | Streaming | Pagination |
245
+ |---|---|---|---|---|
246
+ | create | POST | `/agent/v1/skills` | no | no |
247
+ | delete | DELETE | `/agent/v1/skills/{skill_id}` | no | no |
248
+ | list | GET | `/agent/v1/skills` | no | no |
249
+ | retrieve | GET | `/agent/v1/skills/{skill_id}` | no | no |
250
+
251
+ ### agent.skills.versions
252
+
253
+ | Method | HTTP | Path | Streaming | Pagination |
254
+ |---|---|---|---|---|
255
+ | create | POST | `/agent/v1/skills/{skill_id}/versions` | no | no |
256
+ | delete | DELETE | `/agent/v1/skills/{skill_id}/versions/{version}` | no | no |
257
+ | list | GET | `/agent/v1/skills/{skill_id}/versions` | no | no |
258
+ | retrieve | GET | `/agent/v1/skills/{skill_id}/versions/{version}` | no | no |
259
+ | retrieveContent | GET | `/agent/v1/skills/{skill_id}/versions/{version}/content` | no | no |
260
+
177
261
  ### agent.toolsets
178
262
 
179
263
  | Method | HTTP | Path | Streaming | Pagination |
@@ -256,6 +340,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
256
340
  | list | GET | `/application/v1/workers/{worker_id}/versions` | no | yes |
257
341
  | retrieve | GET | `/application/v1/workers/{worker_id}/versions/{version_id}` | no | no |
258
342
 
343
+ ### application.workers.versions.assets
344
+
345
+ | Method | HTTP | Path | Streaming | Pagination |
346
+ |---|---|---|---|---|
347
+ | retrieveManifest | GET | `/application/v1/workers/{worker_id}/versions/{version_id}/assets/manifest` | no | no |
348
+
259
349
  ## automation
260
350
 
261
351
  ### automation.actions
@@ -555,6 +645,20 @@ Multipart request bodies expand plain objects into bracketed fields (for example
555
645
  | retrieve | GET | `/file/v1/files/{file_id}` | no | no |
556
646
  | retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
557
647
 
648
+ ### file.uploads
649
+
650
+ | Method | HTTP | Path | Streaming | Pagination |
651
+ |---|---|---|---|---|
652
+ | cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
653
+ | complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
654
+ | create | POST | `/file/v1/uploads` | no | no |
655
+
656
+ ### file.uploads.parts
657
+
658
+ | Method | HTTP | Path | Streaming | Pagination |
659
+ |---|---|---|---|---|
660
+ | create | POST | `/file/v1/uploads/{upload_id}/parts` | no | no |
661
+
558
662
  ## knowledge
559
663
 
560
664
  ### knowledge.vectorStores
@@ -888,6 +992,21 @@ Multipart request bodies expand plain objects into bracketed fields (for example
888
992
  | Method | HTTP | Path | Streaming | Pagination |
889
993
  |---|---|---|---|---|
890
994
  | create | POST | `/organization/v1/feedback` | no | no |
995
+ | list | GET | `/organization/v1/feedback` | no | no |
996
+ | retrieve | GET | `/organization/v1/feedback/{id}` | no | no |
997
+
998
+ ### organization.feedback.counts
999
+
1000
+ | Method | HTTP | Path | Streaming | Pagination |
1001
+ |---|---|---|---|---|
1002
+ | list | GET | `/organization/v1/feedback/counts` | no | no |
1003
+
1004
+ ### organization.feedback.messages
1005
+
1006
+ | Method | HTTP | Path | Streaming | Pagination |
1007
+ |---|---|---|---|---|
1008
+ | create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
1009
+ | list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
891
1010
 
892
1011
  ### organization.usage
893
1012
 
@@ -1008,6 +1127,123 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1008
1127
  |---|---|---|---|---|
1009
1128
  | create | POST | `/search/v1/search` | no | no |
1010
1129
 
1130
+ ## ticket
1131
+
1132
+ ### ticket.activity
1133
+
1134
+ | Method | HTTP | Path | Streaming | Pagination |
1135
+ |---|---|---|---|---|
1136
+ | retrieve | GET | `/ticket/v1/activity` | no | no |
1137
+
1138
+ ### ticket.comments
1139
+
1140
+ | Method | HTTP | Path | Streaming | Pagination |
1141
+ |---|---|---|---|---|
1142
+ | delete | DELETE | `/ticket/v1/comments/{id}` | no | no |
1143
+ | retrieve | GET | `/ticket/v1/comments/{id}` | no | no |
1144
+ | update | PATCH | `/ticket/v1/comments/{id}` | no | no |
1145
+
1146
+ ### ticket.comments.reactions
1147
+
1148
+ | Method | HTTP | Path | Streaming | Pagination |
1149
+ |---|---|---|---|---|
1150
+ | create | POST | `/ticket/v1/comments/{id}/reactions` | no | no |
1151
+ | delete | DELETE | `/ticket/v1/comments/{id}/reactions/{content}` | no | no |
1152
+ | list | GET | `/ticket/v1/comments/{id}/reactions` | no | no |
1153
+
1154
+ ### ticket.labels
1155
+
1156
+ | Method | HTTP | Path | Streaming | Pagination |
1157
+ |---|---|---|---|---|
1158
+ | create | POST | `/ticket/v1/labels` | no | no |
1159
+ | delete | DELETE | `/ticket/v1/labels/{name}` | no | no |
1160
+ | list | GET | `/ticket/v1/labels` | no | no |
1161
+ | update | PATCH | `/ticket/v1/labels/{name}` | no | no |
1162
+
1163
+ ### ticket.milestones
1164
+
1165
+ | Method | HTTP | Path | Streaming | Pagination |
1166
+ |---|---|---|---|---|
1167
+ | create | POST | `/ticket/v1/milestones` | no | no |
1168
+ | delete | DELETE | `/ticket/v1/milestones/{number}` | no | no |
1169
+ | list | GET | `/ticket/v1/milestones` | no | no |
1170
+ | retrieve | GET | `/ticket/v1/milestones/{number}` | no | no |
1171
+ | update | PATCH | `/ticket/v1/milestones/{number}` | no | no |
1172
+
1173
+ ### ticket.repositories
1174
+
1175
+ | Method | HTTP | Path | Streaming | Pagination |
1176
+ |---|---|---|---|---|
1177
+ | list | GET | `/ticket/v1/repositories` | no | no |
1178
+
1179
+ ### ticket.tickets
1180
+
1181
+ | Method | HTTP | Path | Streaming | Pagination |
1182
+ |---|---|---|---|---|
1183
+ | create | POST | `/ticket/v1/tickets` | no | no |
1184
+ | deleteLock | DELETE | `/ticket/v1/tickets/{number}/lock` | no | no |
1185
+ | list | GET | `/ticket/v1/tickets` | no | no |
1186
+ | retrieve | GET | `/ticket/v1/tickets/{number}` | no | no |
1187
+ | update | PATCH | `/ticket/v1/tickets/{number}` | no | no |
1188
+ | updateLock | PUT | `/ticket/v1/tickets/{number}/lock` | no | no |
1189
+
1190
+ ### ticket.tickets.comments
1191
+
1192
+ | Method | HTTP | Path | Streaming | Pagination |
1193
+ |---|---|---|---|---|
1194
+ | create | POST | `/ticket/v1/tickets/{number}/comments` | no | no |
1195
+ | list | GET | `/ticket/v1/tickets/{number}/comments` | no | no |
1196
+
1197
+ ### ticket.tickets.dependencies
1198
+
1199
+ | Method | HTTP | Path | Streaming | Pagination |
1200
+ |---|---|---|---|---|
1201
+ | retrieveBlockedBy | GET | `/ticket/v1/tickets/{number}/dependencies/blocked_by` | no | no |
1202
+ | retrieveBlocking | GET | `/ticket/v1/tickets/{number}/dependencies/blocking` | no | no |
1203
+
1204
+ ### ticket.tickets.dependencies.blockedBy
1205
+
1206
+ | Method | HTTP | Path | Streaming | Pagination |
1207
+ |---|---|---|---|---|
1208
+ | create | POST | `/ticket/v1/tickets/{number}/dependencies/blocked_by` | no | no |
1209
+ | delete | DELETE | `/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}` | no | no |
1210
+
1211
+ ### ticket.tickets.events
1212
+
1213
+ | Method | HTTP | Path | Streaming | Pagination |
1214
+ |---|---|---|---|---|
1215
+ | list | GET | `/ticket/v1/tickets/{number}/events` | no | no |
1216
+
1217
+ ### ticket.tickets.reactions
1218
+
1219
+ | Method | HTTP | Path | Streaming | Pagination |
1220
+ |---|---|---|---|---|
1221
+ | create | POST | `/ticket/v1/tickets/{number}/reactions` | no | no |
1222
+ | delete | DELETE | `/ticket/v1/tickets/{number}/reactions/{content}` | no | no |
1223
+ | list | GET | `/ticket/v1/tickets/{number}/reactions` | no | no |
1224
+
1225
+ ### ticket.tickets.relations
1226
+
1227
+ | Method | HTTP | Path | Streaming | Pagination |
1228
+ |---|---|---|---|---|
1229
+ | create | POST | `/ticket/v1/tickets/{number}/relations` | no | no |
1230
+ | delete | DELETE | `/ticket/v1/tickets/{number}/relations/{n}` | no | no |
1231
+ | list | GET | `/ticket/v1/tickets/{number}/relations` | no | no |
1232
+
1233
+ ### ticket.tickets.subTickets
1234
+
1235
+ | Method | HTTP | Path | Streaming | Pagination |
1236
+ |---|---|---|---|---|
1237
+ | create | POST | `/ticket/v1/tickets/{number}/sub_tickets` | no | no |
1238
+ | delete | DELETE | `/ticket/v1/tickets/{number}/sub_tickets/{child}` | no | no |
1239
+ | list | GET | `/ticket/v1/tickets/{number}/sub_tickets` | no | no |
1240
+
1241
+ ### ticket.types
1242
+
1243
+ | Method | HTTP | Path | Streaming | Pagination |
1244
+ |---|---|---|---|---|
1245
+ | list | GET | `/ticket/v1/types` | no | no |
1246
+
1011
1247
  ## vault
1012
1248
 
1013
1249
  ### vault.authorizations
@@ -1,10 +1,18 @@
1
+ import { type UploadFileOptions, type UploadedFile } from '../helpers/file-upload.js';
1
2
  import { resourceFactories } from '../resources.generated.js';
2
3
  import { type PraxisOptions } from './transport.js';
3
4
  import { type PublishInput, type PublishResult } from '../helpers/application-publish.js';
5
+ import { type CountInput, type CountResult } from '../helpers/database-count.js';
4
6
  type Resources = {
5
7
  readonly [K in keyof typeof resourceFactories]: ReturnType<(typeof resourceFactories)[K]>;
6
8
  };
7
- export interface Praxis extends Omit<Resources, 'application'> {
9
+ export interface Praxis extends Omit<Resources, 'application' | 'database' | 'file'> {
10
+ readonly file: Resources['file'] & {
11
+ uploadFile(file: Blob | File, options: UploadFileOptions): Promise<UploadedFile>;
12
+ };
13
+ readonly database: Resources['database'] & {
14
+ count(input: CountInput): Promise<CountResult>;
15
+ };
8
16
  readonly application: Resources['application'] & {
9
17
  publish(input: PublishInput): Promise<PublishResult>;
10
18
  };
@@ -1,12 +1,18 @@
1
+ import { uploadFile } from "../helpers/file-upload.js";
1
2
  import { resourceFactories } from "../resources.generated.js";
2
3
  import { Transport } from "./transport.js";
3
4
  import { publish } from "../helpers/application-publish.js";
5
+ import { count } from "../helpers/database-count.js";
4
6
  export class Praxis {
5
7
  constructor(options) {
6
8
  const transport = new Transport(options);
7
9
  for (const [name, create] of Object.entries(resourceFactories)) {
8
10
  const resource = create(transport);
9
11
  // Assemble before sealing the resource property; never replace a readonly SDK resource.
12
+ if (name === 'file')
13
+ Object.assign(resource, { uploadFile: (file, options) => uploadFile(this, file, options) });
14
+ if (name === 'database')
15
+ Object.assign(resource, { count: (input) => count(transport, input) });
10
16
  if (name === 'application')
11
17
  Object.assign(resource, { publish: (input) => publish(this, input) });
12
18
  Object.defineProperty(this, name, { value: resource, enumerable: true });
@@ -31,6 +31,11 @@ export declare class Transport {
31
31
  private validate;
32
32
  private scope;
33
33
  request<R>(operation: Operation, options?: InternalOptions): Promise<R>;
34
+ /** Internal helper access to response metadata, with the same request policy. */
35
+ requestWithResponse<R>(operation: Operation, options?: InternalOptions): Promise<{
36
+ data: R;
37
+ response: Response;
38
+ }>;
34
39
  stream<E extends SSEEvent = SSEEvent>(operation: Operation, options?: InternalOptions): AsyncGenerator<E>;
35
40
  }
36
41
  export {};
@@ -92,9 +92,14 @@ export class Transport {
92
92
  };
93
93
  }
94
94
  async request(operation, options = {}) {
95
+ return (await this.requestWithResponse(operation, options)).data;
96
+ }
97
+ /** Internal helper access to response metadata, with the same request policy. */
98
+ async requestWithResponse(operation, options = {}) {
95
99
  const scope = this.scope(options, false);
96
100
  try {
97
- return (await abortable(operation(scope.options), scope.signal)).data;
101
+ const result = await abortable(operation(scope.options), scope.signal);
102
+ return { data: result.data, response: result.response };
98
103
  }
99
104
  finally {
100
105
  scope.close();