@spaciv/sdk 0.1.3 → 0.1.5

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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @spaciv/sdk@0.1.3
1
+ ## @spaciv/sdk@0.1.5
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.3 --save
39
+ npm install @spaciv/sdk@0.1.5 --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>;
@@ -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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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>;
@@ -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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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:&lt;id&gt;) 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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
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:&lt;id&gt;) 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) {
@@ -30,6 +30,12 @@ export interface AssistantChatPollBody {
30
30
  * @memberof AssistantChatPollBody
31
31
  */
32
32
  failure?: AssistantConversationFailureBody;
33
+ /**
34
+ * Tool calls whose results, failed or not, were recorded after the since cursor, by the toolCallId of their action message. A call that succeeded has no message of its own, so this is how a client tells a finished action from one still running. A later poll can list a call again.
35
+ * @type {Array<string>}
36
+ * @memberof AssistantChatPollBody
37
+ */
38
+ finishedToolCallIds: Array<string>;
33
39
  /**
34
40
  *
35
41
  * @type {Array<AssistantChatPollMessage>}
@@ -20,6 +20,8 @@ import { AssistantChatPollMessageFromJSON, AssistantChatPollMessageToJSON, } fro
20
20
  export function instanceOfAssistantChatPollBody(value) {
21
21
  if (!('actions' in value) || value['actions'] === undefined)
22
22
  return false;
23
+ if (!('finishedToolCallIds' in value) || value['finishedToolCallIds'] === undefined)
24
+ return false;
23
25
  if (!('messages' in value) || value['messages'] === undefined)
24
26
  return false;
25
27
  if (!('status' in value) || value['status'] === undefined)
@@ -36,6 +38,7 @@ export function AssistantChatPollBodyFromJSONTyped(json, ignoreDiscriminator) {
36
38
  return {
37
39
  'actions': (json['actions'].map(AssistantChatPollActionFromJSON)),
38
40
  'failure': json['failure'] == null ? undefined : AssistantConversationFailureBodyFromJSON(json['failure']),
41
+ 'finishedToolCallIds': json['finishedToolCallIds'],
39
42
  'messages': (json['messages'].map(AssistantChatPollMessageFromJSON)),
40
43
  'status': json['status'],
41
44
  };
@@ -50,6 +53,7 @@ export function AssistantChatPollBodyToJSONTyped(value, ignoreDiscriminator = fa
50
53
  return {
51
54
  'actions': (value['actions'].map(AssistantChatPollActionToJSON)),
52
55
  'failure': AssistantConversationFailureBodyToJSON(value['failure']),
56
+ 'finishedToolCallIds': value['finishedToolCallIds'],
53
57
  'messages': (value['messages'].map(AssistantChatPollMessageToJSON)),
54
58
  'status': value['status'],
55
59
  };
@@ -64,6 +64,12 @@ export interface AssistantChatPollMessage {
64
64
  * @memberof AssistantChatPollMessage
65
65
  */
66
66
  text: string;
67
+ /**
68
+ * Id of the tool call an action message (kind 2) stands for. Empty on every other message.
69
+ * @type {string}
70
+ * @memberof AssistantChatPollMessage
71
+ */
72
+ toolCallId: string;
67
73
  }
68
74
  /**
69
75
  * Check if a given object implements the AssistantChatPollMessage interface.
@@ -32,6 +32,8 @@ export function instanceOfAssistantChatPollMessage(value) {
32
32
  return false;
33
33
  if (!('text' in value) || value['text'] === undefined)
34
34
  return false;
35
+ if (!('toolCallId' in value) || value['toolCallId'] === undefined)
36
+ return false;
35
37
  return true;
36
38
  }
37
39
  export function AssistantChatPollMessageFromJSON(json) {
@@ -50,6 +52,7 @@ export function AssistantChatPollMessageFromJSONTyped(json, ignoreDiscriminator)
50
52
  'requestId': json['requestId'],
51
53
  'role': json['role'],
52
54
  'text': json['text'],
55
+ 'toolCallId': json['toolCallId'],
53
56
  };
54
57
  }
55
58
  export function AssistantChatPollMessageToJSON(json) {
@@ -68,5 +71,6 @@ export function AssistantChatPollMessageToJSONTyped(value, ignoreDiscriminator =
68
71
  'requestId': value['requestId'],
69
72
  'role': value['role'],
70
73
  'text': value['text'],
74
+ 'toolCallId': value['toolCallId'],
71
75
  };
72
76
  }
@@ -30,6 +30,12 @@ export interface AssistantChatPollBody {
30
30
  * @memberof AssistantChatPollBody
31
31
  */
32
32
  failure?: AssistantConversationFailureBody;
33
+ /**
34
+ * Tool calls whose results, failed or not, were recorded after the since cursor, by the toolCallId of their action message. A call that succeeded has no message of its own, so this is how a client tells a finished action from one still running. A later poll can list a call again.
35
+ * @type {Array<string>}
36
+ * @memberof AssistantChatPollBody
37
+ */
38
+ finishedToolCallIds: Array<string>;
33
39
  /**
34
40
  *
35
41
  * @type {Array<AssistantChatPollMessage>}
@@ -27,6 +27,8 @@ const AssistantChatPollMessage_1 = require("./AssistantChatPollMessage");
27
27
  function instanceOfAssistantChatPollBody(value) {
28
28
  if (!('actions' in value) || value['actions'] === undefined)
29
29
  return false;
30
+ if (!('finishedToolCallIds' in value) || value['finishedToolCallIds'] === undefined)
31
+ return false;
30
32
  if (!('messages' in value) || value['messages'] === undefined)
31
33
  return false;
32
34
  if (!('status' in value) || value['status'] === undefined)
@@ -43,6 +45,7 @@ function AssistantChatPollBodyFromJSONTyped(json, ignoreDiscriminator) {
43
45
  return {
44
46
  'actions': (json['actions'].map(AssistantChatPollAction_1.AssistantChatPollActionFromJSON)),
45
47
  'failure': json['failure'] == null ? undefined : (0, AssistantConversationFailureBody_1.AssistantConversationFailureBodyFromJSON)(json['failure']),
48
+ 'finishedToolCallIds': json['finishedToolCallIds'],
46
49
  'messages': (json['messages'].map(AssistantChatPollMessage_1.AssistantChatPollMessageFromJSON)),
47
50
  'status': json['status'],
48
51
  };
@@ -57,6 +60,7 @@ function AssistantChatPollBodyToJSONTyped(value, ignoreDiscriminator = false) {
57
60
  return {
58
61
  'actions': (value['actions'].map(AssistantChatPollAction_1.AssistantChatPollActionToJSON)),
59
62
  'failure': (0, AssistantConversationFailureBody_1.AssistantConversationFailureBodyToJSON)(value['failure']),
63
+ 'finishedToolCallIds': value['finishedToolCallIds'],
60
64
  'messages': (value['messages'].map(AssistantChatPollMessage_1.AssistantChatPollMessageToJSON)),
61
65
  'status': value['status'],
62
66
  };
@@ -64,6 +64,12 @@ export interface AssistantChatPollMessage {
64
64
  * @memberof AssistantChatPollMessage
65
65
  */
66
66
  text: string;
67
+ /**
68
+ * Id of the tool call an action message (kind 2) stands for. Empty on every other message.
69
+ * @type {string}
70
+ * @memberof AssistantChatPollMessage
71
+ */
72
+ toolCallId: string;
67
73
  }
