@deepraxis/sdk 0.1.0-dev.fe2a6ba → 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 +152 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +348 -24
- package/dist/generated/sdk.gen.js +1058 -23
- package/dist/generated/types.gen.d.ts +16690 -11162
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +1631 -106
- package/dist/operations.generated.js +1974 -64
- package/dist/resources.generated.d.ts +673 -0
- package/dist/resources.generated.js +97 -0
- package/package.json +1 -1
package/METHODS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SDK methods
|
|
2
2
|
|
|
3
|
-
Generated by `bun run generate`.
|
|
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
|
|
|
@@ -55,6 +55,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
55
55
|
|
|
56
56
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
57
57
|
|---|---|---|---|---|
|
|
58
|
+
| apply | POST | `/agent/v1/agents/{agent_id}/versions/{version}/apply` | no | no |
|
|
58
59
|
| list | GET | `/agent/v1/agents/{agent_id}/versions` | no | no |
|
|
59
60
|
|
|
60
61
|
### agent.computers
|
|
@@ -238,6 +239,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
238
239
|
|---|---|---|---|---|
|
|
239
240
|
| list | GET | `/agent/v1/sessions/{session_id}/threads/{thread_id}/events` | no | no |
|
|
240
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
|
+
|
|
241
261
|
### agent.toolsets
|
|
242
262
|
|
|
243
263
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -625,6 +645,20 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
625
645
|
| retrieve | GET | `/file/v1/files/{file_id}` | no | no |
|
|
626
646
|
| retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
|
|
627
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
|
+
|
|
628
662
|
## knowledge
|
|
629
663
|
|
|
630
664
|
### knowledge.vectorStores
|
|
@@ -1093,6 +1127,123 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1093
1127
|
|---|---|---|---|---|
|
|
1094
1128
|
| create | POST | `/search/v1/search` | no | no |
|
|
1095
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
|
+
|
|
1096
1247
|
## vault
|
|
1097
1248
|
|
|
1098
1249
|
### vault.authorizations
|
package/dist/core/client.d.ts
CHANGED
|
@@ -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
|
};
|
package/dist/core/client.js
CHANGED
|
@@ -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 });
|
package/dist/core/transport.d.ts
CHANGED
|
@@ -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 {};
|
package/dist/core/transport.js
CHANGED
|
@@ -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
|
-
|
|
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();
|