@deepraxis/cli 0.2.2-dev.8881efc → 0.2.2-dev.93cc895
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/COMMANDS.md +35 -4
- package/README.md +9 -3
- package/dist/praxis.js +2425 -905
- package/package.json +1 -1
package/dist/praxis.js
CHANGED
|
@@ -18683,13 +18683,971 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18683
18683
|
]
|
|
18684
18684
|
}
|
|
18685
18685
|
},
|
|
18686
|
+
{
|
|
18687
|
+
resource: "devops.environments.checkpoints",
|
|
18688
|
+
method: "list",
|
|
18689
|
+
summary: "List environment checkpoints",
|
|
18690
|
+
description: 'List where each target of an environment currently stands: the release and commit deployed to it, the promotion that put it there, and how far behind the default branch that commit is. Read it to answer "what is running in production right now" and to tell a promotion that will change something apart from one that will skip every target as unchanged. behindMain counts commits on the default branch that the deployed commit does not have, so zero means the environment carries the current branch head. Targets that were never deployed to have no checkpoints until something deploys to them.',
|
|
18691
|
+
http: "GET",
|
|
18692
|
+
path: "/devops/v1/environments/{id}/checkpoints",
|
|
18693
|
+
streaming: "no",
|
|
18694
|
+
pagination: false,
|
|
18695
|
+
pathParams: [
|
|
18696
|
+
{
|
|
18697
|
+
name: "id",
|
|
18698
|
+
sdkName: "id",
|
|
18699
|
+
description: "The environment identifier from a project's environment list; the tier or the display name is not an address."
|
|
18700
|
+
}
|
|
18701
|
+
],
|
|
18702
|
+
query: []
|
|
18703
|
+
},
|
|
18704
|
+
{
|
|
18705
|
+
resource: "devops.flags",
|
|
18706
|
+
method: "retrieve",
|
|
18707
|
+
summary: "Retrieve a flag",
|
|
18708
|
+
description: "Read one flag in full: every environment's configuration, the rules and rollouts each environment serves, the flag's lifecycle, and where code references its key as of the last scan. Call it before changing an environment so you can send the version you read, and after a release to confirm the flag reached the state you expected. An archived flag is still readable here — that is how its key and history stay answerable after it stopped evaluating. codeRefs.count tells you how much code still names the key, which is what decides whether removing the flag is safe.",
|
|
18709
|
+
http: "GET",
|
|
18710
|
+
path: "/devops/v1/flags/{id}",
|
|
18711
|
+
streaming: "no",
|
|
18712
|
+
pagination: false,
|
|
18713
|
+
pathParams: [
|
|
18714
|
+
{
|
|
18715
|
+
name: "id",
|
|
18716
|
+
sdkName: "id",
|
|
18717
|
+
description: "The flag identifier from a flag list or create answer; code names a flag by its key, while this API addresses it by id."
|
|
18718
|
+
}
|
|
18719
|
+
],
|
|
18720
|
+
query: []
|
|
18721
|
+
},
|
|
18722
|
+
{
|
|
18723
|
+
resource: "devops.flags",
|
|
18724
|
+
method: "update",
|
|
18725
|
+
summary: "Update a flag",
|
|
18726
|
+
description: "Change a flag's metadata — its name, description, owner, observation deadline, removal ticket or tags — without touching what any environment serves. Send the fields to change inside flag and name them in updateMask; a field present in flag but absent from the mask is left alone, and a mask naming a field this operation cannot change is refused rather than ignored. Sending null clears a nullable field such as observeUntil. Served values are not changed here: use the environment update for what an environment serves, which is versioned and checked. An archived flag cannot be updated.",
|
|
18727
|
+
http: "PATCH",
|
|
18728
|
+
path: "/devops/v1/flags/{id}",
|
|
18729
|
+
streaming: "no",
|
|
18730
|
+
pagination: false,
|
|
18731
|
+
pathParams: [
|
|
18732
|
+
{
|
|
18733
|
+
name: "id",
|
|
18734
|
+
sdkName: "id",
|
|
18735
|
+
description: "The flag identifier from a flag list or create answer; code names a flag by its key, while this API addresses it by id."
|
|
18736
|
+
}
|
|
18737
|
+
],
|
|
18738
|
+
query: [],
|
|
18739
|
+
body: {
|
|
18740
|
+
required: true,
|
|
18741
|
+
fields: [
|
|
18742
|
+
{
|
|
18743
|
+
name: "flag",
|
|
18744
|
+
type: "object",
|
|
18745
|
+
required: true,
|
|
18746
|
+
description: "The updatable fields of a flag, as the body of an update. Values left out are not touched, and null clears a nullable one."
|
|
18747
|
+
},
|
|
18748
|
+
{
|
|
18749
|
+
name: "updateMask",
|
|
18750
|
+
type: "array",
|
|
18751
|
+
itemType: "string",
|
|
18752
|
+
required: false,
|
|
18753
|
+
description: "Which fields to write, by name; omit it to write every field the flag object carries. A field not listed here is left as it is, even when the object carries it."
|
|
18754
|
+
}
|
|
18755
|
+
]
|
|
18756
|
+
}
|
|
18757
|
+
},
|
|
18758
|
+
{
|
|
18759
|
+
resource: "devops.flags.environments",
|
|
18760
|
+
method: "update",
|
|
18761
|
+
summary: "Update a flag's environment",
|
|
18762
|
+
description: "Change what one environment of a flag serves: whether it is on, its targeting rules, its prerequisite flags, its individually targeted keys, its fallthrough, and the progressive rollout it runs. This is the write that changes runtime behaviour, so it is versioned: send the version you read and a change based on a stale version is refused with FLAG_VERSION_CONFLICT instead of silently overwriting someone else's edit. comment records why the configuration changed, next to the change itself. Targets whose keys are not deployed yet are refused with FLAG_CODE_NOT_DEPLOYED, because serving a variation the running code cannot name would fail at evaluation time.",
|
|
18763
|
+
http: "PATCH",
|
|
18764
|
+
path: "/devops/v1/flags/{id}/environments/{environment}",
|
|
18765
|
+
streaming: "no",
|
|
18766
|
+
pagination: false,
|
|
18767
|
+
pathParams: [
|
|
18768
|
+
{
|
|
18769
|
+
name: "id",
|
|
18770
|
+
sdkName: "id",
|
|
18771
|
+
description: "The flag identifier from a flag list or create answer; code names a flag by its key, while this API addresses it by id."
|
|
18772
|
+
},
|
|
18773
|
+
{
|
|
18774
|
+
name: "environment",
|
|
18775
|
+
sdkName: "environment",
|
|
18776
|
+
description: "The environment whose configuration you are changing, from the flag's own environments map or the project's environment list."
|
|
18777
|
+
}
|
|
18778
|
+
],
|
|
18779
|
+
query: [],
|
|
18780
|
+
body: {
|
|
18781
|
+
required: true,
|
|
18782
|
+
fields: [
|
|
18783
|
+
{
|
|
18784
|
+
name: "version",
|
|
18785
|
+
type: "number",
|
|
18786
|
+
required: true,
|
|
18787
|
+
description: "The configuration version you read before making this change; when the environment has moved past it the write is refused with FLAG_VERSION_CONFLICT rather than overwriting."
|
|
18788
|
+
},
|
|
18789
|
+
{
|
|
18790
|
+
name: "comment",
|
|
18791
|
+
type: "string",
|
|
18792
|
+
required: true,
|
|
18793
|
+
description: "Why the configuration is changing, stored with the change so the history reads as decisions rather than as diffs."
|
|
18794
|
+
},
|
|
18795
|
+
{
|
|
18796
|
+
name: "config",
|
|
18797
|
+
type: "object",
|
|
18798
|
+
required: true,
|
|
18799
|
+
description: "The configuration to write for one environment. This call replaces the whole configuration, so send what you read with your change applied rather than only the changed part."
|
|
18800
|
+
}
|
|
18801
|
+
]
|
|
18802
|
+
}
|
|
18803
|
+
},
|
|
18804
|
+
{
|
|
18805
|
+
resource: "devops.flags",
|
|
18806
|
+
method: "archive",
|
|
18807
|
+
summary: "Archive a flag",
|
|
18808
|
+
description: "Archive a flag once it is no longer needed: it stops evaluating in every environment, leaves the ordinary flag list, and keeps its key and history. Use it for a flag whose code has been removed and whose key nothing names any more; codeRefs.count on the flag is what tells you whether that is true. Archiving is the terminal lifecycle state — an archived flag is never un-archived and its key is never reused, so a flag that may come back is turned off in its environment instead. The key stays reserved, which is why a later create with the same key is refused.",
|
|
18809
|
+
http: "POST",
|
|
18810
|
+
path: "/devops/v1/flags/{id}:archive",
|
|
18811
|
+
streaming: "no",
|
|
18812
|
+
pagination: false,
|
|
18813
|
+
pathParams: [
|
|
18814
|
+
{
|
|
18815
|
+
name: "id",
|
|
18816
|
+
sdkName: "id",
|
|
18817
|
+
description: "The flag identifier from a flag list or create answer; code names a flag by its key, while this API addresses it by id."
|
|
18818
|
+
}
|
|
18819
|
+
],
|
|
18820
|
+
query: []
|
|
18821
|
+
},
|
|
18822
|
+
{
|
|
18823
|
+
resource: "devops.flags",
|
|
18824
|
+
method: "conclude",
|
|
18825
|
+
summary: "Conclude a flag",
|
|
18826
|
+
description: "Record the decision a temporary flag's observation window ended with: promote makes the chosen variation the permanent behaviour and moves the flag to launched, rollback returns the environment to its off behaviour, and extend keeps observing with a new observeUntil deadline. reason is stored as the attribution of the decision. This is the act the observation flag machinery requires when the deadline arrives, so an expired flag is concluded rather than left standing. A promote or rollback finishes the flag's rollout; the code and the flag are then removed by the ticket the flag recorded, which this call does not do.",
|
|
18827
|
+
http: "POST",
|
|
18828
|
+
path: "/devops/v1/flags/{id}:conclude",
|
|
18829
|
+
streaming: "no",
|
|
18830
|
+
pagination: false,
|
|
18831
|
+
pathParams: [
|
|
18832
|
+
{
|
|
18833
|
+
name: "id",
|
|
18834
|
+
sdkName: "id",
|
|
18835
|
+
description: "The flag identifier from a flag list or create answer; code names a flag by its key, while this API addresses it by id."
|
|
18836
|
+
}
|
|
18837
|
+
],
|
|
18838
|
+
query: [],
|
|
18839
|
+
body: {
|
|
18840
|
+
required: true,
|
|
18841
|
+
fields: [
|
|
18842
|
+
{
|
|
18843
|
+
name: "action",
|
|
18844
|
+
type: "string",
|
|
18845
|
+
enum: [
|
|
18846
|
+
"promote",
|
|
18847
|
+
"rollback",
|
|
18848
|
+
"extend"
|
|
18849
|
+
],
|
|
18850
|
+
required: true,
|
|
18851
|
+
description: "What the deadline decided; promote and rollback finish the flag's rollout, while extend keeps it running with a new deadline."
|
|
18852
|
+
},
|
|
18853
|
+
{
|
|
18854
|
+
name: "observeUntil",
|
|
18855
|
+
type: "string",
|
|
18856
|
+
required: false,
|
|
18857
|
+
description: "The new deadline, required by extend and refused with the others; it must be later than the deadline being replaced."
|
|
18858
|
+
},
|
|
18859
|
+
{
|
|
18860
|
+
name: "reason",
|
|
18861
|
+
type: "string",
|
|
18862
|
+
required: true,
|
|
18863
|
+
description: "Why the decision went this way, recorded on the flag as the attribution the observation machinery requires."
|
|
18864
|
+
}
|
|
18865
|
+
]
|
|
18866
|
+
}
|
|
18867
|
+
},
|
|
18868
|
+
{
|
|
18869
|
+
resource: "devops.progressiveRollouts",
|
|
18870
|
+
method: "create",
|
|
18871
|
+
summary: "Create a progressive rollout",
|
|
18872
|
+
description: "Start a staged rollout of one variation of a flag in one environment: the steps are percentages with a hold time each, and the guard says which signals are watched and whether a bad reading pauses the rollout or rolls it back. Use it instead of turning a flag fully on, so a bad variation is caught at a small percentage. bucketBy names the context attribute that decides which bucket a caller falls into, so the same caller stays in the same bucket across steps. One progressive rollout runs per flag and environment; a second one while the first is active is refused with ROLLOUT_ALREADY_ACTIVE.",
|
|
18873
|
+
http: "POST",
|
|
18874
|
+
path: "/devops/v1/progressive-rollouts",
|
|
18875
|
+
streaming: "no",
|
|
18876
|
+
pagination: false,
|
|
18877
|
+
pathParams: [],
|
|
18878
|
+
query: [],
|
|
18879
|
+
body: {
|
|
18880
|
+
required: true,
|
|
18881
|
+
fields: [
|
|
18882
|
+
{
|
|
18883
|
+
name: "flag",
|
|
18884
|
+
type: "string",
|
|
18885
|
+
required: true,
|
|
18886
|
+
description: "The flag to ramp; it must not be archived, its environment must already be on, and its configuration must exist there."
|
|
18887
|
+
},
|
|
18888
|
+
{
|
|
18889
|
+
name: "environment",
|
|
18890
|
+
type: "string",
|
|
18891
|
+
required: true,
|
|
18892
|
+
description: "The environment to ramp in; the flag must be on there already, because ramping an off environment would serve nobody."
|
|
18893
|
+
},
|
|
18894
|
+
{
|
|
18895
|
+
name: "variation",
|
|
18896
|
+
type: "string",
|
|
18897
|
+
required: true,
|
|
18898
|
+
description: "The variation to ramp up; it must be one of the flag's variations and must not be the off variation, which is what the rest of the callers already get."
|
|
18899
|
+
},
|
|
18900
|
+
{
|
|
18901
|
+
name: "bucketBy",
|
|
18902
|
+
type: "string",
|
|
18903
|
+
required: false,
|
|
18904
|
+
description: "Which context attribute decides a caller's bucket; omit it to bucket by the targeting key, which keeps one caller on one side."
|
|
18905
|
+
},
|
|
18906
|
+
{
|
|
18907
|
+
name: "steps",
|
|
18908
|
+
type: "array",
|
|
18909
|
+
itemType: "object",
|
|
18910
|
+
required: true,
|
|
18911
|
+
description: "The steps to walk, at least one; percentages must be whole numbers from 0 to 100 that never decrease, and the first step takes effect immediately."
|
|
18912
|
+
},
|
|
18913
|
+
{
|
|
18914
|
+
name: "guard",
|
|
18915
|
+
type: "object",
|
|
18916
|
+
required: true,
|
|
18917
|
+
description: "What is watched while a rollout runs, and what happens when a reading is bad."
|
|
18918
|
+
}
|
|
18919
|
+
]
|
|
18920
|
+
}
|
|
18921
|
+
},
|
|
18922
|
+
{
|
|
18923
|
+
resource: "devops.progressiveRollouts",
|
|
18924
|
+
method: "retrieve",
|
|
18925
|
+
summary: "Retrieve a progressive rollout",
|
|
18926
|
+
description: "Read one progressive rollout: which step it is on, how much of the audience that is, when the next step is due, and every step it has already taken with who moved it and why. Poll it to follow a rollout, and read history to find out why it paused or rolled back — a guard that fired leaves the step and the reason there. state scheduled means the first step has not started, running means it is advancing on its hold times, and rolled_back is terminal. nextStepTime is the time the current hold ends.",
|
|
18927
|
+
http: "GET",
|
|
18928
|
+
path: "/devops/v1/progressive-rollouts/{id}",
|
|
18929
|
+
streaming: "no",
|
|
18930
|
+
pagination: false,
|
|
18931
|
+
pathParams: [
|
|
18932
|
+
{
|
|
18933
|
+
name: "id",
|
|
18934
|
+
sdkName: "id",
|
|
18935
|
+
description: "The progressive rollout identifier returned by the progressive rollout create answer."
|
|
18936
|
+
}
|
|
18937
|
+
],
|
|
18938
|
+
query: []
|
|
18939
|
+
},
|
|
18940
|
+
{
|
|
18941
|
+
resource: "devops.progressiveRollouts",
|
|
18942
|
+
method: "pause",
|
|
18943
|
+
summary: "Pause a progressive rollout",
|
|
18944
|
+
description: "Hold a running progressive rollout at its current percentage: no further step is taken until it is resumed, and the percentage already served keeps being served. Use it when a guard signal looks wrong but not wrong enough to roll back, so a person can look before the rollout advances. reason is recorded on the rollout as the attribution of the hold. Pausing a rollout that already completed or was rolled back is refused; read it first to see whether there is anything to hold.",
|
|
18945
|
+
http: "POST",
|
|
18946
|
+
path: "/devops/v1/progressive-rollouts/{id}:pause",
|
|
18947
|
+
streaming: "no",
|
|
18948
|
+
pagination: false,
|
|
18949
|
+
pathParams: [
|
|
18950
|
+
{
|
|
18951
|
+
name: "id",
|
|
18952
|
+
sdkName: "id",
|
|
18953
|
+
description: "The progressive rollout identifier returned by the progressive rollout create answer."
|
|
18954
|
+
}
|
|
18955
|
+
],
|
|
18956
|
+
query: [],
|
|
18957
|
+
body: {
|
|
18958
|
+
required: true,
|
|
18959
|
+
fields: [
|
|
18960
|
+
{
|
|
18961
|
+
name: "reason",
|
|
18962
|
+
type: "string",
|
|
18963
|
+
required: true,
|
|
18964
|
+
description: "Why the rollout is being paused or rolled back, recorded verbatim in the rollout's history as the attribution of the act."
|
|
18965
|
+
}
|
|
18966
|
+
]
|
|
18967
|
+
}
|
|
18968
|
+
},
|
|
18969
|
+
{
|
|
18970
|
+
resource: "devops.progressiveRollouts",
|
|
18971
|
+
method: "resume",
|
|
18972
|
+
summary: "Resume a progressive rollout",
|
|
18973
|
+
description: "Continue a paused progressive rollout from the step it stopped at, restarting the hold time for the current step rather than skipping it. Use it after a pause has been looked into and the rollout is judged safe to continue. A rollout that is running already, or that finished, is refused; read it first to see whether it is paused. The resumption is attributed to the credential that sends it and recorded in the rollout's step history.",
|
|
18974
|
+
http: "POST",
|
|
18975
|
+
path: "/devops/v1/progressive-rollouts/{id}:resume",
|
|
18976
|
+
streaming: "no",
|
|
18977
|
+
pagination: false,
|
|
18978
|
+
pathParams: [
|
|
18979
|
+
{
|
|
18980
|
+
name: "id",
|
|
18981
|
+
sdkName: "id",
|
|
18982
|
+
description: "The progressive rollout identifier returned by the progressive rollout create answer."
|
|
18983
|
+
}
|
|
18984
|
+
],
|
|
18985
|
+
query: []
|
|
18986
|
+
},
|
|
18987
|
+
{
|
|
18988
|
+
resource: "devops.progressiveRollouts",
|
|
18989
|
+
method: "rollback",
|
|
18990
|
+
summary: "Roll back a progressive rollout",
|
|
18991
|
+
description: "End a progressive rollout by returning the flag's environment to the variation it served before the rollout started, so the audience that was already switched over goes back. Use it when a guard signal says the variation is bad and waiting for the next step would expose more callers. reason is recorded on the rollout as the attribution of the decision. The rollback is terminal: the rollout does not restart, and a new rollout is created if the variation should be tried again. It changes what the environment serves, not the flag's other environments.",
|
|
18992
|
+
http: "POST",
|
|
18993
|
+
path: "/devops/v1/progressive-rollouts/{id}:rollback",
|
|
18994
|
+
streaming: "no",
|
|
18995
|
+
pagination: false,
|
|
18996
|
+
pathParams: [
|
|
18997
|
+
{
|
|
18998
|
+
name: "id",
|
|
18999
|
+
sdkName: "id",
|
|
19000
|
+
description: "The progressive rollout identifier returned by the progressive rollout create answer."
|
|
19001
|
+
}
|
|
19002
|
+
],
|
|
19003
|
+
query: [],
|
|
19004
|
+
body: {
|
|
19005
|
+
required: true,
|
|
19006
|
+
fields: [
|
|
19007
|
+
{
|
|
19008
|
+
name: "reason",
|
|
19009
|
+
type: "string",
|
|
19010
|
+
required: true,
|
|
19011
|
+
description: "Why the rollout is being paused or rolled back, recorded verbatim in the rollout's history as the attribution of the act."
|
|
19012
|
+
}
|
|
19013
|
+
]
|
|
19014
|
+
}
|
|
19015
|
+
},
|
|
19016
|
+
{
|
|
19017
|
+
resource: "devops.projects",
|
|
19018
|
+
method: "list",
|
|
19019
|
+
summary: "List projects",
|
|
19020
|
+
description: "List the delivery projects this organization has, newest first, with each project's repository binding and settings. Call this first when you do not already hold a project id: every other operation in this domain is addressed by one. A project from another organization is never listed, so an empty page means this organization has none rather than that they are hidden. The order is by creation time descending; follow nextPageToken until it is empty to see them all.",
|
|
19021
|
+
http: "GET",
|
|
19022
|
+
path: "/devops/v1/projects",
|
|
19023
|
+
streaming: "no",
|
|
19024
|
+
pagination: false,
|
|
19025
|
+
pathParams: [],
|
|
19026
|
+
query: [
|
|
19027
|
+
{
|
|
19028
|
+
name: "pageSize",
|
|
19029
|
+
type: "integer",
|
|
19030
|
+
required: false,
|
|
19031
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19032
|
+
},
|
|
19033
|
+
{
|
|
19034
|
+
name: "pageToken",
|
|
19035
|
+
type: "string",
|
|
19036
|
+
required: false,
|
|
19037
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19038
|
+
}
|
|
19039
|
+
]
|
|
19040
|
+
},
|
|
19041
|
+
{
|
|
19042
|
+
resource: "devops.projects",
|
|
19043
|
+
method: "retrieve",
|
|
19044
|
+
summary: "Retrieve a project",
|
|
19045
|
+
description: "Read one project by id: its repository binding, its release schedule and its gate settings. Use it to confirm a project's configuration before releasing into it, and to learn which environment a promotion order starts from. A project that was deleted, or that belongs to another organization, answers PROJECT_NOT_FOUND — the two are indistinguishable on purpose, so the answer never tells you whether a project exists elsewhere.",
|
|
19046
|
+
http: "GET",
|
|
19047
|
+
path: "/devops/v1/projects/{id}",
|
|
19048
|
+
streaming: "no",
|
|
19049
|
+
pagination: false,
|
|
19050
|
+
pathParams: [
|
|
19051
|
+
{
|
|
19052
|
+
name: "id",
|
|
19053
|
+
sdkName: "id",
|
|
19054
|
+
description: "The project identifier returned by the project list, not the project's display name or its repository name."
|
|
19055
|
+
}
|
|
19056
|
+
],
|
|
19057
|
+
query: []
|
|
19058
|
+
},
|
|
19059
|
+
{
|
|
19060
|
+
resource: "devops.projects.environments",
|
|
19061
|
+
method: "list",
|
|
19062
|
+
summary: "List environments",
|
|
19063
|
+
description: "List the project's environments in promotion order: development first, production last. order is the promotion sequence, so the environment before the one you are promoting into is the one that must have verified the release first. Each entry carries its tier, whether it requires approval, and whether its queue is idle or busy; a busy queue names the promotion holding it and how many wait behind. This collection is not paged: a project has few environments and the whole ordered list is the answer.",
|
|
19064
|
+
http: "GET",
|
|
19065
|
+
path: "/devops/v1/projects/{project}/environments",
|
|
19066
|
+
streaming: "no",
|
|
19067
|
+
pagination: false,
|
|
19068
|
+
pathParams: [
|
|
19069
|
+
{
|
|
19070
|
+
name: "project",
|
|
19071
|
+
sdkName: "project",
|
|
19072
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19073
|
+
}
|
|
19074
|
+
],
|
|
19075
|
+
query: []
|
|
19076
|
+
},
|
|
19077
|
+
{
|
|
19078
|
+
resource: "devops.projects.flags",
|
|
19079
|
+
method: "list",
|
|
19080
|
+
summary: "List flags",
|
|
19081
|
+
description: "List the project's flags with their per-environment configuration, newest first. Use it to find a flag by key when code names one, and to review the flags of a project — the entries carry lifecycle, staleness, the observation deadline and the removal ticket, which is what an expiry review reads. filter accepts exactly one term, lifecycle=archived, to list the archived flags instead of the live ones; any other filter or orderBy is refused rather than ignored. totalSize is answered on the first page only.",
|
|
19082
|
+
http: "GET",
|
|
19083
|
+
path: "/devops/v1/projects/{project}/flags",
|
|
19084
|
+
streaming: "no",
|
|
19085
|
+
pagination: false,
|
|
19086
|
+
pathParams: [
|
|
19087
|
+
{
|
|
19088
|
+
name: "project",
|
|
19089
|
+
sdkName: "project",
|
|
19090
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19091
|
+
}
|
|
19092
|
+
],
|
|
19093
|
+
query: [
|
|
19094
|
+
{
|
|
19095
|
+
name: "pageSize",
|
|
19096
|
+
type: "integer",
|
|
19097
|
+
required: false,
|
|
19098
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19099
|
+
},
|
|
19100
|
+
{
|
|
19101
|
+
name: "pageToken",
|
|
19102
|
+
type: "string",
|
|
19103
|
+
required: false,
|
|
19104
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19105
|
+
},
|
|
19106
|
+
{
|
|
19107
|
+
name: "filter",
|
|
19108
|
+
type: "string",
|
|
19109
|
+
required: false,
|
|
19110
|
+
description: "Exactly one filter term is accepted: lifecycle=archived lists the archived flags, which are hidden by default. Any other field, operator or value is refused with INVALID_ARGUMENT rather than ignored."
|
|
19111
|
+
}
|
|
19112
|
+
]
|
|
19113
|
+
},
|
|
19114
|
+
{
|
|
19115
|
+
resource: "devops.projects.flags",
|
|
19116
|
+
method: "create",
|
|
19117
|
+
summary: "Create a flag",
|
|
19118
|
+
description: "Create a feature flag in a project: its key, what kind of flag it is, the values it can serve, and which variation is served when it is off. The key is what code names, so it is unique per project and a key already in use is refused with FLAG_KEY_TAKEN rather than reused — an archived flag keeps its key. owner, observeUntil and removalTicket carry the flag's lifecycle: a release or experiment flag expects an observation deadline and the ticket that removes it, and a flag missing them is refused with FLAG_LIFECYCLE_INCOMPLETE. A new flag starts with every environment off, so creating one changes no runtime behaviour; turn an environment on with the environment update.",
|
|
19119
|
+
http: "POST",
|
|
19120
|
+
path: "/devops/v1/projects/{project}/flags",
|
|
19121
|
+
streaming: "no",
|
|
19122
|
+
pagination: false,
|
|
19123
|
+
pathParams: [
|
|
19124
|
+
{
|
|
19125
|
+
name: "project",
|
|
19126
|
+
sdkName: "project",
|
|
19127
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19128
|
+
}
|
|
19129
|
+
],
|
|
19130
|
+
query: [],
|
|
19131
|
+
body: {
|
|
19132
|
+
required: true,
|
|
19133
|
+
fields: [
|
|
19134
|
+
{
|
|
19135
|
+
name: "key",
|
|
19136
|
+
type: "string",
|
|
19137
|
+
required: true,
|
|
19138
|
+
description: "The name code will call this flag by; unique inside the project, and a key already in use is refused with FLAG_KEY_TAKEN rather than reused."
|
|
19139
|
+
},
|
|
19140
|
+
{
|
|
19141
|
+
name: "name",
|
|
19142
|
+
type: "string",
|
|
19143
|
+
required: true,
|
|
19144
|
+
description: "Display name of the flag, shown wherever it is listed."
|
|
19145
|
+
},
|
|
19146
|
+
{
|
|
19147
|
+
name: "description",
|
|
19148
|
+
type: "string",
|
|
19149
|
+
required: false,
|
|
19150
|
+
description: "What this flag does to the product, so a later reader does not have to trace the code to find out."
|
|
19151
|
+
},
|
|
19152
|
+
{
|
|
19153
|
+
name: "kind",
|
|
19154
|
+
type: "string",
|
|
19155
|
+
enum: [
|
|
19156
|
+
"release",
|
|
19157
|
+
"experiment",
|
|
19158
|
+
"ops",
|
|
19159
|
+
"permission"
|
|
19160
|
+
],
|
|
19161
|
+
required: true,
|
|
19162
|
+
description: "What sort of flag this is; it decides the expected lifetime, and a release or experiment flag must carry an observation deadline."
|
|
19163
|
+
},
|
|
19164
|
+
{
|
|
19165
|
+
name: "valueType",
|
|
19166
|
+
type: "string",
|
|
19167
|
+
enum: [
|
|
19168
|
+
"boolean",
|
|
19169
|
+
"string",
|
|
19170
|
+
"number",
|
|
19171
|
+
"object"
|
|
19172
|
+
],
|
|
19173
|
+
required: true,
|
|
19174
|
+
description: "The type every variation must have; a variation of another type is refused."
|
|
19175
|
+
},
|
|
19176
|
+
{
|
|
19177
|
+
name: "variations",
|
|
19178
|
+
type: "array",
|
|
19179
|
+
itemType: "object",
|
|
19180
|
+
required: true,
|
|
19181
|
+
description: "The values the flag can serve, at least two for a flag that decides anything; their ids are what defaults and rules name."
|
|
19182
|
+
},
|
|
19183
|
+
{
|
|
19184
|
+
name: "defaults",
|
|
19185
|
+
type: "object",
|
|
19186
|
+
required: true,
|
|
19187
|
+
description: "The variations a flag falls back to: what a caller that matches nothing gets when the flag is on, and what everyone gets when it is off."
|
|
19188
|
+
},
|
|
19189
|
+
{
|
|
19190
|
+
name: "owner",
|
|
19191
|
+
type: "object",
|
|
19192
|
+
required: false,
|
|
19193
|
+
description: "Who performed an action, so a state change or a run can be attributed rather than guessed at."
|
|
19194
|
+
},
|
|
19195
|
+
{
|
|
19196
|
+
name: "observeUntil",
|
|
19197
|
+
type: "string",
|
|
19198
|
+
required: false,
|
|
19199
|
+
description: "RFC 3339 UTC time this flag must be decided by; required for a release or experiment flag and refused with INVALID_ARGUMENT when it is missing."
|
|
19200
|
+
},
|
|
19201
|
+
{
|
|
19202
|
+
name: "removalTicket",
|
|
19203
|
+
type: "string",
|
|
19204
|
+
required: false,
|
|
19205
|
+
description: "The ticket that will remove the flag and its code; giving it here is what makes the removal traceable from the flag itself."
|
|
19206
|
+
},
|
|
19207
|
+
{
|
|
19208
|
+
name: "pullRequest",
|
|
19209
|
+
type: "string",
|
|
19210
|
+
required: false,
|
|
19211
|
+
description: "The pull request that declared this flag, when the flag comes from a code change rather than being created by hand."
|
|
19212
|
+
},
|
|
19213
|
+
{
|
|
19214
|
+
name: "requestId",
|
|
19215
|
+
type: "string",
|
|
19216
|
+
required: false,
|
|
19217
|
+
description: "Caller-chosen key that makes this create idempotent: repeating it answers the flag the first call created instead of refusing the key as taken."
|
|
19218
|
+
}
|
|
19219
|
+
]
|
|
19220
|
+
}
|
|
19221
|
+
},
|
|
19222
|
+
{
|
|
19223
|
+
resource: "devops.projects.promotions",
|
|
19224
|
+
method: "list",
|
|
19225
|
+
summary: "List promotions",
|
|
19226
|
+
description: `List the project's promotions, newest first, across every environment. Use it to see what is queued, what is observing, and what finished recently, without reading each environment separately. A promotion in a terminal state stays in this list, which is how a caller tells "never promoted" apart from "promoted and then rolled back". Neither filter nor orderBy is accepted yet, so page through with pageToken instead of narrowing the query.`,
|
|
19227
|
+
http: "GET",
|
|
19228
|
+
path: "/devops/v1/projects/{project}/promotions",
|
|
19229
|
+
streaming: "no",
|
|
19230
|
+
pagination: false,
|
|
19231
|
+
pathParams: [
|
|
19232
|
+
{
|
|
19233
|
+
name: "project",
|
|
19234
|
+
sdkName: "project",
|
|
19235
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19236
|
+
}
|
|
19237
|
+
],
|
|
19238
|
+
query: [
|
|
19239
|
+
{
|
|
19240
|
+
name: "pageSize",
|
|
19241
|
+
type: "integer",
|
|
19242
|
+
required: false,
|
|
19243
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19244
|
+
},
|
|
19245
|
+
{
|
|
19246
|
+
name: "pageToken",
|
|
19247
|
+
type: "string",
|
|
19248
|
+
required: false,
|
|
19249
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19250
|
+
}
|
|
19251
|
+
]
|
|
19252
|
+
},
|
|
19253
|
+
{
|
|
19254
|
+
resource: "devops.projects.releases",
|
|
19255
|
+
method: "list",
|
|
19256
|
+
summary: "List releases",
|
|
19257
|
+
description: "List the project's releases, newest first. Use it to find the release a promotion should carry, or to see what has been released recently and whether any of it was abandoned. The list carries the render state and the abandoned flag, so a caller can skip a release that is still rendering or that was withdrawn without reading each one. Neither filter nor orderBy is accepted on this collection yet; a request that sends one is refused rather than silently ignored.",
|
|
19258
|
+
http: "GET",
|
|
19259
|
+
path: "/devops/v1/projects/{project}/releases",
|
|
19260
|
+
streaming: "no",
|
|
19261
|
+
pagination: false,
|
|
19262
|
+
pathParams: [
|
|
19263
|
+
{
|
|
19264
|
+
name: "project",
|
|
19265
|
+
sdkName: "project",
|
|
19266
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19267
|
+
}
|
|
19268
|
+
],
|
|
19269
|
+
query: [
|
|
19270
|
+
{
|
|
19271
|
+
name: "pageSize",
|
|
19272
|
+
type: "integer",
|
|
19273
|
+
required: false,
|
|
19274
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19275
|
+
},
|
|
19276
|
+
{
|
|
19277
|
+
name: "pageToken",
|
|
19278
|
+
type: "string",
|
|
19279
|
+
required: false,
|
|
19280
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19281
|
+
}
|
|
19282
|
+
]
|
|
19283
|
+
},
|
|
19284
|
+
{
|
|
19285
|
+
resource: "devops.projects.releases",
|
|
19286
|
+
method: "create",
|
|
19287
|
+
summary: "Create a release",
|
|
19288
|
+
description: "Create a release: an immutable snapshot of what will be deployed, named and fingerprinted once so later promotions can be compared against it. Send commit to release a commit as it stands, or base plus picks to build a patch release on a release that is already in production; the two shapes are exclusive and the patch shape is refused with PATCH_NOT_ELIGIBLE when the picks do not qualify. Rendering starts immediately and the answer reports its state; a promotion refuses a release that is still rendering with RELEASE_NOT_READY rather than deploying half of it. Set validateOnly to see the plan and the refusals without writing a release, and requestId to make a retry of the same call answer the first release instead of creating a second.",
|
|
19289
|
+
http: "POST",
|
|
19290
|
+
path: "/devops/v1/projects/{project}/releases",
|
|
19291
|
+
streaming: "no",
|
|
19292
|
+
pagination: false,
|
|
19293
|
+
pathParams: [
|
|
19294
|
+
{
|
|
19295
|
+
name: "project",
|
|
19296
|
+
sdkName: "project",
|
|
19297
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19298
|
+
}
|
|
19299
|
+
],
|
|
19300
|
+
query: [],
|
|
19301
|
+
body: {
|
|
19302
|
+
required: true,
|
|
19303
|
+
fields: [
|
|
19304
|
+
{
|
|
19305
|
+
name: "commit",
|
|
19306
|
+
type: "string",
|
|
19307
|
+
required: false,
|
|
19308
|
+
description: "Full 40-character commit to release as it stands; give this or base with picks, never both."
|
|
19309
|
+
},
|
|
19310
|
+
{
|
|
19311
|
+
name: "base",
|
|
19312
|
+
type: "string",
|
|
19313
|
+
required: false,
|
|
19314
|
+
description: "The production release a patch is built on; give it together with picks, and only when production currently runs that release."
|
|
19315
|
+
},
|
|
19316
|
+
{
|
|
19317
|
+
name: "picks",
|
|
19318
|
+
type: "array",
|
|
19319
|
+
itemType: "string",
|
|
19320
|
+
required: false,
|
|
19321
|
+
description: "The commits to cherry-pick onto base, in the request; each must be on the default branch and already verified below production. Request order is not the order they land in."
|
|
19322
|
+
},
|
|
19323
|
+
{
|
|
19324
|
+
name: "validateOnly",
|
|
19325
|
+
type: "boolean",
|
|
19326
|
+
required: false,
|
|
19327
|
+
description: "True to check the request and answer the plan and its refusals without creating a release; use it to find out whether a patch qualifies before committing to it."
|
|
19328
|
+
},
|
|
19329
|
+
{
|
|
19330
|
+
name: "requestId",
|
|
19331
|
+
type: "string",
|
|
19332
|
+
required: false,
|
|
19333
|
+
description: "Caller-chosen key that makes this call idempotent: repeating it answers the release the first call created instead of cutting a second one. Reuse it only for the same content."
|
|
19334
|
+
}
|
|
19335
|
+
]
|
|
19336
|
+
}
|
|
19337
|
+
},
|
|
19338
|
+
{
|
|
19339
|
+
resource: "devops.projects.targets",
|
|
19340
|
+
method: "list",
|
|
19341
|
+
summary: "List targets",
|
|
19342
|
+
description: "List what the project deploys — one target per deployable path in the repository, with its kind, its destination and the targets it depends on. Targets are discovered from the code, not entered by hand, so this list is the service's reading of the repository rather than a configuration you maintain here. A project whose catalog has never been read has it read on the first call, at the default branch's head, so the first answer is already the catalog instead of an empty page. Archived targets, which the repository no longer deploys, are left out.",
|
|
19343
|
+
http: "GET",
|
|
19344
|
+
path: "/devops/v1/projects/{project}/targets",
|
|
19345
|
+
streaming: "no",
|
|
19346
|
+
pagination: false,
|
|
19347
|
+
pathParams: [
|
|
19348
|
+
{
|
|
19349
|
+
name: "project",
|
|
19350
|
+
sdkName: "project",
|
|
19351
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19352
|
+
}
|
|
19353
|
+
],
|
|
19354
|
+
query: [
|
|
19355
|
+
{
|
|
19356
|
+
name: "pageSize",
|
|
19357
|
+
type: "integer",
|
|
19358
|
+
required: false,
|
|
19359
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19360
|
+
},
|
|
19361
|
+
{
|
|
19362
|
+
name: "pageToken",
|
|
19363
|
+
type: "string",
|
|
19364
|
+
required: false,
|
|
19365
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19366
|
+
}
|
|
19367
|
+
]
|
|
19368
|
+
},
|
|
19369
|
+
{
|
|
19370
|
+
resource: "devops.projects.targets",
|
|
19371
|
+
method: "refresh",
|
|
19372
|
+
summary: "Refresh the target catalog",
|
|
19373
|
+
description: "Re-read the repository at a commit and answer the deployment targets it implies, recording what was found. Call it after adding or removing a deployable service so later promotions see the current layout; omit commit to read the default branch's head, or name one to read that commit. The answer includes the dependency graph and any cycles in it, and a cycle is reported rather than refused, matching how the deploy pipeline treats one. This is a read of the repository that also remembers what it read, so it is safe to call again; nothing is deployed by it.",
|
|
19374
|
+
http: "POST",
|
|
19375
|
+
path: "/devops/v1/projects/{project}/targets:refresh",
|
|
19376
|
+
streaming: "no",
|
|
19377
|
+
pagination: false,
|
|
19378
|
+
pathParams: [
|
|
19379
|
+
{
|
|
19380
|
+
name: "project",
|
|
19381
|
+
sdkName: "project",
|
|
19382
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19383
|
+
}
|
|
19384
|
+
],
|
|
19385
|
+
query: [],
|
|
19386
|
+
body: {
|
|
19387
|
+
required: false,
|
|
19388
|
+
fields: [
|
|
19389
|
+
{
|
|
19390
|
+
name: "commit",
|
|
19391
|
+
type: "string",
|
|
19392
|
+
required: false,
|
|
19393
|
+
description: "Full 40-character commit sha to read instead of the default branch's head; use it to see what a past commit implied rather than what the branch says now."
|
|
19394
|
+
}
|
|
19395
|
+
]
|
|
19396
|
+
}
|
|
19397
|
+
},
|
|
18686
19398
|
{
|
|
18687
19399
|
resource: "devops.projects.testCases",
|
|
18688
19400
|
method: "list",
|
|
18689
|
-
summary: "List test cases",
|
|
18690
|
-
description: "List a project's cases with their health, state and recent statistics, so you can decide which ones a plan must run and which are quarantined. This is the read a test dashboard is built on; filter it to narrow by state or health instead of paging through everything. A case's id is a fingerprint of its own title and path, so it survives a rename — read aliases when reconciling history recorded under an older title.",
|
|
19401
|
+
summary: "List test cases",
|
|
19402
|
+
description: "List a project's cases with their health, state and recent statistics, so you can decide which ones a plan must run and which are quarantined. This is the read a test dashboard is built on; filter it to narrow by state or health instead of paging through everything. A case's id is a fingerprint of its own title and path, so it survives a rename — read aliases when reconciling history recorded under an older title.",
|
|
19403
|
+
http: "GET",
|
|
19404
|
+
path: "/devops/v1/projects/{project}/test-cases",
|
|
19405
|
+
streaming: "no",
|
|
19406
|
+
pagination: false,
|
|
19407
|
+
pathParams: [
|
|
19408
|
+
{
|
|
19409
|
+
name: "project",
|
|
19410
|
+
sdkName: "project",
|
|
19411
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19412
|
+
}
|
|
19413
|
+
],
|
|
19414
|
+
query: [
|
|
19415
|
+
{
|
|
19416
|
+
name: "pageSize",
|
|
19417
|
+
type: "integer",
|
|
19418
|
+
required: false,
|
|
19419
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19420
|
+
},
|
|
19421
|
+
{
|
|
19422
|
+
name: "pageToken",
|
|
19423
|
+
type: "string",
|
|
19424
|
+
required: false,
|
|
19425
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19426
|
+
},
|
|
19427
|
+
{
|
|
19428
|
+
name: "filter",
|
|
19429
|
+
type: "string",
|
|
19430
|
+
required: false,
|
|
19431
|
+
description: "AIP-160 equality filter over one declared field at a time, for example state=quarantined or health=broken. Fields a case list does not declare are refused with INVALID_ARGUMENT rather than ignored, so a typo never silently widens the result."
|
|
19432
|
+
},
|
|
19433
|
+
{
|
|
19434
|
+
name: "orderBy",
|
|
19435
|
+
type: "string",
|
|
19436
|
+
required: false,
|
|
19437
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
19438
|
+
}
|
|
19439
|
+
]
|
|
19440
|
+
},
|
|
19441
|
+
{
|
|
19442
|
+
resource: "devops.projects",
|
|
19443
|
+
method: "retrieveTestCatalog",
|
|
19444
|
+
summary: "Read a commit's test catalog",
|
|
19445
|
+
description: 'Read the catalog version discovered at one commit — how many suites and cases it holds, which frameworks they come from, and how the commit changed them. Call this first: it tells you which suites, cases and sizes exist before you list them or select them into a plan, and the reported diff explains why a case count moved. A commit whose discovery has not finished answers CATALOG_NOT_READY, which means "not yet", not "no tests"; wait and read again. Omit commit to read the newest catalog published for the project.',
|
|
19446
|
+
http: "GET",
|
|
19447
|
+
path: "/devops/v1/projects/{project}/test-catalog",
|
|
19448
|
+
streaming: "no",
|
|
19449
|
+
pagination: false,
|
|
19450
|
+
pathParams: [
|
|
19451
|
+
{
|
|
19452
|
+
name: "project",
|
|
19453
|
+
sdkName: "project",
|
|
19454
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19455
|
+
}
|
|
19456
|
+
],
|
|
19457
|
+
query: [
|
|
19458
|
+
{
|
|
19459
|
+
name: "commit",
|
|
19460
|
+
type: "string",
|
|
19461
|
+
required: false,
|
|
19462
|
+
description: "Full 40-character commit sha whose catalog you want, from a project branch or commit read. Omit it to read the newest catalog published for the project."
|
|
19463
|
+
}
|
|
19464
|
+
]
|
|
19465
|
+
},
|
|
19466
|
+
{
|
|
19467
|
+
resource: "devops.projects.testPlans",
|
|
19468
|
+
method: "list",
|
|
19469
|
+
summary: "List test plans",
|
|
19470
|
+
description: "List the project's plans — what each one selects, which stage and gate it belongs to, and when it runs next. Read this before creating a plan, so a new plan extends what exists instead of duplicating a selector an existing plan already covers.",
|
|
19471
|
+
http: "GET",
|
|
19472
|
+
path: "/devops/v1/projects/{project}/test-plans",
|
|
19473
|
+
streaming: "no",
|
|
19474
|
+
pagination: false,
|
|
19475
|
+
pathParams: [
|
|
19476
|
+
{
|
|
19477
|
+
name: "project",
|
|
19478
|
+
sdkName: "project",
|
|
19479
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19480
|
+
}
|
|
19481
|
+
],
|
|
19482
|
+
query: [
|
|
19483
|
+
{
|
|
19484
|
+
name: "pageSize",
|
|
19485
|
+
type: "integer",
|
|
19486
|
+
required: false,
|
|
19487
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19488
|
+
},
|
|
19489
|
+
{
|
|
19490
|
+
name: "pageToken",
|
|
19491
|
+
type: "string",
|
|
19492
|
+
required: false,
|
|
19493
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19494
|
+
},
|
|
19495
|
+
{
|
|
19496
|
+
name: "orderBy",
|
|
19497
|
+
type: "string",
|
|
19498
|
+
required: false,
|
|
19499
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
19500
|
+
}
|
|
19501
|
+
]
|
|
19502
|
+
},
|
|
19503
|
+
{
|
|
19504
|
+
resource: "devops.projects.testPlans",
|
|
19505
|
+
method: "create",
|
|
19506
|
+
summary: "Create a test plan",
|
|
19507
|
+
description: "Create a plan that decides which cases a stage must run. The plan's key is unique inside the project and is what a later run names; the selector chooses cases by size, purpose, tag, package or explicit ids, and the trigger says when the plan fires by itself. A merge or promotion gate must name the environment it guards, and a plan with a gate but no environment is refused with PLAN_GATE_ENVIRONMENT_MISMATCH rather than created and silently ignored. A plan has no revision history: update it with a patch.",
|
|
19508
|
+
http: "POST",
|
|
19509
|
+
path: "/devops/v1/projects/{project}/test-plans",
|
|
19510
|
+
streaming: "no",
|
|
19511
|
+
pagination: false,
|
|
19512
|
+
pathParams: [
|
|
19513
|
+
{
|
|
19514
|
+
name: "project",
|
|
19515
|
+
sdkName: "project",
|
|
19516
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19517
|
+
}
|
|
19518
|
+
],
|
|
19519
|
+
query: [],
|
|
19520
|
+
body: {
|
|
19521
|
+
required: true,
|
|
19522
|
+
fields: [
|
|
19523
|
+
{
|
|
19524
|
+
name: "key",
|
|
19525
|
+
type: "string",
|
|
19526
|
+
required: true,
|
|
19527
|
+
description: "Short name for the plan, unique inside the project; a key already in use is refused rather than silently reused."
|
|
19528
|
+
},
|
|
19529
|
+
{
|
|
19530
|
+
name: "title",
|
|
19531
|
+
type: "string",
|
|
19532
|
+
required: true,
|
|
19533
|
+
description: "Display title of the plan, shown wherever the plan is listed."
|
|
19534
|
+
},
|
|
19535
|
+
{
|
|
19536
|
+
name: "stage",
|
|
19537
|
+
type: "string",
|
|
19538
|
+
enum: [
|
|
19539
|
+
"dev",
|
|
19540
|
+
"presubmit",
|
|
19541
|
+
"postsubmit",
|
|
19542
|
+
"nightly",
|
|
19543
|
+
"production"
|
|
19544
|
+
],
|
|
19545
|
+
required: true,
|
|
19546
|
+
description: "Which stage of delivery this plan belongs to, which decides when it is expected to run."
|
|
19547
|
+
},
|
|
19548
|
+
{
|
|
19549
|
+
name: "trigger",
|
|
19550
|
+
type: "object",
|
|
19551
|
+
required: true,
|
|
19552
|
+
description: "What starts a run of this plan. Exactly one kind applies; the fields a kind needs are the ones it carries."
|
|
19553
|
+
},
|
|
19554
|
+
{
|
|
19555
|
+
name: "selector",
|
|
19556
|
+
type: "object",
|
|
19557
|
+
required: true,
|
|
19558
|
+
description: "Which cases a plan or run selects. Every member is optional and they combine as an intersection, so a selector with no member selects every case in the catalog."
|
|
19559
|
+
},
|
|
19560
|
+
{
|
|
19561
|
+
name: "environment",
|
|
19562
|
+
type: "string",
|
|
19563
|
+
required: false,
|
|
19564
|
+
description: "The environment this plan runs against; required by a merge or promotion gate, and refused with PLAN_GATE_ENVIRONMENT_MISMATCH when it disagrees with the gate."
|
|
19565
|
+
},
|
|
19566
|
+
{
|
|
19567
|
+
name: "gate",
|
|
19568
|
+
type: "string",
|
|
19569
|
+
enum: [
|
|
19570
|
+
"merge",
|
|
19571
|
+
"promotion",
|
|
19572
|
+
"observation",
|
|
19573
|
+
"none"
|
|
19574
|
+
],
|
|
19575
|
+
required: true,
|
|
19576
|
+
description: "Whether this plan's result blocks a stage; a merge or promotion gate must name its environment."
|
|
19577
|
+
},
|
|
19578
|
+
{
|
|
19579
|
+
name: "repeat",
|
|
19580
|
+
type: "integer",
|
|
19581
|
+
required: false,
|
|
19582
|
+
description: "How many times each selected case runs in one run; omit for once. More than one is how a flake is told apart from a real failure."
|
|
19583
|
+
},
|
|
19584
|
+
{
|
|
19585
|
+
name: "timeoutMinutes",
|
|
19586
|
+
type: "integer",
|
|
19587
|
+
required: false,
|
|
19588
|
+
description: "How many minutes a run of this plan may take before it is timed out; omit for the service's default."
|
|
19589
|
+
}
|
|
19590
|
+
]
|
|
19591
|
+
}
|
|
19592
|
+
},
|
|
19593
|
+
{
|
|
19594
|
+
resource: "devops.projects.testReports",
|
|
19595
|
+
method: "create",
|
|
19596
|
+
summary: "Upload an external test report",
|
|
19597
|
+
description: "Record the results of a run executed outside Praxis by uploading a CTRF or JUnit report. Nothing has to exist first: a first upload from CI creates the run it reports on (executor external) and catalogues the cases the report names, so there is no setup call before the first result. When the report already belongs to a run, pass ref and the upload joins it; the run's counts and verdict are recomputed from the report. Uploading the same reportId again is idempotent and counts once, so a retry after a timeout is safe — and a reported case is catalogued once, however many reports carry it. The report's bytes are kept as a file (the file field of the answer) rather than in the results database, so the original document stays retrievable.",
|
|
19598
|
+
http: "POST",
|
|
19599
|
+
path: "/devops/v1/projects/{project}/test-reports",
|
|
19600
|
+
streaming: "no",
|
|
19601
|
+
pagination: false,
|
|
19602
|
+
pathParams: [
|
|
19603
|
+
{
|
|
19604
|
+
name: "project",
|
|
19605
|
+
sdkName: "project",
|
|
19606
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
19607
|
+
}
|
|
19608
|
+
],
|
|
19609
|
+
query: [],
|
|
19610
|
+
body: {
|
|
19611
|
+
required: true,
|
|
19612
|
+
fields: [
|
|
19613
|
+
{
|
|
19614
|
+
name: "reportId",
|
|
19615
|
+
type: "string",
|
|
19616
|
+
required: true,
|
|
19617
|
+
description: "Your own identifier for this report. Uploading the same id again is idempotent and counts once, so a retry after a timeout is safe."
|
|
19618
|
+
},
|
|
19619
|
+
{
|
|
19620
|
+
name: "format",
|
|
19621
|
+
type: "string",
|
|
19622
|
+
enum: [
|
|
19623
|
+
"ctrf",
|
|
19624
|
+
"junit"
|
|
19625
|
+
],
|
|
19626
|
+
required: true,
|
|
19627
|
+
description: "Which report format the document is in; it decides how the document is parsed."
|
|
19628
|
+
},
|
|
19629
|
+
{
|
|
19630
|
+
name: "ref",
|
|
19631
|
+
type: "object",
|
|
19632
|
+
required: true,
|
|
19633
|
+
description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against."
|
|
19634
|
+
},
|
|
19635
|
+
{
|
|
19636
|
+
name: "report",
|
|
19637
|
+
type: "string",
|
|
19638
|
+
required: true,
|
|
19639
|
+
description: "The report document itself, as text — JSON for ctrf, XML for junit. Send the file's contents unchanged; a malformed document is refused with REPORT_INVALID and records nothing."
|
|
19640
|
+
}
|
|
19641
|
+
]
|
|
19642
|
+
}
|
|
19643
|
+
},
|
|
19644
|
+
{
|
|
19645
|
+
resource: "devops.projects.testRuns",
|
|
19646
|
+
method: "list",
|
|
19647
|
+
summary: "List test runs",
|
|
19648
|
+
description: "List the project's runs newest first, with each run's state, result and counts. Use it to find the run id whose executions you want to read, or to see whether a commit's tests have finished. A run whose result is pending has not reached a verdict yet — read it again rather than treating it as passed. Filter by state or result to watch only the runs still in flight.",
|
|
18691
19649
|
http: "GET",
|
|
18692
|
-
path: "/devops/v1/projects/{project}/test-
|
|
19650
|
+
path: "/devops/v1/projects/{project}/test-runs",
|
|
18693
19651
|
streaming: "no",
|
|
18694
19652
|
pagination: false,
|
|
18695
19653
|
pathParams: [
|
|
@@ -18716,7 +19674,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18716
19674
|
name: "filter",
|
|
18717
19675
|
type: "string",
|
|
18718
19676
|
required: false,
|
|
18719
|
-
description: "AIP-160 equality filter over one declared field
|
|
19677
|
+
description: "AIP-160 equality filter over one declared field, for example state=running or result=failed. An undeclared field is refused with INVALID_ARGUMENT; it is never ignored, so a mistyped filter cannot quietly return everything."
|
|
18720
19678
|
},
|
|
18721
19679
|
{
|
|
18722
19680
|
name: "orderBy",
|
|
@@ -18727,12 +19685,12 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18727
19685
|
]
|
|
18728
19686
|
},
|
|
18729
19687
|
{
|
|
18730
|
-
resource: "devops.projects",
|
|
18731
|
-
method: "
|
|
18732
|
-
summary: "
|
|
18733
|
-
description:
|
|
18734
|
-
http: "
|
|
18735
|
-
path: "/devops/v1/projects/{project}/test-
|
|
19688
|
+
resource: "devops.projects.testRuns",
|
|
19689
|
+
method: "create",
|
|
19690
|
+
summary: "Create a test run",
|
|
19691
|
+
description: "Start a run of the project's tests at one commit. Name a plan to use its selector, or pass a selector directly for this run alone; the ref says which commit to test and is required, because a run without a commit has nothing to report against. waitUntil decides how far the call waits before answering — queued, the default, returns as soon as the run exists; started waits until the run has begun, except for an external run, which is answered at once because it leaves queued only when your own CI uploads; finished waits for a verdict. The wait is bounded at about 25 seconds, and a wait that reaches that bound returns the run as it stands rather than failing — read state to see whether it finished. A retry of an earlier run is a new run: pass its commit and selector, and read the earlier run to compare.",
|
|
19692
|
+
http: "POST",
|
|
19693
|
+
path: "/devops/v1/projects/{project}/test-runs",
|
|
18736
19694
|
streaming: "no",
|
|
18737
19695
|
pagination: false,
|
|
18738
19696
|
pathParams: [
|
|
@@ -18742,22 +19700,77 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18742
19700
|
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
18743
19701
|
}
|
|
18744
19702
|
],
|
|
18745
|
-
query: [
|
|
18746
|
-
|
|
18747
|
-
|
|
18748
|
-
|
|
18749
|
-
|
|
18750
|
-
|
|
18751
|
-
|
|
18752
|
-
|
|
19703
|
+
query: [],
|
|
19704
|
+
body: {
|
|
19705
|
+
required: true,
|
|
19706
|
+
fields: [
|
|
19707
|
+
{
|
|
19708
|
+
name: "ref",
|
|
19709
|
+
type: "object",
|
|
19710
|
+
required: true,
|
|
19711
|
+
description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against."
|
|
19712
|
+
},
|
|
19713
|
+
{
|
|
19714
|
+
name: "plan",
|
|
19715
|
+
type: "string",
|
|
19716
|
+
required: false,
|
|
19717
|
+
description: "Plan whose selector this run uses; omit it when passing selector instead. Naming a plan records the run against that plan, which is what a gate reads."
|
|
19718
|
+
},
|
|
19719
|
+
{
|
|
19720
|
+
name: "selector",
|
|
19721
|
+
type: "object",
|
|
19722
|
+
required: false,
|
|
19723
|
+
description: "An ad-hoc selector for this run alone, used instead of a plan's; it is not saved as a plan, so a run you want to repeat should name a plan."
|
|
19724
|
+
},
|
|
19725
|
+
{
|
|
19726
|
+
name: "environment",
|
|
19727
|
+
type: "string",
|
|
19728
|
+
required: false,
|
|
19729
|
+
description: "Environment to run against; it decides whether production-only cases become selectable. Omit it for a run that needs no environment."
|
|
19730
|
+
},
|
|
19731
|
+
{
|
|
19732
|
+
name: "repeat",
|
|
19733
|
+
type: "integer",
|
|
19734
|
+
required: false,
|
|
19735
|
+
description: "How many times each selected case runs, which is how a flake is told apart from a real failure; omit for once."
|
|
19736
|
+
},
|
|
19737
|
+
{
|
|
19738
|
+
name: "waitUntil",
|
|
19739
|
+
type: "string",
|
|
19740
|
+
enum: [
|
|
19741
|
+
"queued",
|
|
19742
|
+
"started",
|
|
19743
|
+
"finished"
|
|
19744
|
+
],
|
|
19745
|
+
required: false,
|
|
19746
|
+
description: "How far the call waits before answering, bounded at about 25 seconds; omit it for queued, which returns at once. The wait reads the run's own state, so a wait that reaches the bound returns the run as it stands instead of failing — check state before assuming the request was honoured."
|
|
19747
|
+
},
|
|
19748
|
+
{
|
|
19749
|
+
name: "executor",
|
|
19750
|
+
type: "string",
|
|
19751
|
+
enum: [
|
|
19752
|
+
"cloud",
|
|
19753
|
+
"external"
|
|
19754
|
+
],
|
|
19755
|
+
required: false,
|
|
19756
|
+
description: "Who carries the run out. cloud, the default, runs the selected cases in Praxis at the commit; external creates a run that waits for your own CI to upload a report with test-reports."
|
|
19757
|
+
},
|
|
19758
|
+
{
|
|
19759
|
+
name: "requestId",
|
|
19760
|
+
type: "string",
|
|
19761
|
+
required: false,
|
|
19762
|
+
description: "A key you choose to make creating this run idempotent: repeating the call with the same requestId returns the run it created instead of starting another, so a retry after a timeout is safe."
|
|
19763
|
+
}
|
|
19764
|
+
]
|
|
19765
|
+
}
|
|
18753
19766
|
},
|
|
18754
19767
|
{
|
|
18755
|
-
resource: "devops.projects.
|
|
19768
|
+
resource: "devops.projects.testSuites",
|
|
18756
19769
|
method: "list",
|
|
18757
|
-
summary: "List test
|
|
18758
|
-
description: "List the project's
|
|
19770
|
+
summary: "List test suites",
|
|
19771
|
+
description: "List the suites the project's newest catalog discovered — one suite per test file and framework pair, with its size, purposes and question count. Use it to find the suite id a case belongs to, or to see which files make up an area before selecting cases from them. Suites come from the catalog, so a file added in code appears only after its commit's catalog is published. Archived suites are returned too; they carry archived true and no case is ever silently dropped from the list.",
|
|
18759
19772
|
http: "GET",
|
|
18760
|
-
path: "/devops/v1/projects/{project}/test-
|
|
19773
|
+
path: "/devops/v1/projects/{project}/test-suites",
|
|
18761
19774
|
streaming: "no",
|
|
18762
19775
|
pagination: false,
|
|
18763
19776
|
pathParams: [
|
|
@@ -18789,109 +19802,178 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18789
19802
|
]
|
|
18790
19803
|
},
|
|
18791
19804
|
{
|
|
18792
|
-
resource: "devops.
|
|
19805
|
+
resource: "devops.promotions",
|
|
18793
19806
|
method: "create",
|
|
18794
|
-
summary: "Create a
|
|
18795
|
-
description: "
|
|
19807
|
+
summary: "Create a promotion",
|
|
19808
|
+
description: "Promote a release into one environment: this is the operation that actually schedules a deployment. Name the release and the environment; path is regular for an ordinary promotion, patch to carry a patch release, targeted to deploy only the targets you list, and rollback to return the environment to an earlier release. The service reads the environment's promotion order and refuses when an upstream environment has not verified this release yet, unless a bypass carries the authorization for that gate. An environment takes one promotion at a time, so a create while another is running is queued behind it rather than refused. Set validateOnly to read the plan and its refusals — layers, skipped targets, pending migrations, missing configuration keys — without scheduling anything, which is the safe way to find out what a promotion will do.",
|
|
18796
19809
|
http: "POST",
|
|
18797
|
-
path: "/devops/v1/
|
|
19810
|
+
path: "/devops/v1/promotions",
|
|
18798
19811
|
streaming: "no",
|
|
18799
19812
|
pagination: false,
|
|
18800
|
-
pathParams: [
|
|
18801
|
-
{
|
|
18802
|
-
name: "project",
|
|
18803
|
-
sdkName: "project",
|
|
18804
|
-
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
18805
|
-
}
|
|
18806
|
-
],
|
|
19813
|
+
pathParams: [],
|
|
18807
19814
|
query: [],
|
|
18808
19815
|
body: {
|
|
18809
19816
|
required: true,
|
|
18810
19817
|
fields: [
|
|
18811
19818
|
{
|
|
18812
|
-
name: "
|
|
19819
|
+
name: "release",
|
|
18813
19820
|
type: "string",
|
|
18814
19821
|
required: true,
|
|
18815
|
-
description: "
|
|
19822
|
+
description: "The release to promote, from a release list or create answer; promoting an abandoned release is refused."
|
|
18816
19823
|
},
|
|
18817
19824
|
{
|
|
18818
|
-
name: "
|
|
19825
|
+
name: "environment",
|
|
18819
19826
|
type: "string",
|
|
18820
19827
|
required: true,
|
|
18821
|
-
description: "
|
|
19828
|
+
description: "The environment to deploy into, from the project's environment list; the upstream environment must have verified the release unless a bypass covers that gate."
|
|
18822
19829
|
},
|
|
18823
19830
|
{
|
|
18824
|
-
name: "
|
|
19831
|
+
name: "path",
|
|
18825
19832
|
type: "string",
|
|
18826
19833
|
enum: [
|
|
18827
|
-
"
|
|
18828
|
-
"
|
|
18829
|
-
"
|
|
18830
|
-
"
|
|
18831
|
-
"production"
|
|
19834
|
+
"regular",
|
|
19835
|
+
"patch",
|
|
19836
|
+
"targeted",
|
|
19837
|
+
"rollback"
|
|
18832
19838
|
],
|
|
18833
|
-
required:
|
|
18834
|
-
description: "
|
|
19839
|
+
required: false,
|
|
19840
|
+
description: "How the release should travel; omit it for an ordinary promotion. A path other than regular is not creatable yet and is refused with NOT_IMPLEMENTED."
|
|
18835
19841
|
},
|
|
18836
19842
|
{
|
|
18837
|
-
name: "
|
|
18838
|
-
type: "
|
|
18839
|
-
|
|
18840
|
-
|
|
19843
|
+
name: "targets",
|
|
19844
|
+
type: "array",
|
|
19845
|
+
itemType: "string",
|
|
19846
|
+
required: false,
|
|
19847
|
+
description: "Deploy only these targets; omit it to let the plan choose from what changed. Naming a target the plan would skip does not force it — read skipped in the plan."
|
|
18841
19848
|
},
|
|
18842
19849
|
{
|
|
18843
|
-
name: "
|
|
18844
|
-
type: "
|
|
18845
|
-
|
|
18846
|
-
|
|
19850
|
+
name: "bypass",
|
|
19851
|
+
type: "array",
|
|
19852
|
+
itemType: "object",
|
|
19853
|
+
required: false,
|
|
19854
|
+
description: "Gates to skip, each naming the approval that authorizes it; a bypass is refused unless the project allows skipping upstream and the approval covers this release, environment and gate."
|
|
18847
19855
|
},
|
|
18848
19856
|
{
|
|
18849
|
-
name: "
|
|
18850
|
-
type: "
|
|
19857
|
+
name: "validateOnly",
|
|
19858
|
+
type: "boolean",
|
|
18851
19859
|
required: false,
|
|
18852
|
-
description: "
|
|
19860
|
+
description: "True to answer the plan without scheduling anything; use it to find out whether a promotion would be refused before committing to it. Nothing is deployed."
|
|
18853
19861
|
},
|
|
18854
19862
|
{
|
|
18855
|
-
name: "
|
|
19863
|
+
name: "requestId",
|
|
18856
19864
|
type: "string",
|
|
18857
|
-
enum: [
|
|
18858
|
-
"merge",
|
|
18859
|
-
"promotion",
|
|
18860
|
-
"observation",
|
|
18861
|
-
"none"
|
|
18862
|
-
],
|
|
18863
|
-
required: true,
|
|
18864
|
-
description: "Whether this plan's result blocks a stage; a merge or promotion gate must name its environment."
|
|
18865
|
-
},
|
|
18866
|
-
{
|
|
18867
|
-
name: "repeat",
|
|
18868
|
-
type: "integer",
|
|
18869
19865
|
required: false,
|
|
18870
|
-
description: "
|
|
19866
|
+
description: "Caller-chosen key that makes this create idempotent: repeating it answers the promotion the first call made instead of scheduling a second one."
|
|
19867
|
+
}
|
|
19868
|
+
]
|
|
19869
|
+
}
|
|
19870
|
+
},
|
|
19871
|
+
{
|
|
19872
|
+
resource: "devops.promotions",
|
|
19873
|
+
method: "retrieve",
|
|
19874
|
+
summary: "Retrieve a promotion",
|
|
19875
|
+
description: "Read one promotion: its state, its approval, its plan, and the failure that stopped it when there is one. Poll this after creating a promotion to follow it to a terminal state, or read it to find out why a deployment stopped — failure.cause tells plan refusal apart from a failed deploy, and executor names the runs involved. Pass expand=rollouts to receive the per-target rollouts in the same answer instead of listing them separately. state observing means the environment is deployed and the observation window is running, so the promotion is not finished and conclude is still to come.",
|
|
19876
|
+
http: "GET",
|
|
19877
|
+
path: "/devops/v1/promotions/{id}",
|
|
19878
|
+
streaming: "no",
|
|
19879
|
+
pagination: false,
|
|
19880
|
+
pathParams: [
|
|
19881
|
+
{
|
|
19882
|
+
name: "id",
|
|
19883
|
+
sdkName: "id",
|
|
19884
|
+
description: "The promotion identifier returned by a promotion list or create answer."
|
|
19885
|
+
}
|
|
19886
|
+
],
|
|
19887
|
+
query: [
|
|
19888
|
+
{
|
|
19889
|
+
name: "expand",
|
|
19890
|
+
type: "string",
|
|
19891
|
+
enum: [
|
|
19892
|
+
"rollouts"
|
|
19893
|
+
],
|
|
19894
|
+
required: false,
|
|
19895
|
+
description: "Extra sections to inline in the answer; today only rollouts, which adds the per-target rollouts this promotion owns. Omit it for the promotion alone."
|
|
19896
|
+
}
|
|
19897
|
+
]
|
|
19898
|
+
},
|
|
19899
|
+
{
|
|
19900
|
+
resource: "devops.promotions",
|
|
19901
|
+
method: "approve",
|
|
19902
|
+
summary: "Approve or reject a promotion",
|
|
19903
|
+
description: "Answer the approval an environment asked for: send approved true to let the promotion proceed, false to reject it and end it in approval_rejected. This is the environment-level gate an environment with requireApproval raises, not the per-rollout approval. Comment records the reasoning next to the decision, which is what a later reader sees instead of the bare verdict. The call is refused with PROMOTION_NOT_AWAITING_APPROVAL when the promotion is not waiting for one, so a stale approval cannot restart something that already finished. Approving is attributed to the credential that sends it.",
|
|
19904
|
+
http: "POST",
|
|
19905
|
+
path: "/devops/v1/promotions/{id}:approve",
|
|
19906
|
+
streaming: "no",
|
|
19907
|
+
pagination: false,
|
|
19908
|
+
pathParams: [
|
|
19909
|
+
{
|
|
19910
|
+
name: "id",
|
|
19911
|
+
sdkName: "id",
|
|
19912
|
+
description: "The promotion identifier returned by a promotion list or create answer."
|
|
19913
|
+
}
|
|
19914
|
+
],
|
|
19915
|
+
query: [],
|
|
19916
|
+
body: {
|
|
19917
|
+
required: true,
|
|
19918
|
+
fields: [
|
|
19919
|
+
{
|
|
19920
|
+
name: "approved",
|
|
19921
|
+
type: "boolean",
|
|
19922
|
+
required: true,
|
|
19923
|
+
description: "True to approve, which lets the promotion deploy; false rejects it and ends the promotion as approval_rejected."
|
|
18871
19924
|
},
|
|
18872
19925
|
{
|
|
18873
|
-
name: "
|
|
18874
|
-
type: "
|
|
19926
|
+
name: "comment",
|
|
19927
|
+
type: "string",
|
|
18875
19928
|
required: false,
|
|
18876
|
-
description: "
|
|
19929
|
+
description: "What the approver wants recorded with the decision, stored verbatim; omit it when there is nothing to add."
|
|
19930
|
+
}
|
|
19931
|
+
]
|
|
19932
|
+
}
|
|
19933
|
+
},
|
|
19934
|
+
{
|
|
19935
|
+
resource: "devops.promotions",
|
|
19936
|
+
method: "cancel",
|
|
19937
|
+
summary: "Cancel a promotion",
|
|
19938
|
+
description: "Stop a promotion that has not finished, moving it through cancelling to cancelled and stopping the deploys it had scheduled. Use it to halt a deployment that is failing or that should no longer continue; reason is recorded as the attribution of the stop. Cancelling does not undo what already deployed: an environment whose targets were written keeps those targets, and returning them to an earlier release is a separate rollback promotion. A promotion that already reached a terminal state is refused with PROMOTION_ALREADY_FINISHED rather than silently ignored.",
|
|
19939
|
+
http: "POST",
|
|
19940
|
+
path: "/devops/v1/promotions/{id}:cancel",
|
|
19941
|
+
streaming: "no",
|
|
19942
|
+
pagination: false,
|
|
19943
|
+
pathParams: [
|
|
19944
|
+
{
|
|
19945
|
+
name: "id",
|
|
19946
|
+
sdkName: "id",
|
|
19947
|
+
description: "The promotion identifier returned by a promotion list or create answer."
|
|
19948
|
+
}
|
|
19949
|
+
],
|
|
19950
|
+
query: [],
|
|
19951
|
+
body: {
|
|
19952
|
+
required: true,
|
|
19953
|
+
fields: [
|
|
19954
|
+
{
|
|
19955
|
+
name: "reason",
|
|
19956
|
+
type: "string",
|
|
19957
|
+
required: true,
|
|
19958
|
+
description: "Why the promotion is being cancelled, stored on it as the attribution of the act."
|
|
18877
19959
|
}
|
|
18878
19960
|
]
|
|
18879
19961
|
}
|
|
18880
19962
|
},
|
|
18881
19963
|
{
|
|
18882
|
-
resource: "devops.
|
|
18883
|
-
method: "
|
|
18884
|
-
summary: "
|
|
18885
|
-
description:
|
|
19964
|
+
resource: "devops.promotions",
|
|
19965
|
+
method: "conclude",
|
|
19966
|
+
summary: "Conclude an observation",
|
|
19967
|
+
description: `Record the verdict on a promotion that is observing: send keep to accept the deployment as the environment's new state, or rollback to return the environment to the release it held before. This is the decision the observation window exists for, so a promotion in observing state stays open until it is concluded; reason is stored as the attribution. Concluding with rollback schedules the return, it does not merely label the promotion. A promotion that is not observing is refused with PROMOTION_NOT_OBSERVING, which is how a caller tells "already concluded" apart from a call that had no effect.`,
|
|
18886
19968
|
http: "POST",
|
|
18887
|
-
path: "/devops/v1/
|
|
19969
|
+
path: "/devops/v1/promotions/{id}:conclude",
|
|
18888
19970
|
streaming: "no",
|
|
18889
19971
|
pagination: false,
|
|
18890
19972
|
pathParams: [
|
|
18891
19973
|
{
|
|
18892
|
-
name: "
|
|
18893
|
-
sdkName: "
|
|
18894
|
-
description: "
|
|
19974
|
+
name: "id",
|
|
19975
|
+
sdkName: "id",
|
|
19976
|
+
description: "The promotion identifier returned by a promotion list or create answer."
|
|
18895
19977
|
}
|
|
18896
19978
|
],
|
|
18897
19979
|
query: [],
|
|
@@ -18899,50 +19981,56 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18899
19981
|
required: true,
|
|
18900
19982
|
fields: [
|
|
18901
19983
|
{
|
|
18902
|
-
name: "
|
|
18903
|
-
type: "string",
|
|
18904
|
-
required: true,
|
|
18905
|
-
description: "Your own identifier for this report. Uploading the same id again is idempotent and counts once, so a retry after a timeout is safe."
|
|
18906
|
-
},
|
|
18907
|
-
{
|
|
18908
|
-
name: "format",
|
|
19984
|
+
name: "action",
|
|
18909
19985
|
type: "string",
|
|
18910
19986
|
enum: [
|
|
18911
|
-
"
|
|
18912
|
-
"
|
|
19987
|
+
"keep",
|
|
19988
|
+
"rollback"
|
|
18913
19989
|
],
|
|
18914
19990
|
required: true,
|
|
18915
|
-
description: "Which
|
|
18916
|
-
},
|
|
18917
|
-
{
|
|
18918
|
-
name: "ref",
|
|
18919
|
-
type: "object",
|
|
18920
|
-
required: true,
|
|
18921
|
-
description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against."
|
|
19991
|
+
description: "Which way the window is decided; a rollback schedules the return of the environment rather than only labelling the promotion."
|
|
18922
19992
|
},
|
|
18923
19993
|
{
|
|
18924
|
-
name: "
|
|
19994
|
+
name: "reason",
|
|
18925
19995
|
type: "string",
|
|
18926
19996
|
required: true,
|
|
18927
|
-
description: "
|
|
19997
|
+
description: "Why the window was decided that way, recorded on the promotion's observation as the attribution of the verdict."
|
|
18928
19998
|
}
|
|
18929
19999
|
]
|
|
18930
20000
|
}
|
|
18931
20001
|
},
|
|
18932
20002
|
{
|
|
18933
|
-
resource: "devops.
|
|
20003
|
+
resource: "devops.promotions",
|
|
20004
|
+
method: "retry",
|
|
20005
|
+
summary: "Retry a promotion",
|
|
20006
|
+
description: "Continue a promotion that stopped part-way, such as one in halted where some targets succeeded and others failed. The retry re-runs the targets that did not succeed and leaves the ones that did alone, so a partially deployed environment is completed rather than redeployed from the start. A promotion that is still running is refused, and so is one that already reached a terminal state; read the promotion first and retry only a halted or errored one. The retry is attributed to the credential that sends it and is recorded on the promotion.",
|
|
20007
|
+
http: "POST",
|
|
20008
|
+
path: "/devops/v1/promotions/{id}:retry",
|
|
20009
|
+
streaming: "no",
|
|
20010
|
+
pagination: false,
|
|
20011
|
+
pathParams: [
|
|
20012
|
+
{
|
|
20013
|
+
name: "id",
|
|
20014
|
+
sdkName: "id",
|
|
20015
|
+
description: "The promotion identifier returned by a promotion list or create answer."
|
|
20016
|
+
}
|
|
20017
|
+
],
|
|
20018
|
+
query: []
|
|
20019
|
+
},
|
|
20020
|
+
{
|
|
20021
|
+
resource: "devops.promotions.rollouts",
|
|
18934
20022
|
method: "list",
|
|
18935
|
-
summary: "List
|
|
18936
|
-
description: "List the
|
|
20023
|
+
summary: "List a promotion's rollouts",
|
|
20024
|
+
description: "List the per-target rollouts of one promotion: which target each is deploying, which layer it waits on, and where in its phases it has got to. Call it when a promotion is halted or failed to find the target that stopped, since the promotion's own state summarises what the rollouts show one by one. A promotion with nothing to deploy answers an empty page rather than a refusal. Neither filter nor orderBy is accepted here, and the rollouts come in the order the plan laid them out.",
|
|
18937
20025
|
http: "GET",
|
|
18938
|
-
path: "/devops/v1/
|
|
20026
|
+
path: "/devops/v1/promotions/{promotion}/rollouts",
|
|
18939
20027
|
streaming: "no",
|
|
18940
20028
|
pagination: false,
|
|
18941
20029
|
pathParams: [
|
|
18942
20030
|
{
|
|
18943
|
-
name: "
|
|
18944
|
-
sdkName: "
|
|
18945
|
-
description: "
|
|
20031
|
+
name: "promotion",
|
|
20032
|
+
sdkName: "promotion",
|
|
20033
|
+
description: "The promotion whose rollouts you are reading, from a promotion list or create answer."
|
|
18946
20034
|
}
|
|
18947
20035
|
],
|
|
18948
20036
|
query: [
|
|
@@ -18957,35 +20045,41 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18957
20045
|
type: "string",
|
|
18958
20046
|
required: false,
|
|
18959
20047
|
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
18960
|
-
},
|
|
18961
|
-
{
|
|
18962
|
-
name: "filter",
|
|
18963
|
-
type: "string",
|
|
18964
|
-
required: false,
|
|
18965
|
-
description: "AIP-160 equality filter over one declared field, for example state=running or result=failed. An undeclared field is refused with INVALID_ARGUMENT; it is never ignored, so a mistyped filter cannot quietly return everything."
|
|
18966
|
-
},
|
|
18967
|
-
{
|
|
18968
|
-
name: "orderBy",
|
|
18969
|
-
type: "string",
|
|
18970
|
-
required: false,
|
|
18971
|
-
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
18972
20048
|
}
|
|
18973
20049
|
]
|
|
18974
20050
|
},
|
|
18975
20051
|
{
|
|
18976
|
-
resource: "devops.
|
|
18977
|
-
method: "
|
|
18978
|
-
summary: "
|
|
18979
|
-
description: "
|
|
20052
|
+
resource: "devops.releases",
|
|
20053
|
+
method: "retrieve",
|
|
20054
|
+
summary: "Retrieve a release",
|
|
20055
|
+
description: "Read one release in full: the commit it carries, the targets and source digests it was rendered from, which environments have verified it, and where it currently runs. Call it before promoting to confirm the release is not abandoned and that its render succeeded, and after deploying to learn which environments already hold it so the same release is not promoted twice. A release from another organization answers RELEASE_NOT_FOUND, which is also the answer for one that never existed.",
|
|
20056
|
+
http: "GET",
|
|
20057
|
+
path: "/devops/v1/releases/{id}",
|
|
20058
|
+
streaming: "no",
|
|
20059
|
+
pagination: false,
|
|
20060
|
+
pathParams: [
|
|
20061
|
+
{
|
|
20062
|
+
name: "id",
|
|
20063
|
+
sdkName: "id",
|
|
20064
|
+
description: "The release identifier returned by a release list or create answer; a release is addressed by this id, never by its display name."
|
|
20065
|
+
}
|
|
20066
|
+
],
|
|
20067
|
+
query: []
|
|
20068
|
+
},
|
|
20069
|
+
{
|
|
20070
|
+
resource: "devops.releases",
|
|
20071
|
+
method: "abandon",
|
|
20072
|
+
summary: "Abandon a release",
|
|
20073
|
+
description: "Withdraw a release so it can no longer be promoted: a later promotion of it is refused with RELEASE_ABANDONED. Use it when a release was created by mistake or has been superseded, and record why in reason — the reason is stored on the release as the attribution of the act. A release with a promotion still in flight cannot be abandoned, because the queue is mid-flight on it; cancel that promotion first, which is the door for stopping a deployment. Abandoning is one-way: a withdrawn release is never un-abandoned, and a new release is created instead.",
|
|
18980
20074
|
http: "POST",
|
|
18981
|
-
path: "/devops/v1/
|
|
20075
|
+
path: "/devops/v1/releases/{id}:abandon",
|
|
18982
20076
|
streaming: "no",
|
|
18983
20077
|
pagination: false,
|
|
18984
20078
|
pathParams: [
|
|
18985
20079
|
{
|
|
18986
|
-
name: "
|
|
18987
|
-
sdkName: "
|
|
18988
|
-
description: "
|
|
20080
|
+
name: "id",
|
|
20081
|
+
sdkName: "id",
|
|
20082
|
+
description: "The release identifier returned by a release list or create answer; a release is addressed by this id, never by its display name."
|
|
18989
20083
|
}
|
|
18990
20084
|
],
|
|
18991
20085
|
query: [],
|
|
@@ -18993,101 +20087,31 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
18993
20087
|
required: true,
|
|
18994
20088
|
fields: [
|
|
18995
20089
|
{
|
|
18996
|
-
name: "
|
|
18997
|
-
type: "object",
|
|
18998
|
-
required: true,
|
|
18999
|
-
description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against."
|
|
19000
|
-
},
|
|
19001
|
-
{
|
|
19002
|
-
name: "plan",
|
|
19003
|
-
type: "string",
|
|
19004
|
-
required: false,
|
|
19005
|
-
description: "Plan whose selector this run uses; omit it when passing selector instead. Naming a plan records the run against that plan, which is what a gate reads."
|
|
19006
|
-
},
|
|
19007
|
-
{
|
|
19008
|
-
name: "selector",
|
|
19009
|
-
type: "object",
|
|
19010
|
-
required: false,
|
|
19011
|
-
description: "An ad-hoc selector for this run alone, used instead of a plan's; it is not saved as a plan, so a run you want to repeat should name a plan."
|
|
19012
|
-
},
|
|
19013
|
-
{
|
|
19014
|
-
name: "environment",
|
|
19015
|
-
type: "string",
|
|
19016
|
-
required: false,
|
|
19017
|
-
description: "Environment to run against; it decides whether production-only cases become selectable. Omit it for a run that needs no environment."
|
|
19018
|
-
},
|
|
19019
|
-
{
|
|
19020
|
-
name: "repeat",
|
|
19021
|
-
type: "integer",
|
|
19022
|
-
required: false,
|
|
19023
|
-
description: "How many times each selected case runs, which is how a flake is told apart from a real failure; omit for once."
|
|
19024
|
-
},
|
|
19025
|
-
{
|
|
19026
|
-
name: "waitUntil",
|
|
19027
|
-
type: "string",
|
|
19028
|
-
enum: [
|
|
19029
|
-
"queued",
|
|
19030
|
-
"started",
|
|
19031
|
-
"finished"
|
|
19032
|
-
],
|
|
19033
|
-
required: false,
|
|
19034
|
-
description: "How far the call waits before answering, bounded at about 25 seconds; omit it for queued, which returns at once. The wait reads the run's own state, so a wait that reaches the bound returns the run as it stands instead of failing — check state before assuming the request was honoured."
|
|
19035
|
-
},
|
|
19036
|
-
{
|
|
19037
|
-
name: "executor",
|
|
19038
|
-
type: "string",
|
|
19039
|
-
enum: [
|
|
19040
|
-
"cloud",
|
|
19041
|
-
"external"
|
|
19042
|
-
],
|
|
19043
|
-
required: false,
|
|
19044
|
-
description: "Who carries the run out. cloud, the default, runs the selected cases in Praxis at the commit; external creates a run that waits for your own CI to upload a report with test-reports."
|
|
19045
|
-
},
|
|
19046
|
-
{
|
|
19047
|
-
name: "requestId",
|
|
20090
|
+
name: "reason",
|
|
19048
20091
|
type: "string",
|
|
19049
|
-
required:
|
|
19050
|
-
description: "
|
|
20092
|
+
required: true,
|
|
20093
|
+
description: "Why this release no longer should be promoted, recorded verbatim on the release for whoever reads it later."
|
|
19051
20094
|
}
|
|
19052
20095
|
]
|
|
19053
20096
|
}
|
|
19054
20097
|
},
|
|
19055
20098
|
{
|
|
19056
|
-
resource: "devops.
|
|
19057
|
-
method: "
|
|
19058
|
-
summary: "
|
|
19059
|
-
description: "
|
|
20099
|
+
resource: "devops.rollouts",
|
|
20100
|
+
method: "retrieve",
|
|
20101
|
+
summary: "Retrieve a rollout",
|
|
20102
|
+
description: "Read one rollout in full: its phases and the jobs inside them, each job's most recent attempt, the checkpoint it was deploying from, and why it failed when it did. This is the level that names the failing step — a promotion tells you that a target failed, a rollout tells you which job run did and what it reported. Use logFileId or a job run's eventLogPath to reach the logs that step produced. A rollout from another organization answers ROLLOUT_NOT_FOUND, the same answer as one that never existed.",
|
|
19060
20103
|
http: "GET",
|
|
19061
|
-
path: "/devops/v1/
|
|
20104
|
+
path: "/devops/v1/rollouts/{id}",
|
|
19062
20105
|
streaming: "no",
|
|
19063
20106
|
pagination: false,
|
|
19064
20107
|
pathParams: [
|
|
19065
20108
|
{
|
|
19066
|
-
name: "
|
|
19067
|
-
sdkName: "
|
|
19068
|
-
description: "
|
|
20109
|
+
name: "id",
|
|
20110
|
+
sdkName: "id",
|
|
20111
|
+
description: "The rollout identifier from a promotion's rollout list or a promotion read with expand=rollouts."
|
|
19069
20112
|
}
|
|
19070
20113
|
],
|
|
19071
|
-
query: [
|
|
19072
|
-
{
|
|
19073
|
-
name: "pageSize",
|
|
19074
|
-
type: "integer",
|
|
19075
|
-
required: false,
|
|
19076
|
-
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
19077
|
-
},
|
|
19078
|
-
{
|
|
19079
|
-
name: "pageToken",
|
|
19080
|
-
type: "string",
|
|
19081
|
-
required: false,
|
|
19082
|
-
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
19083
|
-
},
|
|
19084
|
-
{
|
|
19085
|
-
name: "orderBy",
|
|
19086
|
-
type: "string",
|
|
19087
|
-
required: false,
|
|
19088
|
-
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
19089
|
-
}
|
|
19090
|
-
]
|
|
20114
|
+
query: []
|
|
19091
20115
|
},
|
|
19092
20116
|
{
|
|
19093
20117
|
resource: "devops.testCases",
|
|
@@ -20589,7 +21613,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
20589
21613
|
resource: "media.generation.capabilities",
|
|
20590
21614
|
method: "list",
|
|
20591
21615
|
summary: "Get generation capabilities",
|
|
20592
|
-
description: "Read supported
|
|
21616
|
+
description: "Read supported video generation intents, default model, duration and aspect-ratio limits and per-library concurrency. Generation is charged per second; every output is stored in the library.",
|
|
20593
21617
|
http: "GET",
|
|
20594
21618
|
path: "/media/v1/generation/capabilities",
|
|
20595
21619
|
streaming: "no",
|
|
@@ -21485,6 +22509,73 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21485
22509
|
]
|
|
21486
22510
|
}
|
|
21487
22511
|
},
|
|
22512
|
+
{
|
|
22513
|
+
resource: "media.speech",
|
|
22514
|
+
method: "create",
|
|
22515
|
+
summary: "Create speech",
|
|
22516
|
+
description: "Synthesise speech from text and store the recording straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still synthesise. input is the text to speak and voice is required; speed is passed to the provider unchanged, and instructions and language are refused with OPERATION_NOT_SUPPORTED in this release. A voice that names a voice material of this library is refused the same way — voice cloning opens with voices.create. The provider caps one request at a short stretch of text, so a long input is cut into segments at paragraph and sentence boundaries and synthesised in order, then joined into the single recording the library receives: nothing is spoken twice and nothing is dropped. Because the segments are joined byte for byte, a multi-segment input accepts only response_format mp3 (the default) or pcm; opus is available for a single-segment input. A speech job has one result however many segments it took. Synthesis is charged through Router and the job records the charge in usage; a request refused before it starts costs nothing. The response is 202 with a queued Job whose type is speech and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced asset from the library — the recording carries material_type audio, audio_role voice, ai_generated true, and provenance naming this job, the text spoken and the model. Send Idempotency-Key, or idempotency_key in the body, to retry without synthesising and charging twice. Example: POST /media/v1/libraries/default/audio/speech with {\"input\":\"A red kite above a calm sea at sunrise.\",\"voice\":\"alloy\"}.",
|
|
22517
|
+
http: "POST",
|
|
22518
|
+
path: "/media/v1/libraries/{library_id}/audio/speech",
|
|
22519
|
+
streaming: "no",
|
|
22520
|
+
pagination: false,
|
|
22521
|
+
pathParams: [
|
|
22522
|
+
{
|
|
22523
|
+
name: "library_id",
|
|
22524
|
+
sdkName: "library_id",
|
|
22525
|
+
description: "Library ID returned by creation."
|
|
22526
|
+
}
|
|
22527
|
+
],
|
|
22528
|
+
query: [],
|
|
22529
|
+
body: {
|
|
22530
|
+
required: true,
|
|
22531
|
+
fields: [
|
|
22532
|
+
{
|
|
22533
|
+
name: "input",
|
|
22534
|
+
type: "string",
|
|
22535
|
+
required: true,
|
|
22536
|
+
description: "Text to synthesize; long text is synthesized paragraph by paragraph."
|
|
22537
|
+
},
|
|
22538
|
+
{
|
|
22539
|
+
name: "voice",
|
|
22540
|
+
type: "string",
|
|
22541
|
+
required: true,
|
|
22542
|
+
description: "Voice identifier or platform voice name."
|
|
22543
|
+
},
|
|
22544
|
+
{
|
|
22545
|
+
name: "instructions",
|
|
22546
|
+
type: "string",
|
|
22547
|
+
required: false,
|
|
22548
|
+
description: "Emotion and style guidance for the synthesized speech."
|
|
22549
|
+
},
|
|
22550
|
+
{
|
|
22551
|
+
name: "speed",
|
|
22552
|
+
type: "number",
|
|
22553
|
+
required: false,
|
|
22554
|
+
description: "Speaking-rate multiplier; 1 is the model default."
|
|
22555
|
+
},
|
|
22556
|
+
{
|
|
22557
|
+
name: "response_format",
|
|
22558
|
+
type: "string",
|
|
22559
|
+
enum: [
|
|
22560
|
+
"mp3",
|
|
22561
|
+
"wav",
|
|
22562
|
+
"opus",
|
|
22563
|
+
"aac",
|
|
22564
|
+
"flac",
|
|
22565
|
+
"pcm"
|
|
22566
|
+
],
|
|
22567
|
+
required: false,
|
|
22568
|
+
description: "Audio encoding of the synthesized speech."
|
|
22569
|
+
},
|
|
22570
|
+
{
|
|
22571
|
+
name: "language",
|
|
22572
|
+
type: "string",
|
|
22573
|
+
required: false,
|
|
22574
|
+
description: "Language of the text, when the voice supports several."
|
|
22575
|
+
}
|
|
22576
|
+
]
|
|
22577
|
+
}
|
|
22578
|
+
},
|
|
21488
22579
|
{
|
|
21489
22580
|
resource: "media.libraries.batches",
|
|
21490
22581
|
method: "create",
|
|
@@ -21630,33 +22721,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21630
22721
|
method: "list",
|
|
21631
22722
|
summary: "List folders",
|
|
21632
22723
|
description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.",
|
|
21633
|
-
http: "GET",
|
|
21634
|
-
path: "/media/v1/libraries/{library_id}/folders",
|
|
21635
|
-
streaming: "no",
|
|
21636
|
-
pagination: false,
|
|
21637
|
-
pathParams: [
|
|
21638
|
-
{
|
|
21639
|
-
name: "library_id",
|
|
21640
|
-
sdkName: "library_id",
|
|
21641
|
-
description: "Library ID returned by creation."
|
|
21642
|
-
}
|
|
21643
|
-
],
|
|
21644
|
-
query: [
|
|
21645
|
-
{
|
|
21646
|
-
name: "parent",
|
|
21647
|
-
type: "string",
|
|
21648
|
-
required: false,
|
|
21649
|
-
description: "Folder whose immediate children are returned. Omit or use an empty string for the library root; invalid folder paths are rejected."
|
|
21650
|
-
}
|
|
21651
|
-
]
|
|
21652
|
-
},
|
|
21653
|
-
{
|
|
21654
|
-
resource: "media.libraries.generations",
|
|
21655
|
-
method: "create",
|
|
21656
|
-
summary: "Create video generation",
|
|
21657
|
-
description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.",
|
|
21658
|
-
http: "POST",
|
|
21659
|
-
path: "/media/v1/libraries/{library_id}/generations",
|
|
22724
|
+
http: "GET",
|
|
22725
|
+
path: "/media/v1/libraries/{library_id}/folders",
|
|
21660
22726
|
streaming: "no",
|
|
21661
22727
|
pagination: false,
|
|
21662
22728
|
pathParams: [
|
|
@@ -21666,88 +22732,14 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21666
22732
|
description: "Library ID returned by creation."
|
|
21667
22733
|
}
|
|
21668
22734
|
],
|
|
21669
|
-
query: [
|
|
21670
|
-
|
|
21671
|
-
|
|
21672
|
-
|
|
21673
|
-
|
|
21674
|
-
|
|
21675
|
-
|
|
21676
|
-
|
|
21677
|
-
description: "Generation operation; v1 accepts only video.generate text-to-video requests."
|
|
21678
|
-
},
|
|
21679
|
-
{
|
|
21680
|
-
name: "prompt",
|
|
21681
|
-
type: "string",
|
|
21682
|
-
required: true,
|
|
21683
|
-
description: "Text prompt describing the video to generate."
|
|
21684
|
-
},
|
|
21685
|
-
{
|
|
21686
|
-
name: "count",
|
|
21687
|
-
type: "integer",
|
|
21688
|
-
required: false,
|
|
21689
|
-
description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
|
|
21690
|
-
},
|
|
21691
|
-
{
|
|
21692
|
-
name: "duration_seconds",
|
|
21693
|
-
type: "integer",
|
|
21694
|
-
required: false,
|
|
21695
|
-
description: "Requested video duration in seconds; Router validates the model-specific supported durations."
|
|
21696
|
-
},
|
|
21697
|
-
{
|
|
21698
|
-
name: "aspect_ratio",
|
|
21699
|
-
type: "string",
|
|
21700
|
-
required: false,
|
|
21701
|
-
description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
|
|
21702
|
-
},
|
|
21703
|
-
{
|
|
21704
|
-
name: "model",
|
|
21705
|
-
type: "string",
|
|
21706
|
-
required: false,
|
|
21707
|
-
description: "Router model with video_generation capability; defaults to wan2.7-t2v."
|
|
21708
|
-
},
|
|
21709
|
-
{
|
|
21710
|
-
name: "save",
|
|
21711
|
-
type: "string",
|
|
21712
|
-
enum: [
|
|
21713
|
-
"candidate",
|
|
21714
|
-
"library"
|
|
21715
|
-
],
|
|
21716
|
-
required: false,
|
|
21717
|
-
description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
|
|
21718
|
-
},
|
|
21719
|
-
{
|
|
21720
|
-
name: "asset_folder",
|
|
21721
|
-
type: "string",
|
|
21722
|
-
required: false,
|
|
21723
|
-
description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
21724
|
-
},
|
|
21725
|
-
{
|
|
21726
|
-
name: "tags",
|
|
21727
|
-
type: "array",
|
|
21728
|
-
itemType: "string",
|
|
21729
|
-
required: false,
|
|
21730
|
-
description: "Tags applied when an output becomes a library asset."
|
|
21731
|
-
},
|
|
21732
|
-
{
|
|
21733
|
-
name: "understanding",
|
|
21734
|
-
type: "string",
|
|
21735
|
-
enum: [
|
|
21736
|
-
"auto",
|
|
21737
|
-
"skip"
|
|
21738
|
-
],
|
|
21739
|
-
required: false,
|
|
21740
|
-
description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
|
|
21741
|
-
},
|
|
21742
|
-
{
|
|
21743
|
-
name: "references",
|
|
21744
|
-
type: "array",
|
|
21745
|
-
itemType: "object",
|
|
21746
|
-
required: false,
|
|
21747
|
-
description: "Not supported in v1; omit this field. Only text-to-video is currently available."
|
|
21748
|
-
}
|
|
21749
|
-
]
|
|
21750
|
-
}
|
|
22735
|
+
query: [
|
|
22736
|
+
{
|
|
22737
|
+
name: "parent",
|
|
22738
|
+
type: "string",
|
|
22739
|
+
required: false,
|
|
22740
|
+
description: "Folder whose immediate children are returned. Omit or use an empty string for the library root; invalid folder paths are rejected."
|
|
22741
|
+
}
|
|
22742
|
+
]
|
|
21751
22743
|
},
|
|
21752
22744
|
{
|
|
21753
22745
|
resource: "media.images",
|
|
@@ -21873,7 +22865,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21873
22865
|
resource: "media.libraries.jobs",
|
|
21874
22866
|
method: "list",
|
|
21875
22867
|
summary: "List jobs",
|
|
21876
|
-
description: "List batch and
|
|
22868
|
+
description: "List batch and generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal; every produced output is already a library asset.",
|
|
21877
22869
|
http: "GET",
|
|
21878
22870
|
path: "/media/v1/libraries/{library_id}/jobs",
|
|
21879
22871
|
streaming: "no",
|
|
@@ -21920,7 +22912,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21920
22912
|
resource: "media.libraries.jobs",
|
|
21921
22913
|
method: "retrieve",
|
|
21922
22914
|
summary: "Get job",
|
|
21923
|
-
description: "Read the current batch or
|
|
22915
|
+
description: "Read the current batch or generation Job status and progress. For generation, inspect outputs and failures; a successful output has already landed in the library as an asset.",
|
|
21924
22916
|
http: "GET",
|
|
21925
22917
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
21926
22918
|
streaming: "no",
|
|
@@ -21934,7 +22926,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21934
22926
|
{
|
|
21935
22927
|
name: "job_id",
|
|
21936
22928
|
sdkName: "job_id",
|
|
21937
|
-
description: "Job identifier returned by batch creation,
|
|
22929
|
+
description: "Job identifier returned by batch creation, generation creation or job listing; resolved within this library."
|
|
21938
22930
|
}
|
|
21939
22931
|
],
|
|
21940
22932
|
query: []
|
|
@@ -21943,7 +22935,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21943
22935
|
resource: "media.libraries.jobs",
|
|
21944
22936
|
method: "cancel",
|
|
21945
22937
|
summary: "Cancel job",
|
|
21946
|
-
description: "Cancel a queued or running generation job.
|
|
22938
|
+
description: "Cancel a queued or running generation job. Outputs already produced remain in the library; poll or read the returned Job to confirm its status.",
|
|
21947
22939
|
http: "POST",
|
|
21948
22940
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
21949
22941
|
streaming: "no",
|
|
@@ -21962,68 +22954,6 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
21962
22954
|
],
|
|
21963
22955
|
query: []
|
|
21964
22956
|
},
|
|
21965
|
-
{
|
|
21966
|
-
resource: "media.libraries.jobs.outputs.save",
|
|
21967
|
-
method: "create",
|
|
21968
|
-
summary: "Save generation output",
|
|
21969
|
-
description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.",
|
|
21970
|
-
http: "POST",
|
|
21971
|
-
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
21972
|
-
streaming: "no",
|
|
21973
|
-
pagination: false,
|
|
21974
|
-
pathParams: [
|
|
21975
|
-
{
|
|
21976
|
-
name: "library_id",
|
|
21977
|
-
sdkName: "library_id",
|
|
21978
|
-
description: "Library ID returned by creation."
|
|
21979
|
-
},
|
|
21980
|
-
{
|
|
21981
|
-
name: "job_id",
|
|
21982
|
-
sdkName: "job_id",
|
|
21983
|
-
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
21984
|
-
},
|
|
21985
|
-
{
|
|
21986
|
-
name: "index",
|
|
21987
|
-
sdkName: "index",
|
|
21988
|
-
description: "Zero-based position of the candidate in the Job outputs array."
|
|
21989
|
-
}
|
|
21990
|
-
],
|
|
21991
|
-
query: [],
|
|
21992
|
-
body: {
|
|
21993
|
-
required: false,
|
|
21994
|
-
fields: [
|
|
21995
|
-
{
|
|
21996
|
-
name: "public_id",
|
|
21997
|
-
type: "string",
|
|
21998
|
-
required: false,
|
|
21999
|
-
description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
|
|
22000
|
-
},
|
|
22001
|
-
{
|
|
22002
|
-
name: "asset_folder",
|
|
22003
|
-
type: "string",
|
|
22004
|
-
required: false,
|
|
22005
|
-
description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
22006
|
-
},
|
|
22007
|
-
{
|
|
22008
|
-
name: "tags",
|
|
22009
|
-
type: "array",
|
|
22010
|
-
itemType: "string",
|
|
22011
|
-
required: false,
|
|
22012
|
-
description: "Tags to apply to the saved asset."
|
|
22013
|
-
},
|
|
22014
|
-
{
|
|
22015
|
-
name: "understanding",
|
|
22016
|
-
type: "string",
|
|
22017
|
-
enum: [
|
|
22018
|
-
"auto",
|
|
22019
|
-
"skip"
|
|
22020
|
-
],
|
|
22021
|
-
required: false,
|
|
22022
|
-
description: "Understanding behavior for the saved asset; defaults to auto."
|
|
22023
|
-
}
|
|
22024
|
-
]
|
|
22025
|
-
}
|
|
22026
|
-
},
|
|
22027
22957
|
{
|
|
22028
22958
|
resource: "media.libraries.purge",
|
|
22029
22959
|
method: "create",
|
|
@@ -22380,6 +23310,152 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
22380
23310
|
],
|
|
22381
23311
|
query: []
|
|
22382
23312
|
},
|
|
23313
|
+
{
|
|
23314
|
+
resource: "media.videos",
|
|
23315
|
+
method: "generate",
|
|
23316
|
+
summary: "Generate video",
|
|
23317
|
+
description: "Generate one or more videos from a text prompt and store them straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still generate. mode says what the video is anchored to: text needs only a prompt, image animates the existing image named by first_frame, and first_last interpolates between first_frame and last_frame. The frames must be image or sticker assets of the same library; Router is sent a fetchable URL for each, recorded in the produced asset’s provenance. mode reference and output gif are refused with OPERATION_NOT_SUPPORTED in this release, and negative_prompt, references and an unknown mode are refused before anything is charged. Every output lands in the library as a video asset as soon as it is ready — there is no candidate state and nothing expires, so outputs.save is not part of this lane. Generation is charged per second through Router and the job records the charge in usage; a refused request costs nothing. The response is 202 with a queued Job whose type is video and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced assets from the library. Send Idempotency-Key, or idempotency_key in the body, to retry without generating and charging twice. Example: POST /media/v1/libraries/default/videos/generations with {\"prompt\":\"A red kite above a calm sea at sunrise\",\"mode\":\"text\",\"n\":1}.",
|
|
23318
|
+
http: "POST",
|
|
23319
|
+
path: "/media/v1/libraries/{library_id}/videos/generations",
|
|
23320
|
+
streaming: "no",
|
|
23321
|
+
pagination: false,
|
|
23322
|
+
pathParams: [
|
|
23323
|
+
{
|
|
23324
|
+
name: "library_id",
|
|
23325
|
+
sdkName: "library_id",
|
|
23326
|
+
description: "Library ID returned by creation."
|
|
23327
|
+
}
|
|
23328
|
+
],
|
|
23329
|
+
query: [],
|
|
23330
|
+
body: {
|
|
23331
|
+
required: true,
|
|
23332
|
+
fields: [
|
|
23333
|
+
{
|
|
23334
|
+
name: "prompt",
|
|
23335
|
+
type: "string",
|
|
23336
|
+
required: true,
|
|
23337
|
+
description: "Text prompt describing the video to generate; Router forwards it to the video model unchanged."
|
|
23338
|
+
},
|
|
23339
|
+
{
|
|
23340
|
+
name: "negative_prompt",
|
|
23341
|
+
type: "string",
|
|
23342
|
+
required: false,
|
|
23343
|
+
description: "What the video must not contain. Models without a negative-prompt control ignore it."
|
|
23344
|
+
},
|
|
23345
|
+
{
|
|
23346
|
+
name: "mode",
|
|
23347
|
+
type: "string",
|
|
23348
|
+
enum: [
|
|
23349
|
+
"text",
|
|
23350
|
+
"image",
|
|
23351
|
+
"first_last",
|
|
23352
|
+
"reference"
|
|
23353
|
+
],
|
|
23354
|
+
required: true,
|
|
23355
|
+
description: "What the video is anchored to. text needs only a prompt; image animates first_frame; first_last bookends first_frame and last_frame; reference is refused with OPERATION_NOT_SUPPORTED in this release."
|
|
23356
|
+
},
|
|
23357
|
+
{
|
|
23358
|
+
name: "first_frame",
|
|
23359
|
+
type: "string",
|
|
23360
|
+
required: false,
|
|
23361
|
+
description: "Asset identifier returned by upload or asset listing; distinct from public_id and content hashes."
|
|
23362
|
+
},
|
|
23363
|
+
{
|
|
23364
|
+
name: "last_frame",
|
|
23365
|
+
type: "string",
|
|
23366
|
+
required: false,
|
|
23367
|
+
description: "Asset identifier returned by upload or asset listing; distinct from public_id and content hashes."
|
|
23368
|
+
},
|
|
23369
|
+
{
|
|
23370
|
+
name: "references",
|
|
23371
|
+
type: "array",
|
|
23372
|
+
itemType: "object",
|
|
23373
|
+
required: false,
|
|
23374
|
+
description: "Existing assets the model may use, each with the role it plays. Not supported by the video lane in this release: sending it is refused with OPERATION_NOT_SUPPORTED."
|
|
23375
|
+
},
|
|
23376
|
+
{
|
|
23377
|
+
name: "duration_seconds",
|
|
23378
|
+
type: "integer",
|
|
23379
|
+
required: false,
|
|
23380
|
+
description: "Requested video length in seconds. Router validates it against the chosen model’s supported durations and rejects an unsupported value with INVALID_PARAMS."
|
|
23381
|
+
},
|
|
23382
|
+
{
|
|
23383
|
+
name: "resolution",
|
|
23384
|
+
type: "string",
|
|
23385
|
+
enum: [
|
|
23386
|
+
"480p",
|
|
23387
|
+
"720p",
|
|
23388
|
+
"1080p",
|
|
23389
|
+
"4k"
|
|
23390
|
+
],
|
|
23391
|
+
required: false,
|
|
23392
|
+
description: "Requested output resolution; Router validates it against the chosen model."
|
|
23393
|
+
},
|
|
23394
|
+
{
|
|
23395
|
+
name: "aspect_ratio",
|
|
23396
|
+
type: "string",
|
|
23397
|
+
required: false,
|
|
23398
|
+
description: "Output aspect ratio written as width:height; defaults to 16:9. Router validates it against the chosen model and rejects an unsupported ratio with INVALID_PARAMS."
|
|
23399
|
+
},
|
|
23400
|
+
{
|
|
23401
|
+
name: "generate_audio",
|
|
23402
|
+
type: "boolean",
|
|
23403
|
+
required: false,
|
|
23404
|
+
description: "True to generate an audio track with the video. Whether audio is produced depends on the model."
|
|
23405
|
+
},
|
|
23406
|
+
{
|
|
23407
|
+
name: "output",
|
|
23408
|
+
type: "string",
|
|
23409
|
+
enum: [
|
|
23410
|
+
"mp4",
|
|
23411
|
+
"gif"
|
|
23412
|
+
],
|
|
23413
|
+
required: false,
|
|
23414
|
+
description: "Container of the produced video; defaults to mp4. gif is refused with OPERATION_NOT_SUPPORTED because this release has no GIF encoding for the lane."
|
|
23415
|
+
},
|
|
23416
|
+
{
|
|
23417
|
+
name: "n",
|
|
23418
|
+
type: "integer",
|
|
23419
|
+
required: false,
|
|
23420
|
+
description: "Videos to generate in one job, from 1 to 4; defaults to 1. Each produced video is charged separately."
|
|
23421
|
+
},
|
|
23422
|
+
{
|
|
23423
|
+
name: "seed",
|
|
23424
|
+
type: "integer",
|
|
23425
|
+
required: false,
|
|
23426
|
+
description: "Seed for reproducible sampling; omit it to let the model choose one."
|
|
23427
|
+
},
|
|
23428
|
+
{
|
|
23429
|
+
name: "model",
|
|
23430
|
+
type: "string",
|
|
23431
|
+
required: false,
|
|
23432
|
+
description: "Router model with video-generation capability; omit it to use the library default video model."
|
|
23433
|
+
},
|
|
23434
|
+
{
|
|
23435
|
+
name: "asset_folder",
|
|
23436
|
+
type: "string",
|
|
23437
|
+
required: false,
|
|
23438
|
+
description: "Folder the produced asset is filed under; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
23439
|
+
},
|
|
23440
|
+
{
|
|
23441
|
+
name: "understanding",
|
|
23442
|
+
type: "string",
|
|
23443
|
+
enum: [
|
|
23444
|
+
"auto",
|
|
23445
|
+
"skip"
|
|
23446
|
+
],
|
|
23447
|
+
required: false,
|
|
23448
|
+
description: "Understanding behavior for the produced asset; defaults to auto."
|
|
23449
|
+
},
|
|
23450
|
+
{
|
|
23451
|
+
name: "idempotency_key",
|
|
23452
|
+
type: "string",
|
|
23453
|
+
required: false,
|
|
23454
|
+
description: "Stable key so a retried request reuses the same job instead of generating and charging again; reusing it with different content is rejected."
|
|
23455
|
+
}
|
|
23456
|
+
]
|
|
23457
|
+
}
|
|
23458
|
+
},
|
|
22383
23459
|
{
|
|
22384
23460
|
resource: "meta.docs",
|
|
22385
23461
|
method: "search",
|
|
@@ -28012,7 +29088,7 @@ for more details.`
|
|
|
28012
29088
|
required: true,
|
|
28013
29089
|
fields: [
|
|
28014
29090
|
{
|
|
28015
|
-
name: "
|
|
29091
|
+
name: "update_mask",
|
|
28016
29092
|
type: "array",
|
|
28017
29093
|
itemType: "string",
|
|
28018
29094
|
required: true,
|
|
@@ -28255,7 +29331,7 @@ for more details.`
|
|
|
28255
29331
|
required: true,
|
|
28256
29332
|
fields: [
|
|
28257
29333
|
{
|
|
28258
|
-
name: "
|
|
29334
|
+
name: "update_mask",
|
|
28259
29335
|
type: "array",
|
|
28260
29336
|
itemType: "string",
|
|
28261
29337
|
required: true,
|
|
@@ -28566,7 +29642,7 @@ for more details.`
|
|
|
28566
29642
|
required: true,
|
|
28567
29643
|
fields: [
|
|
28568
29644
|
{
|
|
28569
|
-
name: "
|
|
29645
|
+
name: "update_mask",
|
|
28570
29646
|
type: "array",
|
|
28571
29647
|
itemType: "string",
|
|
28572
29648
|
required: true,
|
|
@@ -28727,7 +29803,7 @@ for more details.`
|
|
|
28727
29803
|
resource: "studio.themes",
|
|
28728
29804
|
method: "list",
|
|
28729
29805
|
summary: "List the rendition themes of a platform",
|
|
28730
|
-
description: "List themes: the layouts a rendition is produced with, for one platform or for all of them. Pass a platform to see only the themes that platform can use. A theme decides the page or card a rendition is built into, so read the chosen theme before creating a rendition rather than after the output looks wrong.",
|
|
29806
|
+
description: "List themes: the layouts a rendition is produced with, for one platform or for all of them. Pass a platform to see only the themes that platform can use. The first page starts with the built-in themes (builtin true, such as warm-card@1 for Xiaohongshu cards and plain-mono@1 for WeChat articles), which every organization can use and nobody can change or delete; your organization's own themes follow. A theme decides the page or card a rendition is built into, so read the chosen theme before creating a rendition rather than after the output looks wrong.",
|
|
28731
29807
|
http: "GET",
|
|
28732
29808
|
path: "/studio/v1/themes",
|
|
28733
29809
|
streaming: "no",
|
|
@@ -28876,7 +29952,7 @@ for more details.`
|
|
|
28876
29952
|
required: true,
|
|
28877
29953
|
fields: [
|
|
28878
29954
|
{
|
|
28879
|
-
name: "
|
|
29955
|
+
name: "update_mask",
|
|
28880
29956
|
type: "array",
|
|
28881
29957
|
itemType: "string",
|
|
28882
29958
|
required: true,
|
|
@@ -29016,7 +30092,7 @@ for more details.`
|
|
|
29016
30092
|
description: "Caller-chosen key and value pairs kept on a resource; the keys are the caller's own names and no platform meaning is attached to them."
|
|
29017
30093
|
},
|
|
29018
30094
|
{
|
|
29019
|
-
name: "
|
|
30095
|
+
name: "request_id",
|
|
29020
30096
|
type: "string",
|
|
29021
30097
|
required: false,
|
|
29022
30098
|
description: "Caller-chosen key that makes this create safe to repeat: the same value answers the first result instead of creating a second work."
|
|
@@ -29089,14 +30165,14 @@ for more details.`
|
|
|
29089
30165
|
required: true,
|
|
29090
30166
|
fields: [
|
|
29091
30167
|
{
|
|
29092
|
-
name: "
|
|
30168
|
+
name: "update_mask",
|
|
29093
30169
|
type: "array",
|
|
29094
30170
|
itemType: "string",
|
|
29095
30171
|
required: true,
|
|
29096
30172
|
description: "Field paths this call changes, spelled as they appear in the work, such as title or goal.message; a field left out keeps its value."
|
|
29097
30173
|
},
|
|
29098
30174
|
{
|
|
29099
|
-
name: "
|
|
30175
|
+
name: "expected_revision",
|
|
29100
30176
|
type: "integer",
|
|
29101
30177
|
required: false,
|
|
29102
30178
|
description: "Work revision the caller read; when the work moved past it the write is refused with REVISION_CONFLICT and nothing changes."
|
|
@@ -29168,7 +30244,7 @@ for more details.`
|
|
|
29168
30244
|
required: true,
|
|
29169
30245
|
fields: [
|
|
29170
30246
|
{
|
|
29171
|
-
name: "
|
|
30247
|
+
name: "expected_revision",
|
|
29172
30248
|
type: "integer",
|
|
29173
30249
|
required: false,
|
|
29174
30250
|
description: "Brief revision the caller read; a mismatch is refused with REVISION_CONFLICT rather than merged."
|
|
@@ -29187,21 +30263,21 @@ for more details.`
|
|
|
29187
30263
|
description: "Source files to keep with the brief, added to the ones already attached."
|
|
29188
30264
|
},
|
|
29189
30265
|
{
|
|
29190
|
-
name: "
|
|
30266
|
+
name: "add_points",
|
|
29191
30267
|
type: "array",
|
|
29192
|
-
itemType: "
|
|
30268
|
+
itemType: "object",
|
|
29193
30269
|
required: false,
|
|
29194
|
-
description: "New requirement points to split out of the brief; each receives the next free key in order."
|
|
30270
|
+
description: "New requirement points to split out of the brief; each receives the next free key in order. A plain string is a unit point; pass { text, scope: work } for a constraint on the whole piece (period, voice, point of view, cast, words to avoid)."
|
|
29195
30271
|
},
|
|
29196
30272
|
{
|
|
29197
|
-
name: "
|
|
30273
|
+
name: "edit_points",
|
|
29198
30274
|
type: "array",
|
|
29199
30275
|
itemType: "object",
|
|
29200
30276
|
required: false,
|
|
29201
30277
|
description: "Existing points to reword, each naming the key it keeps and the text that replaces it."
|
|
29202
30278
|
},
|
|
29203
30279
|
{
|
|
29204
|
-
name: "
|
|
30280
|
+
name: "remove_points",
|
|
29205
30281
|
type: "array",
|
|
29206
30282
|
itemType: "string",
|
|
29207
30283
|
required: false,
|
|
@@ -29284,7 +30360,7 @@ for more details.`
|
|
|
29284
30360
|
description: "Unit tree to create the draft with, given by the caller instead of a template; children nest, and a unit without a kind takes the genre default for its position."
|
|
29285
30361
|
},
|
|
29286
30362
|
{
|
|
29287
|
-
name: "
|
|
30363
|
+
name: "derived_from",
|
|
29288
30364
|
type: "object",
|
|
29289
30365
|
required: false,
|
|
29290
30366
|
description: "What the new draft should be derived from, so the service can record the source revision for later staleness checks."
|
|
@@ -29296,7 +30372,7 @@ for more details.`
|
|
|
29296
30372
|
description: "Initial values for the genre properties, keyed by property key; a value the genre does not define is refused rather than stored."
|
|
29297
30373
|
},
|
|
29298
30374
|
{
|
|
29299
|
-
name: "
|
|
30375
|
+
name: "request_id",
|
|
29300
30376
|
type: "string",
|
|
29301
30377
|
required: false,
|
|
29302
30378
|
description: "Caller-chosen key that makes this create safe to repeat: the same value answers the first draft instead of creating a second one."
|
|
@@ -29365,14 +30441,14 @@ for more details.`
|
|
|
29365
30441
|
required: true,
|
|
29366
30442
|
fields: [
|
|
29367
30443
|
{
|
|
29368
|
-
name: "
|
|
30444
|
+
name: "update_mask",
|
|
29369
30445
|
type: "array",
|
|
29370
30446
|
itemType: "string",
|
|
29371
30447
|
required: true,
|
|
29372
30448
|
description: "Field paths this call changes, such as title, key or props.topics; a field left out keeps its value."
|
|
29373
30449
|
},
|
|
29374
30450
|
{
|
|
29375
|
-
name: "
|
|
30451
|
+
name: "expected_revision",
|
|
29376
30452
|
type: "integer",
|
|
29377
30453
|
required: false,
|
|
29378
30454
|
description: "Draft revision the caller read; a mismatch is refused with REVISION_CONFLICT and nothing changes. Omit it only for structure calls that genuinely do not depend on the current state."
|
|
@@ -29774,7 +30850,7 @@ for more details.`
|
|
|
29774
30850
|
required: false,
|
|
29775
30851
|
fields: [
|
|
29776
30852
|
{
|
|
29777
|
-
name: "
|
|
30853
|
+
name: "expected_revision",
|
|
29778
30854
|
type: "integer",
|
|
29779
30855
|
required: false,
|
|
29780
30856
|
description: "Draft revision the caller read; a mismatch is refused rather than confirming a draft that changed under the caller."
|
|
@@ -37652,507 +38728,812 @@ var canvasListCollections = (options) => (options?.client ?? client).get({
|
|
|
37652
38728
|
url: "/canvas/v1/collections",
|
|
37653
38729
|
...options
|
|
37654
38730
|
});
|
|
37655
|
-
var canvasCreateCollection = (options) => (options.client ?? client).post({
|
|
38731
|
+
var canvasCreateCollection = (options) => (options.client ?? client).post({
|
|
38732
|
+
security: [{
|
|
38733
|
+
key: "BearerAuth",
|
|
38734
|
+
scheme: "bearer",
|
|
38735
|
+
type: "http"
|
|
38736
|
+
}, {
|
|
38737
|
+
key: "ApiKeyAuth",
|
|
38738
|
+
name: "X-API-Key",
|
|
38739
|
+
type: "apiKey"
|
|
38740
|
+
}],
|
|
38741
|
+
url: "/canvas/v1/collections",
|
|
38742
|
+
...options,
|
|
38743
|
+
headers: {
|
|
38744
|
+
"Content-Type": "application/json",
|
|
38745
|
+
...options.headers
|
|
38746
|
+
}
|
|
38747
|
+
});
|
|
38748
|
+
var canvasDeleteCollection = (options) => (options.client ?? client).delete({
|
|
38749
|
+
security: [{
|
|
38750
|
+
key: "BearerAuth",
|
|
38751
|
+
scheme: "bearer",
|
|
38752
|
+
type: "http"
|
|
38753
|
+
}, {
|
|
38754
|
+
key: "ApiKeyAuth",
|
|
38755
|
+
name: "X-API-Key",
|
|
38756
|
+
type: "apiKey"
|
|
38757
|
+
}],
|
|
38758
|
+
url: "/canvas/v1/collections/{collection_id}",
|
|
38759
|
+
...options
|
|
38760
|
+
});
|
|
38761
|
+
var canvasRetrieveCollection = (options) => (options.client ?? client).get({
|
|
38762
|
+
security: [{
|
|
38763
|
+
key: "BearerAuth",
|
|
38764
|
+
scheme: "bearer",
|
|
38765
|
+
type: "http"
|
|
38766
|
+
}, {
|
|
38767
|
+
key: "ApiKeyAuth",
|
|
38768
|
+
name: "X-API-Key",
|
|
38769
|
+
type: "apiKey"
|
|
38770
|
+
}],
|
|
38771
|
+
url: "/canvas/v1/collections/{collection_id}",
|
|
38772
|
+
...options
|
|
38773
|
+
});
|
|
38774
|
+
var canvasUpdateCollection = (options) => (options.client ?? client).patch({
|
|
38775
|
+
security: [{
|
|
38776
|
+
key: "BearerAuth",
|
|
38777
|
+
scheme: "bearer",
|
|
38778
|
+
type: "http"
|
|
38779
|
+
}, {
|
|
38780
|
+
key: "ApiKeyAuth",
|
|
38781
|
+
name: "X-API-Key",
|
|
38782
|
+
type: "apiKey"
|
|
38783
|
+
}],
|
|
38784
|
+
url: "/canvas/v1/collections/{collection_id}",
|
|
38785
|
+
...options,
|
|
38786
|
+
headers: {
|
|
38787
|
+
"Content-Type": "application/json",
|
|
38788
|
+
...options.headers
|
|
38789
|
+
}
|
|
38790
|
+
});
|
|
38791
|
+
var canvasListVersions = (options) => (options.client ?? client).get({
|
|
38792
|
+
security: [{
|
|
38793
|
+
key: "BearerAuth",
|
|
38794
|
+
scheme: "bearer",
|
|
38795
|
+
type: "http"
|
|
38796
|
+
}, {
|
|
38797
|
+
key: "ApiKeyAuth",
|
|
38798
|
+
name: "X-API-Key",
|
|
38799
|
+
type: "apiKey"
|
|
38800
|
+
}],
|
|
38801
|
+
url: "/canvas/v1/canvases/{canvas_id}/versions",
|
|
38802
|
+
...options
|
|
38803
|
+
});
|
|
38804
|
+
var canvasRestoreCanvas = (options) => (options.client ?? client).post({
|
|
38805
|
+
security: [{
|
|
38806
|
+
key: "BearerAuth",
|
|
38807
|
+
scheme: "bearer",
|
|
38808
|
+
type: "http"
|
|
38809
|
+
}, {
|
|
38810
|
+
key: "ApiKeyAuth",
|
|
38811
|
+
name: "X-API-Key",
|
|
38812
|
+
type: "apiKey"
|
|
38813
|
+
}],
|
|
38814
|
+
url: "/canvas/v1/canvases/{canvas_id}:restore",
|
|
38815
|
+
...options,
|
|
38816
|
+
headers: {
|
|
38817
|
+
"Content-Type": "application/json",
|
|
38818
|
+
...options.headers
|
|
38819
|
+
}
|
|
38820
|
+
});
|
|
38821
|
+
var crmObjectsList = (options) => (options.client ?? client).get({
|
|
38822
|
+
querySerializer: { parameters: {
|
|
38823
|
+
associations: { array: { explode: false } },
|
|
38824
|
+
properties: { array: { explode: false } },
|
|
38825
|
+
propertiesWithHistory: { array: { explode: false } }
|
|
38826
|
+
} },
|
|
38827
|
+
security: [{
|
|
38828
|
+
key: "crm-bearerAuth",
|
|
38829
|
+
scheme: "bearer",
|
|
38830
|
+
type: "http"
|
|
38831
|
+
}],
|
|
38832
|
+
url: "/crm/v1/objects/{objectType}",
|
|
38833
|
+
...options
|
|
38834
|
+
});
|
|
38835
|
+
var crmObjectsCreate = (options) => (options.client ?? client).post({
|
|
38836
|
+
security: [{
|
|
38837
|
+
key: "crm-bearerAuth",
|
|
38838
|
+
scheme: "bearer",
|
|
38839
|
+
type: "http"
|
|
38840
|
+
}],
|
|
38841
|
+
url: "/crm/v1/objects/{objectType}",
|
|
38842
|
+
...options,
|
|
38843
|
+
headers: {
|
|
38844
|
+
"Content-Type": "application/json",
|
|
38845
|
+
...options.headers
|
|
38846
|
+
}
|
|
38847
|
+
});
|
|
38848
|
+
var crmObjectsArchive = (options) => (options.client ?? client).delete({
|
|
38849
|
+
security: [{
|
|
38850
|
+
key: "crm-bearerAuth",
|
|
38851
|
+
scheme: "bearer",
|
|
38852
|
+
type: "http"
|
|
38853
|
+
}],
|
|
38854
|
+
url: "/crm/v1/objects/{objectType}/{objectId}",
|
|
38855
|
+
...options
|
|
38856
|
+
});
|
|
38857
|
+
var crmObjectsRetrieve = (options) => (options.client ?? client).get({
|
|
38858
|
+
querySerializer: { parameters: {
|
|
38859
|
+
associations: { array: { explode: false } },
|
|
38860
|
+
properties: { array: { explode: false } },
|
|
38861
|
+
propertiesWithHistory: { array: { explode: false } }
|
|
38862
|
+
} },
|
|
38863
|
+
security: [{
|
|
38864
|
+
key: "crm-bearerAuth",
|
|
38865
|
+
scheme: "bearer",
|
|
38866
|
+
type: "http"
|
|
38867
|
+
}],
|
|
38868
|
+
url: "/crm/v1/objects/{objectType}/{objectId}",
|
|
38869
|
+
...options
|
|
38870
|
+
});
|
|
38871
|
+
var crmObjectsUpdate = (options) => (options.client ?? client).patch({
|
|
38872
|
+
security: [{
|
|
38873
|
+
key: "crm-bearerAuth",
|
|
38874
|
+
scheme: "bearer",
|
|
38875
|
+
type: "http"
|
|
38876
|
+
}],
|
|
38877
|
+
url: "/crm/v1/objects/{objectType}/{objectId}",
|
|
38878
|
+
...options,
|
|
38879
|
+
headers: {
|
|
38880
|
+
"Content-Type": "application/json",
|
|
38881
|
+
...options.headers
|
|
38882
|
+
}
|
|
38883
|
+
});
|
|
38884
|
+
var crmObjectsSearch = (options) => (options.client ?? client).post({
|
|
38885
|
+
security: [{
|
|
38886
|
+
key: "crm-bearerAuth",
|
|
38887
|
+
scheme: "bearer",
|
|
38888
|
+
type: "http"
|
|
38889
|
+
}],
|
|
38890
|
+
url: "/crm/v1/objects/{objectType}/search",
|
|
38891
|
+
...options,
|
|
38892
|
+
headers: {
|
|
38893
|
+
"Content-Type": "application/json",
|
|
38894
|
+
...options.headers
|
|
38895
|
+
}
|
|
38896
|
+
});
|
|
38897
|
+
var crmObjectsBatchRead = (options) => (options.client ?? client).post({
|
|
38898
|
+
security: [{
|
|
38899
|
+
key: "crm-bearerAuth",
|
|
38900
|
+
scheme: "bearer",
|
|
38901
|
+
type: "http"
|
|
38902
|
+
}],
|
|
38903
|
+
url: "/crm/v1/objects/{objectType}/batch/read",
|
|
38904
|
+
...options,
|
|
38905
|
+
headers: {
|
|
38906
|
+
"Content-Type": "application/json",
|
|
38907
|
+
...options.headers
|
|
38908
|
+
}
|
|
38909
|
+
});
|
|
38910
|
+
var crmObjectsBatchCreate = (options) => (options.client ?? client).post({
|
|
38911
|
+
security: [{
|
|
38912
|
+
key: "crm-bearerAuth",
|
|
38913
|
+
scheme: "bearer",
|
|
38914
|
+
type: "http"
|
|
38915
|
+
}],
|
|
38916
|
+
url: "/crm/v1/objects/{objectType}/batch/create",
|
|
38917
|
+
...options,
|
|
38918
|
+
headers: {
|
|
38919
|
+
"Content-Type": "application/json",
|
|
38920
|
+
...options.headers
|
|
38921
|
+
}
|
|
38922
|
+
});
|
|
38923
|
+
var crmObjectsBatchUpdate = (options) => (options.client ?? client).post({
|
|
38924
|
+
security: [{
|
|
38925
|
+
key: "crm-bearerAuth",
|
|
38926
|
+
scheme: "bearer",
|
|
38927
|
+
type: "http"
|
|
38928
|
+
}],
|
|
38929
|
+
url: "/crm/v1/objects/{objectType}/batch/update",
|
|
38930
|
+
...options,
|
|
38931
|
+
headers: {
|
|
38932
|
+
"Content-Type": "application/json",
|
|
38933
|
+
...options.headers
|
|
38934
|
+
}
|
|
38935
|
+
});
|
|
38936
|
+
var crmObjectsBatchUpsert = (options) => (options.client ?? client).post({
|
|
38937
|
+
security: [{
|
|
38938
|
+
key: "crm-bearerAuth",
|
|
38939
|
+
scheme: "bearer",
|
|
38940
|
+
type: "http"
|
|
38941
|
+
}],
|
|
38942
|
+
url: "/crm/v1/objects/{objectType}/batch/upsert",
|
|
38943
|
+
...options,
|
|
38944
|
+
headers: {
|
|
38945
|
+
"Content-Type": "application/json",
|
|
38946
|
+
...options.headers
|
|
38947
|
+
}
|
|
38948
|
+
});
|
|
38949
|
+
var crmObjectsBatchArchive = (options) => (options.client ?? client).post({
|
|
38950
|
+
security: [{
|
|
38951
|
+
key: "crm-bearerAuth",
|
|
38952
|
+
scheme: "bearer",
|
|
38953
|
+
type: "http"
|
|
38954
|
+
}],
|
|
38955
|
+
url: "/crm/v1/objects/{objectType}/batch/archive",
|
|
38956
|
+
...options,
|
|
38957
|
+
headers: {
|
|
38958
|
+
"Content-Type": "application/json",
|
|
38959
|
+
...options.headers
|
|
38960
|
+
}
|
|
38961
|
+
});
|
|
38962
|
+
var crmPropertiesList = (options) => (options.client ?? client).get({
|
|
38963
|
+
security: [{
|
|
38964
|
+
key: "crm-bearerAuth",
|
|
38965
|
+
scheme: "bearer",
|
|
38966
|
+
type: "http"
|
|
38967
|
+
}],
|
|
38968
|
+
url: "/crm/v1/properties/{objectType}",
|
|
38969
|
+
...options
|
|
38970
|
+
});
|
|
38971
|
+
var crmPropertiesCreate = (options) => (options.client ?? client).post({
|
|
37656
38972
|
security: [{
|
|
37657
|
-
key: "
|
|
38973
|
+
key: "crm-bearerAuth",
|
|
37658
38974
|
scheme: "bearer",
|
|
37659
38975
|
type: "http"
|
|
37660
|
-
}, {
|
|
37661
|
-
key: "ApiKeyAuth",
|
|
37662
|
-
name: "X-API-Key",
|
|
37663
|
-
type: "apiKey"
|
|
37664
38976
|
}],
|
|
37665
|
-
url: "/
|
|
38977
|
+
url: "/crm/v1/properties/{objectType}",
|
|
37666
38978
|
...options,
|
|
37667
38979
|
headers: {
|
|
37668
38980
|
"Content-Type": "application/json",
|
|
37669
38981
|
...options.headers
|
|
37670
38982
|
}
|
|
37671
38983
|
});
|
|
37672
|
-
var
|
|
38984
|
+
var crmPropertiesArchive = (options) => (options.client ?? client).delete({
|
|
37673
38985
|
security: [{
|
|
37674
|
-
key: "
|
|
38986
|
+
key: "crm-bearerAuth",
|
|
37675
38987
|
scheme: "bearer",
|
|
37676
38988
|
type: "http"
|
|
37677
|
-
}, {
|
|
37678
|
-
key: "ApiKeyAuth",
|
|
37679
|
-
name: "X-API-Key",
|
|
37680
|
-
type: "apiKey"
|
|
37681
38989
|
}],
|
|
37682
|
-
url: "/
|
|
38990
|
+
url: "/crm/v1/properties/{objectType}/{propertyName}",
|
|
37683
38991
|
...options
|
|
37684
38992
|
});
|
|
37685
|
-
var
|
|
38993
|
+
var crmPropertiesRetrieve = (options) => (options.client ?? client).get({
|
|
37686
38994
|
security: [{
|
|
37687
|
-
key: "
|
|
38995
|
+
key: "crm-bearerAuth",
|
|
37688
38996
|
scheme: "bearer",
|
|
37689
38997
|
type: "http"
|
|
37690
|
-
}, {
|
|
37691
|
-
key: "ApiKeyAuth",
|
|
37692
|
-
name: "X-API-Key",
|
|
37693
|
-
type: "apiKey"
|
|
37694
38998
|
}],
|
|
37695
|
-
url: "/
|
|
38999
|
+
url: "/crm/v1/properties/{objectType}/{propertyName}",
|
|
37696
39000
|
...options
|
|
37697
39001
|
});
|
|
37698
|
-
var
|
|
39002
|
+
var crmPropertiesUpdate = (options) => (options.client ?? client).patch({
|
|
37699
39003
|
security: [{
|
|
37700
|
-
key: "
|
|
39004
|
+
key: "crm-bearerAuth",
|
|
37701
39005
|
scheme: "bearer",
|
|
37702
39006
|
type: "http"
|
|
37703
|
-
}, {
|
|
37704
|
-
key: "ApiKeyAuth",
|
|
37705
|
-
name: "X-API-Key",
|
|
37706
|
-
type: "apiKey"
|
|
37707
39007
|
}],
|
|
37708
|
-
url: "/
|
|
39008
|
+
url: "/crm/v1/properties/{objectType}/{propertyName}",
|
|
37709
39009
|
...options,
|
|
37710
39010
|
headers: {
|
|
37711
39011
|
"Content-Type": "application/json",
|
|
37712
39012
|
...options.headers
|
|
37713
39013
|
}
|
|
37714
39014
|
});
|
|
37715
|
-
var
|
|
39015
|
+
var crmPropertiesGroupsList = (options) => (options.client ?? client).get({
|
|
37716
39016
|
security: [{
|
|
37717
|
-
key: "
|
|
39017
|
+
key: "crm-bearerAuth",
|
|
37718
39018
|
scheme: "bearer",
|
|
37719
39019
|
type: "http"
|
|
37720
|
-
}, {
|
|
37721
|
-
key: "ApiKeyAuth",
|
|
37722
|
-
name: "X-API-Key",
|
|
37723
|
-
type: "apiKey"
|
|
37724
39020
|
}],
|
|
37725
|
-
url: "/
|
|
39021
|
+
url: "/crm/v1/properties/{objectType}/groups",
|
|
37726
39022
|
...options
|
|
37727
39023
|
});
|
|
37728
|
-
var
|
|
39024
|
+
var crmPropertiesGroupsCreate = (options) => (options.client ?? client).post({
|
|
37729
39025
|
security: [{
|
|
37730
|
-
key: "
|
|
39026
|
+
key: "crm-bearerAuth",
|
|
37731
39027
|
scheme: "bearer",
|
|
37732
39028
|
type: "http"
|
|
37733
|
-
}, {
|
|
37734
|
-
key: "ApiKeyAuth",
|
|
37735
|
-
name: "X-API-Key",
|
|
37736
|
-
type: "apiKey"
|
|
37737
39029
|
}],
|
|
37738
|
-
url: "/
|
|
39030
|
+
url: "/crm/v1/properties/{objectType}/groups",
|
|
37739
39031
|
...options,
|
|
37740
39032
|
headers: {
|
|
37741
39033
|
"Content-Type": "application/json",
|
|
37742
39034
|
...options.headers
|
|
37743
39035
|
}
|
|
37744
39036
|
});
|
|
37745
|
-
var
|
|
37746
|
-
querySerializer: { parameters: {
|
|
37747
|
-
associations: { array: { explode: false } },
|
|
37748
|
-
properties: { array: { explode: false } },
|
|
37749
|
-
propertiesWithHistory: { array: { explode: false } }
|
|
37750
|
-
} },
|
|
39037
|
+
var crmPipelinesList = (options) => (options.client ?? client).get({
|
|
37751
39038
|
security: [{
|
|
37752
39039
|
key: "crm-bearerAuth",
|
|
37753
39040
|
scheme: "bearer",
|
|
37754
39041
|
type: "http"
|
|
37755
39042
|
}],
|
|
37756
|
-
url: "/crm/v1/
|
|
39043
|
+
url: "/crm/v1/pipelines/{objectType}",
|
|
37757
39044
|
...options
|
|
37758
39045
|
});
|
|
37759
|
-
var
|
|
39046
|
+
var crmPipelinesCreate = (options) => (options.client ?? client).post({
|
|
37760
39047
|
security: [{
|
|
37761
39048
|
key: "crm-bearerAuth",
|
|
37762
39049
|
scheme: "bearer",
|
|
37763
39050
|
type: "http"
|
|
37764
39051
|
}],
|
|
37765
|
-
url: "/crm/v1/
|
|
39052
|
+
url: "/crm/v1/pipelines/{objectType}",
|
|
37766
39053
|
...options,
|
|
37767
39054
|
headers: {
|
|
37768
39055
|
"Content-Type": "application/json",
|
|
37769
39056
|
...options.headers
|
|
37770
39057
|
}
|
|
37771
39058
|
});
|
|
37772
|
-
var
|
|
39059
|
+
var crmPipelinesArchive = (options) => (options.client ?? client).delete({
|
|
37773
39060
|
security: [{
|
|
37774
39061
|
key: "crm-bearerAuth",
|
|
37775
39062
|
scheme: "bearer",
|
|
37776
39063
|
type: "http"
|
|
37777
39064
|
}],
|
|
37778
|
-
url: "/crm/v1/
|
|
39065
|
+
url: "/crm/v1/pipelines/{objectType}/{pipelineId}",
|
|
37779
39066
|
...options
|
|
37780
39067
|
});
|
|
37781
|
-
var
|
|
37782
|
-
querySerializer: { parameters: {
|
|
37783
|
-
associations: { array: { explode: false } },
|
|
37784
|
-
properties: { array: { explode: false } },
|
|
37785
|
-
propertiesWithHistory: { array: { explode: false } }
|
|
37786
|
-
} },
|
|
39068
|
+
var crmPipelinesRetrieve = (options) => (options.client ?? client).get({
|
|
37787
39069
|
security: [{
|
|
37788
39070
|
key: "crm-bearerAuth",
|
|
37789
39071
|
scheme: "bearer",
|
|
37790
39072
|
type: "http"
|
|
37791
39073
|
}],
|
|
37792
|
-
url: "/crm/v1/
|
|
39074
|
+
url: "/crm/v1/pipelines/{objectType}/{pipelineId}",
|
|
37793
39075
|
...options
|
|
37794
39076
|
});
|
|
37795
|
-
var
|
|
39077
|
+
var crmPipelinesUpdate = (options) => (options.client ?? client).patch({
|
|
37796
39078
|
security: [{
|
|
37797
39079
|
key: "crm-bearerAuth",
|
|
37798
39080
|
scheme: "bearer",
|
|
37799
39081
|
type: "http"
|
|
37800
39082
|
}],
|
|
37801
|
-
url: "/crm/v1/
|
|
39083
|
+
url: "/crm/v1/pipelines/{objectType}/{pipelineId}",
|
|
37802
39084
|
...options,
|
|
37803
39085
|
headers: {
|
|
37804
39086
|
"Content-Type": "application/json",
|
|
37805
39087
|
...options.headers
|
|
37806
39088
|
}
|
|
37807
39089
|
});
|
|
37808
|
-
var
|
|
39090
|
+
var crmPipelinesStagesCreate = (options) => (options.client ?? client).post({
|
|
37809
39091
|
security: [{
|
|
37810
39092
|
key: "crm-bearerAuth",
|
|
37811
39093
|
scheme: "bearer",
|
|
37812
39094
|
type: "http"
|
|
37813
39095
|
}],
|
|
37814
|
-
url: "/crm/v1/
|
|
39096
|
+
url: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages",
|
|
37815
39097
|
...options,
|
|
37816
39098
|
headers: {
|
|
37817
39099
|
"Content-Type": "application/json",
|
|
37818
39100
|
...options.headers
|
|
37819
39101
|
}
|
|
37820
39102
|
});
|
|
37821
|
-
var
|
|
39103
|
+
var crmPipelinesStagesArchive = (options) => (options.client ?? client).delete({
|
|
37822
39104
|
security: [{
|
|
37823
39105
|
key: "crm-bearerAuth",
|
|
37824
39106
|
scheme: "bearer",
|
|
37825
39107
|
type: "http"
|
|
37826
39108
|
}],
|
|
37827
|
-
url: "/crm/v1/
|
|
37828
|
-
...options
|
|
37829
|
-
headers: {
|
|
37830
|
-
"Content-Type": "application/json",
|
|
37831
|
-
...options.headers
|
|
37832
|
-
}
|
|
39109
|
+
url: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}",
|
|
39110
|
+
...options
|
|
37833
39111
|
});
|
|
37834
|
-
var
|
|
39112
|
+
var crmPipelinesStagesUpdate = (options) => (options.client ?? client).patch({
|
|
37835
39113
|
security: [{
|
|
37836
39114
|
key: "crm-bearerAuth",
|
|
37837
39115
|
scheme: "bearer",
|
|
37838
39116
|
type: "http"
|
|
37839
39117
|
}],
|
|
37840
|
-
url: "/crm/v1/
|
|
39118
|
+
url: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}",
|
|
37841
39119
|
...options,
|
|
37842
39120
|
headers: {
|
|
37843
39121
|
"Content-Type": "application/json",
|
|
37844
39122
|
...options.headers
|
|
37845
39123
|
}
|
|
37846
39124
|
});
|
|
37847
|
-
var
|
|
39125
|
+
var crmAssociationsList = (options) => (options.client ?? client).get({
|
|
37848
39126
|
security: [{
|
|
37849
39127
|
key: "crm-bearerAuth",
|
|
37850
39128
|
scheme: "bearer",
|
|
37851
39129
|
type: "http"
|
|
37852
39130
|
}],
|
|
37853
|
-
url: "/crm/v1/objects/{objectType}/
|
|
39131
|
+
url: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}",
|
|
39132
|
+
...options
|
|
39133
|
+
});
|
|
39134
|
+
var crmAssociationsRemove = (options) => (options.client ?? client).delete({
|
|
39135
|
+
security: [{
|
|
39136
|
+
key: "crm-bearerAuth",
|
|
39137
|
+
scheme: "bearer",
|
|
39138
|
+
type: "http"
|
|
39139
|
+
}],
|
|
39140
|
+
url: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}",
|
|
39141
|
+
...options
|
|
39142
|
+
});
|
|
39143
|
+
var crmAssociationsCreate = (options) => (options.client ?? client).put({
|
|
39144
|
+
security: [{
|
|
39145
|
+
key: "crm-bearerAuth",
|
|
39146
|
+
scheme: "bearer",
|
|
39147
|
+
type: "http"
|
|
39148
|
+
}],
|
|
39149
|
+
url: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}",
|
|
37854
39150
|
...options,
|
|
37855
39151
|
headers: {
|
|
37856
39152
|
"Content-Type": "application/json",
|
|
37857
39153
|
...options.headers
|
|
37858
39154
|
}
|
|
37859
39155
|
});
|
|
37860
|
-
var
|
|
39156
|
+
var crmAssociationsCreateDefault = (options) => (options.client ?? client).put({
|
|
37861
39157
|
security: [{
|
|
37862
39158
|
key: "crm-bearerAuth",
|
|
37863
39159
|
scheme: "bearer",
|
|
37864
39160
|
type: "http"
|
|
37865
39161
|
}],
|
|
37866
|
-
url: "/crm/v1/objects/{objectType}/
|
|
39162
|
+
url: "/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}",
|
|
39163
|
+
...options
|
|
39164
|
+
});
|
|
39165
|
+
var crmSchemasList = (options) => (options?.client ?? client).get({
|
|
39166
|
+
security: [{
|
|
39167
|
+
key: "crm-bearerAuth",
|
|
39168
|
+
scheme: "bearer",
|
|
39169
|
+
type: "http"
|
|
39170
|
+
}],
|
|
39171
|
+
url: "/crm/v1/schemas",
|
|
39172
|
+
...options
|
|
39173
|
+
});
|
|
39174
|
+
var crmSchemasCreate = (options) => (options.client ?? client).post({
|
|
39175
|
+
security: [{
|
|
39176
|
+
key: "crm-bearerAuth",
|
|
39177
|
+
scheme: "bearer",
|
|
39178
|
+
type: "http"
|
|
39179
|
+
}],
|
|
39180
|
+
url: "/crm/v1/schemas",
|
|
37867
39181
|
...options,
|
|
37868
39182
|
headers: {
|
|
37869
39183
|
"Content-Type": "application/json",
|
|
37870
39184
|
...options.headers
|
|
37871
39185
|
}
|
|
37872
39186
|
});
|
|
37873
|
-
var
|
|
39187
|
+
var crmLeadsQualify = (options) => (options.client ?? client).post({
|
|
37874
39188
|
security: [{
|
|
37875
39189
|
key: "crm-bearerAuth",
|
|
37876
39190
|
scheme: "bearer",
|
|
37877
39191
|
type: "http"
|
|
37878
39192
|
}],
|
|
37879
|
-
url: "/crm/v1/
|
|
39193
|
+
url: "/crm/v1/leads/{leadId}:qualify",
|
|
37880
39194
|
...options,
|
|
37881
39195
|
headers: {
|
|
37882
39196
|
"Content-Type": "application/json",
|
|
37883
39197
|
...options.headers
|
|
37884
39198
|
}
|
|
37885
39199
|
});
|
|
37886
|
-
var
|
|
39200
|
+
var crmChangesRevert = (options) => (options.client ?? client).post({
|
|
37887
39201
|
security: [{
|
|
37888
39202
|
key: "crm-bearerAuth",
|
|
37889
39203
|
scheme: "bearer",
|
|
37890
39204
|
type: "http"
|
|
37891
39205
|
}],
|
|
37892
|
-
url: "/crm/v1/
|
|
39206
|
+
url: "/crm/v1/changes/{changeSetId}:revert",
|
|
37893
39207
|
...options
|
|
37894
39208
|
});
|
|
37895
|
-
var
|
|
39209
|
+
var crmLayoutsRetrieve = (options) => (options.client ?? client).get({
|
|
37896
39210
|
security: [{
|
|
37897
39211
|
key: "crm-bearerAuth",
|
|
37898
39212
|
scheme: "bearer",
|
|
37899
39213
|
type: "http"
|
|
37900
39214
|
}],
|
|
37901
|
-
url: "/crm/v1/
|
|
37902
|
-
...options
|
|
37903
|
-
headers: {
|
|
37904
|
-
"Content-Type": "application/json",
|
|
37905
|
-
...options.headers
|
|
37906
|
-
}
|
|
39215
|
+
url: "/crm/v1/layouts/{objectType}",
|
|
39216
|
+
...options
|
|
37907
39217
|
});
|
|
37908
|
-
var
|
|
39218
|
+
var crmLayoutsUpdate = (options) => (options.client ?? client).put({
|
|
37909
39219
|
security: [{
|
|
37910
39220
|
key: "crm-bearerAuth",
|
|
37911
39221
|
scheme: "bearer",
|
|
37912
39222
|
type: "http"
|
|
37913
39223
|
}],
|
|
37914
|
-
url: "/crm/v1/
|
|
37915
|
-
...options
|
|
39224
|
+
url: "/crm/v1/layouts/{objectType}",
|
|
39225
|
+
...options,
|
|
39226
|
+
headers: {
|
|
39227
|
+
"Content-Type": "application/json",
|
|
39228
|
+
...options.headers
|
|
39229
|
+
}
|
|
37916
39230
|
});
|
|
37917
|
-
var
|
|
39231
|
+
var cutListProjects = (options) => (options?.client ?? client).get({
|
|
37918
39232
|
security: [{
|
|
37919
|
-
key: "
|
|
39233
|
+
key: "BearerAuth",
|
|
37920
39234
|
scheme: "bearer",
|
|
37921
39235
|
type: "http"
|
|
39236
|
+
}, {
|
|
39237
|
+
key: "ApiKeyAuth",
|
|
39238
|
+
name: "X-API-Key",
|
|
39239
|
+
type: "apiKey"
|
|
37922
39240
|
}],
|
|
37923
|
-
url: "/
|
|
39241
|
+
url: "/cut/v1/projects",
|
|
37924
39242
|
...options
|
|
37925
39243
|
});
|
|
37926
|
-
var
|
|
39244
|
+
var cutCreateProject = (options) => (options.client ?? client).post({
|
|
37927
39245
|
security: [{
|
|
37928
|
-
key: "
|
|
39246
|
+
key: "BearerAuth",
|
|
37929
39247
|
scheme: "bearer",
|
|
37930
39248
|
type: "http"
|
|
39249
|
+
}, {
|
|
39250
|
+
key: "ApiKeyAuth",
|
|
39251
|
+
name: "X-API-Key",
|
|
39252
|
+
type: "apiKey"
|
|
37931
39253
|
}],
|
|
37932
|
-
url: "/
|
|
39254
|
+
url: "/cut/v1/projects",
|
|
37933
39255
|
...options,
|
|
37934
39256
|
headers: {
|
|
37935
39257
|
"Content-Type": "application/json",
|
|
37936
39258
|
...options.headers
|
|
37937
39259
|
}
|
|
37938
39260
|
});
|
|
37939
|
-
var
|
|
39261
|
+
var cutDeleteProject = (options) => (options.client ?? client).delete({
|
|
37940
39262
|
security: [{
|
|
37941
|
-
key: "
|
|
39263
|
+
key: "BearerAuth",
|
|
37942
39264
|
scheme: "bearer",
|
|
37943
39265
|
type: "http"
|
|
39266
|
+
}, {
|
|
39267
|
+
key: "ApiKeyAuth",
|
|
39268
|
+
name: "X-API-Key",
|
|
39269
|
+
type: "apiKey"
|
|
37944
39270
|
}],
|
|
37945
|
-
url: "/
|
|
39271
|
+
url: "/cut/v1/projects/{project_id}",
|
|
37946
39272
|
...options
|
|
37947
39273
|
});
|
|
37948
|
-
var
|
|
39274
|
+
var cutRetrieveProject = (options) => (options.client ?? client).get({
|
|
37949
39275
|
security: [{
|
|
37950
|
-
key: "
|
|
39276
|
+
key: "BearerAuth",
|
|
37951
39277
|
scheme: "bearer",
|
|
37952
39278
|
type: "http"
|
|
39279
|
+
}, {
|
|
39280
|
+
key: "ApiKeyAuth",
|
|
39281
|
+
name: "X-API-Key",
|
|
39282
|
+
type: "apiKey"
|
|
37953
39283
|
}],
|
|
37954
|
-
url: "/
|
|
39284
|
+
url: "/cut/v1/projects/{project_id}",
|
|
39285
|
+
...options
|
|
39286
|
+
});
|
|
39287
|
+
var cutUpdateProject = (options) => (options.client ?? client).patch({
|
|
39288
|
+
security: [{
|
|
39289
|
+
key: "BearerAuth",
|
|
39290
|
+
scheme: "bearer",
|
|
39291
|
+
type: "http"
|
|
39292
|
+
}, {
|
|
39293
|
+
key: "ApiKeyAuth",
|
|
39294
|
+
name: "X-API-Key",
|
|
39295
|
+
type: "apiKey"
|
|
39296
|
+
}],
|
|
39297
|
+
url: "/cut/v1/projects/{project_id}",
|
|
37955
39298
|
...options,
|
|
37956
39299
|
headers: {
|
|
37957
39300
|
"Content-Type": "application/json",
|
|
37958
39301
|
...options.headers
|
|
37959
39302
|
}
|
|
37960
39303
|
});
|
|
37961
|
-
var
|
|
39304
|
+
var cutUndeleteProject = (options) => (options.client ?? client).post({
|
|
37962
39305
|
security: [{
|
|
37963
|
-
key: "
|
|
39306
|
+
key: "BearerAuth",
|
|
37964
39307
|
scheme: "bearer",
|
|
37965
39308
|
type: "http"
|
|
39309
|
+
}, {
|
|
39310
|
+
key: "ApiKeyAuth",
|
|
39311
|
+
name: "X-API-Key",
|
|
39312
|
+
type: "apiKey"
|
|
37966
39313
|
}],
|
|
37967
|
-
url: "/
|
|
39314
|
+
url: "/cut/v1/projects/{project_id}:undelete",
|
|
37968
39315
|
...options
|
|
37969
39316
|
});
|
|
37970
|
-
var
|
|
39317
|
+
var cutExecute = (options) => (options.client ?? client).post({
|
|
37971
39318
|
security: [{
|
|
37972
|
-
key: "
|
|
39319
|
+
key: "BearerAuth",
|
|
37973
39320
|
scheme: "bearer",
|
|
37974
39321
|
type: "http"
|
|
39322
|
+
}, {
|
|
39323
|
+
key: "ApiKeyAuth",
|
|
39324
|
+
name: "X-API-Key",
|
|
39325
|
+
type: "apiKey"
|
|
37975
39326
|
}],
|
|
37976
|
-
url: "/
|
|
39327
|
+
url: "/cut/v1/projects/{project_id}:execute",
|
|
37977
39328
|
...options,
|
|
37978
39329
|
headers: {
|
|
37979
39330
|
"Content-Type": "application/json",
|
|
37980
39331
|
...options.headers
|
|
37981
39332
|
}
|
|
37982
39333
|
});
|
|
37983
|
-
var
|
|
39334
|
+
var cutRetrieveState = (options) => (options.client ?? client).get({
|
|
37984
39335
|
security: [{
|
|
37985
|
-
key: "
|
|
39336
|
+
key: "BearerAuth",
|
|
37986
39337
|
scheme: "bearer",
|
|
37987
39338
|
type: "http"
|
|
39339
|
+
}, {
|
|
39340
|
+
key: "ApiKeyAuth",
|
|
39341
|
+
name: "X-API-Key",
|
|
39342
|
+
type: "apiKey"
|
|
37988
39343
|
}],
|
|
37989
|
-
url: "/
|
|
39344
|
+
url: "/cut/v1/projects/{project_id}/state",
|
|
37990
39345
|
...options
|
|
37991
39346
|
});
|
|
37992
|
-
var
|
|
39347
|
+
var cutRetrieveTimeline = (options) => (options.client ?? client).get({
|
|
37993
39348
|
security: [{
|
|
37994
|
-
key: "
|
|
39349
|
+
key: "BearerAuth",
|
|
37995
39350
|
scheme: "bearer",
|
|
37996
39351
|
type: "http"
|
|
39352
|
+
}, {
|
|
39353
|
+
key: "ApiKeyAuth",
|
|
39354
|
+
name: "X-API-Key",
|
|
39355
|
+
type: "apiKey"
|
|
37997
39356
|
}],
|
|
37998
|
-
url: "/
|
|
39357
|
+
url: "/cut/v1/projects/{project_id}/timeline",
|
|
37999
39358
|
...options
|
|
38000
39359
|
});
|
|
38001
|
-
var
|
|
39360
|
+
var cutListFrames = (options) => (options.client ?? client).get({
|
|
38002
39361
|
security: [{
|
|
38003
|
-
key: "
|
|
39362
|
+
key: "BearerAuth",
|
|
38004
39363
|
scheme: "bearer",
|
|
38005
39364
|
type: "http"
|
|
39365
|
+
}, {
|
|
39366
|
+
key: "ApiKeyAuth",
|
|
39367
|
+
name: "X-API-Key",
|
|
39368
|
+
type: "apiKey"
|
|
38006
39369
|
}],
|
|
38007
|
-
url: "/
|
|
38008
|
-
...options
|
|
38009
|
-
headers: {
|
|
38010
|
-
"Content-Type": "application/json",
|
|
38011
|
-
...options.headers
|
|
38012
|
-
}
|
|
39370
|
+
url: "/cut/v1/projects/{project_id}/frames",
|
|
39371
|
+
...options
|
|
38013
39372
|
});
|
|
38014
|
-
var
|
|
39373
|
+
var cutCreateAnalysis = (options) => (options.client ?? client).post({
|
|
38015
39374
|
security: [{
|
|
38016
|
-
key: "
|
|
39375
|
+
key: "BearerAuth",
|
|
38017
39376
|
scheme: "bearer",
|
|
38018
39377
|
type: "http"
|
|
39378
|
+
}, {
|
|
39379
|
+
key: "ApiKeyAuth",
|
|
39380
|
+
name: "X-API-Key",
|
|
39381
|
+
type: "apiKey"
|
|
38019
39382
|
}],
|
|
38020
|
-
url: "/
|
|
39383
|
+
url: "/cut/v1/projects/{project_id}/analysis",
|
|
38021
39384
|
...options,
|
|
38022
39385
|
headers: {
|
|
38023
39386
|
"Content-Type": "application/json",
|
|
38024
39387
|
...options.headers
|
|
38025
39388
|
}
|
|
38026
39389
|
});
|
|
38027
|
-
var
|
|
39390
|
+
var cutListBindings = (options) => (options.client ?? client).get({
|
|
38028
39391
|
security: [{
|
|
38029
|
-
key: "
|
|
39392
|
+
key: "BearerAuth",
|
|
38030
39393
|
scheme: "bearer",
|
|
38031
39394
|
type: "http"
|
|
39395
|
+
}, {
|
|
39396
|
+
key: "ApiKeyAuth",
|
|
39397
|
+
name: "X-API-Key",
|
|
39398
|
+
type: "apiKey"
|
|
38032
39399
|
}],
|
|
38033
|
-
url: "/
|
|
39400
|
+
url: "/cut/v1/projects/{project_id}/bindings",
|
|
38034
39401
|
...options
|
|
38035
39402
|
});
|
|
38036
|
-
var
|
|
39403
|
+
var cutCreateBinding = (options) => (options.client ?? client).post({
|
|
38037
39404
|
security: [{
|
|
38038
|
-
key: "
|
|
39405
|
+
key: "BearerAuth",
|
|
38039
39406
|
scheme: "bearer",
|
|
38040
39407
|
type: "http"
|
|
39408
|
+
}, {
|
|
39409
|
+
key: "ApiKeyAuth",
|
|
39410
|
+
name: "X-API-Key",
|
|
39411
|
+
type: "apiKey"
|
|
38041
39412
|
}],
|
|
38042
|
-
url: "/
|
|
39413
|
+
url: "/cut/v1/projects/{project_id}/bindings",
|
|
38043
39414
|
...options,
|
|
38044
39415
|
headers: {
|
|
38045
39416
|
"Content-Type": "application/json",
|
|
38046
39417
|
...options.headers
|
|
38047
39418
|
}
|
|
38048
39419
|
});
|
|
38049
|
-
var
|
|
38050
|
-
security: [{
|
|
38051
|
-
key: "crm-bearerAuth",
|
|
38052
|
-
scheme: "bearer",
|
|
38053
|
-
type: "http"
|
|
38054
|
-
}],
|
|
38055
|
-
url: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}",
|
|
38056
|
-
...options
|
|
38057
|
-
});
|
|
38058
|
-
var crmAssociationsRemove = (options) => (options.client ?? client).delete({
|
|
39420
|
+
var cutDeleteBinding = (options) => (options.client ?? client).delete({
|
|
38059
39421
|
security: [{
|
|
38060
|
-
key: "
|
|
39422
|
+
key: "BearerAuth",
|
|
38061
39423
|
scheme: "bearer",
|
|
38062
39424
|
type: "http"
|
|
39425
|
+
}, {
|
|
39426
|
+
key: "ApiKeyAuth",
|
|
39427
|
+
name: "X-API-Key",
|
|
39428
|
+
type: "apiKey"
|
|
38063
39429
|
}],
|
|
38064
|
-
url: "/
|
|
39430
|
+
url: "/cut/v1/projects/{project_id}/bindings/{name}",
|
|
38065
39431
|
...options
|
|
38066
39432
|
});
|
|
38067
|
-
var
|
|
39433
|
+
var cutImportMedia = (options) => (options.client ?? client).post({
|
|
38068
39434
|
security: [{
|
|
38069
|
-
key: "
|
|
39435
|
+
key: "BearerAuth",
|
|
38070
39436
|
scheme: "bearer",
|
|
38071
39437
|
type: "http"
|
|
39438
|
+
}, {
|
|
39439
|
+
key: "ApiKeyAuth",
|
|
39440
|
+
name: "X-API-Key",
|
|
39441
|
+
type: "apiKey"
|
|
38072
39442
|
}],
|
|
38073
|
-
url: "/
|
|
39443
|
+
url: "/cut/v1/projects/{project_id}/media:import",
|
|
38074
39444
|
...options,
|
|
38075
39445
|
headers: {
|
|
38076
39446
|
"Content-Type": "application/json",
|
|
38077
39447
|
...options.headers
|
|
38078
39448
|
}
|
|
38079
39449
|
});
|
|
38080
|
-
var
|
|
38081
|
-
security: [{
|
|
38082
|
-
key: "crm-bearerAuth",
|
|
38083
|
-
scheme: "bearer",
|
|
38084
|
-
type: "http"
|
|
38085
|
-
}],
|
|
38086
|
-
url: "/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}",
|
|
38087
|
-
...options
|
|
38088
|
-
});
|
|
38089
|
-
var crmSchemasList = (options) => (options?.client ?? client).get({
|
|
39450
|
+
var cutListExports = (options) => (options.client ?? client).get({
|
|
38090
39451
|
security: [{
|
|
38091
|
-
key: "
|
|
39452
|
+
key: "BearerAuth",
|
|
38092
39453
|
scheme: "bearer",
|
|
38093
39454
|
type: "http"
|
|
39455
|
+
}, {
|
|
39456
|
+
key: "ApiKeyAuth",
|
|
39457
|
+
name: "X-API-Key",
|
|
39458
|
+
type: "apiKey"
|
|
38094
39459
|
}],
|
|
38095
|
-
url: "/
|
|
39460
|
+
url: "/cut/v1/projects/{project_id}/exports",
|
|
38096
39461
|
...options
|
|
38097
39462
|
});
|
|
38098
|
-
var
|
|
39463
|
+
var cutCreateExport = (options) => (options.client ?? client).post({
|
|
38099
39464
|
security: [{
|
|
38100
|
-
key: "
|
|
39465
|
+
key: "BearerAuth",
|
|
38101
39466
|
scheme: "bearer",
|
|
38102
39467
|
type: "http"
|
|
39468
|
+
}, {
|
|
39469
|
+
key: "ApiKeyAuth",
|
|
39470
|
+
name: "X-API-Key",
|
|
39471
|
+
type: "apiKey"
|
|
38103
39472
|
}],
|
|
38104
|
-
url: "/
|
|
39473
|
+
url: "/cut/v1/projects/{project_id}/exports",
|
|
38105
39474
|
...options,
|
|
38106
39475
|
headers: {
|
|
38107
39476
|
"Content-Type": "application/json",
|
|
38108
39477
|
...options.headers
|
|
38109
39478
|
}
|
|
38110
39479
|
});
|
|
38111
|
-
var
|
|
39480
|
+
var cutCreateRender = (options) => (options.client ?? client).post({
|
|
38112
39481
|
security: [{
|
|
38113
|
-
key: "
|
|
39482
|
+
key: "BearerAuth",
|
|
38114
39483
|
scheme: "bearer",
|
|
38115
39484
|
type: "http"
|
|
39485
|
+
}, {
|
|
39486
|
+
key: "ApiKeyAuth",
|
|
39487
|
+
name: "X-API-Key",
|
|
39488
|
+
type: "apiKey"
|
|
38116
39489
|
}],
|
|
38117
|
-
url: "/
|
|
39490
|
+
url: "/cut/v1/projects/{project_id}/renders",
|
|
38118
39491
|
...options,
|
|
38119
39492
|
headers: {
|
|
38120
39493
|
"Content-Type": "application/json",
|
|
38121
39494
|
...options.headers
|
|
38122
39495
|
}
|
|
38123
39496
|
});
|
|
38124
|
-
var
|
|
39497
|
+
var cutRetrieveRender = (options) => (options.client ?? client).get({
|
|
38125
39498
|
security: [{
|
|
38126
|
-
key: "
|
|
39499
|
+
key: "BearerAuth",
|
|
38127
39500
|
scheme: "bearer",
|
|
38128
39501
|
type: "http"
|
|
39502
|
+
}, {
|
|
39503
|
+
key: "ApiKeyAuth",
|
|
39504
|
+
name: "X-API-Key",
|
|
39505
|
+
type: "apiKey"
|
|
38129
39506
|
}],
|
|
38130
|
-
url: "/
|
|
39507
|
+
url: "/cut/v1/renders/{render_id}",
|
|
38131
39508
|
...options
|
|
38132
39509
|
});
|
|
38133
|
-
var
|
|
39510
|
+
var cutRetrieveExport = (options) => (options.client ?? client).get({
|
|
38134
39511
|
security: [{
|
|
38135
|
-
key: "
|
|
39512
|
+
key: "BearerAuth",
|
|
38136
39513
|
scheme: "bearer",
|
|
38137
39514
|
type: "http"
|
|
39515
|
+
}, {
|
|
39516
|
+
key: "ApiKeyAuth",
|
|
39517
|
+
name: "X-API-Key",
|
|
39518
|
+
type: "apiKey"
|
|
38138
39519
|
}],
|
|
38139
|
-
url: "/
|
|
39520
|
+
url: "/cut/v1/exports/{export_id}",
|
|
38140
39521
|
...options
|
|
38141
39522
|
});
|
|
38142
|
-
var
|
|
39523
|
+
var cutCancelExport = (options) => (options.client ?? client).post({
|
|
38143
39524
|
security: [{
|
|
38144
|
-
key: "
|
|
39525
|
+
key: "BearerAuth",
|
|
38145
39526
|
scheme: "bearer",
|
|
38146
39527
|
type: "http"
|
|
39528
|
+
}, {
|
|
39529
|
+
key: "ApiKeyAuth",
|
|
39530
|
+
name: "X-API-Key",
|
|
39531
|
+
type: "apiKey"
|
|
38147
39532
|
}],
|
|
38148
|
-
url: "/
|
|
38149
|
-
...options
|
|
38150
|
-
headers: {
|
|
38151
|
-
"Content-Type": "application/json",
|
|
38152
|
-
...options.headers
|
|
38153
|
-
}
|
|
39533
|
+
url: "/cut/v1/exports/{export_id}:cancel",
|
|
39534
|
+
...options
|
|
38154
39535
|
});
|
|
38155
|
-
var
|
|
39536
|
+
var cutListVersions = (options) => (options.client ?? client).get({
|
|
38156
39537
|
security: [{
|
|
38157
39538
|
key: "BearerAuth",
|
|
38158
39539
|
scheme: "bearer",
|
|
@@ -38162,10 +39543,10 @@ var cutListProjects = (options) => (options?.client ?? client).get({
|
|
|
38162
39543
|
name: "X-API-Key",
|
|
38163
39544
|
type: "apiKey"
|
|
38164
39545
|
}],
|
|
38165
|
-
url: "/cut/v1/projects",
|
|
39546
|
+
url: "/cut/v1/projects/{project_id}/versions",
|
|
38166
39547
|
...options
|
|
38167
39548
|
});
|
|
38168
|
-
var
|
|
39549
|
+
var cutCreateVersion = (options) => (options.client ?? client).post({
|
|
38169
39550
|
security: [{
|
|
38170
39551
|
key: "BearerAuth",
|
|
38171
39552
|
scheme: "bearer",
|
|
@@ -38175,14 +39556,14 @@ var cutCreateProject = (options) => (options.client ?? client).post({
|
|
|
38175
39556
|
name: "X-API-Key",
|
|
38176
39557
|
type: "apiKey"
|
|
38177
39558
|
}],
|
|
38178
|
-
url: "/cut/v1/projects",
|
|
39559
|
+
url: "/cut/v1/projects/{project_id}/versions",
|
|
38179
39560
|
...options,
|
|
38180
39561
|
headers: {
|
|
38181
39562
|
"Content-Type": "application/json",
|
|
38182
39563
|
...options.headers
|
|
38183
39564
|
}
|
|
38184
39565
|
});
|
|
38185
|
-
var
|
|
39566
|
+
var cutRestoreVersion = (options) => (options.client ?? client).post({
|
|
38186
39567
|
security: [{
|
|
38187
39568
|
key: "BearerAuth",
|
|
38188
39569
|
scheme: "bearer",
|
|
@@ -38192,724 +39573,754 @@ var cutDeleteProject = (options) => (options.client ?? client).delete({
|
|
|
38192
39573
|
name: "X-API-Key",
|
|
38193
39574
|
type: "apiKey"
|
|
38194
39575
|
}],
|
|
38195
|
-
url: "/cut/v1/
|
|
39576
|
+
url: "/cut/v1/versions/{version_id}:restore",
|
|
38196
39577
|
...options
|
|
38197
39578
|
});
|
|
38198
|
-
var
|
|
39579
|
+
var databaseListDatabases = (options) => (options?.client ?? client).get({
|
|
38199
39580
|
security: [{
|
|
38200
|
-
key: "
|
|
39581
|
+
key: "database-bearerAuth",
|
|
38201
39582
|
scheme: "bearer",
|
|
38202
39583
|
type: "http"
|
|
38203
|
-
}, {
|
|
38204
|
-
key: "ApiKeyAuth",
|
|
38205
|
-
name: "X-API-Key",
|
|
38206
|
-
type: "apiKey"
|
|
38207
39584
|
}],
|
|
38208
|
-
url: "/
|
|
39585
|
+
url: "/database/v1/databases",
|
|
38209
39586
|
...options
|
|
38210
39587
|
});
|
|
38211
|
-
var
|
|
39588
|
+
var databaseCreateDatabase = (options) => (options.client ?? client).post({
|
|
38212
39589
|
security: [{
|
|
38213
|
-
key: "
|
|
39590
|
+
key: "database-bearerAuth",
|
|
38214
39591
|
scheme: "bearer",
|
|
38215
39592
|
type: "http"
|
|
38216
|
-
}, {
|
|
38217
|
-
key: "ApiKeyAuth",
|
|
38218
|
-
name: "X-API-Key",
|
|
38219
|
-
type: "apiKey"
|
|
38220
39593
|
}],
|
|
38221
|
-
url: "/
|
|
39594
|
+
url: "/database/v1/databases",
|
|
38222
39595
|
...options,
|
|
38223
39596
|
headers: {
|
|
38224
39597
|
"Content-Type": "application/json",
|
|
38225
39598
|
...options.headers
|
|
38226
39599
|
}
|
|
38227
39600
|
});
|
|
38228
|
-
var
|
|
39601
|
+
var databaseDeleteDatabase = (options) => (options.client ?? client).delete({
|
|
38229
39602
|
security: [{
|
|
38230
|
-
key: "
|
|
39603
|
+
key: "database-bearerAuth",
|
|
39604
|
+
scheme: "bearer",
|
|
39605
|
+
type: "http"
|
|
39606
|
+
}],
|
|
39607
|
+
url: "/database/v1/databases/{database_id}",
|
|
39608
|
+
...options
|
|
39609
|
+
});
|
|
39610
|
+
var databaseGetDatabase = (options) => (options.client ?? client).get({
|
|
39611
|
+
security: [{
|
|
39612
|
+
key: "database-bearerAuth",
|
|
39613
|
+
scheme: "bearer",
|
|
39614
|
+
type: "http"
|
|
39615
|
+
}],
|
|
39616
|
+
url: "/database/v1/databases/{database_id}",
|
|
39617
|
+
...options
|
|
39618
|
+
});
|
|
39619
|
+
var databaseUpdateDatabase = (options) => (options.client ?? client).patch({
|
|
39620
|
+
security: [{
|
|
39621
|
+
key: "database-bearerAuth",
|
|
39622
|
+
scheme: "bearer",
|
|
39623
|
+
type: "http"
|
|
39624
|
+
}],
|
|
39625
|
+
url: "/database/v1/databases/{database_id}",
|
|
39626
|
+
...options,
|
|
39627
|
+
headers: {
|
|
39628
|
+
"Content-Type": "application/json",
|
|
39629
|
+
...options.headers
|
|
39630
|
+
}
|
|
39631
|
+
});
|
|
39632
|
+
var databaseRestoreDatabase = (options) => (options.client ?? client).post({
|
|
39633
|
+
security: [{
|
|
39634
|
+
key: "database-bearerAuth",
|
|
39635
|
+
scheme: "bearer",
|
|
39636
|
+
type: "http"
|
|
39637
|
+
}],
|
|
39638
|
+
url: "/database/v1/databases/{database_id}/restore",
|
|
39639
|
+
...options
|
|
39640
|
+
});
|
|
39641
|
+
var databasePurgeDatabase = (options) => (options.client ?? client).post({
|
|
39642
|
+
security: [{
|
|
39643
|
+
key: "database-bearerAuth",
|
|
39644
|
+
scheme: "bearer",
|
|
39645
|
+
type: "http"
|
|
39646
|
+
}],
|
|
39647
|
+
url: "/database/v1/databases/{database_id}/purge",
|
|
39648
|
+
...options
|
|
39649
|
+
});
|
|
39650
|
+
var databaseListTables = (options) => (options.client ?? client).get({
|
|
39651
|
+
security: [{
|
|
39652
|
+
key: "database-bearerAuth",
|
|
38231
39653
|
scheme: "bearer",
|
|
38232
39654
|
type: "http"
|
|
38233
|
-
}, {
|
|
38234
|
-
key: "ApiKeyAuth",
|
|
38235
|
-
name: "X-API-Key",
|
|
38236
|
-
type: "apiKey"
|
|
38237
39655
|
}],
|
|
38238
|
-
url: "/
|
|
39656
|
+
url: "/database/v1/databases/{database_id}/tables",
|
|
38239
39657
|
...options
|
|
38240
39658
|
});
|
|
38241
|
-
var
|
|
39659
|
+
var databaseCreateTable = (options) => (options.client ?? client).post({
|
|
38242
39660
|
security: [{
|
|
38243
|
-
key: "
|
|
39661
|
+
key: "database-bearerAuth",
|
|
38244
39662
|
scheme: "bearer",
|
|
38245
39663
|
type: "http"
|
|
38246
|
-
}, {
|
|
38247
|
-
key: "ApiKeyAuth",
|
|
38248
|
-
name: "X-API-Key",
|
|
38249
|
-
type: "apiKey"
|
|
38250
39664
|
}],
|
|
38251
|
-
url: "/
|
|
39665
|
+
url: "/database/v1/databases/{database_id}/tables",
|
|
38252
39666
|
...options,
|
|
38253
39667
|
headers: {
|
|
38254
39668
|
"Content-Type": "application/json",
|
|
38255
39669
|
...options.headers
|
|
38256
39670
|
}
|
|
38257
39671
|
});
|
|
38258
|
-
var
|
|
39672
|
+
var databaseDeleteTable = (options) => (options.client ?? client).delete({
|
|
38259
39673
|
security: [{
|
|
38260
|
-
key: "
|
|
39674
|
+
key: "database-bearerAuth",
|
|
38261
39675
|
scheme: "bearer",
|
|
38262
39676
|
type: "http"
|
|
38263
|
-
}, {
|
|
38264
|
-
key: "ApiKeyAuth",
|
|
38265
|
-
name: "X-API-Key",
|
|
38266
|
-
type: "apiKey"
|
|
38267
39677
|
}],
|
|
38268
|
-
url: "/
|
|
39678
|
+
url: "/database/v1/databases/{database_id}/tables/{table}",
|
|
38269
39679
|
...options
|
|
38270
39680
|
});
|
|
38271
|
-
var
|
|
39681
|
+
var databaseGetTable = (options) => (options.client ?? client).get({
|
|
38272
39682
|
security: [{
|
|
38273
|
-
key: "
|
|
39683
|
+
key: "database-bearerAuth",
|
|
38274
39684
|
scheme: "bearer",
|
|
38275
39685
|
type: "http"
|
|
38276
|
-
}, {
|
|
38277
|
-
key: "ApiKeyAuth",
|
|
38278
|
-
name: "X-API-Key",
|
|
38279
|
-
type: "apiKey"
|
|
38280
39686
|
}],
|
|
38281
|
-
url: "/
|
|
39687
|
+
url: "/database/v1/databases/{database_id}/tables/{table}",
|
|
38282
39688
|
...options
|
|
38283
39689
|
});
|
|
38284
|
-
var
|
|
39690
|
+
var databaseUpdateTable = (options) => (options.client ?? client).patch({
|
|
38285
39691
|
security: [{
|
|
38286
|
-
key: "
|
|
39692
|
+
key: "database-bearerAuth",
|
|
38287
39693
|
scheme: "bearer",
|
|
38288
39694
|
type: "http"
|
|
38289
|
-
}, {
|
|
38290
|
-
key: "ApiKeyAuth",
|
|
38291
|
-
name: "X-API-Key",
|
|
38292
|
-
type: "apiKey"
|
|
38293
39695
|
}],
|
|
38294
|
-
url: "/
|
|
38295
|
-
...options
|
|
39696
|
+
url: "/database/v1/databases/{database_id}/tables/{table}",
|
|
39697
|
+
...options,
|
|
39698
|
+
headers: {
|
|
39699
|
+
"Content-Type": "application/json",
|
|
39700
|
+
...options.headers
|
|
39701
|
+
}
|
|
38296
39702
|
});
|
|
38297
|
-
var
|
|
39703
|
+
var databaseAddField = (options) => (options.client ?? client).post({
|
|
38298
39704
|
security: [{
|
|
38299
|
-
key: "
|
|
39705
|
+
key: "database-bearerAuth",
|
|
38300
39706
|
scheme: "bearer",
|
|
38301
39707
|
type: "http"
|
|
38302
|
-
}, {
|
|
38303
|
-
key: "ApiKeyAuth",
|
|
38304
|
-
name: "X-API-Key",
|
|
38305
|
-
type: "apiKey"
|
|
38306
39708
|
}],
|
|
38307
|
-
url: "/
|
|
39709
|
+
url: "/database/v1/databases/{database_id}/tables/{table}/fields",
|
|
38308
39710
|
...options,
|
|
38309
39711
|
headers: {
|
|
38310
39712
|
"Content-Type": "application/json",
|
|
38311
39713
|
...options.headers
|
|
38312
39714
|
}
|
|
38313
39715
|
});
|
|
38314
|
-
var
|
|
39716
|
+
var databaseDeleteField = (options) => (options.client ?? client).delete({
|
|
38315
39717
|
security: [{
|
|
38316
|
-
key: "
|
|
39718
|
+
key: "database-bearerAuth",
|
|
38317
39719
|
scheme: "bearer",
|
|
38318
39720
|
type: "http"
|
|
38319
|
-
}, {
|
|
38320
|
-
key: "ApiKeyAuth",
|
|
38321
|
-
name: "X-API-Key",
|
|
38322
|
-
type: "apiKey"
|
|
38323
39721
|
}],
|
|
38324
|
-
url: "/
|
|
39722
|
+
url: "/database/v1/databases/{database_id}/tables/{table}/fields/{field}",
|
|
38325
39723
|
...options
|
|
38326
39724
|
});
|
|
38327
|
-
var
|
|
39725
|
+
var databaseUpdateField = (options) => (options.client ?? client).patch({
|
|
38328
39726
|
security: [{
|
|
38329
|
-
key: "
|
|
39727
|
+
key: "database-bearerAuth",
|
|
38330
39728
|
scheme: "bearer",
|
|
38331
39729
|
type: "http"
|
|
38332
|
-
}, {
|
|
38333
|
-
key: "ApiKeyAuth",
|
|
38334
|
-
name: "X-API-Key",
|
|
38335
|
-
type: "apiKey"
|
|
38336
39730
|
}],
|
|
38337
|
-
url: "/
|
|
39731
|
+
url: "/database/v1/databases/{database_id}/tables/{table}/fields/{field}",
|
|
38338
39732
|
...options,
|
|
38339
39733
|
headers: {
|
|
38340
39734
|
"Content-Type": "application/json",
|
|
38341
39735
|
...options.headers
|
|
38342
39736
|
}
|
|
38343
39737
|
});
|
|
38344
|
-
var
|
|
39738
|
+
var databaseListEvents = (options) => (options.client ?? client).get({
|
|
38345
39739
|
security: [{
|
|
38346
|
-
key: "
|
|
39740
|
+
key: "database-bearerAuth",
|
|
38347
39741
|
scheme: "bearer",
|
|
38348
39742
|
type: "http"
|
|
38349
|
-
}, {
|
|
38350
|
-
key: "ApiKeyAuth",
|
|
38351
|
-
name: "X-API-Key",
|
|
38352
|
-
type: "apiKey"
|
|
38353
39743
|
}],
|
|
38354
|
-
url: "/
|
|
39744
|
+
url: "/database/v1/databases/{database_id}/events",
|
|
38355
39745
|
...options
|
|
38356
39746
|
});
|
|
38357
|
-
var
|
|
39747
|
+
var databaseDelete = (options) => (options.client ?? client).delete({
|
|
38358
39748
|
security: [{
|
|
38359
|
-
key: "
|
|
39749
|
+
key: "database-bearerAuth",
|
|
38360
39750
|
scheme: "bearer",
|
|
38361
39751
|
type: "http"
|
|
38362
|
-
}, {
|
|
38363
|
-
key: "ApiKeyAuth",
|
|
38364
|
-
name: "X-API-Key",
|
|
38365
|
-
type: "apiKey"
|
|
38366
39752
|
}],
|
|
38367
|
-
url: "/
|
|
38368
|
-
...options
|
|
38369
|
-
headers: {
|
|
38370
|
-
"Content-Type": "application/json",
|
|
38371
|
-
...options.headers
|
|
38372
|
-
}
|
|
39753
|
+
url: "/database/v1/databases/{database_id}/rest/{table}",
|
|
39754
|
+
...options
|
|
38373
39755
|
});
|
|
38374
|
-
var
|
|
39756
|
+
var databaseSelect = (options) => (options.client ?? client).get({
|
|
38375
39757
|
security: [{
|
|
38376
|
-
key: "
|
|
39758
|
+
key: "database-bearerAuth",
|
|
38377
39759
|
scheme: "bearer",
|
|
38378
39760
|
type: "http"
|
|
38379
|
-
}, {
|
|
38380
|
-
key: "ApiKeyAuth",
|
|
38381
|
-
name: "X-API-Key",
|
|
38382
|
-
type: "apiKey"
|
|
38383
39761
|
}],
|
|
38384
|
-
url: "/
|
|
39762
|
+
url: "/database/v1/databases/{database_id}/rest/{table}",
|
|
38385
39763
|
...options
|
|
38386
39764
|
});
|
|
38387
|
-
var
|
|
39765
|
+
var databaseHead = (options) => (options.client ?? client).head({
|
|
38388
39766
|
security: [{
|
|
38389
|
-
key: "
|
|
39767
|
+
key: "database-bearerAuth",
|
|
38390
39768
|
scheme: "bearer",
|
|
38391
39769
|
type: "http"
|
|
38392
|
-
}, {
|
|
38393
|
-
key: "ApiKeyAuth",
|
|
38394
|
-
name: "X-API-Key",
|
|
38395
|
-
type: "apiKey"
|
|
38396
39770
|
}],
|
|
38397
|
-
url: "/
|
|
39771
|
+
url: "/database/v1/databases/{database_id}/rest/{table}",
|
|
39772
|
+
...options
|
|
39773
|
+
});
|
|
39774
|
+
var databaseUpdate = (options) => (options.client ?? client).patch({
|
|
39775
|
+
security: [{
|
|
39776
|
+
key: "database-bearerAuth",
|
|
39777
|
+
scheme: "bearer",
|
|
39778
|
+
type: "http"
|
|
39779
|
+
}],
|
|
39780
|
+
url: "/database/v1/databases/{database_id}/rest/{table}",
|
|
38398
39781
|
...options,
|
|
38399
39782
|
headers: {
|
|
38400
39783
|
"Content-Type": "application/json",
|
|
38401
39784
|
...options.headers
|
|
38402
39785
|
}
|
|
38403
39786
|
});
|
|
38404
|
-
var
|
|
39787
|
+
var databaseInsert = (options) => (options.client ?? client).post({
|
|
38405
39788
|
security: [{
|
|
38406
|
-
key: "
|
|
39789
|
+
key: "database-bearerAuth",
|
|
38407
39790
|
scheme: "bearer",
|
|
38408
39791
|
type: "http"
|
|
38409
|
-
}, {
|
|
38410
|
-
key: "ApiKeyAuth",
|
|
38411
|
-
name: "X-API-Key",
|
|
38412
|
-
type: "apiKey"
|
|
38413
39792
|
}],
|
|
38414
|
-
url: "/
|
|
39793
|
+
url: "/database/v1/databases/{database_id}/rest/{table}",
|
|
38415
39794
|
...options,
|
|
38416
39795
|
headers: {
|
|
38417
39796
|
"Content-Type": "application/json",
|
|
38418
39797
|
...options.headers
|
|
38419
39798
|
}
|
|
38420
39799
|
});
|
|
38421
|
-
var
|
|
39800
|
+
var devopsTestCatalogGet = (options) => (options.client ?? client).get({
|
|
38422
39801
|
security: [{
|
|
38423
|
-
key: "
|
|
39802
|
+
key: "devops-bearerAuth",
|
|
38424
39803
|
scheme: "bearer",
|
|
38425
39804
|
type: "http"
|
|
38426
|
-
}, {
|
|
38427
|
-
key: "ApiKeyAuth",
|
|
38428
|
-
name: "X-API-Key",
|
|
38429
|
-
type: "apiKey"
|
|
38430
39805
|
}],
|
|
38431
|
-
url: "/
|
|
39806
|
+
url: "/devops/v1/projects/{project}/test-catalog",
|
|
38432
39807
|
...options
|
|
38433
39808
|
});
|
|
38434
|
-
var
|
|
39809
|
+
var devopsTestSuitesList = (options) => (options.client ?? client).get({
|
|
38435
39810
|
security: [{
|
|
38436
|
-
key: "
|
|
39811
|
+
key: "devops-bearerAuth",
|
|
38437
39812
|
scheme: "bearer",
|
|
38438
39813
|
type: "http"
|
|
38439
|
-
}, {
|
|
38440
|
-
key: "ApiKeyAuth",
|
|
38441
|
-
name: "X-API-Key",
|
|
38442
|
-
type: "apiKey"
|
|
38443
39814
|
}],
|
|
38444
|
-
url: "/
|
|
39815
|
+
url: "/devops/v1/projects/{project}/test-suites",
|
|
38445
39816
|
...options
|
|
38446
39817
|
});
|
|
38447
|
-
var
|
|
39818
|
+
var devopsTestSuitesGet = (options) => (options.client ?? client).get({
|
|
38448
39819
|
security: [{
|
|
38449
|
-
key: "
|
|
39820
|
+
key: "devops-bearerAuth",
|
|
38450
39821
|
scheme: "bearer",
|
|
38451
39822
|
type: "http"
|
|
38452
|
-
}, {
|
|
38453
|
-
key: "ApiKeyAuth",
|
|
38454
|
-
name: "X-API-Key",
|
|
38455
|
-
type: "apiKey"
|
|
38456
39823
|
}],
|
|
38457
|
-
url: "/
|
|
39824
|
+
url: "/devops/v1/test-suites/{id}",
|
|
38458
39825
|
...options
|
|
38459
39826
|
});
|
|
38460
|
-
var
|
|
39827
|
+
var devopsTestCasesList = (options) => (options.client ?? client).get({
|
|
38461
39828
|
security: [{
|
|
38462
|
-
key: "
|
|
39829
|
+
key: "devops-bearerAuth",
|
|
38463
39830
|
scheme: "bearer",
|
|
38464
39831
|
type: "http"
|
|
38465
|
-
}, {
|
|
38466
|
-
key: "ApiKeyAuth",
|
|
38467
|
-
name: "X-API-Key",
|
|
38468
|
-
type: "apiKey"
|
|
38469
39832
|
}],
|
|
38470
|
-
url: "/
|
|
39833
|
+
url: "/devops/v1/projects/{project}/test-cases",
|
|
38471
39834
|
...options
|
|
38472
39835
|
});
|
|
38473
|
-
var
|
|
39836
|
+
var devopsTestCasesGet = (options) => (options.client ?? client).get({
|
|
38474
39837
|
security: [{
|
|
38475
|
-
key: "
|
|
39838
|
+
key: "devops-bearerAuth",
|
|
38476
39839
|
scheme: "bearer",
|
|
38477
39840
|
type: "http"
|
|
38478
|
-
}, {
|
|
38479
|
-
key: "ApiKeyAuth",
|
|
38480
|
-
name: "X-API-Key",
|
|
38481
|
-
type: "apiKey"
|
|
38482
39841
|
}],
|
|
38483
|
-
url: "/
|
|
39842
|
+
url: "/devops/v1/test-cases/{id}",
|
|
39843
|
+
...options
|
|
39844
|
+
});
|
|
39845
|
+
var devopsTestPlansList = (options) => (options.client ?? client).get({
|
|
39846
|
+
security: [{
|
|
39847
|
+
key: "devops-bearerAuth",
|
|
39848
|
+
scheme: "bearer",
|
|
39849
|
+
type: "http"
|
|
39850
|
+
}],
|
|
39851
|
+
url: "/devops/v1/projects/{project}/test-plans",
|
|
39852
|
+
...options
|
|
39853
|
+
});
|
|
39854
|
+
var devopsTestPlansCreate = (options) => (options.client ?? client).post({
|
|
39855
|
+
security: [{
|
|
39856
|
+
key: "devops-bearerAuth",
|
|
39857
|
+
scheme: "bearer",
|
|
39858
|
+
type: "http"
|
|
39859
|
+
}],
|
|
39860
|
+
url: "/devops/v1/projects/{project}/test-plans",
|
|
38484
39861
|
...options,
|
|
38485
39862
|
headers: {
|
|
38486
39863
|
"Content-Type": "application/json",
|
|
38487
39864
|
...options.headers
|
|
38488
39865
|
}
|
|
38489
39866
|
});
|
|
38490
|
-
var
|
|
39867
|
+
var devopsTestPlansDelete = (options) => (options.client ?? client).delete({
|
|
38491
39868
|
security: [{
|
|
38492
|
-
key: "
|
|
39869
|
+
key: "devops-bearerAuth",
|
|
38493
39870
|
scheme: "bearer",
|
|
38494
39871
|
type: "http"
|
|
38495
|
-
}, {
|
|
38496
|
-
key: "ApiKeyAuth",
|
|
38497
|
-
name: "X-API-Key",
|
|
38498
|
-
type: "apiKey"
|
|
38499
39872
|
}],
|
|
38500
|
-
url: "/
|
|
39873
|
+
url: "/devops/v1/test-plans/{id}",
|
|
38501
39874
|
...options
|
|
38502
39875
|
});
|
|
38503
|
-
var
|
|
39876
|
+
var devopsTestPlansGet = (options) => (options.client ?? client).get({
|
|
38504
39877
|
security: [{
|
|
38505
|
-
key: "
|
|
39878
|
+
key: "devops-bearerAuth",
|
|
38506
39879
|
scheme: "bearer",
|
|
38507
39880
|
type: "http"
|
|
38508
39881
|
}],
|
|
38509
|
-
url: "/
|
|
39882
|
+
url: "/devops/v1/test-plans/{id}",
|
|
38510
39883
|
...options
|
|
38511
39884
|
});
|
|
38512
|
-
var
|
|
39885
|
+
var devopsTestPlansUpdate = (options) => (options.client ?? client).patch({
|
|
38513
39886
|
security: [{
|
|
38514
|
-
key: "
|
|
39887
|
+
key: "devops-bearerAuth",
|
|
38515
39888
|
scheme: "bearer",
|
|
38516
39889
|
type: "http"
|
|
38517
39890
|
}],
|
|
38518
|
-
url: "/
|
|
39891
|
+
url: "/devops/v1/test-plans/{id}",
|
|
38519
39892
|
...options,
|
|
38520
39893
|
headers: {
|
|
38521
39894
|
"Content-Type": "application/json",
|
|
38522
39895
|
...options.headers
|
|
38523
39896
|
}
|
|
38524
39897
|
});
|
|
38525
|
-
var
|
|
39898
|
+
var devopsTestPlansPause = (options) => (options.client ?? client).post({
|
|
38526
39899
|
security: [{
|
|
38527
|
-
key: "
|
|
39900
|
+
key: "devops-bearerAuth",
|
|
38528
39901
|
scheme: "bearer",
|
|
38529
39902
|
type: "http"
|
|
38530
39903
|
}],
|
|
38531
|
-
url: "/
|
|
39904
|
+
url: "/devops/v1/test-plans/{id}:pause",
|
|
39905
|
+
...options,
|
|
39906
|
+
headers: {
|
|
39907
|
+
"Content-Type": "application/json",
|
|
39908
|
+
...options.headers
|
|
39909
|
+
}
|
|
39910
|
+
});
|
|
39911
|
+
var devopsTestPlansResume = (options) => (options.client ?? client).post({
|
|
39912
|
+
security: [{
|
|
39913
|
+
key: "devops-bearerAuth",
|
|
39914
|
+
scheme: "bearer",
|
|
39915
|
+
type: "http"
|
|
39916
|
+
}],
|
|
39917
|
+
url: "/devops/v1/test-plans/{id}:resume",
|
|
38532
39918
|
...options
|
|
38533
39919
|
});
|
|
38534
|
-
var
|
|
39920
|
+
var devopsTestRunsList = (options) => (options.client ?? client).get({
|
|
38535
39921
|
security: [{
|
|
38536
|
-
key: "
|
|
39922
|
+
key: "devops-bearerAuth",
|
|
38537
39923
|
scheme: "bearer",
|
|
38538
39924
|
type: "http"
|
|
38539
39925
|
}],
|
|
38540
|
-
url: "/
|
|
39926
|
+
url: "/devops/v1/projects/{project}/test-runs",
|
|
38541
39927
|
...options
|
|
38542
39928
|
});
|
|
38543
|
-
var
|
|
39929
|
+
var devopsTestRunsCreate = (options) => (options.client ?? client).post({
|
|
38544
39930
|
security: [{
|
|
38545
|
-
key: "
|
|
39931
|
+
key: "devops-bearerAuth",
|
|
38546
39932
|
scheme: "bearer",
|
|
38547
39933
|
type: "http"
|
|
38548
39934
|
}],
|
|
38549
|
-
url: "/
|
|
39935
|
+
url: "/devops/v1/projects/{project}/test-runs",
|
|
38550
39936
|
...options,
|
|
38551
39937
|
headers: {
|
|
38552
39938
|
"Content-Type": "application/json",
|
|
38553
39939
|
...options.headers
|
|
38554
39940
|
}
|
|
38555
39941
|
});
|
|
38556
|
-
var
|
|
39942
|
+
var devopsTestRunsGet = (options) => (options.client ?? client).get({
|
|
38557
39943
|
security: [{
|
|
38558
|
-
key: "
|
|
39944
|
+
key: "devops-bearerAuth",
|
|
38559
39945
|
scheme: "bearer",
|
|
38560
39946
|
type: "http"
|
|
38561
39947
|
}],
|
|
38562
|
-
url: "/
|
|
39948
|
+
url: "/devops/v1/test-runs/{id}",
|
|
38563
39949
|
...options
|
|
38564
39950
|
});
|
|
38565
|
-
var
|
|
39951
|
+
var devopsTestRunsCancel = (options) => (options.client ?? client).post({
|
|
38566
39952
|
security: [{
|
|
38567
|
-
key: "
|
|
39953
|
+
key: "devops-bearerAuth",
|
|
38568
39954
|
scheme: "bearer",
|
|
38569
39955
|
type: "http"
|
|
38570
39956
|
}],
|
|
38571
|
-
url: "/
|
|
39957
|
+
url: "/devops/v1/test-runs/{id}:cancel",
|
|
39958
|
+
...options,
|
|
39959
|
+
headers: {
|
|
39960
|
+
"Content-Type": "application/json",
|
|
39961
|
+
...options.headers
|
|
39962
|
+
}
|
|
39963
|
+
});
|
|
39964
|
+
var devopsTestExecutionsList = (options) => (options.client ?? client).get({
|
|
39965
|
+
security: [{
|
|
39966
|
+
key: "devops-bearerAuth",
|
|
39967
|
+
scheme: "bearer",
|
|
39968
|
+
type: "http"
|
|
39969
|
+
}],
|
|
39970
|
+
url: "/devops/v1/test-runs/{run}/executions",
|
|
38572
39971
|
...options
|
|
38573
39972
|
});
|
|
38574
|
-
var
|
|
39973
|
+
var devopsTestExecutionsGet = (options) => (options.client ?? client).get({
|
|
38575
39974
|
security: [{
|
|
38576
|
-
key: "
|
|
39975
|
+
key: "devops-bearerAuth",
|
|
38577
39976
|
scheme: "bearer",
|
|
38578
39977
|
type: "http"
|
|
38579
39978
|
}],
|
|
38580
|
-
url: "/
|
|
39979
|
+
url: "/devops/v1/test-runs/{run}/executions/{case}",
|
|
38581
39980
|
...options
|
|
38582
39981
|
});
|
|
38583
|
-
var
|
|
39982
|
+
var devopsTestReportsUpload = (options) => (options.client ?? client).post({
|
|
38584
39983
|
security: [{
|
|
38585
|
-
key: "
|
|
39984
|
+
key: "devops-bearerAuth",
|
|
38586
39985
|
scheme: "bearer",
|
|
38587
39986
|
type: "http"
|
|
38588
39987
|
}],
|
|
38589
|
-
url: "/
|
|
39988
|
+
url: "/devops/v1/projects/{project}/test-reports",
|
|
38590
39989
|
...options,
|
|
38591
39990
|
headers: {
|
|
38592
39991
|
"Content-Type": "application/json",
|
|
38593
39992
|
...options.headers
|
|
38594
39993
|
}
|
|
38595
39994
|
});
|
|
38596
|
-
var
|
|
39995
|
+
var devopsProjectsList = (options) => (options?.client ?? client).get({
|
|
38597
39996
|
security: [{
|
|
38598
|
-
key: "
|
|
39997
|
+
key: "devops-bearerAuth",
|
|
38599
39998
|
scheme: "bearer",
|
|
38600
39999
|
type: "http"
|
|
38601
40000
|
}],
|
|
38602
|
-
url: "/
|
|
40001
|
+
url: "/devops/v1/projects",
|
|
38603
40002
|
...options
|
|
38604
40003
|
});
|
|
38605
|
-
var
|
|
40004
|
+
var devopsProjectsGet = (options) => (options.client ?? client).get({
|
|
38606
40005
|
security: [{
|
|
38607
|
-
key: "
|
|
40006
|
+
key: "devops-bearerAuth",
|
|
38608
40007
|
scheme: "bearer",
|
|
38609
40008
|
type: "http"
|
|
38610
40009
|
}],
|
|
38611
|
-
url: "/
|
|
40010
|
+
url: "/devops/v1/projects/{id}",
|
|
38612
40011
|
...options
|
|
38613
40012
|
});
|
|
38614
|
-
var
|
|
40013
|
+
var devopsReleasesList = (options) => (options.client ?? client).get({
|
|
38615
40014
|
security: [{
|
|
38616
|
-
key: "
|
|
40015
|
+
key: "devops-bearerAuth",
|
|
38617
40016
|
scheme: "bearer",
|
|
38618
40017
|
type: "http"
|
|
38619
40018
|
}],
|
|
38620
|
-
url: "/
|
|
38621
|
-
...options
|
|
38622
|
-
headers: {
|
|
38623
|
-
"Content-Type": "application/json",
|
|
38624
|
-
...options.headers
|
|
38625
|
-
}
|
|
40019
|
+
url: "/devops/v1/projects/{project}/releases",
|
|
40020
|
+
...options
|
|
38626
40021
|
});
|
|
38627
|
-
var
|
|
40022
|
+
var devopsReleasesCreate = (options) => (options.client ?? client).post({
|
|
38628
40023
|
security: [{
|
|
38629
|
-
key: "
|
|
40024
|
+
key: "devops-bearerAuth",
|
|
38630
40025
|
scheme: "bearer",
|
|
38631
40026
|
type: "http"
|
|
38632
40027
|
}],
|
|
38633
|
-
url: "/
|
|
40028
|
+
url: "/devops/v1/projects/{project}/releases",
|
|
38634
40029
|
...options,
|
|
38635
40030
|
headers: {
|
|
38636
40031
|
"Content-Type": "application/json",
|
|
38637
40032
|
...options.headers
|
|
38638
40033
|
}
|
|
38639
40034
|
});
|
|
38640
|
-
var
|
|
40035
|
+
var devopsReleasesGet = (options) => (options.client ?? client).get({
|
|
38641
40036
|
security: [{
|
|
38642
|
-
key: "
|
|
40037
|
+
key: "devops-bearerAuth",
|
|
38643
40038
|
scheme: "bearer",
|
|
38644
40039
|
type: "http"
|
|
38645
40040
|
}],
|
|
38646
|
-
url: "/
|
|
40041
|
+
url: "/devops/v1/releases/{id}",
|
|
38647
40042
|
...options
|
|
38648
40043
|
});
|
|
38649
|
-
var
|
|
40044
|
+
var devopsReleasesAbandon = (options) => (options.client ?? client).post({
|
|
38650
40045
|
security: [{
|
|
38651
|
-
key: "
|
|
40046
|
+
key: "devops-bearerAuth",
|
|
38652
40047
|
scheme: "bearer",
|
|
38653
40048
|
type: "http"
|
|
38654
40049
|
}],
|
|
38655
|
-
url: "/
|
|
40050
|
+
url: "/devops/v1/releases/{id}:abandon",
|
|
38656
40051
|
...options,
|
|
38657
40052
|
headers: {
|
|
38658
40053
|
"Content-Type": "application/json",
|
|
38659
40054
|
...options.headers
|
|
38660
40055
|
}
|
|
38661
40056
|
});
|
|
38662
|
-
var
|
|
38663
|
-
security: [{
|
|
38664
|
-
key: "database-bearerAuth",
|
|
38665
|
-
scheme: "bearer",
|
|
38666
|
-
type: "http"
|
|
38667
|
-
}],
|
|
38668
|
-
url: "/database/v1/databases/{database_id}/events",
|
|
38669
|
-
...options
|
|
38670
|
-
});
|
|
38671
|
-
var databaseDelete = (options) => (options.client ?? client).delete({
|
|
40057
|
+
var devopsPromotionsCreate = (options) => (options.client ?? client).post({
|
|
38672
40058
|
security: [{
|
|
38673
|
-
key: "
|
|
40059
|
+
key: "devops-bearerAuth",
|
|
38674
40060
|
scheme: "bearer",
|
|
38675
40061
|
type: "http"
|
|
38676
40062
|
}],
|
|
38677
|
-
url: "/
|
|
38678
|
-
...options
|
|
40063
|
+
url: "/devops/v1/promotions",
|
|
40064
|
+
...options,
|
|
40065
|
+
headers: {
|
|
40066
|
+
"Content-Type": "application/json",
|
|
40067
|
+
...options.headers
|
|
40068
|
+
}
|
|
38679
40069
|
});
|
|
38680
|
-
var
|
|
40070
|
+
var devopsPromotionsList = (options) => (options.client ?? client).get({
|
|
38681
40071
|
security: [{
|
|
38682
|
-
key: "
|
|
40072
|
+
key: "devops-bearerAuth",
|
|
38683
40073
|
scheme: "bearer",
|
|
38684
40074
|
type: "http"
|
|
38685
40075
|
}],
|
|
38686
|
-
url: "/
|
|
40076
|
+
url: "/devops/v1/projects/{project}/promotions",
|
|
38687
40077
|
...options
|
|
38688
40078
|
});
|
|
38689
|
-
var
|
|
40079
|
+
var devopsPromotionsGet = (options) => (options.client ?? client).get({
|
|
38690
40080
|
security: [{
|
|
38691
|
-
key: "
|
|
40081
|
+
key: "devops-bearerAuth",
|
|
38692
40082
|
scheme: "bearer",
|
|
38693
40083
|
type: "http"
|
|
38694
40084
|
}],
|
|
38695
|
-
url: "/
|
|
40085
|
+
url: "/devops/v1/promotions/{id}",
|
|
38696
40086
|
...options
|
|
38697
40087
|
});
|
|
38698
|
-
var
|
|
40088
|
+
var devopsPromotionsApprove = (options) => (options.client ?? client).post({
|
|
38699
40089
|
security: [{
|
|
38700
|
-
key: "
|
|
40090
|
+
key: "devops-bearerAuth",
|
|
38701
40091
|
scheme: "bearer",
|
|
38702
40092
|
type: "http"
|
|
38703
40093
|
}],
|
|
38704
|
-
url: "/
|
|
40094
|
+
url: "/devops/v1/promotions/{id}:approve",
|
|
38705
40095
|
...options,
|
|
38706
40096
|
headers: {
|
|
38707
40097
|
"Content-Type": "application/json",
|
|
38708
40098
|
...options.headers
|
|
38709
40099
|
}
|
|
38710
40100
|
});
|
|
38711
|
-
var
|
|
40101
|
+
var devopsPromotionsCancel = (options) => (options.client ?? client).post({
|
|
38712
40102
|
security: [{
|
|
38713
|
-
key: "
|
|
40103
|
+
key: "devops-bearerAuth",
|
|
38714
40104
|
scheme: "bearer",
|
|
38715
40105
|
type: "http"
|
|
38716
40106
|
}],
|
|
38717
|
-
url: "/
|
|
40107
|
+
url: "/devops/v1/promotions/{id}:cancel",
|
|
38718
40108
|
...options,
|
|
38719
40109
|
headers: {
|
|
38720
40110
|
"Content-Type": "application/json",
|
|
38721
40111
|
...options.headers
|
|
38722
40112
|
}
|
|
38723
40113
|
});
|
|
38724
|
-
var
|
|
40114
|
+
var devopsPromotionsRetry = (options) => (options.client ?? client).post({
|
|
38725
40115
|
security: [{
|
|
38726
40116
|
key: "devops-bearerAuth",
|
|
38727
40117
|
scheme: "bearer",
|
|
38728
40118
|
type: "http"
|
|
38729
40119
|
}],
|
|
38730
|
-
url: "/devops/v1/
|
|
40120
|
+
url: "/devops/v1/promotions/{id}:retry",
|
|
38731
40121
|
...options
|
|
38732
40122
|
});
|
|
38733
|
-
var
|
|
40123
|
+
var devopsPromotionsConclude = (options) => (options.client ?? client).post({
|
|
38734
40124
|
security: [{
|
|
38735
40125
|
key: "devops-bearerAuth",
|
|
38736
40126
|
scheme: "bearer",
|
|
38737
40127
|
type: "http"
|
|
38738
40128
|
}],
|
|
38739
|
-
url: "/devops/v1/
|
|
40129
|
+
url: "/devops/v1/promotions/{id}:conclude",
|
|
40130
|
+
...options,
|
|
40131
|
+
headers: {
|
|
40132
|
+
"Content-Type": "application/json",
|
|
40133
|
+
...options.headers
|
|
40134
|
+
}
|
|
40135
|
+
});
|
|
40136
|
+
var devopsRolloutsList = (options) => (options.client ?? client).get({
|
|
40137
|
+
security: [{
|
|
40138
|
+
key: "devops-bearerAuth",
|
|
40139
|
+
scheme: "bearer",
|
|
40140
|
+
type: "http"
|
|
40141
|
+
}],
|
|
40142
|
+
url: "/devops/v1/promotions/{promotion}/rollouts",
|
|
38740
40143
|
...options
|
|
38741
40144
|
});
|
|
38742
|
-
var
|
|
40145
|
+
var devopsRolloutsGet = (options) => (options.client ?? client).get({
|
|
38743
40146
|
security: [{
|
|
38744
40147
|
key: "devops-bearerAuth",
|
|
38745
40148
|
scheme: "bearer",
|
|
38746
40149
|
type: "http"
|
|
38747
40150
|
}],
|
|
38748
|
-
url: "/devops/v1/
|
|
40151
|
+
url: "/devops/v1/rollouts/{id}",
|
|
38749
40152
|
...options
|
|
38750
40153
|
});
|
|
38751
|
-
var
|
|
40154
|
+
var devopsEnvironmentsList = (options) => (options.client ?? client).get({
|
|
38752
40155
|
security: [{
|
|
38753
40156
|
key: "devops-bearerAuth",
|
|
38754
40157
|
scheme: "bearer",
|
|
38755
40158
|
type: "http"
|
|
38756
40159
|
}],
|
|
38757
|
-
url: "/devops/v1/projects/{project}/
|
|
40160
|
+
url: "/devops/v1/projects/{project}/environments",
|
|
38758
40161
|
...options
|
|
38759
40162
|
});
|
|
38760
|
-
var
|
|
40163
|
+
var devopsEnvironmentsCheckpointsList = (options) => (options.client ?? client).get({
|
|
38761
40164
|
security: [{
|
|
38762
40165
|
key: "devops-bearerAuth",
|
|
38763
40166
|
scheme: "bearer",
|
|
38764
40167
|
type: "http"
|
|
38765
40168
|
}],
|
|
38766
|
-
url: "/devops/v1/
|
|
40169
|
+
url: "/devops/v1/environments/{id}/checkpoints",
|
|
38767
40170
|
...options
|
|
38768
40171
|
});
|
|
38769
|
-
var
|
|
40172
|
+
var devopsTargetsList = (options) => (options.client ?? client).get({
|
|
38770
40173
|
security: [{
|
|
38771
40174
|
key: "devops-bearerAuth",
|
|
38772
40175
|
scheme: "bearer",
|
|
38773
40176
|
type: "http"
|
|
38774
40177
|
}],
|
|
38775
|
-
url: "/devops/v1/projects/{project}/
|
|
40178
|
+
url: "/devops/v1/projects/{project}/targets",
|
|
38776
40179
|
...options
|
|
38777
40180
|
});
|
|
38778
|
-
var
|
|
40181
|
+
var devopsTargetsRefresh = (options) => (options.client ?? client).post({
|
|
38779
40182
|
security: [{
|
|
38780
40183
|
key: "devops-bearerAuth",
|
|
38781
40184
|
scheme: "bearer",
|
|
38782
40185
|
type: "http"
|
|
38783
40186
|
}],
|
|
38784
|
-
url: "/devops/v1/projects/{project}/
|
|
40187
|
+
url: "/devops/v1/projects/{project}/targets:refresh",
|
|
38785
40188
|
...options,
|
|
38786
40189
|
headers: {
|
|
38787
40190
|
"Content-Type": "application/json",
|
|
38788
40191
|
...options.headers
|
|
38789
40192
|
}
|
|
38790
40193
|
});
|
|
38791
|
-
var
|
|
40194
|
+
var devopsFlagsList = (options) => (options.client ?? client).get({
|
|
38792
40195
|
security: [{
|
|
38793
40196
|
key: "devops-bearerAuth",
|
|
38794
40197
|
scheme: "bearer",
|
|
38795
40198
|
type: "http"
|
|
38796
40199
|
}],
|
|
38797
|
-
url: "/devops/v1/
|
|
40200
|
+
url: "/devops/v1/projects/{project}/flags",
|
|
38798
40201
|
...options
|
|
38799
40202
|
});
|
|
38800
|
-
var
|
|
40203
|
+
var devopsFlagsCreate = (options) => (options.client ?? client).post({
|
|
38801
40204
|
security: [{
|
|
38802
40205
|
key: "devops-bearerAuth",
|
|
38803
40206
|
scheme: "bearer",
|
|
38804
40207
|
type: "http"
|
|
38805
40208
|
}],
|
|
38806
|
-
url: "/devops/v1/
|
|
40209
|
+
url: "/devops/v1/projects/{project}/flags",
|
|
40210
|
+
...options,
|
|
40211
|
+
headers: {
|
|
40212
|
+
"Content-Type": "application/json",
|
|
40213
|
+
...options.headers
|
|
40214
|
+
}
|
|
40215
|
+
});
|
|
40216
|
+
var devopsFlagsGet = (options) => (options.client ?? client).get({
|
|
40217
|
+
security: [{
|
|
40218
|
+
key: "devops-bearerAuth",
|
|
40219
|
+
scheme: "bearer",
|
|
40220
|
+
type: "http"
|
|
40221
|
+
}],
|
|
40222
|
+
url: "/devops/v1/flags/{id}",
|
|
38807
40223
|
...options
|
|
38808
40224
|
});
|
|
38809
|
-
var
|
|
40225
|
+
var devopsFlagsUpdate = (options) => (options.client ?? client).patch({
|
|
38810
40226
|
security: [{
|
|
38811
40227
|
key: "devops-bearerAuth",
|
|
38812
40228
|
scheme: "bearer",
|
|
38813
40229
|
type: "http"
|
|
38814
40230
|
}],
|
|
38815
|
-
url: "/devops/v1/
|
|
40231
|
+
url: "/devops/v1/flags/{id}",
|
|
38816
40232
|
...options,
|
|
38817
40233
|
headers: {
|
|
38818
40234
|
"Content-Type": "application/json",
|
|
38819
40235
|
...options.headers
|
|
38820
40236
|
}
|
|
38821
40237
|
});
|
|
38822
|
-
var
|
|
40238
|
+
var devopsFlagsUpdateEnvironment = (options) => (options.client ?? client).patch({
|
|
38823
40239
|
security: [{
|
|
38824
40240
|
key: "devops-bearerAuth",
|
|
38825
40241
|
scheme: "bearer",
|
|
38826
40242
|
type: "http"
|
|
38827
40243
|
}],
|
|
38828
|
-
url: "/devops/v1/
|
|
40244
|
+
url: "/devops/v1/flags/{id}/environments/{environment}",
|
|
38829
40245
|
...options,
|
|
38830
40246
|
headers: {
|
|
38831
40247
|
"Content-Type": "application/json",
|
|
38832
40248
|
...options.headers
|
|
38833
40249
|
}
|
|
38834
40250
|
});
|
|
38835
|
-
var
|
|
40251
|
+
var devopsFlagsConclude = (options) => (options.client ?? client).post({
|
|
38836
40252
|
security: [{
|
|
38837
40253
|
key: "devops-bearerAuth",
|
|
38838
40254
|
scheme: "bearer",
|
|
38839
40255
|
type: "http"
|
|
38840
40256
|
}],
|
|
38841
|
-
url: "/devops/v1/
|
|
38842
|
-
...options
|
|
40257
|
+
url: "/devops/v1/flags/{id}:conclude",
|
|
40258
|
+
...options,
|
|
40259
|
+
headers: {
|
|
40260
|
+
"Content-Type": "application/json",
|
|
40261
|
+
...options.headers
|
|
40262
|
+
}
|
|
38843
40263
|
});
|
|
38844
|
-
var
|
|
40264
|
+
var devopsFlagsArchive = (options) => (options.client ?? client).post({
|
|
38845
40265
|
security: [{
|
|
38846
40266
|
key: "devops-bearerAuth",
|
|
38847
40267
|
scheme: "bearer",
|
|
38848
40268
|
type: "http"
|
|
38849
40269
|
}],
|
|
38850
|
-
url: "/devops/v1/
|
|
40270
|
+
url: "/devops/v1/flags/{id}:archive",
|
|
38851
40271
|
...options
|
|
38852
40272
|
});
|
|
38853
|
-
var
|
|
40273
|
+
var devopsProgressiveRolloutsCreate = (options) => (options.client ?? client).post({
|
|
38854
40274
|
security: [{
|
|
38855
40275
|
key: "devops-bearerAuth",
|
|
38856
40276
|
scheme: "bearer",
|
|
38857
40277
|
type: "http"
|
|
38858
40278
|
}],
|
|
38859
|
-
url: "/devops/v1/
|
|
40279
|
+
url: "/devops/v1/progressive-rollouts",
|
|
38860
40280
|
...options,
|
|
38861
40281
|
headers: {
|
|
38862
40282
|
"Content-Type": "application/json",
|
|
38863
40283
|
...options.headers
|
|
38864
40284
|
}
|
|
38865
40285
|
});
|
|
38866
|
-
var
|
|
40286
|
+
var devopsProgressiveRolloutsGet = (options) => (options.client ?? client).get({
|
|
38867
40287
|
security: [{
|
|
38868
40288
|
key: "devops-bearerAuth",
|
|
38869
40289
|
scheme: "bearer",
|
|
38870
40290
|
type: "http"
|
|
38871
40291
|
}],
|
|
38872
|
-
url: "/devops/v1/
|
|
40292
|
+
url: "/devops/v1/progressive-rollouts/{id}",
|
|
38873
40293
|
...options
|
|
38874
40294
|
});
|
|
38875
|
-
var
|
|
40295
|
+
var devopsProgressiveRolloutsPause = (options) => (options.client ?? client).post({
|
|
38876
40296
|
security: [{
|
|
38877
40297
|
key: "devops-bearerAuth",
|
|
38878
40298
|
scheme: "bearer",
|
|
38879
40299
|
type: "http"
|
|
38880
40300
|
}],
|
|
38881
|
-
url: "/devops/v1/
|
|
40301
|
+
url: "/devops/v1/progressive-rollouts/{id}:pause",
|
|
38882
40302
|
...options,
|
|
38883
40303
|
headers: {
|
|
38884
40304
|
"Content-Type": "application/json",
|
|
38885
40305
|
...options.headers
|
|
38886
40306
|
}
|
|
38887
40307
|
});
|
|
38888
|
-
var
|
|
38889
|
-
security: [{
|
|
38890
|
-
key: "devops-bearerAuth",
|
|
38891
|
-
scheme: "bearer",
|
|
38892
|
-
type: "http"
|
|
38893
|
-
}],
|
|
38894
|
-
url: "/devops/v1/test-runs/{run}/executions",
|
|
38895
|
-
...options
|
|
38896
|
-
});
|
|
38897
|
-
var devopsTestExecutionsGet = (options) => (options.client ?? client).get({
|
|
40308
|
+
var devopsProgressiveRolloutsResume = (options) => (options.client ?? client).post({
|
|
38898
40309
|
security: [{
|
|
38899
40310
|
key: "devops-bearerAuth",
|
|
38900
40311
|
scheme: "bearer",
|
|
38901
40312
|
type: "http"
|
|
38902
40313
|
}],
|
|
38903
|
-
url: "/devops/v1/
|
|
40314
|
+
url: "/devops/v1/progressive-rollouts/{id}:resume",
|
|
38904
40315
|
...options
|
|
38905
40316
|
});
|
|
38906
|
-
var
|
|
40317
|
+
var devopsProgressiveRolloutsRollback = (options) => (options.client ?? client).post({
|
|
38907
40318
|
security: [{
|
|
38908
40319
|
key: "devops-bearerAuth",
|
|
38909
40320
|
scheme: "bearer",
|
|
38910
40321
|
type: "http"
|
|
38911
40322
|
}],
|
|
38912
|
-
url: "/devops/v1/
|
|
40323
|
+
url: "/devops/v1/progressive-rollouts/{id}:rollback",
|
|
38913
40324
|
...options,
|
|
38914
40325
|
headers: {
|
|
38915
40326
|
"Content-Type": "application/json",
|
|
@@ -39481,6 +40892,19 @@ var mediaGenerateImage = (options) => (options.client ?? client).post({
|
|
|
39481
40892
|
...options.headers
|
|
39482
40893
|
}
|
|
39483
40894
|
});
|
|
40895
|
+
var mediaGenerateVideo = (options) => (options.client ?? client).post({
|
|
40896
|
+
security: [{
|
|
40897
|
+
key: "media-BearerAuth",
|
|
40898
|
+
scheme: "bearer",
|
|
40899
|
+
type: "http"
|
|
40900
|
+
}],
|
|
40901
|
+
url: "/media/v1/libraries/{library_id}/videos/generations",
|
|
40902
|
+
...options,
|
|
40903
|
+
headers: {
|
|
40904
|
+
"Content-Type": "application/json",
|
|
40905
|
+
...options.headers
|
|
40906
|
+
}
|
|
40907
|
+
});
|
|
39484
40908
|
var mediaEditAsset = (options) => (options.client ?? client).post({
|
|
39485
40909
|
security: [{
|
|
39486
40910
|
key: "media-BearerAuth",
|
|
@@ -39494,36 +40918,36 @@ var mediaEditAsset = (options) => (options.client ?? client).post({
|
|
|
39494
40918
|
...options.headers
|
|
39495
40919
|
}
|
|
39496
40920
|
});
|
|
39497
|
-
var
|
|
40921
|
+
var mediaCreateSpeech = (options) => (options.client ?? client).post({
|
|
39498
40922
|
security: [{
|
|
39499
40923
|
key: "media-BearerAuth",
|
|
39500
40924
|
scheme: "bearer",
|
|
39501
40925
|
type: "http"
|
|
39502
40926
|
}],
|
|
39503
|
-
url: "/media/v1/libraries/{library_id}/
|
|
39504
|
-
...options
|
|
40927
|
+
url: "/media/v1/libraries/{library_id}/audio/speech",
|
|
40928
|
+
...options,
|
|
40929
|
+
headers: {
|
|
40930
|
+
"Content-Type": "application/json",
|
|
40931
|
+
...options.headers
|
|
40932
|
+
}
|
|
39505
40933
|
});
|
|
39506
|
-
var
|
|
40934
|
+
var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
39507
40935
|
security: [{
|
|
39508
40936
|
key: "media-BearerAuth",
|
|
39509
40937
|
scheme: "bearer",
|
|
39510
40938
|
type: "http"
|
|
39511
40939
|
}],
|
|
39512
|
-
url: "/media/v1/libraries/{library_id}/understandings",
|
|
40940
|
+
url: "/media/v1/libraries/{library_id}/understandings/failure_summary",
|
|
39513
40941
|
...options
|
|
39514
40942
|
});
|
|
39515
|
-
var
|
|
40943
|
+
var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).get({
|
|
39516
40944
|
security: [{
|
|
39517
40945
|
key: "media-BearerAuth",
|
|
39518
40946
|
scheme: "bearer",
|
|
39519
40947
|
type: "http"
|
|
39520
40948
|
}],
|
|
39521
|
-
url: "/media/v1/libraries/{library_id}/
|
|
39522
|
-
...options
|
|
39523
|
-
headers: {
|
|
39524
|
-
"Content-Type": "application/json",
|
|
39525
|
-
...options.headers
|
|
39526
|
-
}
|
|
40949
|
+
url: "/media/v1/libraries/{library_id}/understandings",
|
|
40950
|
+
...options
|
|
39527
40951
|
});
|
|
39528
40952
|
var mediaListJobs = (options) => (options.client ?? client).get({
|
|
39529
40953
|
security: [{
|
|
@@ -39543,19 +40967,6 @@ var mediaCancelJob = (options) => (options.client ?? client).post({
|
|
|
39543
40967
|
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
39544
40968
|
...options
|
|
39545
40969
|
});
|
|
39546
|
-
var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
39547
|
-
security: [{
|
|
39548
|
-
key: "media-BearerAuth",
|
|
39549
|
-
scheme: "bearer",
|
|
39550
|
-
type: "http"
|
|
39551
|
-
}],
|
|
39552
|
-
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
39553
|
-
...options,
|
|
39554
|
-
headers: {
|
|
39555
|
-
"Content-Type": "application/json",
|
|
39556
|
-
...options.headers
|
|
39557
|
-
}
|
|
39558
|
-
});
|
|
39559
40970
|
var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
39560
40971
|
security: [{
|
|
39561
40972
|
key: "media-BearerAuth",
|
|
@@ -42981,8 +44392,49 @@ function createDatabase(transport) {
|
|
|
42981
44392
|
}
|
|
42982
44393
|
function createDevops(transport) {
|
|
42983
44394
|
return {
|
|
44395
|
+
environments: {
|
|
44396
|
+
checkpoints: {
|
|
44397
|
+
list: bind(transport, devopsEnvironmentsCheckpointsList)
|
|
44398
|
+
}
|
|
44399
|
+
},
|
|
44400
|
+
flags: {
|
|
44401
|
+
archive: bind(transport, devopsFlagsArchive),
|
|
44402
|
+
conclude: bind(transport, devopsFlagsConclude),
|
|
44403
|
+
environments: {
|
|
44404
|
+
update: bind(transport, devopsFlagsUpdateEnvironment)
|
|
44405
|
+
},
|
|
44406
|
+
retrieve: bind(transport, devopsFlagsGet),
|
|
44407
|
+
update: bind(transport, devopsFlagsUpdate)
|
|
44408
|
+
},
|
|
44409
|
+
progressiveRollouts: {
|
|
44410
|
+
create: bind(transport, devopsProgressiveRolloutsCreate),
|
|
44411
|
+
pause: bind(transport, devopsProgressiveRolloutsPause),
|
|
44412
|
+
resume: bind(transport, devopsProgressiveRolloutsResume),
|
|
44413
|
+
retrieve: bind(transport, devopsProgressiveRolloutsGet),
|
|
44414
|
+
rollback: bind(transport, devopsProgressiveRolloutsRollback)
|
|
44415
|
+
},
|
|
42984
44416
|
projects: {
|
|
44417
|
+
environments: {
|
|
44418
|
+
list: bind(transport, devopsEnvironmentsList)
|
|
44419
|
+
},
|
|
44420
|
+
flags: {
|
|
44421
|
+
create: bind(transport, devopsFlagsCreate),
|
|
44422
|
+
list: bind(transport, devopsFlagsList)
|
|
44423
|
+
},
|
|
44424
|
+
list: bind(transport, devopsProjectsList),
|
|
44425
|
+
promotions: {
|
|
44426
|
+
list: bind(transport, devopsPromotionsList)
|
|
44427
|
+
},
|
|
44428
|
+
releases: {
|
|
44429
|
+
create: bind(transport, devopsReleasesCreate),
|
|
44430
|
+
list: bind(transport, devopsReleasesList)
|
|
44431
|
+
},
|
|
44432
|
+
retrieve: bind(transport, devopsProjectsGet),
|
|
42985
44433
|
retrieveTestCatalog: bind(transport, devopsTestCatalogGet),
|
|
44434
|
+
targets: {
|
|
44435
|
+
list: bind(transport, devopsTargetsList),
|
|
44436
|
+
refresh: bind(transport, devopsTargetsRefresh)
|
|
44437
|
+
},
|
|
42986
44438
|
testCases: {
|
|
42987
44439
|
list: bind(transport, devopsTestCasesList)
|
|
42988
44440
|
},
|
|
@@ -43001,6 +44453,24 @@ function createDevops(transport) {
|
|
|
43001
44453
|
list: bind(transport, devopsTestSuitesList)
|
|
43002
44454
|
}
|
|
43003
44455
|
},
|
|
44456
|
+
promotions: {
|
|
44457
|
+
approve: bind(transport, devopsPromotionsApprove),
|
|
44458
|
+
cancel: bind(transport, devopsPromotionsCancel),
|
|
44459
|
+
conclude: bind(transport, devopsPromotionsConclude),
|
|
44460
|
+
create: bind(transport, devopsPromotionsCreate),
|
|
44461
|
+
retrieve: bind(transport, devopsPromotionsGet),
|
|
44462
|
+
retry: bind(transport, devopsPromotionsRetry),
|
|
44463
|
+
rollouts: {
|
|
44464
|
+
list: bind(transport, devopsRolloutsList)
|
|
44465
|
+
}
|
|
44466
|
+
},
|
|
44467
|
+
releases: {
|
|
44468
|
+
abandon: bind(transport, devopsReleasesAbandon),
|
|
44469
|
+
retrieve: bind(transport, devopsReleasesGet)
|
|
44470
|
+
},
|
|
44471
|
+
rollouts: {
|
|
44472
|
+
retrieve: bind(transport, devopsRolloutsGet)
|
|
44473
|
+
},
|
|
43004
44474
|
testCases: {
|
|
43005
44475
|
retrieve: bind(transport, devopsTestCasesGet)
|
|
43006
44476
|
},
|
|
@@ -43147,17 +44617,9 @@ function createMedia(transport) {
|
|
|
43147
44617
|
folders: {
|
|
43148
44618
|
list: bind(transport, mediaListFolders)
|
|
43149
44619
|
},
|
|
43150
|
-
generations: {
|
|
43151
|
-
create: bind(transport, mediaCreateGeneration)
|
|
43152
|
-
},
|
|
43153
44620
|
jobs: {
|
|
43154
44621
|
cancel: bind(transport, mediaCancelJob),
|
|
43155
44622
|
list: bindPage(transport, mediaListJobs),
|
|
43156
|
-
outputs: {
|
|
43157
|
-
save: {
|
|
43158
|
-
create: bind(transport, mediaSaveGenerationOutput)
|
|
43159
|
-
}
|
|
43160
|
-
},
|
|
43161
44623
|
retrieve: bind(transport, mediaGetJob)
|
|
43162
44624
|
},
|
|
43163
44625
|
list: bindPage(transport, mediaListLibraries),
|
|
@@ -43185,6 +44647,12 @@ function createMedia(transport) {
|
|
|
43185
44647
|
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
43186
44648
|
},
|
|
43187
44649
|
update: bind(transport, mediaUpdateLibrary)
|
|
44650
|
+
},
|
|
44651
|
+
speech: {
|
|
44652
|
+
create: bind(transport, mediaCreateSpeech)
|
|
44653
|
+
},
|
|
44654
|
+
videos: {
|
|
44655
|
+
generate: bind(transport, mediaGenerateVideo)
|
|
43188
44656
|
}
|
|
43189
44657
|
};
|
|
43190
44658
|
}
|
|
@@ -43761,9 +45229,22 @@ function defaultReadFile(path) {
|
|
|
43761
45229
|
return null;
|
|
43762
45230
|
}
|
|
43763
45231
|
}
|
|
45232
|
+
function credentialsEnv(env) {
|
|
45233
|
+
const declared = nonEmpty(env.PRAXIS_ENV);
|
|
45234
|
+
if (declared && /^[A-Za-z0-9_-]+$/.test(declared))
|
|
45235
|
+
return declared;
|
|
45236
|
+
const apiUrl = nonEmpty(env.PRAXIS_API_URL);
|
|
45237
|
+
if (apiUrl) {
|
|
45238
|
+
try {
|
|
45239
|
+
if (new URL(apiUrl).hostname.includes("-develop."))
|
|
45240
|
+
return "develop";
|
|
45241
|
+
} catch {}
|
|
45242
|
+
}
|
|
45243
|
+
return "production";
|
|
45244
|
+
}
|
|
43764
45245
|
function credentialsPath(env) {
|
|
43765
45246
|
const home = nonEmpty(env.HOME) ?? nonEmpty(env.USERPROFILE);
|
|
43766
|
-
return home ? `${home.replace(
|
|
45247
|
+
return home ? `${home.replace(/[/\\]+$/, "")}/.praxis/cli/${credentialsEnv(env)}.json` : null;
|
|
43767
45248
|
}
|
|
43768
45249
|
function resolveDefaultCredentials(env = globalThis.process?.env ?? {}, readFile = defaultReadFile) {
|
|
43769
45250
|
const envToken = nonEmpty(env.PRAXIS_API_TOKEN);
|
|
@@ -43776,7 +45257,7 @@ function resolveDefaultCredentials(env = globalThis.process?.env ?? {}, readFile
|
|
|
43776
45257
|
return envUrl ? { apiUrl: envUrl } : {};
|
|
43777
45258
|
try {
|
|
43778
45259
|
const file = JSON.parse(text);
|
|
43779
|
-
const token = nonEmpty(file.
|
|
45260
|
+
const token = nonEmpty(file.access_token);
|
|
43780
45261
|
const apiUrl = envUrl ?? nonEmpty(file.api_url);
|
|
43781
45262
|
return { ...token ? { token } : {}, ...apiUrl ? { apiUrl } : {} };
|
|
43782
45263
|
} catch {
|
|
@@ -45656,6 +47137,10 @@ function loadTokens(path) {
|
|
|
45656
47137
|
return null;
|
|
45657
47138
|
}
|
|
45658
47139
|
}
|
|
47140
|
+
function loadManagedLogin(path) {
|
|
47141
|
+
const stored = loadTokens(path);
|
|
47142
|
+
return stored?.managed === true ? stored : null;
|
|
47143
|
+
}
|
|
45659
47144
|
function deleteTokens(path) {
|
|
45660
47145
|
if (!existsSync(path))
|
|
45661
47146
|
return false;
|
|
@@ -45668,6 +47153,10 @@ function createTokenStore(env, path = tokenPath(env), secret = systemSecretStore
|
|
|
45668
47153
|
location: () => location,
|
|
45669
47154
|
async load() {
|
|
45670
47155
|
const file = loadTokens(path);
|
|
47156
|
+
if (file?.managed === true) {
|
|
47157
|
+
location = `file ${path}`;
|
|
47158
|
+
return file;
|
|
47159
|
+
}
|
|
45671
47160
|
if (file) {
|
|
45672
47161
|
await session.save(file);
|
|
45673
47162
|
return file;
|
|
@@ -45686,6 +47175,8 @@ function createTokenStore(env, path = tokenPath(env), secret = systemSecretStore
|
|
|
45686
47175
|
}
|
|
45687
47176
|
},
|
|
45688
47177
|
async save(tokens) {
|
|
47178
|
+
if (tokens.managed === true || loadManagedLogin(path))
|
|
47179
|
+
throw new PraxisError({ code: "MANAGED_LOGIN_READ_ONLY", message: `This machine has a managed login (${path}) that the platform renews; it is already signed in and cannot be replaced locally.` });
|
|
45689
47180
|
try {
|
|
45690
47181
|
await secret.set(env, JSON.stringify(tokens));
|
|
45691
47182
|
} catch {
|
|
@@ -45696,6 +47187,8 @@ function createTokenStore(env, path = tokenPath(env), secret = systemSecretStore
|
|
|
45696
47187
|
return location = "keychain";
|
|
45697
47188
|
},
|
|
45698
47189
|
async delete() {
|
|
47190
|
+
if (loadManagedLogin(path))
|
|
47191
|
+
throw new PraxisError({ code: "MANAGED_LOGIN_READ_ONLY", message: `This machine has a managed login (${path}) that the platform renews, so there is nothing to log out of here.` });
|
|
45699
47192
|
let removed = false;
|
|
45700
47193
|
try {
|
|
45701
47194
|
removed = await secret.delete(env);
|
|
@@ -45878,8 +47371,12 @@ async function withLock(lockPath, run, ports = {}) {
|
|
|
45878
47371
|
function apiKeyVariable(env) {
|
|
45879
47372
|
return env === "develop" ? "PRAXIS_API_KEY_DEVELOP" : "PRAXIS_API_KEY";
|
|
45880
47373
|
}
|
|
45881
|
-
function credentialSource(vars, env) {
|
|
45882
|
-
|
|
47374
|
+
function credentialSource(vars, env, readManaged) {
|
|
47375
|
+
if (vars[apiKeyVariable(env)])
|
|
47376
|
+
return "api-key";
|
|
47377
|
+
if (vars.PRAXIS_API_TOKEN)
|
|
47378
|
+
return "machine-token";
|
|
47379
|
+
return readManaged() ? "managed-login" : "login";
|
|
45883
47380
|
}
|
|
45884
47381
|
async function identityRpc(config, fetchImpl, method, params, token) {
|
|
45885
47382
|
const response = await fetchImpl(`${config.gatewayUrl}/rpc/practice-identity`, {
|
|
@@ -45909,7 +47406,8 @@ function jwtFetch(fetchImpl, token) {
|
|
|
45909
47406
|
function credentials(config, vars, ports) {
|
|
45910
47407
|
const path = ports.path ?? tokenPath(config.env);
|
|
45911
47408
|
const store = ports.store ?? createTokenStore(config.env, path, ports.secretStore);
|
|
45912
|
-
const
|
|
47409
|
+
const readManagedLogin = ports.readManagedLogin ?? (() => loadManagedLogin(path));
|
|
47410
|
+
const source = credentialSource(vars, config.env, () => readManagedLogin() !== null);
|
|
45913
47411
|
const keyVariable = apiKeyVariable(config.env);
|
|
45914
47412
|
const apiKey = vars[keyVariable];
|
|
45915
47413
|
const machineToken = source === "machine-token" ? vars.PRAXIS_API_TOKEN : undefined;
|
|
@@ -45926,7 +47424,17 @@ function credentials(config, vars, ports) {
|
|
|
45926
47424
|
throw new UsageError("The API Key determines the organization; listing or switching login organizations is unavailable.", `Unset ${keyVariable} and run \`praxis login\`, then retry the org command.`);
|
|
45927
47425
|
if (machineToken)
|
|
45928
47426
|
throw new UsageError("The machine token determines the organization; listing or switching login organizations is unavailable.", "Unset PRAXIS_API_TOKEN and run `praxis login`, then retry the org command.");
|
|
47427
|
+
if (source === "managed-login")
|
|
47428
|
+
throw new UsageError("The managed login determines the organization; listing or switching login organizations is unavailable.", "Run `praxis login` on your own computer, then retry the org command.");
|
|
45929
47429
|
};
|
|
47430
|
+
function managedCredential(first) {
|
|
47431
|
+
const stale = (stored) => stored.expires_at - REFRESH_SKEW_MS <= ports.now();
|
|
47432
|
+
const current = stale(first) ? readManagedLogin() ?? first : first;
|
|
47433
|
+
if (stale(current))
|
|
47434
|
+
throw new PraxisError({ code: "MANAGED_LOGIN_EXPIRED", message: "Managed login expired; the platform renews it — retry in a minute, or run praxis login" });
|
|
47435
|
+
remember(current.access_token);
|
|
47436
|
+
return { source: "managed-login", storedIn: `file ${path}`, token: current.access_token, expiresAt: current.expires_at, ...current.organization_id ? { organizationId: current.organization_id } : {} };
|
|
47437
|
+
}
|
|
45930
47438
|
async function exchange(organizationId) {
|
|
45931
47439
|
const stored = await store.load();
|
|
45932
47440
|
if (stored) {
|
|
@@ -45955,6 +47463,12 @@ function credentials(config, vars, ports) {
|
|
|
45955
47463
|
throw new UsageError("--org cannot override a machine token organization", "Remove --org or unset PRAXIS_API_TOKEN and run `praxis login`.");
|
|
45956
47464
|
return { source: "machine-token", token: machineToken };
|
|
45957
47465
|
}
|
|
47466
|
+
const managed = readManagedLogin();
|
|
47467
|
+
if (managed) {
|
|
47468
|
+
if (org)
|
|
47469
|
+
throw new UsageError("--org cannot override a managed login organization", "Remove --org; the managed login and its organization come from the platform.");
|
|
47470
|
+
return managedCredential(managed);
|
|
47471
|
+
}
|
|
45958
47472
|
const stored = await store.load();
|
|
45959
47473
|
const selected = org ?? stored?.organization_id;
|
|
45960
47474
|
const opaqueFresh = stored !== null && stored.expires_at - 30000 > ports.now();
|
|
@@ -46030,13 +47544,13 @@ function skillDocument(commands) {
|
|
|
46030
47544
|
"## General rules",
|
|
46031
47545
|
"",
|
|
46032
47546
|
"- Select the environment only with `PRAXIS_ENV`; there is no `--env` option. The dev package defaults to develop.",
|
|
46033
|
-
"- Authenticate with the API key of the environment (`PRAXIS_API_KEY` for production, `PRAXIS_API_KEY_DEVELOP` for develop; a key only works in the environment that issued it), `PRAXIS_API_TOKEN` (a machine token, sent in the Authorization header
|
|
47547
|
+
"- Authenticate with the API key of the environment (`PRAXIS_API_KEY` for production, `PRAXIS_API_KEY_DEVELOP` for develop; a key only works in the environment that issued it), `PRAXIS_API_TOKEN` (a machine token, sent in the Authorization header) or the stored login, in that order. On a computer the platform manages you are already signed in: it writes the login file (`~/.praxis/cli/<env>.json`, marked `managed`) that the CLI and the SDK read, and it renews that file before the token expires — never run `praxis login` there. On your own computer `praxis login` writes the same file through a browser device code. Login saves the session even when an environment credential takes precedence; unset the named variable in its warning to use the saved login. API keys, machine tokens and managed logins determine the organization; a personal login session can use `--org <organization_id>`. `PRAXIS_API_URL` overrides the API base and must be an https deepraxis.com URL.",
|
|
46034
47548
|
"- AI mode is enabled automatically in supported agent environments. Use `--format agent` to select it explicitly.",
|
|
46035
47549
|
"- Use `--json` for the complete JSON response without presentation truncation. Successful JSON output goes to stdout; errors go to stderr.",
|
|
46036
47550
|
"- Supply bodies with `--data JSON`, `--data @file.json`, or `--data -` for stdin. Scalar field options override matching JSON fields. Structured fields require `--data`. Multipart binary fields accept local file paths (or @paths), with repeatable flags for arrays. A binary field named data uses `--data <path>` instead of JSON.",
|
|
46037
47551
|
"- Deletion requires `--yes` in AI mode. Confirm the intended resource before using it.",
|
|
46038
47552
|
"- Use `--limit N` to limit a server page for SDK-paginated commands. Other lists apply it only to displayed rows; `--param-limit` still sends the API parameter when available. `--all` follows supported pagination and cannot be combined with `--limit`.",
|
|
46039
|
-
"- Error JSON has an `error` object: `code` identifies the failure, `message` describes it, `hint` suggests recovery, `env` identifies the environment, `command` identifies the command, `status` is the HTTP status, and `request_id` correlates diagnostics. Authentication failures also include `credential_source` (api-key, machine-token, or login); follow the source-specific hint. Unavailable fields are null. Exit codes: 0 success, 1 runtime/API error, 2 usage error.",
|
|
47553
|
+
"- Error JSON has an `error` object: `code` identifies the failure, `message` describes it, `hint` suggests recovery, `env` identifies the environment, `command` identifies the command, `status` is the HTTP status, and `request_id` correlates diagnostics. Authentication failures also include `credential_source` (api-key, machine-token, managed-login, or login); follow the source-specific hint. Unavailable fields are null. Exit codes: 0 success, 1 runtime/API error, 2 usage error.",
|
|
46040
47554
|
"- Append `--help` to a command for its optional parameters. Required scalar body options below can also be supplied as fields in `--data`.",
|
|
46041
47555
|
"- Two layers: top-level commands (`login`, `org`, `skill`, …) are workflows and session commands; every API operation is under `praxis api <domain> …`. `praxis api <METHOD> <path>` sends a raw request (the method is uppercase).",
|
|
46042
47556
|
"",
|
|
@@ -46220,7 +47734,7 @@ async function whoami(auth, env, org) {
|
|
|
46220
47734
|
source: credential.source,
|
|
46221
47735
|
...credential.storedIn ? { "stored in": credential.storedIn } : {},
|
|
46222
47736
|
expires_at: credential.expiresAt ? new Date(credential.expiresAt).toISOString() : null,
|
|
46223
|
-
...credential.source === "api-key" ? { note: "The API key determines the organization." } : credential.source === "machine-token" ? { note: "The machine token determines the organization." } : {}
|
|
47737
|
+
...credential.source === "api-key" ? { note: "The API key determines the organization." } : credential.source === "machine-token" ? { note: "The machine token determines the organization." } : credential.source === "managed-login" ? { note: "The managed login determines the organization; the platform renews it." } : {}
|
|
46224
47738
|
};
|
|
46225
47739
|
}
|
|
46226
47740
|
|
|
@@ -49301,6 +50815,8 @@ function authHint(source, env) {
|
|
|
49301
50815
|
return `The ${env} API key from ${keyVariable} was rejected; check or replace it, or unset it to use \`praxis login\`.`;
|
|
49302
50816
|
case "machine-token":
|
|
49303
50817
|
return "The machine token from PRAXIS_API_TOKEN was rejected (it may have expired); unset it to use `praxis login`, or refresh it.";
|
|
50818
|
+
case "managed-login":
|
|
50819
|
+
return "The managed login the platform wrote was rejected or has expired; the platform renews it — retry in a minute. Run `praxis login` on your own computer to use a personal login instead.";
|
|
49304
50820
|
case "login":
|
|
49305
50821
|
return `Run \`praxis login\` or set ${keyVariable}.`;
|
|
49306
50822
|
}
|
|
@@ -49324,7 +50840,7 @@ function errorInput(error, ctx) {
|
|
|
49324
50840
|
message = `${humanize(code)}${message ? `: ${message}` : ""}`;
|
|
49325
50841
|
const status = sdk?.status, request_id = sdk?.requestId;
|
|
49326
50842
|
message = serverText(problem?.detail) ?? serverText(problem?.title) ?? message;
|
|
49327
|
-
const authFailure = status === 401 || ["NOT_LOGGED_IN", "UNAUTHENTICATED", "TOKEN_REVOKED", "LOGIN_FAILED"].includes(code);
|
|
50843
|
+
const authFailure = status === 401 || ["NOT_LOGGED_IN", "UNAUTHENTICATED", "TOKEN_REVOKED", "LOGIN_FAILED", "MANAGED_LOGIN_EXPIRED"].includes(code);
|
|
49328
50844
|
const source = ctx.credentialSource ?? "login";
|
|
49329
50845
|
let hint2 = genericHint;
|
|
49330
50846
|
if (error instanceof UsageError)
|
|
@@ -49371,7 +50887,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
49371
50887
|
}
|
|
49372
50888
|
|
|
49373
50889
|
// src/main.ts
|
|
49374
|
-
var version = "0.2.2-dev.
|
|
50890
|
+
var version = "0.2.2-dev.93cc895";
|
|
49375
50891
|
var commands = commandTree(operations);
|
|
49376
50892
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
49377
50893
|
function route(argv) {
|
|
@@ -49695,10 +51211,14 @@ Examples:
|
|
|
49695
51211
|
case "login":
|
|
49696
51212
|
if (flags["no-input"] || quiet)
|
|
49697
51213
|
throw new UsageError("login requires displaying a device code", "Remove --no-input / --quiet, or set PRAXIS_API_KEY (production) / PRAXIS_API_KEY_DEVELOP (develop) for scripts.");
|
|
51214
|
+
if (auth.source === "managed-login")
|
|
51215
|
+
throw new UsageError("This machine has a managed login the platform renews; it is already signed in", "Use it as it is. `praxis login` is for your own computer, where no platform writes the login file.");
|
|
49698
51216
|
ctx.credentialSource = "login";
|
|
49699
51217
|
await login(config, path, { ...ports, source: auth.source, json: ctx.mode === "json", store: store2, fetch: wireFetch, emit, remember: (s) => secrets.push(s) });
|
|
49700
51218
|
break;
|
|
49701
51219
|
case "logout":
|
|
51220
|
+
if (auth.source === "managed-login")
|
|
51221
|
+
throw new UsageError("This machine has a managed login the platform renews; there is nothing to log out of", "Nothing here is a session of yours to end. `praxis logout` removes a login you made on your own computer.");
|
|
49702
51222
|
emit({ kind: "message", text: await store2.delete() ? "Logged out." : "Not logged in." });
|
|
49703
51223
|
break;
|
|
49704
51224
|
case "whoami":
|