@deepraxis/sdk 0.1.1-dev.f8aa5de → 0.1.1-dev.faa3b25
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 +786 -1
- package/README.md +5 -5
- 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/credentials.d.ts +12 -3
- package/dist/core/credentials.js +22 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/core/transport.d.ts +10 -1
- 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 +1941 -252
- package/dist/generated/sdk.gen.js +5749 -932
- package/dist/generated/types.gen.d.ts +61769 -34021
- package/dist/helpers/browser-actions.d.ts +84 -0
- package/dist/helpers/browser-actions.js +141 -0
- package/dist/helpers/browser-connect.d.ts +26 -2
- package/dist/helpers/browser-connect.js +263 -25
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +53 -0
- package/dist/helpers/browser-documentation.d.ts +1 -1
- package/dist/helpers/browser-documentation.js +20 -11
- package/dist/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 +35 -13481
- package/dist/operations.generated.js +14859 -5071
- package/dist/resources.generated.d.ts +747 -37
- package/dist/resources.generated.js +485 -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`. 678 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 |
|
|
@@ -554,12 +576,20 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
554
576
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
555
577
|
|---|---|---|---|---|
|
|
556
578
|
| create | POST | `/browser/v1/sessions` | no | no |
|
|
579
|
+
| frames | GET | `/browser/v1/sessions/{sessionId}/frames` | always | no |
|
|
557
580
|
| list | GET | `/browser/v1/sessions` | no | no |
|
|
558
581
|
| retrieve | GET | `/browser/v1/sessions/{sessionId}` | no | no |
|
|
559
582
|
| retrieveDebug | GET | `/browser/v1/sessions/{sessionId}/debug` | no | no |
|
|
583
|
+
| retrieveFrame | GET | `/browser/v1/sessions/{sessionId}/frame` | no | no |
|
|
560
584
|
| stream | GET | `/browser/v1/sessions/{sessionId}/stream` | always | no |
|
|
561
585
|
| update | POST | `/browser/v1/sessions/{sessionId}` | no | no |
|
|
562
586
|
|
|
587
|
+
### browser.sessions.actions
|
|
588
|
+
|
|
589
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
590
|
+
|---|---|---|---|---|
|
|
591
|
+
| create | POST | `/browser/v1/sessions/{sessionId}/actions` | no | no |
|
|
592
|
+
|
|
563
593
|
### browser.sessions.events
|
|
564
594
|
|
|
565
595
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -579,6 +609,222 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
579
609
|
|---|---|---|---|---|
|
|
580
610
|
| create | POST | `/browser/v1/sessions/{sessionId}/viewer` | no | no |
|
|
581
611
|
|
|
612
|
+
## canvas
|
|
613
|
+
|
|
614
|
+
### canvas.canvases
|
|
615
|
+
|
|
616
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
617
|
+
|---|---|---|---|---|
|
|
618
|
+
| create | POST | `/canvas/v1/canvases` | no | no |
|
|
619
|
+
| delete | DELETE | `/canvas/v1/canvases/{canvas_id}` | no | no |
|
|
620
|
+
| execute | POST | `/canvas/v1/canvases/{canvas_id}:execute` | no | no |
|
|
621
|
+
| list | GET | `/canvas/v1/canvases` | no | yes |
|
|
622
|
+
| restore | POST | `/canvas/v1/canvases/{canvas_id}:restore` | no | no |
|
|
623
|
+
| retrieve | GET | `/canvas/v1/canvases/{canvas_id}` | no | no |
|
|
624
|
+
| update | PATCH | `/canvas/v1/canvases/{canvas_id}` | no | no |
|
|
625
|
+
|
|
626
|
+
### canvas.canvases.images
|
|
627
|
+
|
|
628
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
629
|
+
|---|---|---|---|---|
|
|
630
|
+
| list | GET | `/canvas/v1/canvases/{canvas_id}/images` | no | no |
|
|
631
|
+
|
|
632
|
+
### canvas.canvases.nodes
|
|
633
|
+
|
|
634
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
635
|
+
|---|---|---|---|---|
|
|
636
|
+
| list | GET | `/canvas/v1/canvases/{canvas_id}/nodes` | no | no |
|
|
637
|
+
|
|
638
|
+
### canvas.canvases.versions
|
|
639
|
+
|
|
640
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
641
|
+
|---|---|---|---|---|
|
|
642
|
+
| list | GET | `/canvas/v1/canvases/{canvas_id}/versions` | no | no |
|
|
643
|
+
|
|
644
|
+
### canvas.collections
|
|
645
|
+
|
|
646
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
647
|
+
|---|---|---|---|---|
|
|
648
|
+
| create | POST | `/canvas/v1/collections` | no | no |
|
|
649
|
+
| delete | DELETE | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
650
|
+
| list | GET | `/canvas/v1/collections` | no | no |
|
|
651
|
+
| retrieve | GET | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
652
|
+
| update | PATCH | `/canvas/v1/collections/{collection_id}` | no | no |
|
|
653
|
+
|
|
654
|
+
## crm
|
|
655
|
+
|
|
656
|
+
### crm.associations
|
|
657
|
+
|
|
658
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
659
|
+
|---|---|---|---|---|
|
|
660
|
+
| create | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
|
|
661
|
+
| createDefault | PUT | `/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}` | no | no |
|
|
662
|
+
| list | GET | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}` | no | no |
|
|
663
|
+
| remove | DELETE | `/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}` | no | no |
|
|
664
|
+
|
|
665
|
+
### crm.changes
|
|
666
|
+
|
|
667
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
668
|
+
|---|---|---|---|---|
|
|
669
|
+
| revert | POST | `/crm/v1/changes/{changeSetId}:revert` | no | no |
|
|
670
|
+
|
|
671
|
+
### crm.layouts
|
|
672
|
+
|
|
673
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
674
|
+
|---|---|---|---|---|
|
|
675
|
+
| retrieve | GET | `/crm/v1/layouts/{objectType}` | no | no |
|
|
676
|
+
| update | PUT | `/crm/v1/layouts/{objectType}` | no | no |
|
|
677
|
+
|
|
678
|
+
### crm.leads
|
|
679
|
+
|
|
680
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
681
|
+
|---|---|---|---|---|
|
|
682
|
+
| qualify | POST | `/crm/v1/leads/{leadId}:qualify` | no | no |
|
|
683
|
+
|
|
684
|
+
### crm.objects
|
|
685
|
+
|
|
686
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
687
|
+
|---|---|---|---|---|
|
|
688
|
+
| archive | DELETE | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
689
|
+
| create | POST | `/crm/v1/objects/{objectType}` | no | no |
|
|
690
|
+
| list | GET | `/crm/v1/objects/{objectType}` | no | no |
|
|
691
|
+
| retrieve | GET | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
692
|
+
| search | POST | `/crm/v1/objects/{objectType}/search` | no | no |
|
|
693
|
+
| update | PATCH | `/crm/v1/objects/{objectType}/{objectId}` | no | no |
|
|
694
|
+
|
|
695
|
+
### crm.objects.batch
|
|
696
|
+
|
|
697
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
698
|
+
|---|---|---|---|---|
|
|
699
|
+
| archive | POST | `/crm/v1/objects/{objectType}/batch/archive` | no | no |
|
|
700
|
+
| create | POST | `/crm/v1/objects/{objectType}/batch/create` | no | no |
|
|
701
|
+
| read | POST | `/crm/v1/objects/{objectType}/batch/read` | no | no |
|
|
702
|
+
| update | POST | `/crm/v1/objects/{objectType}/batch/update` | no | no |
|
|
703
|
+
| upsert | POST | `/crm/v1/objects/{objectType}/batch/upsert` | no | no |
|
|
704
|
+
|
|
705
|
+
### crm.pipelines
|
|
706
|
+
|
|
707
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
708
|
+
|---|---|---|---|---|
|
|
709
|
+
| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
710
|
+
| create | POST | `/crm/v1/pipelines/{objectType}` | no | no |
|
|
711
|
+
| list | GET | `/crm/v1/pipelines/{objectType}` | no | no |
|
|
712
|
+
| retrieve | GET | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
713
|
+
| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}` | no | no |
|
|
714
|
+
|
|
715
|
+
### crm.pipelines.stages
|
|
716
|
+
|
|
717
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
718
|
+
|---|---|---|---|---|
|
|
719
|
+
| archive | DELETE | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
|
|
720
|
+
| create | POST | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages` | no | no |
|
|
721
|
+
| update | PATCH | `/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}` | no | no |
|
|
722
|
+
|
|
723
|
+
### crm.properties
|
|
724
|
+
|
|
725
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
726
|
+
|---|---|---|---|---|
|
|
727
|
+
| archive | DELETE | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
728
|
+
| create | POST | `/crm/v1/properties/{objectType}` | no | no |
|
|
729
|
+
| list | GET | `/crm/v1/properties/{objectType}` | no | no |
|
|
730
|
+
| retrieve | GET | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
731
|
+
| update | PATCH | `/crm/v1/properties/{objectType}/{propertyName}` | no | no |
|
|
732
|
+
|
|
733
|
+
### crm.properties.groups
|
|
734
|
+
|
|
735
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
736
|
+
|---|---|---|---|---|
|
|
737
|
+
| create | POST | `/crm/v1/properties/{objectType}/groups` | no | no |
|
|
738
|
+
| list | GET | `/crm/v1/properties/{objectType}/groups` | no | no |
|
|
739
|
+
|
|
740
|
+
### crm.schemas
|
|
741
|
+
|
|
742
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
743
|
+
|---|---|---|---|---|
|
|
744
|
+
| create | POST | `/crm/v1/schemas` | no | no |
|
|
745
|
+
| list | GET | `/crm/v1/schemas` | no | no |
|
|
746
|
+
|
|
747
|
+
## cut
|
|
748
|
+
|
|
749
|
+
### cut.exports
|
|
750
|
+
|
|
751
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
752
|
+
|---|---|---|---|---|
|
|
753
|
+
| cancel | POST | `/cut/v1/exports/{export_id}:cancel` | no | no |
|
|
754
|
+
| retrieve | GET | `/cut/v1/exports/{export_id}` | no | no |
|
|
755
|
+
|
|
756
|
+
### cut.projects
|
|
757
|
+
|
|
758
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
759
|
+
|---|---|---|---|---|
|
|
760
|
+
| create | POST | `/cut/v1/projects` | no | no |
|
|
761
|
+
| delete | DELETE | `/cut/v1/projects/{project_id}` | no | no |
|
|
762
|
+
| execute | POST | `/cut/v1/projects/{project_id}:execute` | no | no |
|
|
763
|
+
| list | GET | `/cut/v1/projects` | no | no |
|
|
764
|
+
| retrieve | GET | `/cut/v1/projects/{project_id}` | no | no |
|
|
765
|
+
| retrieveState | GET | `/cut/v1/projects/{project_id}/state` | no | no |
|
|
766
|
+
| retrieveTimeline | GET | `/cut/v1/projects/{project_id}/timeline` | no | no |
|
|
767
|
+
| undelete | POST | `/cut/v1/projects/{project_id}:undelete` | no | no |
|
|
768
|
+
| update | PATCH | `/cut/v1/projects/{project_id}` | no | no |
|
|
769
|
+
|
|
770
|
+
### cut.projects.analysis
|
|
771
|
+
|
|
772
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
773
|
+
|---|---|---|---|---|
|
|
774
|
+
| create | POST | `/cut/v1/projects/{project_id}/analysis` | no | no |
|
|
775
|
+
|
|
776
|
+
### cut.projects.bindings
|
|
777
|
+
|
|
778
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
779
|
+
|---|---|---|---|---|
|
|
780
|
+
| create | POST | `/cut/v1/projects/{project_id}/bindings` | no | no |
|
|
781
|
+
| delete | DELETE | `/cut/v1/projects/{project_id}/bindings/{name}` | no | no |
|
|
782
|
+
| list | GET | `/cut/v1/projects/{project_id}/bindings` | no | no |
|
|
783
|
+
|
|
784
|
+
### cut.projects.exports
|
|
785
|
+
|
|
786
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
787
|
+
|---|---|---|---|---|
|
|
788
|
+
| create | POST | `/cut/v1/projects/{project_id}/exports` | no | no |
|
|
789
|
+
| list | GET | `/cut/v1/projects/{project_id}/exports` | no | no |
|
|
790
|
+
|
|
791
|
+
### cut.projects.frames
|
|
792
|
+
|
|
793
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
794
|
+
|---|---|---|---|---|
|
|
795
|
+
| list | GET | `/cut/v1/projects/{project_id}/frames` | no | no |
|
|
796
|
+
|
|
797
|
+
### cut.projects.media
|
|
798
|
+
|
|
799
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
800
|
+
|---|---|---|---|---|
|
|
801
|
+
| import | POST | `/cut/v1/projects/{project_id}/media:import` | no | no |
|
|
802
|
+
|
|
803
|
+
### cut.projects.renders
|
|
804
|
+
|
|
805
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
806
|
+
|---|---|---|---|---|
|
|
807
|
+
| create | POST | `/cut/v1/projects/{project_id}/renders` | no | no |
|
|
808
|
+
|
|
809
|
+
### cut.projects.versions
|
|
810
|
+
|
|
811
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
812
|
+
|---|---|---|---|---|
|
|
813
|
+
| create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
814
|
+
| list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
815
|
+
|
|
816
|
+
### cut.renders
|
|
817
|
+
|
|
818
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
819
|
+
|---|---|---|---|---|
|
|
820
|
+
| retrieve | GET | `/cut/v1/renders/{render_id}` | no | no |
|
|
821
|
+
|
|
822
|
+
### cut.versions
|
|
823
|
+
|
|
824
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
825
|
+
|---|---|---|---|---|
|
|
826
|
+
| restore | POST | `/cut/v1/versions/{version_id}:restore` | no | no |
|
|
827
|
+
|
|
582
828
|
## database
|
|
583
829
|
|
|
584
830
|
### database.databases
|
|
@@ -632,6 +878,178 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
632
878
|
| delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
|
|
633
879
|
| update | PATCH | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
|
|
634
880
|
|
|
881
|
+
## devops
|
|
882
|
+
|
|
883
|
+
### devops.environments.checkpoints
|
|
884
|
+
|
|
885
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
886
|
+
|---|---|---|---|---|
|
|
887
|
+
| list | GET | `/devops/v1/environments/{id}/checkpoints` | no | no |
|
|
888
|
+
|
|
889
|
+
### devops.flags
|
|
890
|
+
|
|
891
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
892
|
+
|---|---|---|---|---|
|
|
893
|
+
| archive | POST | `/devops/v1/flags/{id}:archive` | no | no |
|
|
894
|
+
| conclude | POST | `/devops/v1/flags/{id}:conclude` | no | no |
|
|
895
|
+
| retrieve | GET | `/devops/v1/flags/{id}` | no | no |
|
|
896
|
+
| update | PATCH | `/devops/v1/flags/{id}` | no | no |
|
|
897
|
+
|
|
898
|
+
### devops.flags.environments
|
|
899
|
+
|
|
900
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
901
|
+
|---|---|---|---|---|
|
|
902
|
+
| update | PATCH | `/devops/v1/flags/{id}/environments/{environment}` | no | no |
|
|
903
|
+
|
|
904
|
+
### devops.progressiveRollouts
|
|
905
|
+
|
|
906
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
907
|
+
|---|---|---|---|---|
|
|
908
|
+
| create | POST | `/devops/v1/progressive-rollouts` | no | no |
|
|
909
|
+
| pause | POST | `/devops/v1/progressive-rollouts/{id}:pause` | no | no |
|
|
910
|
+
| resume | POST | `/devops/v1/progressive-rollouts/{id}:resume` | no | no |
|
|
911
|
+
| retrieve | GET | `/devops/v1/progressive-rollouts/{id}` | no | no |
|
|
912
|
+
| rollback | POST | `/devops/v1/progressive-rollouts/{id}:rollback` | no | no |
|
|
913
|
+
|
|
914
|
+
### devops.projects
|
|
915
|
+
|
|
916
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
917
|
+
|---|---|---|---|---|
|
|
918
|
+
| list | GET | `/devops/v1/projects` | no | no |
|
|
919
|
+
| retrieve | GET | `/devops/v1/projects/{id}` | no | no |
|
|
920
|
+
| retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
|
|
921
|
+
|
|
922
|
+
### devops.projects.environments
|
|
923
|
+
|
|
924
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
925
|
+
|---|---|---|---|---|
|
|
926
|
+
| list | GET | `/devops/v1/projects/{project}/environments` | no | no |
|
|
927
|
+
|
|
928
|
+
### devops.projects.flags
|
|
929
|
+
|
|
930
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
931
|
+
|---|---|---|---|---|
|
|
932
|
+
| create | POST | `/devops/v1/projects/{project}/flags` | no | no |
|
|
933
|
+
| list | GET | `/devops/v1/projects/{project}/flags` | no | no |
|
|
934
|
+
|
|
935
|
+
### devops.projects.promotions
|
|
936
|
+
|
|
937
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
938
|
+
|---|---|---|---|---|
|
|
939
|
+
| list | GET | `/devops/v1/projects/{project}/promotions` | no | no |
|
|
940
|
+
|
|
941
|
+
### devops.projects.releases
|
|
942
|
+
|
|
943
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
944
|
+
|---|---|---|---|---|
|
|
945
|
+
| create | POST | `/devops/v1/projects/{project}/releases` | no | no |
|
|
946
|
+
| list | GET | `/devops/v1/projects/{project}/releases` | no | no |
|
|
947
|
+
|
|
948
|
+
### devops.projects.targets
|
|
949
|
+
|
|
950
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
951
|
+
|---|---|---|---|---|
|
|
952
|
+
| list | GET | `/devops/v1/projects/{project}/targets` | no | no |
|
|
953
|
+
| refresh | POST | `/devops/v1/projects/{project}/targets:refresh` | no | no |
|
|
954
|
+
|
|
955
|
+
### devops.projects.testCases
|
|
956
|
+
|
|
957
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
958
|
+
|---|---|---|---|---|
|
|
959
|
+
| list | GET | `/devops/v1/projects/{project}/test-cases` | no | no |
|
|
960
|
+
|
|
961
|
+
### devops.projects.testPlans
|
|
962
|
+
|
|
963
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
964
|
+
|---|---|---|---|---|
|
|
965
|
+
| create | POST | `/devops/v1/projects/{project}/test-plans` | no | no |
|
|
966
|
+
| list | GET | `/devops/v1/projects/{project}/test-plans` | no | no |
|
|
967
|
+
|
|
968
|
+
### devops.projects.testReports
|
|
969
|
+
|
|
970
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
971
|
+
|---|---|---|---|---|
|
|
972
|
+
| create | POST | `/devops/v1/projects/{project}/test-reports` | no | no |
|
|
973
|
+
|
|
974
|
+
### devops.projects.testRuns
|
|
975
|
+
|
|
976
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
977
|
+
|---|---|---|---|---|
|
|
978
|
+
| create | POST | `/devops/v1/projects/{project}/test-runs` | no | no |
|
|
979
|
+
| list | GET | `/devops/v1/projects/{project}/test-runs` | no | no |
|
|
980
|
+
|
|
981
|
+
### devops.projects.testSuites
|
|
982
|
+
|
|
983
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
984
|
+
|---|---|---|---|---|
|
|
985
|
+
| list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
|
|
986
|
+
|
|
987
|
+
### devops.promotions
|
|
988
|
+
|
|
989
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
990
|
+
|---|---|---|---|---|
|
|
991
|
+
| approve | POST | `/devops/v1/promotions/{id}:approve` | no | no |
|
|
992
|
+
| cancel | POST | `/devops/v1/promotions/{id}:cancel` | no | no |
|
|
993
|
+
| conclude | POST | `/devops/v1/promotions/{id}:conclude` | no | no |
|
|
994
|
+
| create | POST | `/devops/v1/promotions` | no | no |
|
|
995
|
+
| retrieve | GET | `/devops/v1/promotions/{id}` | no | no |
|
|
996
|
+
| retry | POST | `/devops/v1/promotions/{id}:retry` | no | no |
|
|
997
|
+
|
|
998
|
+
### devops.promotions.rollouts
|
|
999
|
+
|
|
1000
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1001
|
+
|---|---|---|---|---|
|
|
1002
|
+
| list | GET | `/devops/v1/promotions/{promotion}/rollouts` | no | no |
|
|
1003
|
+
|
|
1004
|
+
### devops.releases
|
|
1005
|
+
|
|
1006
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1007
|
+
|---|---|---|---|---|
|
|
1008
|
+
| abandon | POST | `/devops/v1/releases/{id}:abandon` | no | no |
|
|
1009
|
+
| retrieve | GET | `/devops/v1/releases/{id}` | no | no |
|
|
1010
|
+
|
|
1011
|
+
### devops.rollouts
|
|
1012
|
+
|
|
1013
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1014
|
+
|---|---|---|---|---|
|
|
1015
|
+
| retrieve | GET | `/devops/v1/rollouts/{id}` | no | no |
|
|
1016
|
+
|
|
1017
|
+
### devops.testCases
|
|
1018
|
+
|
|
1019
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1020
|
+
|---|---|---|---|---|
|
|
1021
|
+
| retrieve | GET | `/devops/v1/test-cases/{id}` | no | no |
|
|
1022
|
+
|
|
1023
|
+
### devops.testPlans
|
|
1024
|
+
|
|
1025
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1026
|
+
|---|---|---|---|---|
|
|
1027
|
+
| delete | DELETE | `/devops/v1/test-plans/{id}` | no | no |
|
|
1028
|
+
| pause | POST | `/devops/v1/test-plans/{id}:pause` | no | no |
|
|
1029
|
+
| resume | POST | `/devops/v1/test-plans/{id}:resume` | no | no |
|
|
1030
|
+
| retrieve | GET | `/devops/v1/test-plans/{id}` | no | no |
|
|
1031
|
+
| update | PATCH | `/devops/v1/test-plans/{id}` | no | no |
|
|
1032
|
+
|
|
1033
|
+
### devops.testRuns
|
|
1034
|
+
|
|
1035
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1036
|
+
|---|---|---|---|---|
|
|
1037
|
+
| cancel | POST | `/devops/v1/test-runs/{id}:cancel` | no | no |
|
|
1038
|
+
| retrieve | GET | `/devops/v1/test-runs/{id}` | no | no |
|
|
1039
|
+
|
|
1040
|
+
### devops.testRuns.executions
|
|
1041
|
+
|
|
1042
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1043
|
+
|---|---|---|---|---|
|
|
1044
|
+
| list | GET | `/devops/v1/test-runs/{run}/executions` | no | no |
|
|
1045
|
+
| retrieve | GET | `/devops/v1/test-runs/{run}/executions/{case}` | no | no |
|
|
1046
|
+
|
|
1047
|
+
### devops.testSuites
|
|
1048
|
+
|
|
1049
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1050
|
+
|---|---|---|---|---|
|
|
1051
|
+
| retrieve | GET | `/devops/v1/test-suites/{id}` | no | no |
|
|
1052
|
+
|
|
635
1053
|
## file
|
|
636
1054
|
|
|
637
1055
|
### file.files
|
|
@@ -644,6 +1062,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
644
1062
|
| retrieve | GET | `/file/v1/files/{file_id}` | no | no |
|
|
645
1063
|
| retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
|
|
646
1064
|
|
|
1065
|
+
### file.files.contentLinks
|
|
1066
|
+
|
|
1067
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1068
|
+
|---|---|---|---|---|
|
|
1069
|
+
| revoke | POST | `/file/v1/files/{file_id}/content_links:revoke` | no | no |
|
|
1070
|
+
|
|
1071
|
+
### file.files.contentUrl
|
|
1072
|
+
|
|
1073
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1074
|
+
|---|---|---|---|---|
|
|
1075
|
+
| create | POST | `/file/v1/files/{file_id}/content_url` | no | no |
|
|
1076
|
+
|
|
647
1077
|
### file.uploads
|
|
648
1078
|
|
|
649
1079
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -651,6 +1081,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
651
1081
|
| cancel | POST | `/file/v1/uploads/{upload_id}/cancel` | no | no |
|
|
652
1082
|
| complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
|
|
653
1083
|
| create | POST | `/file/v1/uploads` | no | no |
|
|
1084
|
+
| createSigned | POST | `/file/v1/uploads/signed` | no | no |
|
|
1085
|
+
| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
|
|
654
1086
|
|
|
655
1087
|
### file.uploads.parts
|
|
656
1088
|
|
|
@@ -734,6 +1166,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
734
1166
|
|
|
735
1167
|
## media
|
|
736
1168
|
|
|
1169
|
+
### media.assets
|
|
1170
|
+
|
|
1171
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1172
|
+
|---|---|---|---|---|
|
|
1173
|
+
| edit | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/edits` | no | no |
|
|
1174
|
+
| lineage | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | no | no |
|
|
1175
|
+
|
|
1176
|
+
### media.generation.capabilities
|
|
1177
|
+
|
|
1178
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1179
|
+
|---|---|---|---|---|
|
|
1180
|
+
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
1181
|
+
|
|
1182
|
+
### media.images
|
|
1183
|
+
|
|
1184
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1185
|
+
|---|---|---|---|---|
|
|
1186
|
+
| generate | POST | `/media/v1/libraries/{library_id}/images/generations` | no | no |
|
|
1187
|
+
|
|
737
1188
|
### media.libraries
|
|
738
1189
|
|
|
739
1190
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -743,6 +1194,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
743
1194
|
| list | GET | `/media/v1/libraries` | no | yes |
|
|
744
1195
|
| restore | POST | `/media/v1/libraries/{library_id}/restore` | no | no |
|
|
745
1196
|
| retrieve | GET | `/media/v1/libraries/{library_id}` | no | no |
|
|
1197
|
+
| retrieveDefault | GET | `/media/v1/libraries/default` | no | no |
|
|
1198
|
+
| setDefault | PUT | `/media/v1/libraries/default` | no | no |
|
|
746
1199
|
| update | PATCH | `/media/v1/libraries/{library_id}` | no | no |
|
|
747
1200
|
|
|
748
1201
|
### media.libraries.assets
|
|
@@ -756,6 +1209,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
756
1209
|
| retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
757
1210
|
| update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
758
1211
|
|
|
1212
|
+
### media.libraries.assets.frames
|
|
1213
|
+
|
|
1214
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1215
|
+
|---|---|---|---|---|
|
|
1216
|
+
| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
|
|
1217
|
+
|
|
759
1218
|
### media.libraries.assets.import
|
|
760
1219
|
|
|
761
1220
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -781,6 +1240,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
781
1240
|
| create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
|
|
782
1241
|
| retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
|
|
783
1242
|
|
|
1243
|
+
### media.libraries.deliveryTokens
|
|
1244
|
+
|
|
1245
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1246
|
+
|---|---|---|---|---|
|
|
1247
|
+
| create | POST | `/media/v1/libraries/{library_id}/delivery_tokens` | no | no |
|
|
1248
|
+
|
|
784
1249
|
### media.libraries.events
|
|
785
1250
|
|
|
786
1251
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -797,6 +1262,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
797
1262
|
|
|
798
1263
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
799
1264
|
|---|---|---|---|---|
|
|
1265
|
+
| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
|
|
1266
|
+
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
800
1267
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
801
1268
|
|
|
802
1269
|
### media.libraries.purge
|
|
@@ -829,8 +1296,34 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
829
1296
|
|---|---|---|---|---|
|
|
830
1297
|
| create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
|
|
831
1298
|
|
|
1299
|
+
### media.libraries.understandings
|
|
1300
|
+
|
|
1301
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1302
|
+
|---|---|---|---|---|
|
|
1303
|
+
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1304
|
+
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1305
|
+
|
|
1306
|
+
### media.speech
|
|
1307
|
+
|
|
1308
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1309
|
+
|---|---|---|---|---|
|
|
1310
|
+
| create | POST | `/media/v1/libraries/{library_id}/audio/speech` | no | no |
|
|
1311
|
+
|
|
1312
|
+
### media.videos
|
|
1313
|
+
|
|
1314
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1315
|
+
|---|---|---|---|---|
|
|
1316
|
+
| generate | POST | `/media/v1/libraries/{library_id}/videos/generations` | no | no |
|
|
1317
|
+
|
|
832
1318
|
## meta
|
|
833
1319
|
|
|
1320
|
+
### meta.docs
|
|
1321
|
+
|
|
1322
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1323
|
+
|---|---|---|---|---|
|
|
1324
|
+
| retrieve | GET | `/meta/v1/docs/{path}` | no | no |
|
|
1325
|
+
| search | GET | `/meta/v1/docs/search` | no | no |
|
|
1326
|
+
|
|
834
1327
|
### meta.health
|
|
835
1328
|
|
|
836
1329
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -954,6 +1447,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
954
1447
|
|---|---|---|---|---|
|
|
955
1448
|
| create | POST | `/model/v1/responses/input_tokens` | no | no |
|
|
956
1449
|
|
|
1450
|
+
### model.systemone
|
|
1451
|
+
|
|
1452
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1453
|
+
|---|---|---|---|---|
|
|
1454
|
+
| create | POST | `/model/v1/systemone` | no | no |
|
|
1455
|
+
|
|
957
1456
|
### model.videos
|
|
958
1457
|
|
|
959
1458
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -965,6 +1464,58 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
965
1464
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
966
1465
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
967
1466
|
|
|
1467
|
+
## ontology
|
|
1468
|
+
|
|
1469
|
+
### ontology.changesets
|
|
1470
|
+
|
|
1471
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1472
|
+
|---|---|---|---|---|
|
|
1473
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1474
|
+
|
|
1475
|
+
### ontology.nodes
|
|
1476
|
+
|
|
1477
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1478
|
+
|---|---|---|---|---|
|
|
1479
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1480
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1481
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1482
|
+
| retrieveNeighborhood | GET | `/ontology/v1/nodes/{node_id}/neighborhood` | no | no |
|
|
1483
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1484
|
+
|
|
1485
|
+
### ontology.nodes.merge
|
|
1486
|
+
|
|
1487
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1488
|
+
|---|---|---|---|---|
|
|
1489
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1490
|
+
|
|
1491
|
+
### ontology.relations
|
|
1492
|
+
|
|
1493
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1494
|
+
|---|---|---|---|---|
|
|
1495
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1496
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1497
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1498
|
+
|
|
1499
|
+
### ontology.relations.invalidate
|
|
1500
|
+
|
|
1501
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1502
|
+
|---|---|---|---|---|
|
|
1503
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1504
|
+
|
|
1505
|
+
### ontology.search
|
|
1506
|
+
|
|
1507
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1508
|
+
|---|---|---|---|---|
|
|
1509
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1510
|
+
|
|
1511
|
+
### ontology.types
|
|
1512
|
+
|
|
1513
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1514
|
+
|---|---|---|---|---|
|
|
1515
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1516
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1517
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1518
|
+
|
|
968
1519
|
## organization
|
|
969
1520
|
|
|
970
1521
|
### organization.charges
|
|
@@ -1007,6 +1558,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1007
1558
|
| create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1008
1559
|
| list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1009
1560
|
|
|
1561
|
+
### organization.members
|
|
1562
|
+
|
|
1563
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1564
|
+
|---|---|---|---|---|
|
|
1565
|
+
| list | GET | `/organization/v1/members` | no | no |
|
|
1566
|
+
|
|
1010
1567
|
### organization.usage
|
|
1011
1568
|
|
|
1012
1569
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1015,6 +1572,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1015
1572
|
|
|
1016
1573
|
## sandbox
|
|
1017
1574
|
|
|
1575
|
+
### sandbox.events.sandboxes
|
|
1576
|
+
|
|
1577
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1578
|
+
|---|---|---|---|---|
|
|
1579
|
+
| retrieve | GET | `/sandbox/v1/events/sandboxes/{sandboxID}` | no | no |
|
|
1580
|
+
|
|
1018
1581
|
### sandbox.sandboxes
|
|
1019
1582
|
|
|
1020
1583
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1089,7 +1652,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1089
1652
|
|
|
1090
1653
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1091
1654
|
|---|---|---|---|---|
|
|
1655
|
+
| create | POST | `/sandbox/v1/templates` | no | no |
|
|
1656
|
+
| delete | DELETE | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1092
1657
|
| list | GET | `/sandbox/v1/templates` | no | no |
|
|
1658
|
+
| retrieve | GET | `/sandbox/v1/templates/{templateID}` | no | no |
|
|
1659
|
+
|
|
1660
|
+
### sandbox.templates.aliases
|
|
1661
|
+
|
|
1662
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1663
|
+
|---|---|---|---|---|
|
|
1664
|
+
| retrieve | GET | `/sandbox/v1/templates/aliases/{alias}` | no | no |
|
|
1665
|
+
|
|
1666
|
+
### sandbox.templates.builds
|
|
1667
|
+
|
|
1668
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1669
|
+
|---|---|---|---|---|
|
|
1670
|
+
| update | POST | `/sandbox/v1/templates/{templateID}/builds/{buildID}` | no | no |
|
|
1671
|
+
|
|
1672
|
+
### sandbox.templates.builds.status
|
|
1673
|
+
|
|
1674
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1675
|
+
|---|---|---|---|---|
|
|
1676
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/builds/{buildID}/status` | no | no |
|
|
1677
|
+
|
|
1678
|
+
### sandbox.templates.tags
|
|
1679
|
+
|
|
1680
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1681
|
+
|---|---|---|---|---|
|
|
1682
|
+
| create | POST | `/sandbox/v1/templates/tags` | no | no |
|
|
1683
|
+
| delete | DELETE | `/sandbox/v1/templates/tags` | no | no |
|
|
1684
|
+
| list | GET | `/sandbox/v1/templates/{templateID}/tags` | no | no |
|
|
1093
1685
|
|
|
1094
1686
|
### sandbox.volumes
|
|
1095
1687
|
|
|
@@ -1126,6 +1718,167 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1126
1718
|
|---|---|---|---|---|
|
|
1127
1719
|
| create | POST | `/search/v1/search` | no | no |
|
|
1128
1720
|
|
|
1721
|
+
## studio
|
|
1722
|
+
|
|
1723
|
+
### studio.codexes
|
|
1724
|
+
|
|
1725
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1726
|
+
|---|---|---|---|---|
|
|
1727
|
+
| create | POST | `/studio/v1/codexes` | no | no |
|
|
1728
|
+
| delete | DELETE | `/studio/v1/codexes/{codex}` | no | no |
|
|
1729
|
+
| list | GET | `/studio/v1/codexes` | no | no |
|
|
1730
|
+
| retrieve | GET | `/studio/v1/codexes/{codex}` | no | no |
|
|
1731
|
+
| update | PATCH | `/studio/v1/codexes/{codex}` | no | no |
|
|
1732
|
+
|
|
1733
|
+
### studio.codexes.entries
|
|
1734
|
+
|
|
1735
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1736
|
+
|---|---|---|---|---|
|
|
1737
|
+
| create | POST | `/studio/v1/codexes/{codex}/entries` | no | no |
|
|
1738
|
+
| delete | DELETE | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1739
|
+
| list | GET | `/studio/v1/codexes/{codex}/entries` | no | no |
|
|
1740
|
+
| retrieve | GET | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1741
|
+
| update | PATCH | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1742
|
+
|
|
1743
|
+
### studio.genres
|
|
1744
|
+
|
|
1745
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1746
|
+
|---|---|---|---|---|
|
|
1747
|
+
| list | GET | `/studio/v1/genres` | no | no |
|
|
1748
|
+
| retrieve | GET | `/studio/v1/genres/{genre}` | no | no |
|
|
1749
|
+
|
|
1750
|
+
### studio.platforms
|
|
1751
|
+
|
|
1752
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1753
|
+
|---|---|---|---|---|
|
|
1754
|
+
| list | GET | `/studio/v1/platforms` | no | no |
|
|
1755
|
+
| retrieve | GET | `/studio/v1/platforms/{platform}` | no | no |
|
|
1756
|
+
|
|
1757
|
+
### studio.styles
|
|
1758
|
+
|
|
1759
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1760
|
+
|---|---|---|---|---|
|
|
1761
|
+
| create | POST | `/studio/v1/styles` | no | no |
|
|
1762
|
+
| delete | DELETE | `/studio/v1/styles/{style}` | no | no |
|
|
1763
|
+
| list | GET | `/studio/v1/styles` | no | no |
|
|
1764
|
+
| retrieve | GET | `/studio/v1/styles/{style}` | no | no |
|
|
1765
|
+
| update | PATCH | `/studio/v1/styles/{style}` | no | no |
|
|
1766
|
+
|
|
1767
|
+
### studio.templates
|
|
1768
|
+
|
|
1769
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1770
|
+
|---|---|---|---|---|
|
|
1771
|
+
| create | POST | `/studio/v1/templates` | no | no |
|
|
1772
|
+
| delete | DELETE | `/studio/v1/templates/{template}` | no | no |
|
|
1773
|
+
| list | GET | `/studio/v1/templates` | no | no |
|
|
1774
|
+
| retrieve | GET | `/studio/v1/templates/{template}` | no | no |
|
|
1775
|
+
|
|
1776
|
+
### studio.themes
|
|
1777
|
+
|
|
1778
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1779
|
+
|---|---|---|---|---|
|
|
1780
|
+
| create | POST | `/studio/v1/themes` | no | no |
|
|
1781
|
+
| delete | DELETE | `/studio/v1/themes/{theme}` | no | no |
|
|
1782
|
+
| list | GET | `/studio/v1/themes` | no | no |
|
|
1783
|
+
| retrieve | GET | `/studio/v1/themes/{theme}` | no | no |
|
|
1784
|
+
| update | PATCH | `/studio/v1/themes/{theme}` | no | no |
|
|
1785
|
+
|
|
1786
|
+
### studio.works
|
|
1787
|
+
|
|
1788
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1789
|
+
|---|---|---|---|---|
|
|
1790
|
+
| create | POST | `/studio/v1/works` | no | no |
|
|
1791
|
+
| list | GET | `/studio/v1/works` | no | no |
|
|
1792
|
+
| resolve | GET | `/studio/v1/works:resolve` | no | no |
|
|
1793
|
+
| retrieve | GET | `/studio/v1/works/{work}` | no | no |
|
|
1794
|
+
| update | PATCH | `/studio/v1/works/{work}` | no | no |
|
|
1795
|
+
| updateBrief | PATCH | `/studio/v1/works/{work}/brief` | no | no |
|
|
1796
|
+
|
|
1797
|
+
### studio.works.drafts
|
|
1798
|
+
|
|
1799
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1800
|
+
|---|---|---|---|---|
|
|
1801
|
+
| create | POST | `/studio/v1/works/{work}/drafts` | no | no |
|
|
1802
|
+
| list | GET | `/studio/v1/works/{work}/drafts` | no | no |
|
|
1803
|
+
| rebase | POST | `/studio/v1/works/{work}/drafts/{draft}:rebase` | no | no |
|
|
1804
|
+
| retrieve | GET | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1805
|
+
| retrieveExport | GET | `/studio/v1/works/{work}/drafts/{draft}/export` | no | no |
|
|
1806
|
+
| retrieveOutline | GET | `/studio/v1/works/{work}/drafts/{draft}/outline` | no | no |
|
|
1807
|
+
| retrieveReview | GET | `/studio/v1/works/{work}/drafts/{draft}/review` | no | no |
|
|
1808
|
+
| update | PATCH | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1809
|
+
|
|
1810
|
+
### studio.works.drafts.renditions
|
|
1811
|
+
|
|
1812
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1813
|
+
|---|---|---|---|---|
|
|
1814
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/renditions` | no | no |
|
|
1815
|
+
|
|
1816
|
+
### studio.works.drafts.status
|
|
1817
|
+
|
|
1818
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1819
|
+
|---|---|---|---|---|
|
|
1820
|
+
| list | GET | `/studio/v1/works/{work}/drafts/{draft}/status` | no | no |
|
|
1821
|
+
|
|
1822
|
+
### studio.works.drafts.units
|
|
1823
|
+
|
|
1824
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1825
|
+
|---|---|---|---|---|
|
|
1826
|
+
| batchCreate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchCreate` | no | no |
|
|
1827
|
+
| batchUpdate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchUpdate` | no | no |
|
|
1828
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/units` | no | no |
|
|
1829
|
+
|
|
1830
|
+
### studio.works.renditions
|
|
1831
|
+
|
|
1832
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1833
|
+
|---|---|---|---|---|
|
|
1834
|
+
| delete | DELETE | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1835
|
+
| list | GET | `/studio/v1/works/{work}/renditions` | no | no |
|
|
1836
|
+
| publish | POST | `/studio/v1/works/{work}/renditions/{rendition}:publish` | no | no |
|
|
1837
|
+
| render | POST | `/studio/v1/works/{work}/renditions/{rendition}:render` | no | no |
|
|
1838
|
+
| retrieve | GET | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1839
|
+
| retrieveContent | GET | `/studio/v1/works/{work}/renditions/{rendition}/content` | no | no |
|
|
1840
|
+
| update | PATCH | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1841
|
+
|
|
1842
|
+
### studio.works.reviewSettings
|
|
1843
|
+
|
|
1844
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1845
|
+
|---|---|---|---|---|
|
|
1846
|
+
| retrieve | GET | `/studio/v1/works/{work}/review-settings` | no | no |
|
|
1847
|
+
| update | PATCH | `/studio/v1/works/{work}/review-settings` | no | no |
|
|
1848
|
+
|
|
1849
|
+
### studio.works.reviewers
|
|
1850
|
+
|
|
1851
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1852
|
+
|---|---|---|---|---|
|
|
1853
|
+
| create | POST | `/studio/v1/works/{work}/reviewers` | no | no |
|
|
1854
|
+
| delete | DELETE | `/studio/v1/works/{work}/reviewers/{agent}` | no | no |
|
|
1855
|
+
| list | GET | `/studio/v1/works/{work}/reviewers` | no | no |
|
|
1856
|
+
| update | PATCH | `/studio/v1/works/{work}/reviewers/{agent}` | no | no |
|
|
1857
|
+
|
|
1858
|
+
### studio.works.reviews
|
|
1859
|
+
|
|
1860
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1861
|
+
|---|---|---|---|---|
|
|
1862
|
+
| cancel | POST | `/studio/v1/works/{work}/reviews/{review}:cancel` | no | no |
|
|
1863
|
+
| create | POST | `/studio/v1/works/{work}/reviews` | no | no |
|
|
1864
|
+
| list | GET | `/studio/v1/works/{work}/reviews` | no | no |
|
|
1865
|
+
| retrieve | GET | `/studio/v1/works/{work}/reviews/{review}` | no | no |
|
|
1866
|
+
|
|
1867
|
+
### studio.works.units
|
|
1868
|
+
|
|
1869
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1870
|
+
|---|---|---|---|---|
|
|
1871
|
+
| move | POST | `/studio/v1/works/{work}/units/{unit}:move` | no | no |
|
|
1872
|
+
| retrieve | GET | `/studio/v1/works/{work}/units/{unit}` | no | no |
|
|
1873
|
+
| retrieveContext | GET | `/studio/v1/works/{work}/units/{unit}/context` | no | no |
|
|
1874
|
+
| update | PATCH | `/studio/v1/works/{work}/units/{unit}` | no | no |
|
|
1875
|
+
|
|
1876
|
+
### studio.works.units.blocks
|
|
1877
|
+
|
|
1878
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1879
|
+
|---|---|---|---|---|
|
|
1880
|
+
| patch | POST | `/studio/v1/works/{work}/units/{unit}/blocks:patch` | no | no |
|
|
1881
|
+
|
|
1129
1882
|
## ticket
|
|
1130
1883
|
|
|
1131
1884
|
### ticket.activity
|
|
@@ -1174,6 +1927,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1174
1927
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1175
1928
|
|---|---|---|---|---|
|
|
1176
1929
|
| list | GET | `/ticket/v1/repositories` | no | no |
|
|
1930
|
+
| update | PATCH | `/ticket/v1/repositories/{id}` | no | no |
|
|
1177
1931
|
|
|
1178
1932
|
### ticket.tickets
|
|
1179
1933
|
|
|
@@ -1339,14 +2093,45 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1339
2093
|
| agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
|
|
1340
2094
|
| automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
|
|
1341
2095
|
| automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
|
|
2096
|
+
| automation.scripts.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1342
2097
|
| automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
|
|
1343
2098
|
| automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
|
|
2099
|
+
| automation.workflows.vaults.set | Assign a whole vault to a definition alias, independently of published versions. |
|
|
1344
2100
|
| automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
|
|
2101
|
+
| crm.objects.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
2102
|
+
| crm.objects.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
2103
|
+
| crm.objects.batch.create | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
2104
|
+
| crm.objects.batch.read | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
2105
|
+
| crm.objects.batch.update | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
2106
|
+
| crm.objects.batch.upsert | The terminal batch segment is the requested operation, not another collection; retain its read/create/update/upsert/archive verb. |
|
|
2107
|
+
| crm.objects.search | The terminal search segment queries records without creating a nested search resource. |
|
|
2108
|
+
| crm.objects.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
2109
|
+
| 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. |
|
|
2110
|
+
| 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. |
|
|
2111
|
+
| 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. |
|
|
2112
|
+
| 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. |
|
|
2113
|
+
| crm.pipelines.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
2114
|
+
| crm.pipelines.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
2115
|
+
| crm.pipelines.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
2116
|
+
| crm.pipelines.stages.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
2117
|
+
| crm.properties.list | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
2118
|
+
| crm.properties.create | CRM objectType selects a collection, not an entity; preserve list/create separately from retrieve/update on an identified resource. |
|
|
2119
|
+
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1345
2120
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
2121
|
+
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
2122
|
+
| media.libraries.retrieveDefault | ADR-094 §9 names the default-library read libraries.retrieveDefault; the URL names a reference rather than an id, so the path-derived name would otherwise read as retrieving a library called default. |
|
|
2123
|
+
| media.libraries.setDefault | ADR-094 §9 names the default-library write libraries.setDefault; the URL has no library id because the organization owns one default library, so the path alone cannot say which. |
|
|
2124
|
+
| media.assets.edit | ADR-094 §9 names the edit write assets.edit; an edit acts on the addressed asset and returns a Job, so the URL nesting under a library is a mount rather than an SDK resource level. |
|
|
2125
|
+
| media.assets.lineage | ADR-094 §9 names the edit-tree read assets.lineage; lineage is the product verb and the URL nesting under a library is a mount, not an SDK resource level. |
|
|
2126
|
+
| media.speech.create | ADR-094 §1/§9 names speech synthesis speech.create; the URL says audio/speech because that is the artifact the caller gets back, and the path alone would derive a speech collection create under an audio level that is not an SDK resource. |
|
|
2127
|
+
| media.images.generate | ADR-094 §9 names image generation images.generate; the URL mounts it under a library, but generation is an operation on images and the path alone would derive a generations collection create. |
|
|
2128
|
+
| media.videos.generate | ADR-094 §2/§9 names video generation videos.generate beside images.generate; the URL mounts it under a library, but generation is an operation on videos and the path alone would derive a generations collection create. The unqualified videos resource is the video lane, distinct from the batch and legacy job resources. |
|
|
2129
|
+
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1346
2130
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1347
2131
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1348
2132
|
| sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1349
2133
|
| sandbox.sandboxes.files.write | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
2134
|
+
| studio.works.reviewSettings.retrieve | A work has one review-settings singleton; the segment ends in s only because English writes it that way, so the collection rule would derive reviewSettings.list for a read that returns the settings object itself. |
|
|
1350
2135
|
| vault.oauth.retrieveClientMetadata | The literal .json filename otherwise introduces a dot inside a method identifier. |
|
|
1351
2136
|
|
|
1352
2137
|
## SDK parameter aliases
|