68
74
  /**
69
75
  * Check if a given object implements the AssistantChatPollMessage interface.
@@ -39,6 +39,8 @@ function instanceOfAssistantChatPollMessage(value) {
39
39
  return false;
40
40
  if (!('text' in value) || value['text'] === undefined)
41
41
  return false;
42
+ if (!('toolCallId' in value) || value['toolCallId'] === undefined)
43
+ return false;
42
44
  return true;
43
45
  }
44
46
  function AssistantChatPollMessageFromJSON(json) {
@@ -57,6 +59,7 @@ function AssistantChatPollMessageFromJSONTyped(json, ignoreDiscriminator) {
57
59
  'requestId': json['requestId'],
58
60
  'role': json['role'],
59
61
  'text': json['text'],
62
+ 'toolCallId': json['toolCallId'],
60
63
  };
61
64
  }
62
65
  function AssistantChatPollMessageToJSON(json) {
@@ -75,5 +78,6 @@ function AssistantChatPollMessageToJSONTyped(value, ignoreDiscriminator = false)
75
78
  'requestId': value['requestId'],
76
79
  'role': value['role'],
77
80
  'text': value['text'],
81
+ 'toolCallId': value['toolCallId'],
78
82
  };
79
83
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spaciv/sdk",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "OpenAPI client for @spaciv/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -43,7 +43,7 @@ export interface AnalysisApiCreateAnalyseRequest {
43
43
  */
