@deepraxis/sdk 0.1.1-dev.f01ff52 → 0.1.1-dev.f0d75b7
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 +360 -13
- package/README.md +2 -2
- package/dist/core/credentials.d.ts +12 -3
- package/dist/core/credentials.js +22 -2
- package/dist/core/transport.d.ts +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +792 -29
- package/dist/generated/sdk.gen.js +3506 -1188
- package/dist/generated/types.gen.d.ts +51030 -37763
- package/dist/helpers/browser-actions.d.ts +84 -0
- package/dist/helpers/browser-actions.js +141 -0
- package/dist/helpers/browser-connect.d.ts +26 -2
- package/dist/helpers/browser-connect.js +263 -25
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +53 -0
- package/dist/helpers/browser-documentation.d.ts +1 -1
- package/dist/helpers/browser-documentation.js +20 -11
- package/dist/operations.generated.d.ts +35 -17832
- package/dist/operations.generated.js +10906 -5870
- package/dist/resources.generated.d.ts +259 -10
- package/dist/resources.generated.js +226 -8
- 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`. 694 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
|
|
|
@@ -576,12 +576,20 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
576
576
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
577
577
|
|---|---|---|---|---|
|
|
578
578
|
| create | POST | `/browser/v1/sessions` | no | no |
|
|
579
|
+
| frames | GET | `/browser/v1/sessions/{sessionId}/frames` | always | no |
|
|
579
580
|
| list | GET | `/browser/v1/sessions` | no | no |
|
|
580
581
|
| retrieve | GET | `/browser/v1/sessions/{sessionId}` | no | no |
|
|
581
582
|
| retrieveDebug | GET | `/browser/v1/sessions/{sessionId}/debug` | no | no |
|
|
583
|
+
| retrieveFrame | GET | `/browser/v1/sessions/{sessionId}/frame` | no | no |
|
|
582
584
|
| stream | GET | `/browser/v1/sessions/{sessionId}/stream` | always | no |
|
|
583
585
|
| update | POST | `/browser/v1/sessions/{sessionId}` | no | no |
|
|
584
586
|
|
|
587
|
+
### browser.sessions.actions
|
|
588
|
+
|
|
589
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
590
|
+
|---|---|---|---|---|
|
|
591
|
+
| create | POST | `/browser/v1/sessions/{sessionId}/actions` | no | no |
|
|
592
|
+
|
|
585
593
|
### browser.sessions.events
|
|
586
594
|
|
|
587
595
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -872,12 +880,113 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
872
880
|
|
|
873
881
|
## devops
|
|
874
882
|
|
|
883
|
+
### devops.changes
|
|
884
|
+
|
|
885
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
886
|
+
|---|---|---|---|---|
|
|
887
|
+
| abandon | POST | `/devops/v1/changes/{id}:abandon` | no | no |
|
|
888
|
+
| markLastSlice | POST | `/devops/v1/changes/{id}:markLastSlice` | no | no |
|
|
889
|
+
| retrieve | GET | `/devops/v1/changes/{id}` | no | no |
|
|
890
|
+
|
|
891
|
+
### devops.environments.checkpoints
|
|
892
|
+
|
|
893
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
894
|
+
|---|---|---|---|---|
|
|
895
|
+
| list | GET | `/devops/v1/environments/{id}/checkpoints` | no | no |
|
|
896
|
+
|
|
897
|
+
### devops.flags
|
|
898
|
+
|
|
899
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
900
|
+
|---|---|---|---|---|
|
|
901
|
+
| archive | POST | `/devops/v1/flags/{id}:archive` | no | no |
|
|
902
|
+
| conclude | POST | `/devops/v1/flags/{id}:conclude` | no | no |
|
|
903
|
+
| retrieve | GET | `/devops/v1/flags/{id}` | no | no |
|
|
904
|
+
| update | PATCH | `/devops/v1/flags/{id}` | no | no |
|
|
905
|
+
|
|
906
|
+
### devops.flags.environments
|
|
907
|
+
|
|
908
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
909
|
+
|---|---|---|---|---|
|
|
910
|
+
| update | PATCH | `/devops/v1/flags/{id}/environments/{environment}` | no | no |
|
|
911
|
+
|
|
912
|
+
### devops.progressiveRollouts
|
|
913
|
+
|
|
914
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
915
|
+
|---|---|---|---|---|
|
|
916
|
+
| create | POST | `/devops/v1/progressive-rollouts` | no | no |
|
|
917
|
+
| pause | POST | `/devops/v1/progressive-rollouts/{id}:pause` | no | no |
|
|
918
|
+
| resume | POST | `/devops/v1/progressive-rollouts/{id}:resume` | no | no |
|
|
919
|
+
| retrieve | GET | `/devops/v1/progressive-rollouts/{id}` | no | no |
|
|
920
|
+
| rollback | POST | `/devops/v1/progressive-rollouts/{id}:rollback` | no | no |
|
|
921
|
+
|
|
875
922
|
### devops.projects
|
|
876
923
|
|
|
877
924
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
878
925
|
|---|---|---|---|---|
|
|
926
|
+
| list | GET | `/devops/v1/projects` | no | no |
|
|
927
|
+
| retrieve | GET | `/devops/v1/projects/{id}` | no | no |
|
|
879
928
|
| retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
|
|
880
929
|
|
|
930
|
+
### devops.projects.changes
|
|
931
|
+
|
|
932
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
933
|
+
|---|---|---|---|---|
|
|
934
|
+
| create | POST | `/devops/v1/projects/{project}/changes` | no | no |
|
|
935
|
+
| list | GET | `/devops/v1/projects/{project}/changes` | no | no |
|
|
936
|
+
|
|
937
|
+
### devops.projects.environments
|
|
938
|
+
|
|
939
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
940
|
+
|---|---|---|---|---|
|
|
941
|
+
| list | GET | `/devops/v1/projects/{project}/environments` | no | no |
|
|
942
|
+
|
|
943
|
+
### devops.projects.environments.targets
|
|
944
|
+
|
|
945
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
946
|
+
|---|---|---|---|---|
|
|
947
|
+
| deleteState | DELETE | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state` | no | no |
|
|
948
|
+
| retrieveState | GET | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state` | no | no |
|
|
949
|
+
|
|
950
|
+
### devops.projects.environments.targets.state
|
|
951
|
+
|
|
952
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
953
|
+
|---|---|---|---|---|
|
|
954
|
+
| create | POST | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state` | no | no |
|
|
955
|
+
| deleteLock | DELETE | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state/lock` | no | no |
|
|
956
|
+
|
|
957
|
+
### devops.projects.environments.targets.state.lock
|
|
958
|
+
|
|
959
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
960
|
+
|---|---|---|---|---|
|
|
961
|
+
| create | POST | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state/lock` | no | no |
|
|
962
|
+
|
|
963
|
+
### devops.projects.flags
|
|
964
|
+
|
|
965
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
966
|
+
|---|---|---|---|---|
|
|
967
|
+
| create | POST | `/devops/v1/projects/{project}/flags` | no | no |
|
|
968
|
+
| list | GET | `/devops/v1/projects/{project}/flags` | no | no |
|
|
969
|
+
|
|
970
|
+
### devops.projects.promotions
|
|
971
|
+
|
|
972
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
973
|
+
|---|---|---|---|---|
|
|
974
|
+
| list | GET | `/devops/v1/projects/{project}/promotions` | no | no |
|
|
975
|
+
|
|
976
|
+
### devops.projects.releases
|
|
977
|
+
|
|
978
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
979
|
+
|---|---|---|---|---|
|
|
980
|
+
| create | POST | `/devops/v1/projects/{project}/releases` | no | no |
|
|
981
|
+
| list | GET | `/devops/v1/projects/{project}/releases` | no | no |
|
|
982
|
+
|
|
983
|
+
### devops.projects.targets
|
|
984
|
+
|
|
985
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
986
|
+
|---|---|---|---|---|
|
|
987
|
+
| list | GET | `/devops/v1/projects/{project}/targets` | no | no |
|
|
988
|
+
| refresh | POST | `/devops/v1/projects/{project}/targets:refresh` | no | no |
|
|
989
|
+
|
|
881
990
|
### devops.projects.testCases
|
|
882
991
|
|
|
883
992
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -910,6 +1019,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
910
1019
|
|---|---|---|---|---|
|
|
911
1020
|
| list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
|
|
912
1021
|
|
|
1022
|
+
### devops.promotions
|
|
1023
|
+
|
|
1024
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1025
|
+
|---|---|---|---|---|
|
|
1026
|
+
| approve | POST | `/devops/v1/promotions/{id}:approve` | no | no |
|
|
1027
|
+
| cancel | POST | `/devops/v1/promotions/{id}:cancel` | no | no |
|
|
1028
|
+
| conclude | POST | `/devops/v1/promotions/{id}:conclude` | no | no |
|
|
1029
|
+
| create | POST | `/devops/v1/promotions` | no | no |
|
|
1030
|
+
| retrieve | GET | `/devops/v1/promotions/{id}` | no | no |
|
|
1031
|
+
| retry | POST | `/devops/v1/promotions/{id}:retry` | no | no |
|
|
1032
|
+
|
|
1033
|
+
### devops.promotions.rollouts
|
|
1034
|
+
|
|
1035
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1036
|
+
|---|---|---|---|---|
|
|
1037
|
+
| list | GET | `/devops/v1/promotions/{promotion}/rollouts` | no | no |
|
|
1038
|
+
|
|
1039
|
+
### devops.releases
|
|
1040
|
+
|
|
1041
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1042
|
+
|---|---|---|---|---|
|
|
1043
|
+
| abandon | POST | `/devops/v1/releases/{id}:abandon` | no | no |
|
|
1044
|
+
| retrieve | GET | `/devops/v1/releases/{id}` | no | no |
|
|
1045
|
+
|
|
1046
|
+
### devops.rollouts
|
|
1047
|
+
|
|
1048
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1049
|
+
|---|---|---|---|---|
|
|
1050
|
+
| retrieve | GET | `/devops/v1/rollouts/{id}` | no | no |
|
|
1051
|
+
|
|
913
1052
|
### devops.testCases
|
|
914
1053
|
|
|
915
1054
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1062,12 +1201,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1062
1201
|
|
|
1063
1202
|
## media
|
|
1064
1203
|
|
|
1204
|
+
### media.assets
|
|
1205
|
+
|
|
1206
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1207
|
+
|---|---|---|---|---|
|
|
1208
|
+
| edit | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/edits` | no | no |
|
|
1209
|
+
| lineage | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | no | no |
|
|
1210
|
+
|
|
1065
1211
|
### media.generation.capabilities
|
|
1066
1212
|
|
|
1067
1213
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1068
1214
|
|---|---|---|---|---|
|
|
1069
1215
|
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
1070
1216
|
|
|
1217
|
+
### media.images
|
|
1218
|
+
|
|
1219
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1220
|
+
|---|---|---|---|---|
|
|
1221
|
+
| generate | POST | `/media/v1/libraries/{library_id}/images/generations` | no | no |
|
|
1222
|
+
|
|
1071
1223
|
### media.libraries
|
|
1072
1224
|
|
|
1073
1225
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1077,6 +1229,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1077
1229
|
| list | GET | `/media/v1/libraries` | no | yes |
|
|
1078
1230
|
| restore | POST | `/media/v1/libraries/{library_id}/restore` | no | no |
|
|
1079
1231
|
| retrieve | GET | `/media/v1/libraries/{library_id}` | no | no |
|
|
1232
|
+
| retrieveDefault | GET | `/media/v1/libraries/default` | no | no |
|
|
1233
|
+
| setDefault | PUT | `/media/v1/libraries/default` | no | no |
|
|
1080
1234
|
| update | PATCH | `/media/v1/libraries/{library_id}` | no | no |
|
|
1081
1235
|
|
|
1082
1236
|
### media.libraries.assets
|
|
@@ -1139,12 +1293,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1139
1293
|
|---|---|---|---|---|
|
|
1140
1294
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
1141
1295
|
|
|
1142
|
-
### media.libraries.generations
|
|
1143
|
-
|
|
1144
|
-
| Method | HTTP | Path | Streaming | Pagination |
|
|
1145
|
-
|---|---|---|---|---|
|
|
1146
|
-
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1147
|
-
|
|
1148
1296
|
### media.libraries.jobs
|
|
1149
1297
|
|
|
1150
1298
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1153,12 +1301,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1153
1301
|
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
1154
1302
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
1155
1303
|
|
|
1156
|
-
### media.libraries.jobs.outputs.save
|
|
1157
|
-
|
|
1158
|
-
| Method | HTTP | Path | Streaming | Pagination |
|
|
1159
|
-
|---|---|---|---|---|
|
|
1160
|
-
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1161
|
-
|
|
1162
1304
|
### media.libraries.purge
|
|
1163
1305
|
|
|
1164
1306
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1196,6 +1338,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1196
1338
|
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1197
1339
|
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1198
1340
|
|
|
1341
|
+
### media.speech
|
|
1342
|
+
|
|
1343
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1344
|
+
|---|---|---|---|---|
|
|
1345
|
+
| create | POST | `/media/v1/libraries/{library_id}/audio/speech` | no | no |
|
|
1346
|
+
|
|
1347
|
+
### media.videos
|
|
1348
|
+
|
|
1349
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1350
|
+
|---|---|---|---|---|
|
|
1351
|
+
| generate | POST | `/media/v1/libraries/{library_id}/videos/generations` | no | no |
|
|
1352
|
+
|
|
1199
1353
|
## meta
|
|
1200
1354
|
|
|
1201
1355
|
### meta.docs
|
|
@@ -1360,6 +1514,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1360
1514
|
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1361
1515
|
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1362
1516
|
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1517
|
+
| retrieveNeighborhood | GET | `/ontology/v1/nodes/{node_id}/neighborhood` | no | no |
|
|
1363
1518
|
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1364
1519
|
|
|
1365
1520
|
### ontology.nodes.merge
|
|
@@ -1452,6 +1607,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1452
1607
|
|
|
1453
1608
|
## sandbox
|
|
1454
1609
|
|
|
1610
|
+
### sandbox.events.sandboxes
|
|
1611
|
+
|
|
1612
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1613
|
+
|---|---|---|---|---|
|
|
1614
|
+
| retrieve | GET | `/sandbox/v1/events/sandboxes/{sandboxID}` | no | no |
|
|
1615
|
+
|
|
1455
1616
|
### sandbox.sandboxes
|
|
1456
1617
|
|
|
1457
1618
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1592,6 +1753,183 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1592
1753
|
|---|---|---|---|---|
|
|
1593
1754
|
| create | POST | `/search/v1/search` | no | no |
|
|
1594
1755
|
|
|
1756
|
+
## studio
|
|
1757
|
+
|
|
1758
|
+
### studio.codexes
|
|
1759
|
+
|
|
1760
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1761
|
+
|---|---|---|---|---|
|
|
1762
|
+
| create | POST | `/studio/v1/codexes` | no | no |
|
|
1763
|
+
| delete | DELETE | `/studio/v1/codexes/{codex}` | no | no |
|
|
1764
|
+
| list | GET | `/studio/v1/codexes` | no | no |
|
|
1765
|
+
| retrieve | GET | `/studio/v1/codexes/{codex}` | no | no |
|
|
1766
|
+
| update | PATCH | `/studio/v1/codexes/{codex}` | no | no |
|
|
1767
|
+
|
|
1768
|
+
### studio.codexes.entries
|
|
1769
|
+
|
|
1770
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1771
|
+
|---|---|---|---|---|
|
|
1772
|
+
| create | POST | `/studio/v1/codexes/{codex}/entries` | no | no |
|
|
1773
|
+
| delete | DELETE | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1774
|
+
| list | GET | `/studio/v1/codexes/{codex}/entries` | no | no |
|
|
1775
|
+
| retrieve | GET | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1776
|
+
| update | PATCH | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1777
|
+
|
|
1778
|
+
### studio.genres
|
|
1779
|
+
|
|
1780
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1781
|
+
|---|---|---|---|---|
|
|
1782
|
+
| list | GET | `/studio/v1/genres` | no | no |
|
|
1783
|
+
| retrieve | GET | `/studio/v1/genres/{genre}` | no | no |
|
|
1784
|
+
|
|
1785
|
+
### studio.platforms
|
|
1786
|
+
|
|
1787
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1788
|
+
|---|---|---|---|---|
|
|
1789
|
+
| list | GET | `/studio/v1/platforms` | no | no |
|
|
1790
|
+
| retrieve | GET | `/studio/v1/platforms/{platform}` | no | no |
|
|
1791
|
+
|
|
1792
|
+
### studio.styles
|
|
1793
|
+
|
|
1794
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1795
|
+
|---|---|---|---|---|
|
|
1796
|
+
| create | POST | `/studio/v1/styles` | no | no |
|
|
1797
|
+
| delete | DELETE | `/studio/v1/styles/{style}` | no | no |
|
|
1798
|
+
| list | GET | `/studio/v1/styles` | no | no |
|
|
1799
|
+
| retrieve | GET | `/studio/v1/styles/{style}` | no | no |
|
|
1800
|
+
| update | PATCH | `/studio/v1/styles/{style}` | no | no |
|
|
1801
|
+
|
|
1802
|
+
### studio.templates
|
|
1803
|
+
|
|
1804
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1805
|
+
|---|---|---|---|---|
|
|
1806
|
+
| create | POST | `/studio/v1/templates` | no | no |
|
|
1807
|
+
| delete | DELETE | `/studio/v1/templates/{template}` | no | no |
|
|
1808
|
+
| list | GET | `/studio/v1/templates` | no | no |
|
|
1809
|
+
| retrieve | GET | `/studio/v1/templates/{template}` | no | no |
|
|
1810
|
+
|
|
1811
|
+
### studio.themes
|
|
1812
|
+
|
|
1813
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1814
|
+
|---|---|---|---|---|
|
|
1815
|
+
| create | POST | `/studio/v1/themes` | no | no |
|
|
1816
|
+
| delete | DELETE | `/studio/v1/themes/{theme}` | no | no |
|
|
1817
|
+
| list | GET | `/studio/v1/themes` | no | no |
|
|
1818
|
+
| retrieve | GET | `/studio/v1/themes/{theme}` | no | no |
|
|
1819
|
+
| update | PATCH | `/studio/v1/themes/{theme}` | no | no |
|
|
1820
|
+
|
|
1821
|
+
### studio.works
|
|
1822
|
+
|
|
1823
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1824
|
+
|---|---|---|---|---|
|
|
1825
|
+
| create | POST | `/studio/v1/works` | no | no |
|
|
1826
|
+
| list | GET | `/studio/v1/works` | no | no |
|
|
1827
|
+
| resolve | GET | `/studio/v1/works:resolve` | no | no |
|
|
1828
|
+
| retrieve | GET | `/studio/v1/works/{work}` | no | no |
|
|
1829
|
+
| update | PATCH | `/studio/v1/works/{work}` | no | no |
|
|
1830
|
+
|
|
1831
|
+
### studio.works.drafts
|
|
1832
|
+
|
|
1833
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1834
|
+
|---|---|---|---|---|
|
|
1835
|
+
| create | POST | `/studio/v1/works/{work}/drafts` | no | no |
|
|
1836
|
+
| list | GET | `/studio/v1/works/{work}/drafts` | no | no |
|
|
1837
|
+
| rebase | POST | `/studio/v1/works/{work}/drafts/{draft}:rebase` | no | no |
|
|
1838
|
+
| retrieve | GET | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1839
|
+
| retrieveExport | GET | `/studio/v1/works/{work}/drafts/{draft}/export` | no | no |
|
|
1840
|
+
| retrieveOutline | GET | `/studio/v1/works/{work}/drafts/{draft}/outline` | no | no |
|
|
1841
|
+
| retrieveReview | GET | `/studio/v1/works/{work}/drafts/{draft}/review` | no | no |
|
|
1842
|
+
| update | PATCH | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1843
|
+
| updateBrief | PATCH | `/studio/v1/works/{work}/drafts/{draft}/brief` | no | no |
|
|
1844
|
+
|
|
1845
|
+
### studio.works.drafts.foreshadows
|
|
1846
|
+
|
|
1847
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1848
|
+
|---|---|---|---|---|
|
|
1849
|
+
| delete | DELETE | `/studio/v1/works/{work}/drafts/{draft}/foreshadows/{key}` | no | no |
|
|
1850
|
+
| list | GET | `/studio/v1/works/{work}/drafts/{draft}/foreshadows` | no | no |
|
|
1851
|
+
| update | PUT | `/studio/v1/works/{work}/drafts/{draft}/foreshadows/{key}` | no | no |
|
|
1852
|
+
|
|
1853
|
+
### studio.works.drafts.renditions
|
|
1854
|
+
|
|
1855
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1856
|
+
|---|---|---|---|---|
|
|
1857
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/renditions` | no | no |
|
|
1858
|
+
|
|
1859
|
+
### studio.works.drafts.status
|
|
1860
|
+
|
|
1861
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1862
|
+
|---|---|---|---|---|
|
|
1863
|
+
| list | GET | `/studio/v1/works/{work}/drafts/{draft}/status` | no | no |
|
|
1864
|
+
|
|
1865
|
+
### studio.works.drafts.units
|
|
1866
|
+
|
|
1867
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1868
|
+
|---|---|---|---|---|
|
|
1869
|
+
| batchCreate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchCreate` | no | no |
|
|
1870
|
+
| batchUpdate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchUpdate` | no | no |
|
|
1871
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/units` | no | no |
|
|
1872
|
+
|
|
1873
|
+
### studio.works.progressions
|
|
1874
|
+
|
|
1875
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1876
|
+
|---|---|---|---|---|
|
|
1877
|
+
| create | POST | `/studio/v1/works/{work}/progressions` | no | no |
|
|
1878
|
+
| delete | DELETE | `/studio/v1/works/{work}/progressions/{id}` | no | no |
|
|
1879
|
+
| list | GET | `/studio/v1/works/{work}/progressions` | no | no |
|
|
1880
|
+
|
|
1881
|
+
### studio.works.renditions
|
|
1882
|
+
|
|
1883
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1884
|
+
|---|---|---|---|---|
|
|
1885
|
+
| delete | DELETE | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1886
|
+
| list | GET | `/studio/v1/works/{work}/renditions` | no | no |
|
|
1887
|
+
| publish | POST | `/studio/v1/works/{work}/renditions/{rendition}:publish` | no | no |
|
|
1888
|
+
| render | POST | `/studio/v1/works/{work}/renditions/{rendition}:render` | no | no |
|
|
1889
|
+
| retrieve | GET | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1890
|
+
| retrieveContent | GET | `/studio/v1/works/{work}/renditions/{rendition}/content` | no | no |
|
|
1891
|
+
| update | PATCH | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1892
|
+
|
|
1893
|
+
### studio.works.reviewSettings
|
|
1894
|
+
|
|
1895
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1896
|
+
|---|---|---|---|---|
|
|
1897
|
+
| retrieve | GET | `/studio/v1/works/{work}/review-settings` | no | no |
|
|
1898
|
+
| update | PATCH | `/studio/v1/works/{work}/review-settings` | no | no |
|
|
1899
|
+
|
|
1900
|
+
### studio.works.reviewers
|
|
1901
|
+
|
|
1902
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1903
|
+
|---|---|---|---|---|
|
|
1904
|
+
| create | POST | `/studio/v1/works/{work}/reviewers` | no | no |
|
|
1905
|
+
| delete | DELETE | `/studio/v1/works/{work}/reviewers/{agent}` | no | no |
|
|
1906
|
+
| list | GET | `/studio/v1/works/{work}/reviewers` | no | no |
|
|
1907
|
+
| update | PATCH | `/studio/v1/works/{work}/reviewers/{agent}` | no | no |
|
|
1908
|
+
|
|
1909
|
+
### studio.works.reviews
|
|
1910
|
+
|
|
1911
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1912
|
+
|---|---|---|---|---|
|
|
1913
|
+
| cancel | POST | `/studio/v1/works/{work}/reviews/{review}:cancel` | no | no |
|
|
1914
|
+
| create | POST | `/studio/v1/works/{work}/reviews` | no | no |
|
|
1915
|
+
| list | GET | `/studio/v1/works/{work}/reviews` | no | no |
|
|
1916
|
+
| retrieve | GET | `/studio/v1/works/{work}/reviews/{review}` | no | no |
|
|
1917
|
+
|
|
1918
|
+
### studio.works.units
|
|
1919
|
+
|
|
1920
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1921
|
+
|---|---|---|---|---|
|
|
1922
|
+
| move | POST | `/studio/v1/works/{work}/units/{unit}:move` | no | no |
|
|
1923
|
+
| retrieve | GET | `/studio/v1/works/{work}/units/{unit}` | no | no |
|
|
1924
|
+
| retrieveContext | GET | `/studio/v1/works/{work}/units/{unit}/context` | no | no |
|
|
1925
|
+
| update | PATCH | `/studio/v1/works/{work}/units/{unit}` | no | no |
|
|
1926
|
+
|
|
1927
|
+
### studio.works.units.blocks
|
|
1928
|
+
|
|
1929
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1930
|
+
|---|---|---|---|---|
|
|
1931
|
+
| patch | POST | `/studio/v1/works/{work}/units/{unit}/blocks:patch` | no | no |
|
|
1932
|
+
|
|
1595
1933
|
## ticket
|
|
1596
1934
|
|
|
1597
1935
|
### ticket.activity
|
|
@@ -1640,6 +1978,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1640
1978
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1641
1979
|
|---|---|---|---|---|
|
|
1642
1980
|
| list | GET | `/ticket/v1/repositories` | no | no |
|
|
1981
|
+
| update | PATCH | `/ticket/v1/repositories/{id}` | no | no |
|
|
1643
1982
|
|
|
1644
1983
|
### ticket.tickets
|
|
1645
1984
|
|
|
@@ -1831,11 +2170,19 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1831
2170
|
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1832
2171
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1833
2172
|
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
2173
|
+
| media.libraries.retrieveDefault | ADR-094 §9 names the default-library read libraries.retrieveDefault; the URL names a reference rather than an id, so the path-derived name would otherwise read as retrieving a library called default. |
|
|
2174
|
+
| media.libraries.setDefault | ADR-094 §9 names the default-library write libraries.setDefault; the URL has no library id because the organization owns one default library, so the path alone cannot say which. |
|
|
2175
|
+
| media.assets.edit | ADR-094 §9 names the edit write assets.edit; an edit acts on the addressed asset and returns a Job, so the URL nesting under a library is a mount rather than an SDK resource level. |
|
|
2176
|
+
| media.assets.lineage | ADR-094 §9 names the edit-tree read assets.lineage; lineage is the product verb and the URL nesting under a library is a mount, not an SDK resource level. |
|
|
2177
|
+
| media.speech.create | ADR-094 §1/§9 names speech synthesis speech.create; the URL says audio/speech because that is the artifact the caller gets back, and the path alone would derive a speech collection create under an audio level that is not an SDK resource. |
|
|
2178
|
+
| media.images.generate | ADR-094 §9 names image generation images.generate; the URL mounts it under a library, but generation is an operation on images and the path alone would derive a generations collection create. |
|
|
2179
|
+
| media.videos.generate | ADR-094 §2/§9 names video generation videos.generate beside images.generate; the URL mounts it under a library, but generation is an operation on videos and the path alone would derive a generations collection create. The unqualified videos resource is the video lane, distinct from the batch and legacy job resources. |
|
|
1834
2180
|
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1835
2181
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1836
2182
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1837
2183
|
| sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1838
2184
|
| sandbox.sandboxes.files.write | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
2185
|
+
| studio.works.reviewSettings.retrieve | A work has one review-settings singleton; the segment ends in s only because English writes it that way, so the collection rule would derive reviewSettings.list for a read that returns the settings object itself. |
|
|
1839
2186
|
| vault.oauth.retrieveClientMetadata | The literal .json filename otherwise introduces a dot inside a method identifier. |
|
|
1840
2187
|
|
|
1841
2188
|
## SDK parameter aliases
|
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ console.log(completion.choices[0]?.message.content);
|
|
|
33
33
|
## Why this SDK
|
|
34
34
|
|
|
35
35
|
- **The whole platform, one client.** About 350 operations across models, agents, sandboxes,
|
|
36
|
-
|
|
36
|
+
browsers, web search, databases, knowledge bases, files, media, automation and hosted
|
|
37
37
|
applications, generated from the same contract as the API.
|
|
38
38
|
- **Types from the contract.** Every path, query, body and response is typed, including the
|
|
39
39
|
events of each stream, so your editor knows what comes back.
|
|
@@ -122,7 +122,7 @@ conversation with it, on its own machine.
|
|
|
122
122
|
```ts
|
|
123
123
|
const { sandboxes } = praxis.sandbox;
|
|
124
124
|
const sandbox = await sandboxes.create({
|
|
125
|
-
body: { templateID: 'base' },
|
|
125
|
+
body: { templateID: 'base', autoPause: false }, // ends at its timeout; autoPause: true keeps a long-lived computer
|
|
126
126
|
});
|
|
127
127
|
const result = await sandboxes.commands.run({
|
|
128
128
|
path: { sandbox_id: sandbox.sandboxID },
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Default credential chain for code running on a Praxis computer (ticket-5367):
|
|
3
|
-
* PRAXIS_API_TOKEN environment variable, then
|
|
4
|
-
*
|
|
2
|
+
* Default credential chain for code running on a Praxis computer (ticket-5367, ADR-098 §2):
|
|
3
|
+
* the PRAXIS_API_TOKEN environment variable, then the login file of the environment,
|
|
4
|
+
* `~/.praxis/cli/<env>.json` — the one file `praxis login` writes for a person and the platform writes
|
|
5
|
+
* for a managed login. Resolved at call time so a token the platform renewed in the file is picked up
|
|
6
|
+
* by an already-running process.
|
|
5
7
|
*/
|
|
6
8
|
export interface ResolvedCredentials {
|
|
7
9
|
token?: string;
|
|
@@ -9,6 +11,13 @@ export interface ResolvedCredentials {
|
|
|
9
11
|
}
|
|
10
12
|
type Env = Record<string, string | undefined>;
|
|
11
13
|
type ReadFile = (path: string) => string | null;
|
|
14
|
+
/**
|
|
15
|
+
* Which environment's login file applies: PRAXIS_ENV when it names one, otherwise a `-develop.` host in
|
|
16
|
+
* PRAXIS_API_URL means develop and any other host production — the rule apps/cli/src/config/env.ts
|
|
17
|
+
* applies. A PRAXIS_ENV that is not a plain name is no environment at all and is ignored. Pure.
|
|
18
|
+
*/
|
|
19
|
+
export declare function credentialsEnv(env: Env): string;
|
|
20
|
+
/** The one login file, the same path the CLI reads for this environment. Null without a home directory. Pure. */
|
|
12
21
|
export declare function credentialsPath(env: Env): string | null;
|
|
13
22
|
export declare function resolveDefaultCredentials(env?: Env, readFile?: ReadFile): ResolvedCredentials;
|
|
14
23
|
export {};
|
package/dist/core/credentials.js
CHANGED
|
@@ -8,9 +8,29 @@ function defaultReadFile(path) {
|
|
|
8
8
|
return null;
|
|
9
9
|
}
|
|
10
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* Which environment's login file applies: PRAXIS_ENV when it names one, otherwise a `-develop.` host in
|
|
13
|
+
* PRAXIS_API_URL means develop and any other host production — the rule apps/cli/src/config/env.ts
|
|
14
|
+
* applies. A PRAXIS_ENV that is not a plain name is no environment at all and is ignored. Pure.
|
|
15
|
+
*/
|
|
16
|
+
export function credentialsEnv(env) {
|
|
17
|
+
const declared = nonEmpty(env.PRAXIS_ENV);
|
|
18
|
+
if (declared && /^[A-Za-z0-9_-]+$/.test(declared))
|
|
19
|
+
return declared;
|
|
20
|
+
const apiUrl = nonEmpty(env.PRAXIS_API_URL);
|
|
21
|
+
if (apiUrl) {
|
|
22
|
+
try {
|
|
23
|
+
if (new URL(apiUrl).hostname.includes('-develop.'))
|
|
24
|
+
return 'develop';
|
|
25
|
+
}
|
|
26
|
+
catch { /* a malformed URL is not evidence of develop */ }
|
|
27
|
+
}
|
|
28
|
+
return 'production';
|
|
29
|
+
}
|
|
30
|
+
/** The one login file, the same path the CLI reads for this environment. Null without a home directory. Pure. */
|
|
11
31
|
export function credentialsPath(env) {
|
|
12
32
|
const home = nonEmpty(env.HOME) ?? nonEmpty(env.USERPROFILE);
|
|
13
|
-
return home ? `${home.replace(
|
|
33
|
+
return home ? `${home.replace(/[/\\]+$/, '')}/.praxis/cli/${credentialsEnv(env)}.json` : null;
|
|
14
34
|
}
|
|
15
35
|
export function resolveDefaultCredentials(env = globalThis.process?.env ?? {}, readFile = defaultReadFile) {
|
|
16
36
|
const envToken = nonEmpty(env.PRAXIS_API_TOKEN);
|
|
@@ -23,7 +43,7 @@ export function resolveDefaultCredentials(env = globalThis.process?.env ?? {}, r
|
|
|
23
43
|
return envUrl ? { apiUrl: envUrl } : {};
|
|
24
44
|
try {
|
|
25
45
|
const file = JSON.parse(text);
|
|
26
|
-
const token = nonEmpty(file.
|
|
46
|
+
const token = nonEmpty(file.access_token);
|
|
27
47
|
const apiUrl = envUrl ?? nonEmpty(file.api_url);
|
|
28
48
|
return { ...(token ? { token } : {}), ...(apiUrl ? { apiUrl } : {}) };
|
|
29
49
|
}
|
package/dist/core/transport.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type SSEEvent } from './sse.js';
|
|
2
2
|
export interface PraxisOptions {
|
|
3
|
-
/** Explicit key. Omitted on a Praxis computer: PRAXIS_API_TOKEN, then
|
|
3
|
+
/** Explicit key. Omitted on a Praxis computer: PRAXIS_API_TOKEN, then the login file `~/.praxis/cli/<env>.json`, are used. */
|
|
4
4
|
apiKey?: string;
|
|
5
5
|
baseUrl?: string;
|
|
6
6
|
timeoutMs?: number;
|