@deepraxis/sdk 0.1.1-dev.ed5af3e → 0.1.1-dev.f23829c
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 +402 -1
- package/README.md +3 -3
- 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 +953 -58
- package/dist/generated/sdk.gen.js +2960 -512
- package/dist/generated/types.gen.d.ts +44876 -31298
- 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 +4342 -606
- package/dist/operations.generated.js +8102 -3456
- package/dist/resources.generated.d.ts +479 -37
- package/dist/resources.generated.js +245 -1
- package/package.json +2 -2
package/METHODS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SDK methods
|
|
2
2
|
|
|
3
|
-
Generated by `bun run generate`.
|
|
3
|
+
Generated by `bun run generate`. 546 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
|
|
4
4
|
|
|
5
5
|
`always` returns an AsyncIterable; `optional` streams with `{ stream: true }`; `yes` pagination returns a Page. Only `{ data, next_cursor }` + `cursor` query contracts are automatically paginated.
|
|
6
6
|
|
|
@@ -103,6 +103,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
103
103
|
| list | GET | `/agent/v1/computers/{computer_id}/files` | no | no |
|
|
104
104
|
| retrieveContent | GET | `/agent/v1/computers/{computer_id}/files/content` | no | no |
|
|
105
105
|
|
|
106
|
+
### agent.computers.files.convert
|
|
107
|
+
|
|
108
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
109
|
+
|---|---|---|---|---|
|
|
110
|
+
| create | POST | `/agent/v1/computers/{computer_id}/files/convert` | no | no |
|
|
111
|
+
|
|
106
112
|
### agent.computers.leases
|
|
107
113
|
|
|
108
114
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -449,6 +455,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
449
455
|
| list | GET | `/automation/v1/scripts/{ns}/{name}/dist-tags` | no | no |
|
|
450
456
|
| set | PUT | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
|
|
451
457
|
|
|
458
|
+
### automation.scripts.vaults
|
|
459
|
+
|
|
460
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
461
|
+
|---|---|---|---|---|
|
|
462
|
+
| delete | DELETE | `/automation/v1/scripts/{ns}/{name}/vaults/{alias}` | no | no |
|
|
463
|
+
| list | GET | `/automation/v1/scripts/{ns}/{name}/vaults` | no | no |
|
|
464
|
+
| set | PUT | `/automation/v1/scripts/{ns}/{name}/vaults/{alias}` | no | no |
|
|
465
|
+
|
|
452
466
|
### automation.scripts.versions
|
|
453
467
|
|
|
454
468
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -510,6 +524,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
510
524
|
| list | GET | `/automation/v1/workflows/{ns}/{name}/dist-tags` | no | no |
|
|
511
525
|
| set | PUT | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
|
|
512
526
|
|
|
527
|
+
### automation.workflows.vaults
|
|
528
|
+
|
|
529
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
530
|
+
|---|---|---|---|---|
|
|
531
|
+
| delete | DELETE | `/automation/v1/workflows/{ns}/{name}/vaults/{alias}` | no | no |
|
|
532
|
+
| list | GET | `/automation/v1/workflows/{ns}/{name}/vaults` | no | no |
|
|
533
|
+
| set | PUT | `/automation/v1/workflows/{ns}/{name}/vaults/{alias}` | no | no |
|
|
534
|
+
|
|
513
535
|
### automation.workflows.versions
|
|
514
536
|
|
|
515
537
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -579,6 +601,210 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
579
601
|
|---|---|---|---|---|
|
|
580
602
|
| create | POST | `/browser/v1/sessions/{sessionId}/viewer` | no | no |
|
|
581
603
|
|
|
604
|
+
## canvas
|
|
605
|
+
|
|
606
|
+
### canvas.canvases
|
|
607
|
+
|
|
608
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
609
|
+
|---|---|---|---|---|
|
|
610
|
+
| create | POST | `/canvas/v1/canvases` | no | no |
|
|
611
|
+
| delete | DELETE | `/canvas/v1/canvases/{canvas_id}` | no | no |
|
|
612
|
+
| execute | POST | `/canvas/v1/canvases/{canvas_id}:execute` | no | no |
|
|
613
|
+
| list | GET | `/canvas/v1/canvases` | no | yes |
|
|
614
|
+
| restore | POST | `/canvas/v1/canvases/{canvas_id}:restore` | no | no |
|
|
615
|
+
| retrieve | GET | `/canvas/v1/canvases/{canvas_id}` | no | no |
|
|
616
|
+
| update | PATCH | `/canvas/v1/canvases/{canvas_id}` | no | no |
|
|
617
|
+
|
|
618
|
+
### canvas.canvases.images
|
|
619
|
+
|
|
620
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
621
|
+
|---|---|---|---|---|
|
|
622
|
+
| list | GET | `/canvas/v1/canvases/{canvas_id}/images` | no | no |
|
|
623
|
+
|
|
624
|
+
### canvas.canvases.nodes
|
|
625
|
+
|
|
626
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
627
|
+
|---|---|---|---|---|
|
|
628
|
+
| list | GET | `/canvas/v1/canvases/{canvas_id}/nodes` | no | no |
|
|
629
|
+
|
|
630
|
+
### canvas.canvases.versions
|
|
631
|
+
|
|
632
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
633
|
+
|---|---|---|---|---|
|
|
634
|
+
| list | GET | `/canvas/v1/canvases/{canvas_id}/versions` | no | no |
|
|
635
|
+
|
|
636
|
+
### canvas.collections
|
|
637
|
+
|
|
638
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
639
|
+
|---|---|---|---|---|
|
|
640
|
+
| create | POST | `/canvas/v1/collections` | no | no |
|
|
641
|
+
| delete | DELETE | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
642
|
+
| list | GET | `/canvas/v1/collections` | no | no |
|
|
643
|
+
| retrieve | GET | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
644
|
+
| update | PATCH | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
645
|
+
|
|
646
|
+
## crm
|
|
647
|
+
|
|
648
|
+
### crm.associations
|
|
649
|
+
|
|
650
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
651
|
+
|---|---|---|---|---|
|
|
652
|
+
| create | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
|
|
653
|
+
| createDefault | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}` | no | no |
|
|
654
|
+
| list | GET | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}` | no | no |
|
|
655
|
+
| remove | DELETE | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
|
|
656
|
+
|
|
657
|
+
### crm.changes
|
|
658
|
+
|
|
659
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
660
|
+
|---|---|---|---|---|
|
|
661
|
+
| revert | POST | `/crm/v1/changes/{changeSetId}:revert` | no | no |
|
|
662
|
+
|
|
663
|
+
### crm.layouts
|
|
664
|
+
|
|
665
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
666
|
+
|---|---|---|---|---|
|
|
667
|
+
| retrieve | GET | `/crm/v1/layouts/{objectType}` | no | no |
|
|
668
|
+
| update | PUT | `/crm/v1/layouts/{objectType}` | no | no |
|
|
669
|
+
|
|
670
|
+
### crm.leads
|
|
671
|
+
|
|
672
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
673
|
+
|---|---|---|---|---|
|
|
674
|
+
| qualify | POST | `/crm/v1/leads/{leadId}:qualify` | no | no |
|
|
675
|
+
|
|
676
|
+
### crm.objects
|
|
677
|
+
|
|
678
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
679
|
+
|---|---|---|---|---|
|
|
680
|
+
| archive | DELETE | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
681
|
+
| create | POST | `/crm/v1/objects/{objectType}` | no | no |
|
|
682
|
+
| list | GET | `/crm/v1/objects/{objectType}` | no | no |
|
|
683
|
+
| retrieve | GET | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
684
|
+
| search | POST | `/crm/v1/objects/{objectType}/search` | no | no |
|
|
685
|
+
| update | PATCH | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
686
|
+
|
|
687
|
+
### crm.objects.batch
|
|
688
|
+
|
|
689
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
690
|
+
|---|---|---|---|---|
|
|
691
|
+
| archive | POST | `/crm/v1/objects/{objectType}/batch/archive` | no | no |
|
|
692
|
+
| create | POST | `/crm/v1/objects/{objectType}/batch/create` | no | no |
|
|
693
|
+
| read | POST | `/crm/v1/objects/{objectType}/batch/read` | no | no |
|
|
694
|
+
| update | POST | `/crm/v1/objects/{objectType}/batch/update` | no | no |
|
|
695
|
+
| upsert | POST | `/crm/v1/objects/{objectType}/batch/upsert` | no | no |
|
|
696
|
+
|
|
697
|
+
### crm.pipelines
|
|
698
|
+
|
|
699
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
700
|
+
|---|---|---|---|---|
|
|
701
|
+
| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
702
|
+
| create | POST | `/crm/v1/pipelines/{objectType}` | no | no |
|
|
703
|
+
| list | GET | `/crm/v1/pipelines/{objectType}` | no | no |
|
|
704
|
+
| retrieve | GET | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
705
|
+
| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
706
|
+
|
|
707
|
+
### crm.pipelines.stages
|
|
708
|
+
|
|
709
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
710
|
+
|---|---|---|---|---|
|
|
711
|
+
| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
|
|
712
|
+
| create | POST | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages` | no | no |
|
|
713
|
+
| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
|
|
714
|
+
|
|
715
|
+
### crm.properties
|
|
716
|
+
|
|
717
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
718
|
+
|---|---|---|---|---|
|
|
719
|
+
| archive | DELETE | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
720
|
+
| create | POST | `/crm/v1/properties/{objectType}` | no | no |
|
|
721
|
+
| list | GET | `/crm/v1/properties/{objectType}` | no | no |
|
|
722
|
+
| retrieve | GET | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
723
|
+
| update | PATCH | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
724
|
+
|
|
725
|
+
### crm.properties.groups
|
|
726
|
+
|
|
727
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
728
|
+
|---|---|---|---|---|
|
|
729
|
+
| create | POST | `/crm/v1/properties/{objectType}/groups` | no | no |
|
|
730
|
+
| list | GET | `/crm/v1/properties/{objectType}/groups` | no | no |
|
|
731
|
+
|
|
732
|
+
### crm.schemas
|
|
733
|
+
|
|
734
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
735
|
+
|---|---|---|---|---|
|
|
736
|
+
| create | POST | `/crm/v1/schemas` | no | no |
|
|
737
|
+
| list | GET | `/crm/v1/schemas` | no | no |
|
|
738
|
+
|
|
739
|
+
## cut
|
|
740
|
+
|
|
741
|
+
### cut.exports
|
|
742
|
+
|
|
743
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
744
|
+
|---|---|---|---|---|
|
|
745
|
+
| cancel | POST | `/cut/v1/exports/{export_id}:cancel` | no | no |
|
|
746
|
+
| retrieve | GET | `/cut/v1/exports/{export_id}` | no | no |
|
|
747
|
+
|
|
748
|
+
### cut.projects
|
|
749
|
+
|
|
750
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
751
|
+
|---|---|---|---|---|
|
|
752
|
+
| create | POST | `/cut/v1/projects` | no | no |
|
|
753
|
+
| delete | DELETE | `/cut/v1/projects/{project_id}` | no | no |
|
|
754
|
+
| execute | POST | `/cut/v1/projects/{project_id}:execute` | no | no |
|
|
755
|
+
| list | GET | `/cut/v1/projects` | no | no |
|
|
756
|
+
| retrieve | GET | `/cut/v1/projects/{project_id}` | no | no |
|
|
757
|
+
| retrieveState | GET | `/cut/v1/projects/{project_id}/state` | no | no |
|
|
758
|
+
| retrieveTimeline | GET | `/cut/v1/projects/{project_id}/timeline` | no | no |
|
|
759
|
+
| undelete | POST | `/cut/v1/projects/{project_id}:undelete` | no | no |
|
|
760
|
+
| update | PATCH | `/cut/v1/projects/{project_id}` | no | no |
|
|
761
|
+
|
|
762
|
+
### cut.projects.analysis
|
|
763
|
+
|
|
764
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
765
|
+
|---|---|---|---|---|
|
|
766
|
+
| create | POST | `/cut/v1/projects/{project_id}/analysis` | no | no |
|
|
767
|
+
|
|
768
|
+
### cut.projects.bindings
|
|
769
|
+
|
|
770
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
771
|
+
|---|---|---|---|---|
|
|
772
|
+
| create | POST | `/cut/v1/projects/{project_id}/bindings` | no | no |
|
|
773
|
+
| delete | DELETE | `/cut/v1/projects/{project_id}/bindings/{name}` | no | no |
|
|
774
|
+
| list | GET | `/cut/v1/projects/{project_id}/bindings` | no | no |
|
|
775
|
+
|
|
776
|
+
### cut.projects.exports
|
|
777
|
+
|
|
778
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
779
|
+
|---|---|---|---|---|
|
|
780
|
+
| create | POST | `/cut/v1/projects/{project_id}/exports` | no | no |
|
|
781
|
+
| list | GET | `/cut/v1/projects/{project_id}/exports` | no | no |
|
|
782
|
+
|
|
783
|
+
### cut.projects.frames
|
|
784
|
+
|
|
785
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
786
|
+
|---|---|---|---|---|
|
|
787
|
+
| list | GET | `/cut/v1/projects/{project_id}/frames` | no | no |
|
|
788
|
+
|
|
789
|
+
### cut.projects.media
|
|
790
|
+
|
|
791
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
792
|
+
|---|---|---|---|---|
|
|
793
|
+
| import | POST | `/cut/v1/projects/{project_id}/media:import` | no | no |
|
|
794
|
+
|
|
795
|
+
### cut.projects.versions
|
|
796
|
+
|
|
797
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
798
|
+
|---|---|---|---|---|
|
|
799
|
+
| create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
800
|
+
| list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
801
|
+
|
|
802
|
+
### cut.versions
|
|
803
|
+
|
|
804
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
805
|
+
|---|---|---|---|---|
|
|
806
|
+
| restore | POST | `/cut/v1/versions/{version_id}:restore` | no | no |
|
|
807
|
+
|
|
582
808
|
## database
|
|
583
809
|
|
|
584
810
|
### database.databases
|
|
@@ -644,6 +870,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
644
870
|
| retrieve | GET | `/file/v1/files/{file_id}` | no | no |
|
|
645
871
|
| retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
|
|
646
872
|
|
|
873
|
+
### file.files.contentLinks
|
|
874
|
+
|
|
875
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
876
|
+
|---|---|---|---|---|
|
|
877
|
+
| revoke | POST | `/file/v1/files/{file_id}/content_links:revoke` | no | no |
|
|
878
|
+
|
|
879
|
+
### file.files.contentUrl
|
|
880
|
+
|
|
881
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
882
|
+
|---|---|---|---|---|
|
|
883
|
+
| create | POST | `/file/v1/files/{file_id}/content_url` | no | no |
|
|
884
|
+
|
|
647
885
|
### file.uploads
|
|
648
886
|
|
|
649
887
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -651,6 +889,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
651
889
|
| cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
|
|
652
890
|
| complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
|
|
653
891
|
| create | POST | `/file/v1/uploads` | no | no |
|
|
892
|
+
| createSigned | POST | `/file/v1/uploads/signed` | no | no |
|
|
893
|
+
| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
|
|
654
894
|
|
|
655
895
|
### file.uploads.parts
|
|
656
896
|
|
|
@@ -734,6 +974,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
734
974
|
|
|
735
975
|
## media
|
|
736
976
|
|
|
977
|
+
### media.generation.capabilities
|
|
978
|
+
|
|
979
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
980
|
+
|---|---|---|---|---|
|
|
981
|
+
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
982
|
+
|
|
737
983
|
### media.libraries
|
|
738
984
|
|
|
739
985
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -756,6 +1002,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
756
1002
|
| retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
757
1003
|
| update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
758
1004
|
|
|
1005
|
+
### media.libraries.assets.frames
|
|
1006
|
+
|
|
1007
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1008
|
+
|---|---|---|---|---|
|
|
1009
|
+
| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
|
|
1010
|
+
|
|
759
1011
|
### media.libraries.assets.import
|
|
760
1012
|
|
|
761
1013
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -781,6 +1033,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
781
1033
|
| create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
|
|
782
1034
|
| retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
|
|
783
1035
|
|
|
1036
|
+
### media.libraries.deliveryTokens
|
|
1037
|
+
|
|
1038
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1039
|
+
|---|---|---|---|---|
|
|
1040
|
+
| create | POST | `/media/v1/libraries/{library_id}/delivery_tokens` | no | no |
|
|
1041
|
+
|
|
784
1042
|
### media.libraries.events
|
|
785
1043
|
|
|
786
1044
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -793,12 +1051,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
793
1051
|
|---|---|---|---|---|
|
|
794
1052
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
795
1053
|
|
|
1054
|
+
### media.libraries.generations
|
|
1055
|
+
|
|
1056
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1057
|
+
|---|---|---|---|---|
|
|
1058
|
+
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1059
|
+
|
|
796
1060
|
### media.libraries.jobs
|
|
797
1061
|
|
|
798
1062
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
799
1063
|
|---|---|---|---|---|
|
|
1064
|
+
| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
|
|
1065
|
+
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
800
1066
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
801
1067
|
|
|
1068
|
+
### media.libraries.jobs.outputs.save
|
|
1069
|
+
|
|
1070
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1071
|
+
|---|---|---|---|---|
|
|
1072
|
+
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1073
|
+
|
|
802
1074
|
### media.libraries.purge
|
|
803
1075
|
|
|
804
1076
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -829,8 +1101,22 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
829
1101
|
|---|---|---|---|---|
|
|
830
1102
|
| create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
|
|
831
1103
|
|
|
1104
|
+
### media.libraries.understandings
|
|
1105
|
+
|
|
1106
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1107
|
+
|---|---|---|---|---|
|
|
1108
|
+
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1109
|
+
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1110
|
+
|
|
832
1111
|
## meta
|
|
833
1112
|
|
|
1113
|
+
### meta.docs
|
|
1114
|
+
|
|
1115
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1116
|
+
|---|---|---|---|---|
|
|
1117
|
+
| retrieve | GET | `/meta/v1/docs/{path}` | no | no |
|
|
1118
|
+
| search | GET | `/meta/v1/docs/search` | no | no |
|
|
1119
|
+
|
|
834
1120
|
### meta.health
|
|
835
1121
|
|
|
836
1122
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -954,6 +1240,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
954
1240
|
|---|---|---|---|---|
|
|
955
1241
|
| create | POST | `/model/v1/responses/input_tokens` | no | no |
|
|
956
1242
|
|
|
1243
|
+
### model.systemone
|
|
1244
|
+
|
|
1245
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1246
|
+
|---|---|---|---|---|
|
|
1247
|
+
| create | POST | `/model/v1/systemone` | no | no |
|
|
1248
|
+
|
|
957
1249
|
### model.videos
|
|
958
1250
|
|
|
959
1251
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -965,6 +1257,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
965
1257
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
966
1258
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
967
1259
|
|
|
1260
|
+
## ontology
|
|
1261
|
+
|
|
1262
|
+
### ontology.changesets
|
|
1263
|
+
|
|
1264
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1265
|
+
|---|---|---|---|---|
|
|
1266
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1267
|
+
|
|
1268
|
+
### ontology.nodes
|
|
1269
|
+
|
|
1270
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1271
|
+
|---|---|---|---|---|
|
|
1272
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1273
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1274
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1275
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1276
|
+
|
|
1277
|
+
### ontology.nodes.merge
|
|
1278
|
+
|
|
1279
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1280
|
+
|---|---|---|---|---|
|
|
1281
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1282
|
+
|
|
1283
|
+
### ontology.relations
|
|
1284
|
+
|
|
1285
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1286
|
+
|---|---|---|---|---|
|
|
1287
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1288
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1289
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1290
|
+
|
|
1291
|
+
### ontology.relations.invalidate
|
|
1292
|
+
|
|
1293
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1294
|
+
|---|---|---|---|---|
|
|
1295
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1296
|
+
|
|
1297
|
+
### ontology.search
|
|
1298
|
+
|
|
1299
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1300
|
+
|---|---|---|---|---|
|
|
1301
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1302
|
+
|
|
1303
|
+
### ontology.types
|
|
1304
|
+
|
|
1305
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1306
|
+
|---|---|---|---|---|
|
|
1307
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1308
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1309
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1310
|
+
|
|
968
1311
|
## organization
|
|
969
1312
|
|
|
970
1313
|
### organization.charges
|
|
@@ -1007,6 +1350,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1007
1350
|
| create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1008
1351
|
| list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1009
1352
|
|
|
1353
|
+
### organization.members
|
|
1354
|
+
|
|
1355
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1356
|
+
|---|---|---|---|---|
|
|
1357
|
+
| list | GET | `/organization/v1/members` | no | no |
|
|
1358
|
+
|
|
1010
1359
|
### organization.usage
|
|
1011
1360
|
|
|
1012
1361
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1089,7 +1438,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1089
1438
|
|
|
1090
1439
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1091
1440
|
|---|---|---|---|---|
|
|
1441
|
+
| create | POST | `/sandbox/v1/templates` | no | no |
|
|
1442
|
+
| delete | DELETE | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1092
1443
|
| list | GET | `/sandbox/v1/templates` | no | no |
|
|
1444
|
+
| retrieve | GET | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1445
|
+
|
|
1446
|
+
### sandbox.templates.aliases
|
|
1447
|
+
|
|
1448
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1449
|
+
|---|---|---|---|---|
|
|
1450
|
+
| retrieve | GET | `/sandbox/v1/templates/aliases/{alias}` | no | no |
|
|
1451
|
+
|
|
1452
|
+
### sandbox.templates.builds
|
|
1453
|
+
|
|
1454
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1455
|
+
|---|---|---|---|---|
|
|
1456
|
+
| update | POST | `/sandbox/v1/templates/{templateID}/builds/{buildID}` | no | no |
|
|
1457
|
+
|
|
1458
|
+
### sandbox.templates.builds.status
|
|
1459
|
+
|
|
1460
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1461
|
+
|---|---|---|---|---|
|
|
1462
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/builds/{buildID}/status` | no | no |
|
|
1463
|
+
|
|
1464
|
+
### sandbox.templates.tags
|
|
1465
|
+
|
|
1466
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1467
|
+
|---|---|---|---|---|
|
|
1468
|
+
| create | POST | `/sandbox/v1/templates/tags` | no | no |
|
|
1469
|
+
| delete | DELETE | `/sandbox/v1/templates/tags` | no | no |
|
|
1470
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/tags` | no | no |
|
|
1093
1471
|
|
|
1094
1472
|
### sandbox.volumes
|
|
1095
1473
|
|
|
@@ -1339,10 +1717,33 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1339
1717
|
| agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
|
|
1340
1718
|
| automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
|
|
1341
1719
|
| automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
|
|
1720
|
+
| automation.scripts.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1342
1721
|
| automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
|
|
1343
1722
|
| automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
|
|
1723
|
+
| automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1344
1724
|
| automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
|
|
1725
|
+
| crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1726
|
+
| crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1727
|
+
| crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1728
|
+
| crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1729
|
+
| crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1730
|
+
| crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1731
|
+
| crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
|
|
1732
|
+
| crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1733
|
+
| crm.associations.createDefault | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1734
|
+
| crm.associations.list | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1735
|
+
| crm.associations.remove | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1736
|
+
| crm.associations.create | CRM relationships live below objects in the URL but form the associations SDK resource; distinguish labelled and default creation from record updates. |
|
|
1737
|
+
| crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1738
|
+
| crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1739
|
+
| crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1740
|
+
| crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1741
|
+
| crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1742
|
+
| crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1743
|
+
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1345
1744
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1745
|
+
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
1746
|
+
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1346
1747
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1347
1748
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1348
1749
|
| sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Models, agents, sandboxes, search, data and automation, typed end to end.**
|
|
6
6
|
|
|
7
|
-
The official TypeScript SDK for [
|
|
7
|
+
The official TypeScript SDK for [Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
|
|
8
8
|
|
|
9
9
|
[](https://www.npmjs.com/package/@deepraxis/sdk)
|
|
10
10
|
[](https://bundlephobia.com/package/@deepraxis/sdk)
|
|
@@ -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
|
});
|
|
@@ -276,5 +276,5 @@ sandboxes, search, data, automation and the rest of the platform.
|
|
|
276
276
|
|
|
277
277
|
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). Copyright 2026 南京深度实践人工智能科技有限公司 (Deepractice).
|
|
278
278
|
|
|
279
|
-
"Praxis"
|
|
279
|
+
"Praxis" and "Deepraxis" are trademarks of Deepractice; the license does not grant
|
|
280
280
|
rights to use them.
|
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')
|