44
44
  export interface AnalysisApiInterface {
45
45
  /**
46
- * 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.
46
+ * 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.
47
47
  * @summary Run analysis
48
48
  * @param {CalcBody} [calcBody]
49
49
  * @param {*} [options] Override http request option.
@@ -53,7 +53,7 @@ export interface AnalysisApiInterface {
53
53
  createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
54
54
 
55
55
  /**
56
- * 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.
56
+ * 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.
57
57
  * Run analysis
58
58
  */
59
59
  createAnalyse(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
@@ -66,7 +66,7 @@ export interface AnalysisApiInterface {
66
66
  export class AnalysisApi extends runtime.BaseAPI implements AnalysisApiInterface {
67
67
 
68
68
  /**
69
- * 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.
69
+ * 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.
70
70
  * Run analysis
71
71
  */
72
72
  async createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>> {
@@ -99,7 +99,7 @@ export class AnalysisApi extends runtime.BaseAPI implements AnalysisApiInterface
99
99
  }
100
100
 
101
101
  /**
102
- * 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.
102
+ * 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.
103
103
  * Run analysis
104
104
  */
105
105
  async createAnalyse(requestParameters: AnalysisApiCreateAnalyseRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes> {
@@ -168,7 +168,7 @@ export interface ProjectsApiInterface {
168
168
  list(requestParameters: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
169
169
 
170
170
  /**
171
- * 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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
171
+ * 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.
172
172
  * @summary Update a project
173
173
  * @param {ProjectPatchBody} [projectPatchBody]
174
174
  * @param {*} [options] Override http request option.
@@ -178,7 +178,7 @@ export interface ProjectsApiInterface {
178
178
  updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
179
179
 
180
180
  /**
181
- * 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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
181
+ * 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.
182
182
  * Update a project
183
183
  */
184
184
  update(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -472,7 +472,7 @@ export class ProjectsApi extends runtime.BaseAPI implements ProjectsApiInterface
472
472
  }
473
473
 
474
474
  /**
475
- * 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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
475
+ * 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.
476
476
  * Update a project
477
477
  */
478
478
  async updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -505,7 +505,7 @@ export class ProjectsApi extends runtime.BaseAPI implements ProjectsApiInterface
505
505
  }
506
506
 
507
507
  /**
508
- * 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 range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
508
+ * 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.
509
509
  * Update a project
510
510
  */
511
511
  async update(requestParameters: ProjectsApiUpdateRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -66,7 +66,7 @@ export interface VariablesApiUpdateRequest {
66
66
  */
67
67
  export interface VariablesApiInterface {
68
68
  /**
69
- * 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.
69
+ * 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.
70
70
  * @summary Create an account variable
71
71
  * @param {VariableCreate} [variableCreate]
72
72
  * @param {*} [options] Override http request option.
@@ -76,7 +76,7 @@ export interface VariablesApiInterface {
76
76
  createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
77
77
 
78
78
  /**
79
- * 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.
79
+ * 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.
80
80
  * Create an account variable
81
81
  */
82
82
  create(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -145,7 +145,7 @@ export interface VariablesApiInterface {
145
145
  listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
146
146
 
147
147
  /**
148
- * 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.
148
+ * 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.
149
149
  * @summary Update an account variable
150
150
  * @param {string} id Account variable ID, either qualified (account:&lt;id&gt;) or bare.
151
151
  * @param {VariablePatch} [variablePatch]
@@ -156,7 +156,7 @@ export interface VariablesApiInterface {
156
156
  updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
157
157
 
158
158
  /**
159
- * 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.
159
+ * 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.
160
160
  * Update an account variable
161
161
  */
162
162
  update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -169,7 +169,7 @@ export interface VariablesApiInterface {
169
169
  export class VariablesApi extends runtime.BaseAPI implements VariablesApiInterface {
170
170
 
171
171
  /**
172
- * 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.
172
+ * 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.
173
173
  * Create an account variable
174
174
  */
175
175
  async createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
@@ -206,7 +206,7 @@ export class VariablesApi extends runtime.BaseAPI implements VariablesApiInterfa
206
206
  }
207
207
 
208
208
  /**
209
- * 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.
209
+ * 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.
210
210
  * Create an account variable
211
211
  */
212
212
  async create(requestParameters: VariablesApiCreateRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
@@ -394,7 +394,7 @@ export class VariablesApi extends runtime.BaseAPI implements VariablesApiInterfa
394
394
  }
395
395
 
396
396
  /**
397
- * 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.
397
+ * 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.
398
398
  * Update an account variable
399
399
  */
400
400
  async updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -435,7 +435,7 @@ export class VariablesApi extends runtime.BaseAPI implements VariablesApiInterfa
435
435
  }
436
436
 
437
437
  /**
438
- * 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.
438
+ * 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.
439
439
  * Update an account variable
440
440
  */
441
441
  async update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -53,6 +53,12 @@ export interface AssistantChatPollBody {
53
53
  * @memberof AssistantChatPollBody
54
54
  */
55
55
  failure?: AssistantConversationFailureBody;
56
+ /**
57
+ * Tool calls whose results, failed or not, were recorded after the since cursor, by the toolCallId of their action message. A call that succeeded has no message of its own, so this is how a client tells a finished action from one still running. A later poll can list a call again.
58
+ * @type {Array<string>}
59
+ * @memberof AssistantChatPollBody
60
+ */
61
+ finishedToolCallIds: Array<string>;
56
62
  /**
57
63
  *
58
64
  * @type {Array<AssistantChatPollMessage>}
@@ -72,6 +78,7 @@ export interface AssistantChatPollBody {
72
78
  */
73
79
  export function instanceOfAssistantChatPollBody(value: object): value is AssistantChatPollBody {
74
80
  if (!('actions' in value) || value['actions'] === undefined) return false;
81
+ if (!('finishedToolCallIds' in value) || value['finishedToolCallIds'] === undefined) return false;
75
82
  if (!('messages' in value) || value['messages'] === undefined) return false;
76
83
  if (!('status' in value) || value['status'] === undefined) return false;
77
84
  return true;
@@ -89,6 +96,7 @@ export function AssistantChatPollBodyFromJSONTyped(json: any, ignoreDiscriminato
89
96
 
90
97
  'actions': ((json['actions'] as Array<any>).map(AssistantChatPollActionFromJSON)),
91
98
  'failure': json['failure'] == null ? undefined : AssistantConversationFailureBodyFromJSON(json['failure']),
99
+ 'finishedToolCallIds': json['finishedToolCallIds'],
92
100
  'messages': ((json['messages'] as Array<any>).map(AssistantChatPollMessageFromJSON)),
93
101
  'status': json['status'],
94
102
  };
@@ -107,6 +115,7 @@ export function AssistantChatPollBodyToJSONTyped(value?: AssistantChatPollBody |
107
115
 
108
116
  'actions': ((value['actions'] as Array<any>).map(AssistantChatPollActionToJSON)),
109
117
  'failure': AssistantConversationFailureBodyToJSON(value['failure']),
118
+ 'finishedToolCallIds': value['finishedToolCallIds'],
110
119
  'messages': ((value['messages'] as Array<any>).map(AssistantChatPollMessageToJSON)),
111
120
  'status': value['status'],
112
121
  };
@@ -75,6 +75,12 @@ export interface AssistantChatPollMessage {
75
75
  * @memberof AssistantChatPollMessage
76
76
  */
77
77
  text: string;
78
+ /**
79
+ * Id of the tool call an action message (kind 2) stands for. Empty on every other message.
80
+ * @type {string}
81
+ * @memberof AssistantChatPollMessage
82
+ */
83
+ toolCallId: string;
78
84
  }
79
85
 
80
86
  /**
@@ -89,6 +95,7 @@ export function instanceOfAssistantChatPollMessage(value: object): value is Assi
89
95
  if (!('requestId' in value) || value['requestId'] === undefined) return false;
90
96
  if (!('role' in value) || value['role'] === undefined) return false;
91
97
  if (!('text' in value) || value['text'] === undefined) return false;
98
+ if (!('toolCallId' in value) || value['toolCallId'] === undefined) return false;
92
99
  return true;
93
100
  }
94
101
 
@@ -110,6 +117,7 @@ export function AssistantChatPollMessageFromJSONTyped(json: any, ignoreDiscrimin
110
117
  'requestId': json['requestId'],
111
118
  'role': json['role'],
112
119
  'text': json['text'],
120
+ 'toolCallId': json['toolCallId'],
113
121
  };
114
122
  }
115
123
 
@@ -132,6 +140,7 @@ export function AssistantChatPollMessageToJSONTyped(value?: AssistantChatPollMes
132
140
  'requestId': value['requestId'],
133
141
  'role': value['role'],
134
142
  'text': value['text'],
143
+ 'toolCallId': value['toolCallId'],
135
144
  };
136
145
  }
137
146