@deepraxis/sdk 0.1.1-dev.d775f1e → 0.1.1-dev.da8587f
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 +500 -1
- package/README.md +3 -3
- package/dist/automation.d.ts +61 -0
- package/dist/core/client.d.ts +11 -1
- package/dist/core/client.js +13 -0
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -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 +1113 -62
- package/dist/generated/sdk.gen.js +3404 -523
- package/dist/generated/types.gen.d.ts +53939 -36915
- package/dist/helpers/application-build.d.ts +10 -0
- package/dist/helpers/application-build.js +98 -0
- package/dist/helpers/application-publish.d.ts +8 -0
- package/dist/helpers/application-publish.js +26 -9
- package/dist/helpers/browser-connect.d.ts +78 -0
- package/dist/helpers/browser-connect.js +161 -0
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +84 -0
- package/dist/helpers/browser-documentation.d.ts +2 -0
- package/dist/helpers/browser-documentation.js +47 -0
- 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 +6 -0
- package/dist/index.js +3 -0
- package/dist/operations.generated.d.ts +6641 -2179
- package/dist/operations.generated.js +8968 -3410
- package/dist/resources.generated.d.ts +601 -47
- package/dist/resources.generated.js +304 -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`. 567 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 |
|
|
@@ -374,6 +380,16 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
374
380
|
|---|---|---|---|---|
|
|
375
381
|
| send | POST | `/automation/v1/hooks/{trigger_id}/{token}` | no | no |
|
|
376
382
|
|
|
383
|
+
### automation.humanTasks
|
|
384
|
+
|
|
385
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
386
|
+
|---|---|---|---|---|
|
|
387
|
+
| cancel | POST | `/automation/v1/human-tasks/{id}/cancel` | no | no |
|
|
388
|
+
| delegate | POST | `/automation/v1/human-tasks/{id}/delegate` | no | no |
|
|
389
|
+
| list | GET | `/automation/v1/human-tasks` | no | yes |
|
|
390
|
+
| respond | POST | `/automation/v1/human-tasks/{id}/respond` | no | no |
|
|
391
|
+
| retrieve | GET | `/automation/v1/human-tasks/{id}` | no | no |
|
|
392
|
+
|
|
377
393
|
### automation.resolve
|
|
378
394
|
|
|
379
395
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -439,6 +455,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
439
455
|
| list | GET | `/automation/v1/scripts/{ns}/{name}/dist-tags` | no | no |
|
|
440
456
|
| set | PUT | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
|
|
441
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
|
+
|
|
442
466
|
### automation.scripts.versions
|
|
443
467
|
|
|
444
468
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -500,6 +524,14 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
500
524
|
| list | GET | `/automation/v1/workflows/{ns}/{name}/dist-tags` | no | no |
|
|
501
525
|
| set | PUT | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
|
|
502
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
|
+
|
|
503
535
|
### automation.workflows.versions
|
|
504
536
|
|
|
505
537
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -569,6 +601,222 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
569
601
|
|---|---|---|---|---|
|
|
570
602
|
| create | POST | `/browser/v1/sessions/{sessionId}/viewer` | no | no |
|
|
571
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.renders
|
|
796
|
+
|
|
797
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
798
|
+
|---|---|---|---|---|
|
|
799
|
+
| create | POST | `/cut/v1/projects/{project_id}/renders` | no | no |
|
|
800
|
+
|
|
801
|
+
### cut.projects.versions
|
|
802
|
+
|
|
803
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
804
|
+
|---|---|---|---|---|
|
|
805
|
+
| create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
806
|
+
| list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
807
|
+
|
|
808
|
+
### cut.renders
|
|
809
|
+
|
|
810
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
811
|
+
|---|---|---|---|---|
|
|
812
|
+
| retrieve | GET | `/cut/v1/renders/{render_id}` | no | no |
|
|
813
|
+
|
|
814
|
+
### cut.versions
|
|
815
|
+
|
|
816
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
817
|
+
|---|---|---|---|---|
|
|
818
|
+
| restore | POST | `/cut/v1/versions/{version_id}:restore` | no | no |
|
|
819
|
+
|
|
572
820
|
## database
|
|
573
821
|
|
|
574
822
|
### database.databases
|
|
@@ -622,6 +870,82 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
622
870
|
| delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
|
|
623
871
|
| update | PATCH | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
|
|
624
872
|
|
|
873
|
+
## devops
|
|
874
|
+
|
|
875
|
+
### devops.projects
|
|
876
|
+
|
|
877
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
878
|
+
|---|---|---|---|---|
|
|
879
|
+
| retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
|
|
880
|
+
|
|
881
|
+
### devops.projects.testCases
|
|
882
|
+
|
|
883
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
884
|
+
|---|---|---|---|---|
|
|
885
|
+
| list | GET | `/devops/v1/projects/{project}/test-cases` | no | no |
|
|
886
|
+
|
|
887
|
+
### devops.projects.testPlans
|
|
888
|
+
|
|
889
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
890
|
+
|---|---|---|---|---|
|
|
891
|
+
| create | POST | `/devops/v1/projects/{project}/test-plans` | no | no |
|
|
892
|
+
| list | GET | `/devops/v1/projects/{project}/test-plans` | no | no |
|
|
893
|
+
|
|
894
|
+
### devops.projects.testReports
|
|
895
|
+
|
|
896
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
897
|
+
|---|---|---|---|---|
|
|
898
|
+
| create | POST | `/devops/v1/projects/{project}/test-reports` | no | no |
|
|
899
|
+
|
|
900
|
+
### devops.projects.testRuns
|
|
901
|
+
|
|
902
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
903
|
+
|---|---|---|---|---|
|
|
904
|
+
| create | POST | `/devops/v1/projects/{project}/test-runs` | no | no |
|
|
905
|
+
| list | GET | `/devops/v1/projects/{project}/test-runs` | no | no |
|
|
906
|
+
|
|
907
|
+
### devops.projects.testSuites
|
|
908
|
+
|
|
909
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
910
|
+
|---|---|---|---|---|
|
|
911
|
+
| list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
|
|
912
|
+
|
|
913
|
+
### devops.testCases
|
|
914
|
+
|
|
915
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
916
|
+
|---|---|---|---|---|
|
|
917
|
+
| retrieve | GET | `/devops/v1/test-cases/{id}` | no | no |
|
|
918
|
+
|
|
919
|
+
### devops.testPlans
|
|
920
|
+
|
|
921
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
922
|
+
|---|---|---|---|---|
|
|
923
|
+
| delete | DELETE | `/devops/v1/test-plans/{id}` | no | no |
|
|
924
|
+
| pause | POST | `/devops/v1/test-plans/{id}:pause` | no | no |
|
|
925
|
+
| resume | POST | `/devops/v1/test-plans/{id}:resume` | no | no |
|
|
926
|
+
| retrieve | GET | `/devops/v1/test-plans/{id}` | no | no |
|
|
927
|
+
| update | PATCH | `/devops/v1/test-plans/{id}` | no | no |
|
|
928
|
+
|
|
929
|
+
### devops.testRuns
|
|
930
|
+
|
|
931
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
932
|
+
|---|---|---|---|---|
|
|
933
|
+
| cancel | POST | `/devops/v1/test-runs/{id}:cancel` | no | no |
|
|
934
|
+
| retrieve | GET | `/devops/v1/test-runs/{id}` | no | no |
|
|
935
|
+
|
|
936
|
+
### devops.testRuns.executions
|
|
937
|
+
|
|
938
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
939
|
+
|---|---|---|---|---|
|
|
940
|
+
| list | GET | `/devops/v1/test-runs/{run}/executions` | no | no |
|
|
941
|
+
| retrieve | GET | `/devops/v1/test-runs/{run}/executions/{case}` | no | no |
|
|
942
|
+
|
|
943
|
+
### devops.testSuites
|
|
944
|
+
|
|
945
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
946
|
+
|---|---|---|---|---|
|
|
947
|
+
| retrieve | GET | `/devops/v1/test-suites/{id}` | no | no |
|
|
948
|
+
|
|
625
949
|
## file
|
|
626
950
|
|
|
627
951
|
### file.files
|
|
@@ -634,6 +958,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
634
958
|
| retrieve | GET | `/file/v1/files/{file_id}` | no | no |
|
|
635
959
|
| retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
|
|
636
960
|
|
|
961
|
+
### file.files.contentLinks
|
|
962
|
+
|
|
963
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
964
|
+
|---|---|---|---|---|
|
|
965
|
+
| revoke | POST | `/file/v1/files/{file_id}/content_links:revoke` | no | no |
|
|
966
|
+
|
|
967
|
+
### file.files.contentUrl
|
|
968
|
+
|
|
969
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
970
|
+
|---|---|---|---|---|
|
|
971
|
+
| create | POST | `/file/v1/files/{file_id}/content_url` | no | no |
|
|
972
|
+
|
|
637
973
|
### file.uploads
|
|
638
974
|
|
|
639
975
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -641,6 +977,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
641
977
|
| cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
|
|
642
978
|
| complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
|
|
643
979
|
| create | POST | `/file/v1/uploads` | no | no |
|
|
980
|
+
| createSigned | POST | `/file/v1/uploads/signed` | no | no |
|
|
981
|
+
| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
|
|
644
982
|
|
|
645
983
|
### file.uploads.parts
|
|
646
984
|
|
|
@@ -724,6 +1062,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
724
1062
|
|
|
725
1063
|
## media
|
|
726
1064
|
|
|
1065
|
+
### media.generation.capabilities
|
|
1066
|
+
|
|
1067
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1068
|
+
|---|---|---|---|---|
|
|
1069
|
+
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
1070
|
+
|
|
727
1071
|
### media.libraries
|
|
728
1072
|
|
|
729
1073
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -746,6 +1090,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
746
1090
|
| retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
747
1091
|
| update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
748
1092
|
|
|
1093
|
+
### media.libraries.assets.frames
|
|
1094
|
+
|
|
1095
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1096
|
+
|---|---|---|---|---|
|
|
1097
|
+
| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
|
|
1098
|
+
|
|
749
1099
|
### media.libraries.assets.import
|
|
750
1100
|
|
|
751
1101
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -771,6 +1121,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
771
1121
|
| create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
|
|
772
1122
|
| retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
|
|
773
1123
|
|
|
1124
|
+
### media.libraries.deliveryTokens
|
|
1125
|
+
|
|
1126
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1127
|
+
|---|---|---|---|---|
|
|
1128
|
+
| create | POST | `/media/v1/libraries/{library_id}/delivery_tokens` | no | no |
|
|
1129
|
+
|
|
774
1130
|
### media.libraries.events
|
|
775
1131
|
|
|
776
1132
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -783,12 +1139,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
783
1139
|
|---|---|---|---|---|
|
|
784
1140
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
785
1141
|
|
|
1142
|
+
### media.libraries.generations
|
|
1143
|
+
|
|
1144
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1145
|
+
|---|---|---|---|---|
|
|
1146
|
+
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1147
|
+
|
|
786
1148
|
### media.libraries.jobs
|
|
787
1149
|
|
|
788
1150
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
789
1151
|
|---|---|---|---|---|
|
|
1152
|
+
| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
|
|
1153
|
+
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
790
1154
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
791
1155
|
|
|
1156
|
+
### media.libraries.jobs.outputs.save
|
|
1157
|
+
|
|
1158
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1159
|
+
|---|---|---|---|---|
|
|
1160
|
+
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1161
|
+
|
|
792
1162
|
### media.libraries.purge
|
|
793
1163
|
|
|
794
1164
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -819,8 +1189,22 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
819
1189
|
|---|---|---|---|---|
|
|
820
1190
|
| create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
|
|
821
1191
|
|
|
1192
|
+
### media.libraries.understandings
|
|
1193
|
+
|
|
1194
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1195
|
+
|---|---|---|---|---|
|
|
1196
|
+
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1197
|
+
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1198
|
+
|
|
822
1199
|
## meta
|
|
823
1200
|
|
|
1201
|
+
### meta.docs
|
|
1202
|
+
|
|
1203
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1204
|
+
|---|---|---|---|---|
|
|
1205
|
+
| retrieve | GET | `/meta/v1/docs/{path}` | no | no |
|
|
1206
|
+
| search | GET | `/meta/v1/docs/search` | no | no |
|
|
1207
|
+
|
|
824
1208
|
### meta.health
|
|
825
1209
|
|
|
826
1210
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -944,6 +1328,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
944
1328
|
|---|---|---|---|---|
|
|
945
1329
|
| create | POST | `/model/v1/responses/input_tokens` | no | no |
|
|
946
1330
|
|
|
1331
|
+
### model.systemone
|
|
1332
|
+
|
|
1333
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1334
|
+
|---|---|---|---|---|
|
|
1335
|
+
| create | POST | `/model/v1/systemone` | no | no |
|
|
1336
|
+
|
|
947
1337
|
### model.videos
|
|
948
1338
|
|
|
949
1339
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -955,6 +1345,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
955
1345
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
956
1346
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
957
1347
|
|
|
1348
|
+
## ontology
|
|
1349
|
+
|
|
1350
|
+
### ontology.changesets
|
|
1351
|
+
|
|
1352
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1353
|
+
|---|---|---|---|---|
|
|
1354
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1355
|
+
|
|
1356
|
+
### ontology.nodes
|
|
1357
|
+
|
|
1358
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1359
|
+
|---|---|---|---|---|
|
|
1360
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1361
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1362
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1363
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1364
|
+
|
|
1365
|
+
### ontology.nodes.merge
|
|
1366
|
+
|
|
1367
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1368
|
+
|---|---|---|---|---|
|
|
1369
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1370
|
+
|
|
1371
|
+
### ontology.relations
|
|
1372
|
+
|
|
1373
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1374
|
+
|---|---|---|---|---|
|
|
1375
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1376
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1377
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1378
|
+
|
|
1379
|
+
### ontology.relations.invalidate
|
|
1380
|
+
|
|
1381
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1382
|
+
|---|---|---|---|---|
|
|
1383
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1384
|
+
|
|
1385
|
+
### ontology.search
|
|
1386
|
+
|
|
1387
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1388
|
+
|---|---|---|---|---|
|
|
1389
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1390
|
+
|
|
1391
|
+
### ontology.types
|
|
1392
|
+
|
|
1393
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1394
|
+
|---|---|---|---|---|
|
|
1395
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1396
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1397
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1398
|
+
|
|
958
1399
|
## organization
|
|
959
1400
|
|
|
960
1401
|
### organization.charges
|
|
@@ -997,6 +1438,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
997
1438
|
| create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
998
1439
|
| list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
999
1440
|
|
|
1441
|
+
### organization.members
|
|
1442
|
+
|
|
1443
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1444
|
+
|---|---|---|---|---|
|
|
1445
|
+
| list | GET | `/organization/v1/members` | no | no |
|
|
1446
|
+
|
|
1000
1447
|
### organization.usage
|
|
1001
1448
|
|
|
1002
1449
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1079,7 +1526,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1079
1526
|
|
|
1080
1527
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1081
1528
|
|---|---|---|---|---|
|
|
1529
|
+
| create | POST | `/sandbox/v1/templates` | no | no |
|
|
1530
|
+
| delete | DELETE | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1082
1531
|
| list | GET | `/sandbox/v1/templates` | no | no |
|
|
1532
|
+
| retrieve | GET | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1533
|
+
|
|
1534
|
+
### sandbox.templates.aliases
|
|
1535
|
+
|
|
1536
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1537
|
+
|---|---|---|---|---|
|
|
1538
|
+
| retrieve | GET | `/sandbox/v1/templates/aliases/{alias}` | no | no |
|
|
1539
|
+
|
|
1540
|
+
### sandbox.templates.builds
|
|
1541
|
+
|
|
1542
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1543
|
+
|---|---|---|---|---|
|
|
1544
|
+
| update | POST | `/sandbox/v1/templates/{templateID}/builds/{buildID}` | no | no |
|
|
1545
|
+
|
|
1546
|
+
### sandbox.templates.builds.status
|
|
1547
|
+
|
|
1548
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1549
|
+
|---|---|---|---|---|
|
|
1550
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/builds/{buildID}/status` | no | no |
|
|
1551
|
+
|
|
1552
|
+
### sandbox.templates.tags
|
|
1553
|
+
|
|
1554
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1555
|
+
|---|---|---|---|---|
|
|
1556
|
+
| create | POST | `/sandbox/v1/templates/tags` | no | no |
|
|
1557
|
+
| delete | DELETE | `/sandbox/v1/templates/tags` | no | no |
|
|
1558
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/tags` | no | no |
|
|
1083
1559
|
|
|
1084
1560
|
### sandbox.volumes
|
|
1085
1561
|
|
|
@@ -1329,10 +1805,33 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1329
1805
|
| agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
|
|
1330
1806
|
| automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
|
|
1331
1807
|
| automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
|
|
1808
|
+
| automation.scripts.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1332
1809
|
| automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
|
|
1333
1810
|
| automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
|
|
1811
|
+
| automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1334
1812
|
| automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
|
|
1813
|
+
| crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1814
|
+
| crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1815
|
+
| crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1816
|
+
| crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1817
|
+
| crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1818
|
+
| crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
1819
|
+
| crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
|
|
1820
|
+
| crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1821
|
+
| 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. |
|
|
1822
|
+
| 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. |
|
|
1823
|
+
| 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. |
|
|
1824
|
+
| 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. |
|
|
1825
|
+
| crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1826
|
+
| crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1827
|
+
| crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1828
|
+
| crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1829
|
+
| crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1830
|
+
| crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
1831
|
+
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1335
1832
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1833
|
+
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
1834
|
+
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1336
1835
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1337
1836
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1338
1837
|
| 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.
|