@deepraxis/sdk 0.1.1-dev.de0a917 → 0.1.1-dev.df9eeaa
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 +210 -1
- package/README.md +2 -2
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +560 -47
- package/dist/generated/sdk.gen.js +1775 -632
- package/dist/generated/types.gen.d.ts +38429 -30541
- package/dist/operations.generated.d.ts +2943 -788
- package/dist/operations.generated.js +3874 -1165
- package/dist/resources.generated.d.ts +157 -8
- package/dist/resources.generated.js +125 -0
- package/package.json +2 -2
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`. 546 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
|
|
|
@@ -103,6 +103,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
103
103
|
| list | GET | `/agent/v1/computers/{computer_id}/files` | no | no |
|
|
104
104
|
| retrieveContent | GET | `/agent/v1/computers/{computer_id}/files/content` | no | no |
|
|
105
105
|
|
|
106
|
+
### agent.computers.files.convert
|
|
107
|
+
|
|
108
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
109
|
+
|---|---|---|---|---|
|
|
110
|
+
| create | POST | `/agent/v1/computers/{computer_id}/files/convert` | no | no |
|
|
111
|
+
|
|
106
112
|
### agent.computers.leases
|
|
107
113
|
|
|
108
114
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -637,6 +643,99 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
637
643
|
| retrieve | GET | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
638
644
|
| update | PATCH | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
639
645
|
|
|
646
|
+
## crm
|
|
647
|
+
|
|
648
|
+
### crm.associations
|
|
649
|
+
|
|
650
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
651
|
+
|---|---|---|---|---|
|
|
652
|
+
| create | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
|
|
653
|
+
| createDefault | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}` | no | no |
|
|
654
|
+
| list | GET | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}` | no | no |
|
|
655
|
+
| remove | DELETE | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
|
|
656
|
+
|
|
657
|
+
### crm.changes
|
|
658
|
+
|
|
659
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
660
|
+
|---|---|---|---|---|
|
|
661
|
+
| revert | POST | `/crm/v1/changes/{changeSetId}:revert` | no | no |
|
|
662
|
+
|
|
663
|
+
### crm.layouts
|
|
664
|
+
|
|
665
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
666
|
+
|---|---|---|---|---|
|
|
667
|
+
| retrieve | GET | `/crm/v1/layouts/{objectType}` | no | no |
|
|
668
|
+
| update | PUT | `/crm/v1/layouts/{objectType}` | no | no |
|
|
669
|
+
|
|
670
|
+
### crm.leads
|
|
671
|
+
|
|
672
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
673
|
+
|---|---|---|---|---|
|
|
674
|
+
| qualify | POST | `/crm/v1/leads/{leadId}:qualify` | no | no |
|
|
675
|
+
|
|
676
|
+
### crm.objects
|
|
677
|
+
|
|
678
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
679
|
+
|---|---|---|---|---|
|
|
680
|
+
| archive | DELETE | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
681
|
+
| create | POST | `/crm/v1/objects/{objectType}` | no | no |
|
|
682
|
+
| list | GET | `/crm/v1/objects/{objectType}` | no | no |
|
|
683
|
+
| retrieve | GET | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
684
|
+
| search | POST | `/crm/v1/objects/{objectType}/search` | no | no |
|
|
685
|
+
| update | PATCH | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
686
|
+
|
|
687
|
+
### crm.objects.batch
|
|
688
|
+
|
|
689
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
690
|
+
|---|---|---|---|---|
|
|
691
|
+
| archive | POST | `/crm/v1/objects/{objectType}/batch/archive` | no | no |
|
|
692
|
+
| create | POST | `/crm/v1/objects/{objectType}/batch/create` | no | no |
|
|
693
|
+
| read | POST | `/crm/v1/objects/{objectType}/batch/read` | no | no |
|
|
694
|
+
| update | POST | `/crm/v1/objects/{objectType}/batch/update` | no | no |
|
|
695
|
+
| upsert | POST | `/crm/v1/objects/{objectType}/batch/upsert` | no | no |
|
|
696
|
+
|
|
697
|
+
### crm.pipelines
|
|
698
|
+
|
|
699
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
700
|
+
|---|---|---|---|---|
|
|
701
|
+
| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
702
|
+
| create | POST | `/crm/v1/pipelines/{objectType}` | no | no |
|
|
703
|
+
| list | GET | `/crm/v1/pipelines/{objectType}` | no | no |
|
|
704
|
+
| retrieve | GET | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
705
|
+
| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
706
|
+
|
|
707
|
+
### crm.pipelines.stages
|
|
708
|
+
|
|
709
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
710
|
+
|---|---|---|---|---|
|
|
711
|
+
| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
|
|
712
|
+
| create | POST | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages` | no | no |
|
|
713
|
+
| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
|
|
714
|
+
|
|
715
|
+
### crm.properties
|
|
716
|
+
|
|
717
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
718
|
+
|---|---|---|---|---|
|
|
719
|
+
| archive | DELETE | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
720
|
+
| create | POST | `/crm/v1/properties/{objectType}` | no | no |
|
|
721
|
+
| list | GET | `/crm/v1/properties/{objectType}` | no | no |
|
|
722
|
+
| retrieve | GET | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
723
|
+
| update | PATCH | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
724
|
+
|
|
725
|
+
### crm.properties.groups
|
|
726
|
+
|
|
727
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
728
|
+
|---|---|---|---|---|
|
|
729
|
+
| create | POST | `/crm/v1/properties/{objectType}/groups` | no | no |
|
|
730
|
+
| list | GET | `/crm/v1/properties/{objectType}/groups` | no | no |
|
|
731
|
+
|
|
732
|
+
### crm.schemas
|
|
733
|
+
|
|
734
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
735
|
+
|---|---|---|---|---|
|
|
736
|
+
| create | POST | `/crm/v1/schemas` | no | no |
|
|
737
|
+
| list | GET | `/crm/v1/schemas` | no | no |
|
|
738
|
+
|
|
640
739
|
## cut
|
|
641
740
|
|
|
642
741
|
### cut.exports
|
|
@@ -791,6 +890,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
791
890
|
| complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
|
|
792
891
|
| create | POST | `/file/v1/uploads` | no | no |
|
|
793
892
|
| createSigned | POST | `/file/v1/uploads/signed` | no | no |
|
|
893
|
+
| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
|
|
794
894
|
|
|
795
895
|
### file.uploads.parts
|
|
796
896
|
|
|
@@ -874,6 +974,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
874
974
|
|
|
875
975
|
## media
|
|
876
976
|
|
|
977
|
+
### media.generation.capabilities
|
|
978
|
+
|
|
979
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
980
|
+
|---|---|---|---|---|
|
|
981
|
+
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
982
|
+
|
|
877
983
|
### media.libraries
|
|
878
984
|
|
|
879
985
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -896,6 +1002,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
896
1002
|
| retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
897
1003
|
| update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
898
1004
|
|
|
1005
|
+
### media.libraries.assets.frames
|
|
1006
|
+
|
|
1007
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1008
|
+
|---|---|---|---|---|
|
|
1009
|
+
| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
|
|
1010
|
+
|
|
899
1011
|
### media.libraries.assets.import
|
|
900
1012
|
|
|
901
1013
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -939,12 +1051,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
939
1051
|
|---|---|---|---|---|
|
|
940
1052
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
941
1053
|
|
|
1054
|
+
### media.libraries.generations
|
|
1055
|
+
|
|
1056
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1057
|
+
|---|---|---|---|---|
|
|
1058
|
+
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1059
|
+
|
|
942
1060
|
### media.libraries.jobs
|
|
943
1061
|
|
|
944
1062
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
945
1063
|
|---|---|---|---|---|
|
|
1064
|
+
| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
|
|
1065
|
+
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
946
1066
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
947
1067
|
|
|
1068
|
+
### media.libraries.jobs.outputs.save
|
|
1069
|
+
|
|
1070
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1071
|
+
|---|---|---|---|---|
|
|
1072
|
+
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1073
|
+
|
|
948
1074
|
### media.libraries.purge
|
|
949
1075
|
|
|
950
1076
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -975,6 +1101,13 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
975
1101
|
|---|---|---|---|---|
|
|
976
1102
|
| create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
|
|
977
1103
|
|
|
1104
|
+
### media.libraries.understandings
|
|
1105
|
+
|
|
1106
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1107
|
+
|---|---|---|---|---|
|
|
1108
|
+
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1109
|
+
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1110
|
+
|
|
978
1111
|
## meta
|
|
979
1112
|
|
|
980
1113
|
### meta.docs
|
|
@@ -1124,6 +1257,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1124
1257
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
1125
1258
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
1126
1259
|
|
|
1260
|
+
## ontology
|
|
1261
|
+
|
|
1262
|
+
### ontology.changesets
|
|
1263
|
+
|
|
1264
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1265
|
+
|---|---|---|---|---|
|
|
1266
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1267
|
+
|
|
1268
|
+
### ontology.nodes
|
|
1269
|
+
|
|
1270
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1271
|
+
|---|---|---|---|---|
|
|
1272
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1273
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1274
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1275
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1276
|
+
|
|
1277
|
+
### ontology.nodes.merge
|
|
1278
|
+
|
|
1279
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1280
|
+
|---|---|---|---|---|
|
|
1281
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1282
|
+
|
|
1283
|
+
### ontology.relations
|
|
1284
|
+
|
|
1285
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1286
|
+
|---|---|---|---|---|
|
|
1287
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1288
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1289
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1290
|
+
|
|
1291
|
+
### ontology.relations.invalidate
|
|
1292
|
+
|
|
1293
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1294
|
+
|---|---|---|---|---|
|
|
1295
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1296
|
+
|
|
1297
|
+
### ontology.search
|
|
1298
|
+
|
|
1299
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1300
|
+
|---|---|---|---|---|
|
|
1301
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1302
|
+
|
|
1303
|
+
### ontology.types
|
|
1304
|
+
|
|
1305
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1306
|
+
|---|---|---|---|---|
|
|
1307
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1308
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1309
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1310
|
+
|
|
1127
1311
|
## organization
|
|
1128
1312
|
|
|
1129
1313
|
### organization.charges
|
|
@@ -1166,6 +1350,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1166
1350
|
| create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1167
1351
|
| list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1168
1352
|
|
|
1353
|
+
### organization.members
|
|
1354
|
+
|
|
1355
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1356
|
+
|---|---|---|---|---|
|
|
1357
|
+
| list | GET | `/organization/v1/members` | no | no |
|
|
1358
|
+
|
|
1169
1359
|
### organization.usage
|
|
1170
1360
|
|
|
1171
1361
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1532,6 +1722,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1532
1722
|
| automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
|
|
1533
1723
|
| automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1534
1724
|
| automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
|
|
1725
|
+
| crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1726
|
+
| crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1727
|
+
| crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1728
|
+
| crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1729
|
+
| crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1730
|
+
| crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1731
|
+
| crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
|
|
1732
|
+
| crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1733
|
+
| crm.associations.createDefault | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1734
|
+
| crm.associations.list | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1735
|
+
| crm.associations.remove | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1736
|
+
| crm.associations.create | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1737
|
+
| crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1738
|
+
| crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1739
|
+
| crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1740
|
+
| crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1741
|
+
| crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1742
|
+
| crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1743
|
+
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1535
1744
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1536
1745
|
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
1537
1746
|
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Models, agents, sandboxes, search, data and automation, typed end to end.**
|
|
6
6
|
|
|
7
|
-
The official TypeScript SDK for [
|
|
7
|
+
The official TypeScript SDK for [Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
|
|
8
8
|
|
|
9
9
|
[](https://www.npmjs.com/package/@deepraxis/sdk)
|
|
10
10
|
[](https://bundlephobia.com/package/@deepraxis/sdk)
|
|
@@ -276,5 +276,5 @@ sandboxes, search, data, automation and the rest of the platform.
|
|
|
276
276
|
|
|
277
277
|
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). Copyright 2026 南京深度实践人工智能科技有限公司 (Deepractice).
|
|
278
278
|
|
|
279
|
-
"Praxis"
|
|
279
|
+
"Praxis" and "Deepraxis" are trademarks of Deepractice; the license does not grant
|
|
280
280
|
rights to use them.
|