@deepraxis/sdk 0.1.1-dev.ed5af3e → 0.1.1-dev.f5193c4
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 +396 -1
- package/README.md +1 -1
- package/dist/automation.d.ts +54 -0
- package/dist/core/client.d.ts +7 -1
- package/dist/core/client.js +3 -0
- package/dist/core/transport.d.ts +9 -0
- package/dist/core/transport.js +13 -2
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +925 -55
- package/dist/generated/sdk.gen.js +2890 -483
- package/dist/generated/types.gen.d.ts +45219 -31915
- package/dist/helpers/file-upload.d.ts +2 -2
- package/dist/helpers/sandbox-templates.d.ts +121 -0
- package/dist/helpers/sandbox-templates.js +60 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/operations.generated.d.ts +4321 -609
- package/dist/operations.generated.js +8131 -3514
- package/dist/resources.generated.d.ts +465 -37
- package/dist/resources.generated.js +242 -1
- 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`. 545 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
|
|
|
@@ -449,6 +449,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
449
449
|
| list | GET | `/automation/v1/scripts/{ns}/{name}/dist-tags` | no | no |
|
|
450
450
|
| set | PUT | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
|
|
451
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
|
+
|
|
452
460
|
### automation.scripts.versions
|
|
453
461
|
|
|
454
462
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -510,6 +518,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
510
518
|
| list | GET | `/automation/v1/workflows/{ns}/{name}/dist-tags` | no | no |
|
|
511
519
|
| set | PUT | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
|
|
512
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
|
+
|
|
513
529
|
### automation.workflows.versions
|
|
514
530
|
|
|
515
531
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -579,6 +595,210 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
579
595
|
|---|---|---|---|---|
|
|
580
596
|
| create | POST | `/browser/v1/sessions/{sessionId}/viewer` | no | no |
|
|
581
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
|
+
|
|
582
802
|
## database
|
|
583
803
|
|
|
584
804
|
### database.databases
|
|
@@ -644,6 +864,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
644
864
|
| retrieve | GET | `/file/v1/files/{file_id}` | no | no |
|
|
645
865
|
| retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
|
|
646
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
|
+
|
|
647
879
|
### file.uploads
|
|
648
880
|
|
|
649
881
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -651,6 +883,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
651
883
|
| cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
|
|
652
884
|
| complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
|
|
653
885
|
| create | POST | `/file/v1/uploads` | no | no |
|
|
886
|
+
| createSigned | POST | `/file/v1/uploads/signed` | no | no |
|
|
887
|
+
| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
|
|
654
888
|
|
|
655
889
|
### file.uploads.parts
|
|
656
890
|
|
|
@@ -734,6 +968,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
734
968
|
|
|
735
969
|
## media
|
|
736
970
|
|
|
971
|
+
### media.generation.capabilities
|
|
972
|
+
|
|
973
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
974
|
+
|---|---|---|---|---|
|
|
975
|
+
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
976
|
+
|
|
737
977
|
### media.libraries
|
|
738
978
|
|
|
739
979
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -756,6 +996,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
756
996
|
| retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
757
997
|
| update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
758
998
|
|
|
999
|
+
### media.libraries.assets.frames
|
|
1000
|
+
|
|
1001
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1002
|
+
|---|---|---|---|---|
|
|
1003
|
+
| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
|
|
1004
|
+
|
|
759
1005
|
### media.libraries.assets.import
|
|
760
1006
|
|
|
761
1007
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -781,6 +1027,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
781
1027
|
| create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
|
|
782
1028
|
| retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
|
|
783
1029
|
|
|
1030
|
+
### media.libraries.deliveryTokens
|
|
1031
|
+
|
|
1032
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1033
|
+
|---|---|---|---|---|
|
|
1034
|
+
| create | POST | `/media/v1/libraries/{library_id}/delivery_tokens` | no | no |
|
|
1035
|
+
|
|
784
1036
|
### media.libraries.events
|
|
785
1037
|
|
|
786
1038
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -793,12 +1045,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
793
1045
|
|---|---|---|---|---|
|
|
794
1046
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
795
1047
|
|
|
1048
|
+
### media.libraries.generations
|
|
1049
|
+
|
|
1050
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1051
|
+
|---|---|---|---|---|
|
|
1052
|
+
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1053
|
+
|
|
796
1054
|
### media.libraries.jobs
|
|
797
1055
|
|
|
798
1056
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
799
1057
|
|---|---|---|---|---|
|
|
1058
|
+
| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
|
|
1059
|
+
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
800
1060
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
801
1061
|
|
|
1062
|
+
### media.libraries.jobs.outputs.save
|
|
1063
|
+
|
|
1064
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1065
|
+
|---|---|---|---|---|
|
|
1066
|
+
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1067
|
+
|
|
802
1068
|
### media.libraries.purge
|
|
803
1069
|
|
|
804
1070
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -829,8 +1095,22 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
829
1095
|
|---|---|---|---|---|
|
|
830
1096
|
| create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
|
|
831
1097
|
|
|
1098
|
+
### media.libraries.understandings
|
|
1099
|
+
|
|
1100
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1101
|
+
|---|---|---|---|---|
|
|
1102
|
+
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1103
|
+
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1104
|
+
|
|
832
1105
|
## meta
|
|
833
1106
|
|
|
1107
|
+
### meta.docs
|
|
1108
|
+
|
|
1109
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1110
|
+
|---|---|---|---|---|
|
|
1111
|
+
| retrieve | GET | `/meta/v1/docs/{path}` | no | no |
|
|
1112
|
+
| search | GET | `/meta/v1/docs/search` | no | no |
|
|
1113
|
+
|
|
834
1114
|
### meta.health
|
|
835
1115
|
|
|
836
1116
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -954,6 +1234,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
954
1234
|
|---|---|---|---|---|
|
|
955
1235
|
| create | POST | `/model/v1/responses/input_tokens` | no | no |
|
|
956
1236
|
|
|
1237
|
+
### model.systemone
|
|
1238
|
+
|
|
1239
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1240
|
+
|---|---|---|---|---|
|
|
1241
|
+
| create | POST | `/model/v1/systemone` | no | no |
|
|
1242
|
+
|
|
957
1243
|
### model.videos
|
|
958
1244
|
|
|
959
1245
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -965,6 +1251,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
965
1251
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
966
1252
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
967
1253
|
|
|
1254
|
+
## ontology
|
|
1255
|
+
|
|
1256
|
+
### ontology.changesets
|
|
1257
|
+
|
|
1258
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1259
|
+
|---|---|---|---|---|
|
|
1260
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1261
|
+
|
|
1262
|
+
### ontology.nodes
|
|
1263
|
+
|
|
1264
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1265
|
+
|---|---|---|---|---|
|
|
1266
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1267
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1268
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1269
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1270
|
+
|
|
1271
|
+
### ontology.nodes.merge
|
|
1272
|
+
|
|
1273
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1274
|
+
|---|---|---|---|---|
|
|
1275
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1276
|
+
|
|
1277
|
+
### ontology.relations
|
|
1278
|
+
|
|
1279
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1280
|
+
|---|---|---|---|---|
|
|
1281
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1282
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1283
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1284
|
+
|
|
1285
|
+
### ontology.relations.invalidate
|
|
1286
|
+
|
|
1287
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1288
|
+
|---|---|---|---|---|
|
|
1289
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1290
|
+
|
|
1291
|
+
### ontology.search
|
|
1292
|
+
|
|
1293
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1294
|
+
|---|---|---|---|---|
|
|
1295
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1296
|
+
|
|
1297
|
+
### ontology.types
|
|
1298
|
+
|
|
1299
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1300
|
+
|---|---|---|---|---|
|
|
1301
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1302
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1303
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1304
|
+
|
|
968
1305
|
## organization
|
|
969
1306
|
|
|
970
1307
|
### organization.charges
|
|
@@ -1007,6 +1344,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1007
1344
|
| create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1008
1345
|
| list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1009
1346
|
|
|
1347
|
+
### organization.members
|
|
1348
|
+
|
|
1349
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1350
|
+
|---|---|---|---|---|
|
|
1351
|
+
| list | GET | `/organization/v1/members` | no | no |
|
|
1352
|
+
|
|
1010
1353
|
### organization.usage
|
|
1011
1354
|
|
|
1012
1355
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1089,7 +1432,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1089
1432
|
|
|
1090
1433
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1091
1434
|
|---|---|---|---|---|
|
|
1435
|
+
| create | POST | `/sandbox/v1/templates` | no | no |
|
|
1436
|
+
| delete | DELETE | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1092
1437
|
| list | GET | `/sandbox/v1/templates` | no | no |
|
|
1438
|
+
| retrieve | GET | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1439
|
+
|
|
1440
|
+
### sandbox.templates.aliases
|
|
1441
|
+
|
|
1442
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1443
|
+
|---|---|---|---|---|
|
|
1444
|
+
| retrieve | GET | `/sandbox/v1/templates/aliases/{alias}` | no | no |
|
|
1445
|
+
|
|
1446
|
+
### sandbox.templates.builds
|
|
1447
|
+
|
|
1448
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1449
|
+
|---|---|---|---|---|
|
|
1450
|
+
| update | POST | `/sandbox/v1/templates/{templateID}/builds/{buildID}` | no | no |
|
|
1451
|
+
|
|
1452
|
+
### sandbox.templates.builds.status
|
|
1453
|
+
|
|
1454
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1455
|
+
|---|---|---|---|---|
|
|
1456
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/builds/{buildID}/status` | no | no |
|
|
1457
|
+
|
|
1458
|
+
### sandbox.templates.tags
|
|
1459
|
+
|
|
1460
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1461
|
+
|---|---|---|---|---|
|
|
1462
|
+
| create | POST | `/sandbox/v1/templates/tags` | no | no |
|
|
1463
|
+
| delete | DELETE | `/sandbox/v1/templates/tags` | no | no |
|
|
1464
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/tags` | no | no |
|
|
1093
1465
|
|
|
1094
1466
|
### sandbox.volumes
|
|
1095
1467
|
|
|
@@ -1339,10 +1711,33 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1339
1711
|
| agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
|
|
1340
1712
|
| automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
|
|
1341
1713
|
| automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
|
|
1714
|
+
| automation.scripts.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1342
1715
|
| automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
|
|
1343
1716
|
| automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
|
|
1717
|
+
| automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1344
1718
|
| automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
|
|
1719
|
+
| crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1720
|
+
| crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1721
|
+
| crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1722
|
+
| crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1723
|
+
| crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1724
|
+
| crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1725
|
+
| crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
|
|
1726
|
+
| crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1727
|
+
| 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. |
|
|
1728
|
+
| 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. |
|
|
1729
|
+
| 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. |
|
|
1730
|
+
| 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. |
|
|
1731
|
+
| crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1732
|
+
| crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1733
|
+
| crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1734
|
+
| crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1735
|
+
| crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1736
|
+
| crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1737
|
+
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1345
1738
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1739
|
+
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
1740
|
+
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1346
1741
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1347
1742
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1348
1743
|
| 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:
|
|
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
|
});
|
package/dist/automation.d.ts
CHANGED
|
@@ -96,6 +96,33 @@ export declare function createAutomationClient(options: PraxisOptions): {
|
|
|
96
96
|
restore: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsRestoreData>) => Promise<import("./generated/types.gen.js").AutomationDefinition>;
|
|
97
97
|
retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsGetData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
|
|
98
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
|
+
};
|
|
99
126
|
versions: {
|
|
100
127
|
create: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsPublishData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
|
|
101
128
|
deprecate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationScriptsDeprecateData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
|
|
@@ -143,6 +170,33 @@ export declare function createAutomationClient(options: PraxisOptions): {
|
|
|
143
170
|
restore: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsRestoreData>) => Promise<import("./generated/types.gen.js").AutomationDefinition>;
|
|
144
171
|
retrieve: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsGetData>) => Promise<import("./generated/types.gen.js").AutomationDefinitionDetail>;
|
|
145
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
|
+
};
|
|
146
200
|
versions: {
|
|
147
201
|
create: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsPublishData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
|
|
148
202
|
deprecate: (options: import("./core/transport.js").CallOptions<import("./generated/types.gen.js").AutomationWorkflowsDeprecateData>) => Promise<import("./generated/types.gen.js").AutomationVersion>;
|
package/dist/core/client.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
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';
|
|
@@ -7,7 +8,12 @@ import { type CountInput, type CountResult } from '../helpers/database-count.js'
|
|
|
7
8
|
type Resources = {
|
|
8
9
|
readonly [K in keyof typeof resourceFactories]: ReturnType<(typeof resourceFactories)[K]>;
|
|
9
10
|
};
|
|
10
|
-
export interface Praxis extends Omit<Resources, 'application' | 'browser' | '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
|
+
};
|
|
11
17
|
readonly browser: Resources['browser'] & {
|
|
12
18
|
connect(options?: BrowserConnectOptions): Promise<PraxisBrowser>;
|
|
13
19
|
};
|
package/dist/core/client.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { buildSandboxTemplate } from "../helpers/sandbox-templates.js";
|
|
1
2
|
import { uploadFile } from "../helpers/file-upload.js";
|
|
2
3
|
import { resourceFactories } from "../resources.generated.js";
|
|
3
4
|
import { Transport } from "./transport.js";
|
|
@@ -10,6 +11,8 @@ export class Praxis {
|
|
|
10
11
|
for (const [name, create] of Object.entries(resourceFactories)) {
|
|
11
12
|
const resource = create(transport);
|
|
12
13
|
// Assemble before sealing the resource property; never replace a readonly SDK resource.
|
|
14
|
+
if (name === 'sandbox')
|
|
15
|
+
Object.assign(resource.templates, { build: (input) => buildSandboxTemplate(this, input) });
|
|
13
16
|
if (name === 'file')
|
|
14
17
|
Object.assign(resource, { uploadFile: (file, options) => uploadFile(this, file, options) });
|
|
15
18
|
if (name === 'database')
|
package/dist/core/transport.d.ts
CHANGED
|
@@ -25,6 +25,15 @@ type InternalOptions = RequestOptions & {
|
|
|
25
25
|
query?: unknown;
|
|
26
26
|
lastEventId?: string;
|
|
27
27
|
};
|
|
28
|
+
/** Margin over a server-side execution deadline: the response still has to travel back after it. */
|
|
29
|
+
export declare const SERVER_DEADLINE_MARGIN_MS = 30000;
|
|
30
|
+
/**
|
|
31
|
+
* A request body that carries its own execution deadline (`timeoutMs`, as in sandbox commands.run) is
|
|
32
|
+
* waited for at least that long plus a margin, so the client never gives up before the server answers.
|
|
33
|
+
*/
|
|
34
|
+
export declare function serverDeadlineMs(options: {
|
|
35
|
+
body?: unknown;
|
|
36
|
+
}): number;
|
|
28
37
|
export declare class Transport {
|
|
29
38
|
private readonly config;
|
|
30
39
|
constructor(options: PraxisOptions);
|