@deepraxis/sdk 0.1.1-dev.d25d171 → 0.1.1-dev.da4893e

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`. 426 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`. 525 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
 
@@ -16,8 +16,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
16
16
  | create | POST | `/agent/v1/agents` | no | no |
17
17
  | list | GET | `/agent/v1/agents` | no | no |
18
18
  | retrieve | GET | `/agent/v1/agents/{agent_id}` | no | no |
19
+ | retrieveAppearance | GET | `/agent/v1/agents/{agent_id}/appearance` | no | no |
19
20
  | update | POST | `/agent/v1/agents/{agent_id}` | no | no |
20
21
 
22
+ ### agent.agents.customers
23
+
24
+ | Method | HTTP | Path | Streaming | Pagination |
25
+ |---|---|---|---|---|
26
+ | delete | DELETE | `/agent/v1/agents/{agent_id}/customers/{customer_id}` | no | no |
27
+ | list | GET | `/agent/v1/agents/{agent_id}/customers` | no | no |
28
+ | retrieve | GET | `/agent/v1/agents/{agent_id}/customers/{customer_id}` | no | no |
29
+ | retrieveDeletion | GET | `/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion` | no | no |
30
+
21
31
  ### agent.agents.customers.auth.accessTokens
22
32
 
23
33
  | Method | HTTP | Path | Streaming | Pagination |
