@spaciv/sdk 0.1.2 → 0.1.4
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/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/dist/apis/AnalysisApi.d.ts +4 -4
- package/dist/apis/AnalysisApi.js +2 -2
- package/dist/apis/ProjectsApi.d.ts +4 -4
- package/dist/apis/ProjectsApi.js +2 -2
- package/dist/apis/VariablesApi.d.ts +8 -8
- package/dist/apis/VariablesApi.js +4 -4
- package/dist/esm/apis/AnalysisApi.d.ts +4 -4
- package/dist/esm/apis/AnalysisApi.js +2 -2
- package/dist/esm/apis/ProjectsApi.d.ts +4 -4
- package/dist/esm/apis/ProjectsApi.js +2 -2
- package/dist/esm/apis/VariablesApi.d.ts +8 -8
- package/dist/esm/apis/VariablesApi.js +4 -4
- package/dist/esm/models/VariableData.d.ts +2 -1
- package/dist/esm/models/VariableData.js +7 -0
- package/dist/esm/models/VariableDataOneOf2.d.ts +3 -3
- package/dist/esm/models/VariableDataOneOf2.js +4 -4
- package/dist/esm/models/VariableDataOneOf3.d.ts +3 -3
- package/dist/esm/models/VariableDataOneOf3.js +4 -4
- package/dist/esm/models/VariableDataOneOf4.d.ts +3 -3
- package/dist/esm/models/VariableDataOneOf4.js +4 -4
- package/dist/esm/models/VariableDataOneOf5.d.ts +3 -2
- package/dist/esm/models/VariableDataOneOf5.js +4 -3
- package/dist/esm/models/VariableDataOneOf6.d.ts +1 -1
- package/dist/esm/models/VariableDataOneOf6.js +3 -3
- package/dist/esm/models/VariableDataOneOf7.d.ts +32 -0
- package/dist/esm/models/VariableDataOneOf7.js +43 -0
- package/dist/esm/models/VariableDate.d.ts +50 -0
- package/dist/esm/models/VariableDate.js +55 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/VariableData.d.ts +2 -1
- package/dist/models/VariableData.js +7 -0
- package/dist/models/VariableDataOneOf2.d.ts +3 -3
- package/dist/models/VariableDataOneOf2.js +4 -4
- package/dist/models/VariableDataOneOf3.d.ts +3 -3
- package/dist/models/VariableDataOneOf3.js +4 -4
- package/dist/models/VariableDataOneOf4.d.ts +3 -3
- package/dist/models/VariableDataOneOf4.js +4 -4
- package/dist/models/VariableDataOneOf5.d.ts +3 -2
- package/dist/models/VariableDataOneOf5.js +4 -3
- package/dist/models/VariableDataOneOf6.d.ts +1 -1
- package/dist/models/VariableDataOneOf6.js +3 -3
- package/dist/models/VariableDataOneOf7.d.ts +32 -0
- package/dist/models/VariableDataOneOf7.js +50 -0
- package/dist/models/VariableDate.d.ts +50 -0
- package/dist/models/VariableDate.js +62 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/AnalysisApi.ts +4 -4
- package/src/apis/ProjectsApi.ts +4 -4
- package/src/apis/VariablesApi.ts +8 -8
- package/src/models/VariableData.ts +14 -1
- package/src/models/VariableDataOneOf2.ts +11 -11
- package/src/models/VariableDataOneOf3.ts +11 -11
- package/src/models/VariableDataOneOf4.ts +11 -11
- package/src/models/VariableDataOneOf5.ts +13 -5
- package/src/models/VariableDataOneOf6.ts +4 -4
- package/src/models/VariableDataOneOf7.ts +66 -0
- package/src/models/VariableDate.ts +93 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -388,6 +388,8 @@ src/models/VariableDataOneOf3.ts
|
|
|
388
388
|
src/models/VariableDataOneOf4.ts
|
|
389
389
|
src/models/VariableDataOneOf5.ts
|
|
390
390
|
src/models/VariableDataOneOf6.ts
|
|
391
|
+
src/models/VariableDataOneOf7.ts
|
|
392
|
+
src/models/VariableDate.ts
|
|
391
393
|
src/models/VariableListRes.ts
|
|
392
394
|
src/models/VariableNotFoundDetail.ts
|
|
393
395
|
src/models/VariableNumber.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.4
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @spaciv/sdk@0.1.
|
|
39
|
+
npm install @spaciv/sdk@0.1.4 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -22,7 +22,7 @@ export interface AnalysisApiCreateAnalyseRequest {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface AnalysisApiInterface {
|
|
24
24
|
/**
|
|
25
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
25
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
26
26
|
* @summary Run analysis
|
|
27
27
|
* @param {CalcBody} [calcBody]
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -31,7 +31,7 @@ export interface AnalysisApiInterface {
|
|
|
31
31
|
*/
|
|
32
32
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
33
33
|
/**
|
|
34
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
34
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
35
35
|
* Run analysis
|
|
36
36
|
*/
|
|
37
37
|
createAnalyse(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
|
@@ -41,12 +41,12 @@ export interface AnalysisApiInterface {
|
|
|
41
41
|
*/
|
|
42
42
|
export declare class AnalysisApi extends runtime.BaseAPI implements AnalysisApiInterface {
|
|
43
43
|
/**
|
|
44
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
44
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
45
45
|
* Run analysis
|
|
46
46
|
*/
|
|
47
47
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
48
48
|
/**
|
|
49
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
49
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
50
50
|
* Run analysis
|
|
51
51
|
*/
|
|
52
52
|
createAnalyse(requestParameters?: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
package/dist/apis/AnalysisApi.js
CHANGED
|
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class AnalysisApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
33
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
34
34
|
* Run analysis
|
|
35
35
|
*/
|
|
36
36
|
createAnalyseRaw(requestParameters, initOverrides) {
|
|
@@ -57,7 +57,7 @@ class AnalysisApi extends runtime.BaseAPI {
|
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
60
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
61
61
|
* Run analysis
|
|
62
62
|
*/
|
|
63
63
|
createAnalyse() {
|
|
@@ -126,7 +126,7 @@ export interface ProjectsApiInterface {
|
|
|
126
126
|
*/
|
|
127
127
|
list(requestParameters: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
|
|
128
128
|
/**
|
|
129
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
129
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
130
130
|
* @summary Update a project
|
|
131
131
|
* @param {ProjectPatchBody} [projectPatchBody]
|
|
132
132
|
* @param {*} [options] Override http request option.
|
|
@@ -135,7 +135,7 @@ export interface ProjectsApiInterface {
|
|
|
135
135
|
*/
|
|
136
136
|
updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
137
137
|
/**
|
|
138
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
138
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
139
139
|
* Update a project
|
|
140
140
|
*/
|
|
141
141
|
update(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -220,12 +220,12 @@ export declare class ProjectsApi extends runtime.BaseAPI implements ProjectsApiI
|
|
|
220
220
|
*/
|
|
221
221
|
list(requestParameters?: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
|
|
222
222
|
/**
|
|
223
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
223
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
224
224
|
* Update a project
|
|
225
225
|
*/
|
|
226
226
|
updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
227
227
|
/**
|
|
228
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
228
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
229
229
|
* Update a project
|
|
230
230
|
*/
|
|
231
231
|
update(requestParameters?: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
package/dist/apis/ProjectsApi.js
CHANGED
|
@@ -266,7 +266,7 @@ class ProjectsApi extends runtime.BaseAPI {
|
|
|
266
266
|
});
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
269
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
270
270
|
* Update a project
|
|
271
271
|
*/
|
|
272
272
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -293,7 +293,7 @@ class ProjectsApi extends runtime.BaseAPI {
|
|
|
293
293
|
});
|
|
294
294
|
}
|
|
295
295
|
/**
|
|
296
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
296
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
297
297
|
* Update a project
|
|
298
298
|
*/
|
|
299
299
|
update() {
|
|
@@ -35,7 +35,7 @@ export interface VariablesApiUpdateRequest {
|
|
|
35
35
|
*/
|
|
36
36
|
export interface VariablesApiInterface {
|
|
37
37
|
/**
|
|
38
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
38
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
39
39
|
* @summary Create an account variable
|
|
40
40
|
* @param {VariableCreate} [variableCreate]
|
|
41
41
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +44,7 @@ export interface VariablesApiInterface {
|
|
|
44
44
|
*/
|
|
45
45
|
createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
46
46
|
/**
|
|
47
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
47
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
48
48
|
* Create an account variable
|
|
49
49
|
*/
|
|
50
50
|
create(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
@@ -104,7 +104,7 @@ export interface VariablesApiInterface {
|
|
|
104
104
|
*/
|
|
105
105
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
106
106
|
/**
|
|
107
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
107
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
108
108
|
* @summary Update an account variable
|
|
109
109
|
* @param {string} id Account variable ID, either qualified (account:<id>) or bare.
|
|
110
110
|
* @param {VariablePatch} [variablePatch]
|
|
@@ -114,7 +114,7 @@ export interface VariablesApiInterface {
|
|
|
114
114
|
*/
|
|
115
115
|
updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
116
116
|
/**
|
|
117
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
117
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
118
118
|
* Update an account variable
|
|
119
119
|
*/
|
|
120
120
|
update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -124,12 +124,12 @@ export interface VariablesApiInterface {
|
|
|
124
124
|
*/
|
|
125
125
|
export declare class VariablesApi extends runtime.BaseAPI implements VariablesApiInterface {
|
|
126
126
|
/**
|
|
127
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
127
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
128
128
|
* Create an account variable
|
|
129
129
|
*/
|
|
130
130
|
createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
131
131
|
/**
|
|
132
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
132
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
133
133
|
* Create an account variable
|
|
134
134
|
*/
|
|
135
135
|
create(requestParameters?: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
@@ -174,12 +174,12 @@ export declare class VariablesApi extends runtime.BaseAPI implements VariablesAp
|
|
|
174
174
|
*/
|
|
175
175
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
176
176
|
/**
|
|
177
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
177
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
178
178
|
* Update an account variable
|
|
179
179
|
*/
|
|
180
180
|
updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
181
181
|
/**
|
|
182
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
182
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
183
183
|
* Update an account variable
|
|
184
184
|
*/
|
|
185
185
|
update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class VariablesApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
33
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
34
34
|
* Create an account variable
|
|
35
35
|
*/
|
|
36
36
|
createRaw(requestParameters, initOverrides) {
|
|
@@ -62,7 +62,7 @@ class VariablesApi extends runtime.BaseAPI {
|
|
|
62
62
|
});
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
65
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
66
66
|
* Create an account variable
|
|
67
67
|
*/
|
|
68
68
|
create() {
|
|
@@ -223,7 +223,7 @@ class VariablesApi extends runtime.BaseAPI {
|
|
|
223
223
|
});
|
|
224
224
|
}
|
|
225
225
|
/**
|
|
226
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
226
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
227
227
|
* Update an account variable
|
|
228
228
|
*/
|
|
229
229
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -254,7 +254,7 @@ class VariablesApi extends runtime.BaseAPI {
|
|
|
254
254
|
});
|
|
255
255
|
}
|
|
256
256
|
/**
|
|
257
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
257
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
258
258
|
* Update an account variable
|
|
259
259
|
*/
|
|
260
260
|
update(requestParameters, initOverrides) {
|
|
@@ -22,7 +22,7 @@ export interface AnalysisApiCreateAnalyseRequest {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface AnalysisApiInterface {
|
|
24
24
|
/**
|
|
25
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
25
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
26
26
|
* @summary Run analysis
|
|
27
27
|
* @param {CalcBody} [calcBody]
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -31,7 +31,7 @@ export interface AnalysisApiInterface {
|
|
|
31
31
|
*/
|
|
32
32
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
33
33
|
/**
|
|
34
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
34
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
35
35
|
* Run analysis
|
|
36
36
|
*/
|
|
37
37
|
createAnalyse(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
|
@@ -41,12 +41,12 @@ export interface AnalysisApiInterface {
|
|
|
41
41
|
*/
|
|
42
42
|
export declare class AnalysisApi extends runtime.BaseAPI implements AnalysisApiInterface {
|
|
43
43
|
/**
|
|
44
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
44
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
45
45
|
* Run analysis
|
|
46
46
|
*/
|
|
47
47
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
48
48
|
/**
|
|
49
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
49
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
50
50
|
* Run analysis
|
|
51
51
|
*/
|
|
52
52
|
createAnalyse(requestParameters?: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
|
@@ -27,7 +27,7 @@ import { CalcBodyToJSON, CalcResFromJSON, } from '../models/index';
|
|
|
27
27
|
*/
|
|
28
28
|
export class AnalysisApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
30
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
31
31
|
* Run analysis
|
|
32
32
|
*/
|
|
33
33
|
createAnalyseRaw(requestParameters, initOverrides) {
|
|
@@ -54,7 +54,7 @@ export class AnalysisApi extends runtime.BaseAPI {
|
|
|
54
54
|
});
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. Requires the *View ideal space* permission.
|
|
57
|
+
* Runs the scenario through the calculation engine and returns the resulting model. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
58
58
|
* Run analysis
|
|
59
59
|
*/
|
|
60
60
|
createAnalyse() {
|
|
@@ -126,7 +126,7 @@ export interface ProjectsApiInterface {
|
|
|
126
126
|
*/
|
|
127
127
|
list(requestParameters: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
|
|
128
128
|
/**
|
|
129
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
129
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
130
130
|
* @summary Update a project
|
|
131
131
|
* @param {ProjectPatchBody} [projectPatchBody]
|
|
132
132
|
* @param {*} [options] Override http request option.
|
|
@@ -135,7 +135,7 @@ export interface ProjectsApiInterface {
|
|
|
135
135
|
*/
|
|
136
136
|
updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
137
137
|
/**
|
|
138
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
138
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
139
139
|
* Update a project
|
|
140
140
|
*/
|
|
141
141
|
update(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -220,12 +220,12 @@ export declare class ProjectsApi extends runtime.BaseAPI implements ProjectsApiI
|
|
|
220
220
|
*/
|
|
221
221
|
list(requestParameters?: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
|
|
222
222
|
/**
|
|
223
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
223
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
224
224
|
* Update a project
|
|
225
225
|
*/
|
|
226
226
|
updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
227
227
|
/**
|
|
228
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
228
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
229
229
|
* Update a project
|
|
230
230
|
*/
|
|
231
231
|
update(requestParameters?: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -263,7 +263,7 @@ export class ProjectsApi extends runtime.BaseAPI {
|
|
|
263
263
|
});
|
|
264
264
|
}
|
|
265
265
|
/**
|
|
266
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
266
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
267
267
|
* Update a project
|
|
268
268
|
*/
|
|
269
269
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -290,7 +290,7 @@ export class ProjectsApi extends runtime.BaseAPI {
|
|
|
290
290
|
});
|
|
291
291
|
}
|
|
292
292
|
/**
|
|
293
|
-
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and
|
|
293
|
+
* Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type, range and `options` come from the account definition; such an override must not set `options` itself and must choose one of the listed values. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
|
|
294
294
|
* Update a project
|
|
295
295
|
*/
|
|
296
296
|
update() {
|
|
@@ -35,7 +35,7 @@ export interface VariablesApiUpdateRequest {
|
|
|
35
35
|
*/
|
|
36
36
|
export interface VariablesApiInterface {
|
|
37
37
|
/**
|
|
38
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
38
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
39
39
|
* @summary Create an account variable
|
|
40
40
|
* @param {VariableCreate} [variableCreate]
|
|
41
41
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +44,7 @@ export interface VariablesApiInterface {
|
|
|
44
44
|
*/
|
|
45
45
|
createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
46
46
|
/**
|
|
47
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
47
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
48
48
|
* Create an account variable
|
|
49
49
|
*/
|
|
50
50
|
create(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
@@ -104,7 +104,7 @@ export interface VariablesApiInterface {
|
|
|
104
104
|
*/
|
|
105
105
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
106
106
|
/**
|
|
107
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
107
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
108
108
|
* @summary Update an account variable
|
|
109
109
|
* @param {string} id Account variable ID, either qualified (account:<id>) or bare.
|
|
110
110
|
* @param {VariablePatch} [variablePatch]
|
|
@@ -114,7 +114,7 @@ export interface VariablesApiInterface {
|
|
|
114
114
|
*/
|
|
115
115
|
updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
116
116
|
/**
|
|
117
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
117
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
118
118
|
* Update an account variable
|
|
119
119
|
*/
|
|
120
120
|
update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -124,12 +124,12 @@ export interface VariablesApiInterface {
|
|
|
124
124
|
*/
|
|
125
125
|
export declare class VariablesApi extends runtime.BaseAPI implements VariablesApiInterface {
|
|
126
126
|
/**
|
|
127
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
127
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
128
128
|
* Create an account variable
|
|
129
129
|
*/
|
|
130
130
|
createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
131
131
|
/**
|
|
132
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
132
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
133
133
|
* Create an account variable
|
|
134
134
|
*/
|
|
135
135
|
create(requestParameters?: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
@@ -174,12 +174,12 @@ export declare class VariablesApi extends runtime.BaseAPI implements VariablesAp
|
|
|
174
174
|
*/
|
|
175
175
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
176
176
|
/**
|
|
177
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
177
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
178
178
|
* Update an account variable
|
|
179
179
|
*/
|
|
180
180
|
updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
181
181
|
/**
|
|
182
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
182
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
183
183
|
* Update an account variable
|
|
184
184
|
*/
|
|
185
185
|
update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -27,7 +27,7 @@ import { ReferencesResFromJSON, VariableCreateToJSON, VariableListResFromJSON, V
|
|
|
27
27
|
*/
|
|
28
28
|
export class VariablesApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
30
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
31
31
|
* Create an account variable
|
|
32
32
|
*/
|
|
33
33
|
createRaw(requestParameters, initOverrides) {
|
|
@@ -59,7 +59,7 @@ export class VariablesApi extends runtime.BaseAPI {
|
|
|
59
59
|
});
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
|
|
62
|
+
* Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Option variables may restrict their values with `options`; the value must be one of them. Requires the *Manage my account* permission.
|
|
63
63
|
* Create an account variable
|
|
64
64
|
*/
|
|
65
65
|
create() {
|
|
@@ -220,7 +220,7 @@ export class VariablesApi extends runtime.BaseAPI {
|
|
|
220
220
|
});
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
223
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
224
224
|
* Update an account variable
|
|
225
225
|
*/
|
|
226
226
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -251,7 +251,7 @@ export class VariablesApi extends runtime.BaseAPI {
|
|
|
251
251
|
});
|
|
252
252
|
}
|
|
253
253
|
/**
|
|
254
|
-
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
|
|
254
|
+
* Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Narrowing `options` so that an existing project override is no longer listed is rejected the same way. Sending `data` replaces the variable\'s `options` too. Requires the *Manage my account* permission.
|
|
255
255
|
* Update an account variable
|
|
256
256
|
*/
|
|
257
257
|
update(requestParameters, initOverrides) {
|
|
@@ -17,12 +17,13 @@ import type { VariableDataOneOf3 } from './VariableDataOneOf3';
|
|
|
17
17
|
import type { VariableDataOneOf4 } from './VariableDataOneOf4';
|
|
18
18
|
import type { VariableDataOneOf5 } from './VariableDataOneOf5';
|
|
19
19
|
import type { VariableDataOneOf6 } from './VariableDataOneOf6';
|
|
20
|
+
import type { VariableDataOneOf7 } from './VariableDataOneOf7';
|
|
20
21
|
/**
|
|
21
22
|
* @type VariableData
|
|
22
23
|
*
|
|
23
24
|
* @export
|
|
24
25
|
*/
|
|
25
|
-
export type VariableData = PropertySourceOneOf | VariableDataOneOf | VariableDataOneOf1 | VariableDataOneOf2 | VariableDataOneOf3 | VariableDataOneOf4 | VariableDataOneOf5 | VariableDataOneOf6;
|
|
26
|
+
export type VariableData = PropertySourceOneOf | VariableDataOneOf | VariableDataOneOf1 | VariableDataOneOf2 | VariableDataOneOf3 | VariableDataOneOf4 | VariableDataOneOf5 | VariableDataOneOf6 | VariableDataOneOf7;
|
|
26
27
|
export declare function VariableDataFromJSON(json: any): VariableData;
|
|
27
28
|
export declare function VariableDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): VariableData;
|
|
28
29
|
export declare function VariableDataToJSON(json: any): any;
|
|
@@ -19,6 +19,7 @@ import { instanceOfVariableDataOneOf3, VariableDataOneOf3FromJSONTyped, Variable
|
|
|
19
19
|
import { instanceOfVariableDataOneOf4, VariableDataOneOf4FromJSONTyped, VariableDataOneOf4ToJSON, } from './VariableDataOneOf4';
|
|
20
20
|
import { instanceOfVariableDataOneOf5, VariableDataOneOf5FromJSONTyped, VariableDataOneOf5ToJSON, } from './VariableDataOneOf5';
|
|
21
21
|
import { instanceOfVariableDataOneOf6, VariableDataOneOf6FromJSONTyped, VariableDataOneOf6ToJSON, } from './VariableDataOneOf6';
|
|
22
|
+
import { instanceOfVariableDataOneOf7, VariableDataOneOf7FromJSONTyped, VariableDataOneOf7ToJSON, } from './VariableDataOneOf7';
|
|
22
23
|
export function VariableDataFromJSON(json) {
|
|
23
24
|
return VariableDataFromJSONTyped(json, false);
|
|
24
25
|
}
|
|
@@ -53,6 +54,9 @@ export function VariableDataFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
53
54
|
if (instanceOfVariableDataOneOf6(json)) {
|
|
54
55
|
return VariableDataOneOf6FromJSONTyped(json, true);
|
|
55
56
|
}
|
|
57
|
+
if (instanceOfVariableDataOneOf7(json)) {
|
|
58
|
+
return VariableDataOneOf7FromJSONTyped(json, true);
|
|
59
|
+
}
|
|
56
60
|
return {};
|
|
57
61
|
}
|
|
58
62
|
export function VariableDataToJSON(json) {
|
|
@@ -89,5 +93,8 @@ export function VariableDataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
89
93
|
if (instanceOfVariableDataOneOf6(value)) {
|
|
90
94
|
return VariableDataOneOf6ToJSON(value);
|
|
91
95
|
}
|
|
96
|
+
if (instanceOfVariableDataOneOf7(value)) {
|
|
97
|
+
return VariableDataOneOf7ToJSON(value);
|
|
98
|
+
}
|
|
92
99
|
return {};
|
|
93
100
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { VariableDate } from './VariableDate';
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
@@ -18,10 +18,10 @@ import type { VariableProperty } from './VariableProperty';
|
|
|
18
18
|
export interface VariableDataOneOf2 {
|
|
19
19
|
/**
|
|
20
20
|
*
|
|
21
|
-
* @type {
|
|
21
|
+
* @type {VariableDate}
|
|
22
22
|
* @memberof VariableDataOneOf2
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
dateRange: VariableDate;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
27
|
* Check if a given object implements the VariableDataOneOf2 interface.
|
|
@@ -11,12 +11,12 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
import {
|
|
14
|
+
import { VariableDateFromJSON, VariableDateToJSON, } from './VariableDate';
|
|
15
15
|
/**
|
|
16
16
|
* Check if a given object implements the VariableDataOneOf2 interface.
|
|
17
17
|
*/
|
|
18
18
|
export function instanceOfVariableDataOneOf2(value) {
|
|
19
|
-
if (!('
|
|
19
|
+
if (!('dateRange' in value) || value['dateRange'] === undefined)
|
|
20
20
|
return false;
|
|
21
21
|
return true;
|
|
22
22
|
}
|
|
@@ -28,7 +28,7 @@ export function VariableDataOneOf2FromJSONTyped(json, ignoreDiscriminator) {
|
|
|
28
28
|
return json;
|
|
29
29
|
}
|
|
30
30
|
return {
|
|
31
|
-
'
|
|
31
|
+
'dateRange': VariableDateFromJSON(json['dateRange']),
|
|
32
32
|
};
|
|
33
33
|
}
|
|
34
34
|
export function VariableDataOneOf2ToJSON(json) {
|
|
@@ -39,6 +39,6 @@ export function VariableDataOneOf2ToJSONTyped(value, ignoreDiscriminator = false
|
|
|
39
39
|
return value;
|
|
40
40
|
}
|
|
41
41
|
return {
|
|
42
|
-
'
|
|
42
|
+
'dateRange': VariableDateToJSON(value['dateRange']),
|
|
43
43
|
};
|
|
44
44
|
}
|