@@ -37,32 +47,23 @@ Multipart request bodies expand plain objects into bracketed fields (for example
37
47
  |---|---|---|---|---|
38
48
  | create | POST | `/agent/v1/agents/{agent_id}/customers/auth/grant_codes` | no | no |
39
49
 
40
- ### agent.agents.endUsers
41
-
42
- | Method | HTTP | Path | Streaming | Pagination |
43
- |---|---|---|---|---|
44
- | delete | DELETE | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | no | no |
45
- | list | GET | `/agent/v1/agents/{agent_id}/end_users` | no | no |
46
- | retrieve | GET | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | no | no |
47
- | retrieveDeletion | GET | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion` | no | no |
48
-
49
- ### agent.agents.endUsers.block
50
+ ### agent.agents.customers.block
50
51
 
51
52
  | Method | HTTP | Path | Streaming | Pagination |
52
53
  |---|---|---|---|---|
53
- | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block` | no | no |
54
+ | create | POST | `/agent/v1/agents/{agent_id}/customers/{customer_id}/block` | no | no |
54
55
 
55
- ### agent.agents.endUsers.revokeTokens
56
+ ### agent.agents.customers.revokeTokens
56
57
 
57
58
  | Method | HTTP | Path | Streaming | Pagination |
58
59
  |---|---|---|---|---|
59
- | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens` | no | no |
60
+ | create | POST | `/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens` | no | no |
60
61
 
61
- ### agent.agents.endUsers.unblock
62
+ ### agent.agents.customers.unblock
62
63
 
63
64
  | Method | HTTP | Path | Streaming | Pagination |
64
65
  |---|---|---|---|---|
65
- | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock` | no | no |
66
+ | create | POST | `/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock` | no | no |
66
67
 
67
68
  ### agent.agents.unarchive
68
69
 
@@ -144,37 +145,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
144
145
  |---|---|---|---|---|
145
146
  | create | POST | `/agent/v1/deployments/{deployment_id}/unpause` | no | no |
146
147
 
147
- ### agent.embed
148
-
149
- | Method | HTTP | Path | Streaming | Pagination |
150
- |---|---|---|---|---|
151
- | retrieveAppearance | GET | `/agent/v1/embed/appearance` | no | no |
152
-
153
- ### agent.embed.exchange
154
-
155
- | Method | HTTP | Path | Streaming | Pagination |
156
- |---|---|---|---|---|
157
- | create | POST | `/agent/v1/embed/exchange` | no | no |
158
-
159
- ### agent.embedTokens
160
-
161
- | Method | HTTP | Path | Streaming | Pagination |
162
- |---|---|---|---|---|
163
- | create | POST | `/agent/v1/embed_tokens` | no | no |
164
- | list | GET | `/agent/v1/embed_tokens` | no | no |
165
-
166
- ### agent.embedTokens.anonymous
167
-
168
- | Method | HTTP | Path | Streaming | Pagination |
169
- |---|---|---|---|---|
170
- | create | POST | `/agent/v1/embed_tokens/anonymous` | no | no |
171
-
172
- ### agent.embedTokens.revoke
173
-
174
- | Method | HTTP | Path | Streaming | Pagination |
175
- |---|---|---|---|---|
176
- | create | POST | `/agent/v1/embed_tokens/{id}/revoke` | no | no |
177
-
178
148
  ### agent.environments
179
149
 
180
150
  | Method | HTTP | Path | Streaming | Pagination |
@@ -404,6 +374,16 @@ Multipart request bodies expand plain objects into bracketed fields (for example
404
374
  |---|---|---|---|---|
405
375
  | send | POST | `/automation/v1/hooks/{trigger_id}/{token}` | no | no |
406
376
 
377
+ ### automation.humanTasks
378
+
379
+ | Method | HTTP | Path | Streaming | Pagination |
380
+ |---|---|---|---|---|
381
+ | cancel | POST | `/automation/v1/human-tasks/{id}/cancel` | no | no |
382
+ | delegate | POST | `/automation/v1/human-tasks/{id}/delegate` | no | no |
383
+ | list | GET | `/automation/v1/human-tasks` | no | yes |
384
+ | respond | POST | `/automation/v1/human-tasks/{id}/respond` | no | no |
385
+ | retrieve | GET | `/automation/v1/human-tasks/{id}` | no | no |
386
+
407
387
  ### automation.resolve
408
388
 
409
389
  | Method | HTTP | Path | Streaming | Pagination |
@@ -469,6 +449,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
469
449
  | list | GET | `/automation/v1/scripts/{ns}/{name}/dist-tags` | no | no |
470
450
  | set | PUT | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
471
451
 
452
+ ### automation.scripts.vaults
453
+
454
+ | Method | HTTP | Path | Streaming | Pagination |
455
+ |---|---|---|---|---|
456
+ | delete | DELETE | `/automation/v1/scripts/{ns}/{name}/vaults/{alias}` | no | no |
457
+ | list | GET | `/automation/v1/scripts/{ns}/{name}/vaults` | no | no |
458
+ | set | PUT | `/automation/v1/scripts/{ns}/{name}/vaults/{alias}` | no | no |
459
+
472
460
  ### automation.scripts.versions
473
461
 
474
462
  | Method | HTTP | Path | Streaming | Pagination |
@@ -530,6 +518,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
530
518
  | list | GET | `/automation/v1/workflows/{ns}/{name}/dist-tags` | no | no |
531
519
  | set | PUT | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
532
520
 
521
+ ### automation.workflows.vaults
522
+
523
+ | Method | HTTP | Path | Streaming | Pagination |
524
+ |---|---|---|---|---|
525
+ | delete | DELETE | `/automation/v1/workflows/{ns}/{name}/vaults/{alias}` | no | no |
526
+ | list | GET | `/automation/v1/workflows/{ns}/{name}/vaults` | no | no |
527
+ | set | PUT | `/automation/v1/workflows/{ns}/{name}/vaults/{alias}` | no | no |
528
+
533
529
  ### automation.workflows.versions
534
530
 
535
531
  | Method | HTTP | Path | Streaming | Pagination |
@@ -599,6 +595,210 @@ Multipart request bodies expand plain objects into bracketed fields (for example
599
595
  |---|---|---|---|---|
600
596
  | create | POST | `/browser/v1/sessions/{sessionId}/viewer` | no | no |
601
597
 
598
+ ## canvas
599
+
600
+ ### canvas.canvases
601
+
602
+ | Method | HTTP | Path | Streaming | Pagination |
603
+ |---|---|---|---|---|
604
+ | create | POST | `/canvas/v1/canvases` | no | no |
605
+ | delete | DELETE | `/canvas/v1/canvases/{canvas_id}` | no | no |
606
+ | execute | POST | `/canvas/v1/canvases/{canvas_id}:execute` | no | no |
607
+ | list | GET | `/canvas/v1/canvases` | no | yes |
608
+ | restore | POST | `/canvas/v1/canvases/{canvas_id}:restore` | no | no |
609
+ | retrieve | GET | `/canvas/v1/canvases/{canvas_id}` | no | no |
610
+ | update | PATCH | `/canvas/v1/canvases/{canvas_id}` | no | no |
611
+
612
+ ### canvas.canvases.images
613
+
614
+ | Method | HTTP | Path | Streaming | Pagination |
615
+ |---|---|---|---|---|
616
+ | list | GET | `/canvas/v1/canvases/{canvas_id}/images` | no | no |
617
+
618
+ ### canvas.canvases.nodes
619
+
620
+ | Method | HTTP | Path | Streaming | Pagination |
621
+ |---|---|---|---|---|
622
+ | list | GET | `/canvas/v1/canvases/{canvas_id}/nodes` | no | no |
623
+
624
+ ### canvas.canvases.versions
625
+
626
+ | Method | HTTP | Path | Streaming | Pagination |
627
+ |---|---|---|---|---|
628
+ | list | GET | `/canvas/v1/canvases/{canvas_id}/versions` | no | no |
629
+
630
+ ### canvas.collections
631
+
632
+ | Method | HTTP | Path | Streaming | Pagination |
633
+ |---|---|---|---|---|
634
+ | create | POST | `/canvas/v1/collections` | no | no |
635
+ | delete | DELETE | `/canvas/v1/collections/{collection_id}` | no | no |
636
+ | list | GET | `/canvas/v1/collections` | no | no |
637
+ | retrieve | GET | `/canvas/v1/collections/{collection_id}` | no | no |
638
+ | update | PATCH | `/canvas/v1/collections/{collection_id}` | no | no |
639
+
640
+ ## crm
641
+
642
+ ### crm.associations
643
+
644
+ | Method | HTTP | Path | Streaming | Pagination |
645
+ |---|---|---|---|---|
646
+ | create | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
647
+ | createDefault | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}` | no | no |
648
+ | list | GET | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}` | no | no |
649
+ | remove | DELETE | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
650
+
651
+ ### crm.changes
652
+
653
+ | Method | HTTP | Path | Streaming | Pagination |
654
+ |---|---|---|---|---|
655
+ | revert | POST | `/crm/v1/changes/{changeSetId}:revert` | no | no |
656
+
657
+ ### crm.layouts
658
+
659
+ | Method | HTTP | Path | Streaming | Pagination |
660
+ |---|---|---|---|---|
661
+ | retrieve | GET | `/crm/v1/layouts/{objectType}` | no | no |
662
+ | update | PUT | `/crm/v1/layouts/{objectType}` | no | no |
663
+
664
+ ### crm.leads
665
+
666
+ | Method | HTTP | Path | Streaming | Pagination |
667
+ |---|---|---|---|---|
668
+ | qualify | POST | `/crm/v1/leads/{leadId}:qualify` | no | no |
669
+
670
+ ### crm.objects
671
+
672
+ | Method | HTTP | Path | Streaming | Pagination |
673
+ |---|---|---|---|---|
674
+ | archive | DELETE | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
675
+ | create | POST | `/crm/v1/objects/{objectType}` | no | no |
676
+ | list | GET | `/crm/v1/objects/{objectType}` | no | no |
677
+ | retrieve | GET | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
678
+ | search | POST | `/crm/v1/objects/{objectType}/search` | no | no |
679
+ | update | PATCH | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
680
+
681
+ ### crm.objects.batch
682
+
683
+ | Method | HTTP | Path | Streaming | Pagination |
684
+ |---|---|---|---|---|
685
+ | archive | POST | `/crm/v1/objects/{objectType}/batch/archive` | no | no |
686
+ | create | POST | `/crm/v1/objects/{objectType}/batch/create` | no | no |
687
+ | read | POST | `/crm/v1/objects/{objectType}/batch/read` | no | no |
688
+ | update | POST | `/crm/v1/objects/{objectType}/batch/update` | no | no |
689
+ | upsert | POST | `/crm/v1/objects/{objectType}/batch/upsert` | no | no |
690
+
691
+ ### crm.pipelines
692
+
693
+ | Method | HTTP | Path | Streaming | Pagination |
694
+ |---|---|---|---|---|
695
+ | archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
696
+ | create | POST | `/crm/v1/pipelines/{objectType}` | no | no |
697
+ | list | GET | `/crm/v1/pipelines/{objectType}` | no | no |
698
+ | retrieve | GET | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
699
+ | update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
700
+
701
+ ### crm.pipelines.stages
702
+
703
+ | Method | HTTP | Path | Streaming | Pagination |
704
+ |---|---|---|---|---|
705
+ | archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
706
+ | create | POST | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages` | no | no |
707
+ | update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
708
+
709
+ ### crm.properties
710
+
711
+ | Method | HTTP | Path | Streaming | Pagination |
712
+ |---|---|---|---|---|
713
+ | archive | DELETE | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
714
+ | create | POST | `/crm/v1/properties/{objectType}` | no | no |
715
+ | list | GET | `/crm/v1/properties/{objectType}` | no | no |
716
+ | retrieve | GET | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
717
+ | update | PATCH | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
718
+
719
+ ### crm.properties.groups
720
+
721
+ | Method | HTTP | Path | Streaming | Pagination |
722
+ |---|---|---|---|---|
723
+ | create | POST | `/crm/v1/properties/{objectType}/groups` | no | no |
724
+ | list | GET | `/crm/v1/properties/{objectType}/groups` | no | no |
725
+
726
+ ### crm.schemas
727
+
728
+ | Method | HTTP | Path | Streaming | Pagination |
729
+ |---|---|---|---|---|
730
+ | create | POST | `/crm/v1/schemas` | no | no |
731
+ | list | GET | `/crm/v1/schemas` | no | no |
732
+
733
+ ## cut
734
+
735
+ ### cut.exports
736
+
737
+ | Method | HTTP | Path | Streaming | Pagination |
738
+ |---|---|---|---|---|
739
+ | cancel | POST | `/cut/v1/exports/{export_id}:cancel` | no | no |
740
+ | retrieve | GET | `/cut/v1/exports/{export_id}` | no | no |
741
+
742
+ ### cut.projects
743
+
744
+ | Method | HTTP | Path | Streaming | Pagination |
745
+ |---|---|---|---|---|
746
+ | create | POST | `/cut/v1/projects` | no | no |
747
+ | delete | DELETE | `/cut/v1/projects/{project_id}` | no | no |
748
+ | execute | POST | `/cut/v1/projects/{project_id}:execute` | no | no |
749
+ | list | GET | `/cut/v1/projects` | no | no |
750
+ | retrieve | GET | `/cut/v1/projects/{project_id}` | no | no |
751
+ | retrieveState | GET | `/cut/v1/projects/{project_id}/state` | no | no |
752
+ | retrieveTimeline | GET | `/cut/v1/projects/{project_id}/timeline` | no | no |
753
+ | undelete | POST | `/cut/v1/projects/{project_id}:undelete` | no | no |
754
+ | update | PATCH | `/cut/v1/projects/{project_id}` | no | no |
755
+
756
+ ### cut.projects.analysis
757
+
758
+ | Method | HTTP | Path | Streaming | Pagination |
759
+ |---|---|---|---|---|
760
+ | create | POST | `/cut/v1/projects/{project_id}/analysis` | no | no |
761
+
762
+ ### cut.projects.bindings
763
+
764
+ | Method | HTTP | Path | Streaming | Pagination |
765
+ |---|---|---|---|---|
766
+ | create | POST | `/cut/v1/projects/{project_id}/bindings` | no | no |
767
+ | delete | DELETE | `/cut/v1/projects/{project_id}/bindings/{name}` | no | no |
768
+ | list | GET | `/cut/v1/projects/{project_id}/bindings` | no | no |
769
+
770
+ ### cut.projects.exports
771
+
772
+ | Method | HTTP | Path | Streaming | Pagination |
773
+ |---|---|---|---|---|
774
+ | create | POST | `/cut/v1/projects/{project_id}/exports` | no | no |
775
+ | list | GET | `/cut/v1/projects/{project_id}/exports` | no | no |
776
+
777
+ ### cut.projects.frames
778
+
779
+ | Method | HTTP | Path | Streaming | Pagination |
780
+ |---|---|---|---|---|
781
+ | list | GET | `/cut/v1/projects/{project_id}/frames` | no | no |
782
+
783
+ ### cut.projects.media
784
+
785
+ | Method | HTTP | Path | Streaming | Pagination |
786
+ |---|---|---|---|---|
787
+ | import | POST | `/cut/v1/projects/{project_id}/media:import` | no | no |
788
+
789
+ ### cut.projects.versions
790
+
791
+ | Method | HTTP | Path | Streaming | Pagination |
792
+ |---|---|---|---|---|
793
+ | create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
794
+ | list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
795
+
796
+ ### cut.versions
797
+
798
+ | Method | HTTP | Path | Streaming | Pagination |
799
+ |---|---|---|---|---|
800
+ | restore | POST | `/cut/v1/versions/{version_id}:restore` | no | no |
801
+
602
802
  ## database
603
803
 
604
804
  ### database.databases
@@ -664,6 +864,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
664
864
  | retrieve | GET | `/file/v1/files/{file_id}` | no | no |
665
865
  | retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
666
866
 
867
+ ### file.files.contentLinks
868
+
869
+ | Method | HTTP | Path | Streaming | Pagination |
870
+ |---|---|---|---|---|
871
+ | revoke | POST | `/file/v1/files/{file_id}/content_links:revoke` | no | no |
872
+
873
+ ### file.files.contentUrl
874
+
875
+ | Method | HTTP | Path | Streaming | Pagination |
876
+ |---|---|---|---|---|
877
+ | create | POST | `/file/v1/files/{file_id}/content_url` | no | no |
878
+
667
879
  ### file.uploads
668
880
 
669
881
  | Method | HTTP | Path | Streaming | Pagination |
@@ -671,6 +883,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
671
883
  | cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
672
884
  | complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
673
885
  | create | POST | `/file/v1/uploads` | no | no |
886
+ | createSigned | POST | `/file/v1/uploads/signed` | no | no |
674
887
 
675
888
  ### file.uploads.parts
676
889
 
@@ -776,6 +989,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
776
989
  | retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
777
990
  | update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
778
991
 
992
+ ### media.libraries.assets.frames
993
+
994
+ | Method | HTTP | Path | Streaming | Pagination |
995
+ |---|---|---|---|---|
996
+ | create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
997
+
779
998
  ### media.libraries.assets.import
780
999
 
781
1000
  | Method | HTTP | Path | Streaming | Pagination |
@@ -801,6 +1020,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
801
1020
  | create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
802
1021
  | retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
803
1022
 
1023
+ ### media.libraries.deliveryTokens
1024
+
1025
+ | Method | HTTP | Path | Streaming | Pagination |
1026
+ |---|---|---|---|---|
1027
+ | create | POST | `/media/v1/libraries/{library_id}/delivery_tokens` | no | no |
1028
+
804
1029
  ### media.libraries.events
805
1030
 
806
1031
  | Method | HTTP | Path | Streaming | Pagination |
@@ -849,8 +1074,22 @@ Multipart request bodies expand plain objects into bracketed fields (for example
849
1074
  |---|---|---|---|---|
850
1075
  | create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
851
1076
 
1077
+ ### media.libraries.understandings
1078
+
1079
+ | Method | HTTP | Path | Streaming | Pagination |
1080
+ |---|---|---|---|---|
1081
+ | list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
1082
+ | retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
1083
+
852
1084
  ## meta
853
1085
 
1086
+ ### meta.docs
1087
+
1088
+ | Method | HTTP | Path | Streaming | Pagination |
1089
+ |---|---|---|---|---|
1090
+ | retrieve | GET | `/meta/v1/docs/{path}` | no | no |
1091
+ | search | GET | `/meta/v1/docs/search` | no | no |
1092
+
854
1093
  ### meta.health
855
1094
 
856
1095
  | Method | HTTP | Path | Streaming | Pagination |
@@ -974,6 +1213,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
974
1213
  |---|---|---|---|---|
975
1214
  | create | POST | `/model/v1/responses/input_tokens` | no | no |
976
1215
 
1216
+ ### model.systemone
1217
+
1218
+ | Method | HTTP | Path | Streaming | Pagination |
1219
+ |---|---|---|---|---|
1220
+ | create | POST | `/model/v1/systemone` | no | no |
1221
+
977
1222
  ### model.videos
978
1223
 
979
1224
  | Method | HTTP | Path | Streaming | Pagination |
@@ -1027,6 +1272,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1027
1272
  | create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
1028
1273
  | list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
1029
1274
 
1275
+ ### organization.members
1276
+
1277
+ | Method | HTTP | Path | Streaming | Pagination |
1278
+ |---|---|---|---|---|
1279
+ | list | GET | `/organization/v1/members` | no | no |
1280
+
1030
1281
  ### organization.usage
1031
1282
 
1032
1283
  | Method | HTTP | Path | Streaming | Pagination |
@@ -1109,7 +1360,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1109
1360
 
1110
1361
  | Method | HTTP | Path | Streaming | Pagination |
1111
1362
  |---|---|---|---|---|
1363
+ | create | POST | `/sandbox/v1/templates` | no | no |
1364
+ | delete | DELETE | `/sandbox/v1/templates/{templateID}` | no | no |
1112
1365
  | list | GET | `/sandbox/v1/templates` | no | no |
1366
+ | retrieve | GET | `/sandbox/v1/templates/{templateID}` | no | no |
1367
+
1368
+ ### sandbox.templates.aliases
1369
+
1370
+ | Method | HTTP | Path | Streaming | Pagination |
1371
+ |---|---|---|---|---|
1372
+ | retrieve | GET | `/sandbox/v1/templates/aliases/{alias}` | no | no |
1373
+
1374
+ ### sandbox.templates.builds
1375
+
1376
+ | Method | HTTP | Path | Streaming | Pagination |
1377
+ |---|---|---|---|---|
1378
+ | update | POST | `/sandbox/v1/templates/{templateID}/builds/{buildID}` | no | no |
1379
+
1380
+ ### sandbox.templates.builds.status
1381
+
1382
+ | Method | HTTP | Path | Streaming | Pagination |
1383
+ |---|---|---|---|---|
1384
+ | list | GET | `/sandbox/v1/templates/{templateID}/builds/{buildID}/status` | no | no |
1385
+
1386
+ ### sandbox.templates.tags
1387
+
1388
+ | Method | HTTP | Path | Streaming | Pagination |
1389
+ |---|---|---|---|---|
1390
+ | create | POST | `/sandbox/v1/templates/tags` | no | no |
1391
+ | delete | DELETE | `/sandbox/v1/templates/tags` | no | no |
1392
+ | list | GET | `/sandbox/v1/templates/{templateID}/tags` | no | no |
1113
1393
 
1114
1394
  ### sandbox.volumes
1115
1395
 
@@ -1359,10 +1639,33 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1359
1639
  | agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
1360
1640
  | automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
1361
1641
  | automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
1642
+ | automation.scripts.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
1362
1643
  | automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
1363
1644
  | automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
1645
+ | automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
1364
1646
  | automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
1647
+ | crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
1648
+ | crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
1649
+ | crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
1650
+ | crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
1651
+ | crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
1652
+ | crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
1653
+ | crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
1654
+ | crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
1655
+ | 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. |
1656
+ | 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. |
1657
+ | 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. |
1658
+ | 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. |
1659
+ | crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
1660
+ | crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
1661
+ | crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
1662
+ | crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
1663
+ | crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
1664
+ | crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
1665
+ | crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
1365
1666
  | database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
1667
+ | file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
1668
+ | meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
1366
1669
  | sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
1367
1670
  | sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
1368
1671
  | sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
package/README.md CHANGED
@@ -55,7 +55,7 @@ server. You need a Praxis account; sign up at [deepraxis.com](https://deepraxis.
55
55
  const praxis = new Praxis({
56
56
  apiKey: process.env.PRAXIS_API_KEY!,
57
57
  baseUrl: 'https://api.deepraxis.com', // default
58
- timeoutMs: 60_000, // default; the whole call, body included
58
+ timeoutMs: 600_000, // default (10 minutes, as the OpenAI and Anthropic SDKs); the whole call, body included
59
59
  maxRetries: 2, // default
60
60
  // fetch: customFetch, // bring your own fetch
61
61
  });
@@ -23,6 +23,13 @@ export declare function createAutomationClient(options: PraxisOptions): {
23
23
  hooks: {
24
24
  send: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationHooksReceiveData>) => Promise<import("./generated/types.gen.js").AutomationFiring>;
25
25
  };
26
+ humanTasks: {
27
+ cancel: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationHumanTasksCancelData>) => Promise<import("./generated/types.gen.js").AutomationHumanTask>;
28
+ delegate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationHumanTasksDelegateData>) => Promise<import("./generated/types.gen.js").AutomationHumanTask>;
29
+ list: (options?: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationHumanTasksListData> | undefined) => Promise<import("./automation.js").Page<import("./generated/types.gen.js").AutomationHumanTask>>;
30
+ respond: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationHumanTasksRespondData>) => Promise<import("./generated/types.gen.js").AutomationHumanTask>;
31
+ retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationHumanTasksGetData>) => Promise<import("./generated/types.gen.js").AutomationHumanTask>;
32
+ };
26
33
  resolve: {
27
34
  retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationResolveResolveData>) => Promise<import("./generated/types.gen.js").AutomationResolveResult>;
28
35
  };
@@ -89,6 +96,33 @@ export declare function createAutomationClient(options: PraxisOptions): {
89
96
  restore: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsRestoreData>) => Promise<import("./generated/types.gen.js").AutomationDefinition>;
90
97
  retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsGetData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
91
98
  update: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsPatchData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
99
+ vaults: {
100
+ delete: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsVaultsDeleteData>) => Promise<void>;
101
+ list: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsVaultsListData>) => Promise<{
102
+ data: Array<{
103
+ alias: string;
104
+ vault: {
105
+ id: string;
106
+ name: string;
107
+ };
108
+ secrets: Array<{
109
+ name: string;
110
+ }>;
111
+ secrets_unavailable?: true;
112
+ }>;
113
+ }>;
114
+ set: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsVaultsSetData>) => Promise<{
115
+ alias: string;
116
+ vault: {
117
+ id: string;
118
+ name: string;
119
+ };
120
+ secrets: Array<{
121
+ name: string;
122
+ }>;
123
+ secrets_unavailable?: true;
124
+ }>;
125
+ };
92
126
  versions: {
93
127
  create: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsPublishData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
94
128
  deprecate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsDeprecateData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
@@ -136,6 +170,33 @@ export declare function createAutomationClient(options: PraxisOptions): {
136
170
  restore: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsRestoreData>) => Promise<import("./generated/types.gen.js").AutomationDefinition>;
137
171
  retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsGetData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
138
172
  update: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsPatchData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
173
+ vaults: {
174
+ delete: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsVaultsDeleteData>) => Promise<void>;
175
+ list: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsVaultsListData>) => Promise<{
176
+ data: Array<{
177
+ alias: string;
178
+ vault: {
179
+ id: string;
180
+ name: string;
181
+ };
182
+ secrets: Array<{
183
+ name: string;
184
+ }>;
185
+ secrets_unavailable?: true;
186
+ }>;
187
+ }>;
188
+ set: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsVaultsSetData>) => Promise<{
189
+ alias: string;
190
+ vault: {
191
+ id: string;
192
+ name: string;
193
+ };
194
+ secrets: Array<{
195
+ name: string;
196
+ }>;
197
+ secrets_unavailable?: true;
198
+ }>;
199
+ };
139
200
  versions: {
140
201
  create: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsPublishData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
141
202
  deprecate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsDeprecateData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
@@ -1,12 +1,22 @@
1
+ import { type SandboxTemplateBuildInput, type SandboxTemplateBuildResult } from "../helpers/sandbox-templates.js";
1
2
  import { type UploadFileOptions, type UploadedFile } from '../helpers/file-upload.js';
2
3
  import { resourceFactories } from '../resources.generated.js';
3
4
  import { type PraxisOptions } from './transport.js';
4
5
  import { type PublishInput, type PublishResult } from '../helpers/application-publish.js';
6
+ import { type BrowserConnectOptions, type PraxisBrowser } from '../helpers/browser-connect.js';
5
7
  import { type CountInput, type CountResult } from '../helpers/database-count.js';
6
8
  type Resources = {
7
9
  readonly [K in keyof typeof resourceFactories]: ReturnType<(typeof resourceFactories)[K]>;
8
10
  };
9
- export interface Praxis extends Omit<Resources, 'application' | 'database' | 'file'> {
11
+ export interface Praxis extends Omit<Resources, 'application' | 'browser' | 'database' | 'file' | 'sandbox'> {
12
+ readonly sandbox: Omit<Resources['sandbox'], 'templates'> & {
13
+ templates: Resources['sandbox']['templates'] & {
14
+ build(input: SandboxTemplateBuildInput): Promise<SandboxTemplateBuildResult>;
15
+ };
16
+ };
17
+ readonly browser: Resources['browser'] & {
18
+ connect(options?: BrowserConnectOptions): Promise<PraxisBrowser>;
19
+ };
10
20
  readonly file: Resources['file'] & {
11
21
  uploadFile(file: Blob | File, options: UploadFileOptions): Promise<UploadedFile>;
12
22
  };