diff --git a/qase-api-client/docs/DefectCreate.md b/qase-api-client/docs/DefectCreate.md index 2436f914..e2050749 100644 --- a/qase-api-client/docs/DefectCreate.md +++ b/qase-api-client/docs/DefectCreate.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **severity** | **number** | | [default to undefined] **milestone_id** | **number** | | [optional] [default to undefined] **attachments** | **Array<string>** | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] **tags** | **Array<string>** | | [optional] [default to undefined] ## Example diff --git a/qase-api-client/docs/DefectUpdate.md b/qase-api-client/docs/DefectUpdate.md index 1938186f..763e4277 100644 --- a/qase-api-client/docs/DefectUpdate.md +++ b/qase-api-client/docs/DefectUpdate.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **severity** | **number** | | [optional] [default to undefined] **milestone_id** | **number** | | [optional] [default to undefined] **attachments** | **Array<string>** | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Partial update: only fields present in the payload are validated; required fields not included are not enforced. Send `\"\"` to clear a value. Unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] **tags** | **Array<string>** | | [optional] [default to undefined] ## Example diff --git a/qase-api-client/docs/RunCreate.md b/qase-api-client/docs/RunCreate.md index aed7db1e..93c12901 100644 --- a/qase-api-client/docs/RunCreate.md +++ b/qase-api-client/docs/RunCreate.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **author_id** | **number** | | [optional] [default to undefined] **tags** | **Array<string>** | | [optional] [default to undefined] **configurations** | **Array<number>** | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] **start_time** | **string** | | [optional] [default to undefined] **end_time** | **string** | | [optional] [default to undefined] **is_cloud** | **boolean** | Indicates if the run is created for the Test Cases produced by AIDEN | [optional] [default to undefined] diff --git a/qase-api-client/docs/Runupdate.md b/qase-api-client/docs/Runupdate.md index 9f80c48f..e0fd3b3b 100644 --- a/qase-api-client/docs/Runupdate.md +++ b/qase-api-client/docs/Runupdate.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **milestone_id** | **number** | | [optional] [default to undefined] **tags** | **Array<string>** | | [optional] [default to undefined] **configurations** | **Array<number>** | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] ## Example diff --git a/qase-api-client/docs/TestCase.md b/qase-api-client/docs/TestCase.md index 901be233..62f259cf 100644 --- a/qase-api-client/docs/TestCase.md +++ b/qase-api-client/docs/TestCase.md @@ -17,7 +17,9 @@ Name | Type | Description | Notes **layer** | **number** | | [optional] [default to undefined] **is_flaky** | **number** | | [optional] [default to undefined] **behavior** | **number** | | [optional] [default to undefined] -**automation** | **number** | | [optional] [default to undefined] +**automation** | **number** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. | [optional] [default to undefined] +**isManual** | **number** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional] [default to undefined] +**isToBeAutomated** | **number** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional] [default to undefined] **status** | **number** | | [optional] [default to undefined] **milestone_id** | **number** | | [optional] [default to undefined] **suite_id** | **number** | | [optional] [default to undefined] @@ -56,6 +58,8 @@ const instance: TestCase = { is_flaky, behavior, automation, + isManual, + isToBeAutomated, status, milestone_id, suite_id, diff --git a/qase-api-client/docs/TestCaseCreate.md b/qase-api-client/docs/TestCaseCreate.md index 4b138ccb..ce36d621 100644 --- a/qase-api-client/docs/TestCaseCreate.md +++ b/qase-api-client/docs/TestCaseCreate.md @@ -17,7 +17,9 @@ Name | Type | Description | Notes **is_flaky** | **number** | | [optional] [default to undefined] **suite_id** | **number** | | [optional] [default to undefined] **milestone_id** | **number** | | [optional] [default to undefined] -**automation** | **number** | | [optional] [default to undefined] +**automation** | **number** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. | [optional] [default to undefined] +**isManual** | **number** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional] [default to undefined] +**isToBeAutomated** | **number** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional] [default to undefined] **status** | **number** | | [optional] [default to undefined] **steps_type** | **string** | Determines the format of the steps field. When \"classic\", steps use the standard action/expected_result/data format. When \"gherkin\", steps use the {value: \"Given...\\nWhen...\\nThen...\"} format. | [optional] [default to StepsTypeEnum_CLASSIC] **attachments** | **Array<string>** | A list of Attachment hashes. | [optional] [default to undefined] @@ -25,7 +27,7 @@ Name | Type | Description | Notes **tags** | **Array<string>** | | [optional] [default to undefined] **params** | **{ [key: string]: Array<string>; }** | Deprecated, use `parameters` instead. | [optional] [default to undefined] **parameters** | [**Array<TestCaseParameterCreate>**](TestCaseParameterCreate.md) | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] **created_at** | **string** | | [optional] [default to undefined] **updated_at** | **string** | | [optional] [default to undefined] @@ -48,6 +50,8 @@ const instance: TestCaseCreate = { suite_id, milestone_id, automation, + isManual, + isToBeAutomated, status, steps_type, attachments, diff --git a/qase-api-client/docs/TestCaseUpdate.md b/qase-api-client/docs/TestCaseUpdate.md index 609ac7a6..cd4638e1 100644 --- a/qase-api-client/docs/TestCaseUpdate.md +++ b/qase-api-client/docs/TestCaseUpdate.md @@ -17,7 +17,9 @@ Name | Type | Description | Notes **is_flaky** | **number** | | [optional] [default to undefined] **suite_id** | **number** | | [optional] [default to undefined] **milestone_id** | **number** | | [optional] [default to undefined] -**automation** | **number** | | [optional] [default to undefined] +**automation** | **number** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. | [optional] [default to undefined] +**isManual** | **number** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional] [default to undefined] +**isToBeAutomated** | **number** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional] [default to undefined] **status** | **number** | | [optional] [default to undefined] **steps_type** | **string** | Determines the format of the steps field. When \"classic\", steps use the standard action/expected_result/data format. When \"gherkin\", steps use the {value: \"Given...\\nWhen...\\nThen...\"} format. | [optional] [default to StepsTypeEnum_CLASSIC] **attachments** | **Array<string>** | A list of Attachment hashes. | [optional] [default to undefined] @@ -25,7 +27,7 @@ Name | Type | Description | Notes **tags** | **Array<string>** | | [optional] [default to undefined] **params** | **{ [key: string]: Array<string>; }** | Deprecated, use `parameters` instead. | [optional] [default to undefined] **parameters** | [**Array<TestCaseParameterCreate>**](TestCaseParameterCreate.md) | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Partial update: only fields present in the payload are validated; required fields not included are not enforced. Send `\"\"` to clear a value. Unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] ## Example @@ -46,6 +48,8 @@ const instance: TestCaseUpdate = { suite_id, milestone_id, automation, + isManual, + isToBeAutomated, status, steps_type, attachments, diff --git a/qase-api-client/docs/TestCasebulkCasesInner.md b/qase-api-client/docs/TestCasebulkCasesInner.md index 265d5a72..cd67aa89 100644 --- a/qase-api-client/docs/TestCasebulkCasesInner.md +++ b/qase-api-client/docs/TestCasebulkCasesInner.md @@ -17,7 +17,9 @@ Name | Type | Description | Notes **is_flaky** | **number** | | [optional] [default to undefined] **suite_id** | **number** | | [optional] [default to undefined] **milestone_id** | **number** | | [optional] [default to undefined] -**automation** | **number** | | [optional] [default to undefined] +**automation** | **number** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. | [optional] [default to undefined] +**isManual** | **number** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional] [default to undefined] +**isToBeAutomated** | **number** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional] [default to undefined] **status** | **number** | | [optional] [default to undefined] **steps_type** | **string** | Determines the format of the steps field. When \"classic\", steps use the standard action/expected_result/data format. When \"gherkin\", steps use the {value: \"Given...\\nWhen...\\nThen...\"} format. | [optional] [default to StepsTypeEnum_CLASSIC] **attachments** | **Array<string>** | A list of Attachment hashes. | [optional] [default to undefined] @@ -25,7 +27,7 @@ Name | Type | Description | Notes **tags** | **Array<string>** | | [optional] [default to undefined] **params** | **{ [key: string]: Array<string>; }** | Deprecated, use `parameters` instead. | [optional] [default to undefined] **parameters** | [**Array<TestCaseParameterCreate>**](TestCaseParameterCreate.md) | | [optional] [default to undefined] -**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined] +**custom_field** | **{ [key: string]: string; }** | Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional] [default to undefined] **created_at** | **string** | | [optional] [default to undefined] **updated_at** | **string** | | [optional] [default to undefined] **id** | **number** | | [optional] [default to undefined] @@ -49,6 +51,8 @@ const instance: TestCasebulkCasesInner = { suite_id, milestone_id, automation, + isManual, + isToBeAutomated, status, steps_type, attachments, diff --git a/qase-api-client/package.json b/qase-api-client/package.json index 0436aeb1..9446191d 100644 --- a/qase-api-client/package.json +++ b/qase-api-client/package.json @@ -1,6 +1,6 @@ { "name": "qase-api-client", - "version": "1.1.9", + "version": "1.1.10", "description": "Qase TMS Javascript API V1 Client", "main": "./dist/index.js", "types": "./dist/index.d.ts", diff --git a/qase-api-client/src/model/defect-create.ts b/qase-api-client/src/model/defect-create.ts index c3aad1e9..b9ecfe03 100644 --- a/qase-api-client/src/model/defect-create.ts +++ b/qase-api-client/src/model/defect-create.ts @@ -50,7 +50,7 @@ export interface DefectCreate { */ 'attachments'?: Array; /** - * A map of custom fields values (id => value) + * Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. * @type {{ [key: string]: string; }} * @memberof DefectCreate */ diff --git a/qase-api-client/src/model/defect-update.ts b/qase-api-client/src/model/defect-update.ts index f0679977..9f32047d 100644 --- a/qase-api-client/src/model/defect-update.ts +++ b/qase-api-client/src/model/defect-update.ts @@ -50,7 +50,7 @@ export interface DefectUpdate { */ 'attachments'?: Array; /** - * A map of custom fields values (id => value) + * Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Partial update: only fields present in the payload are validated; required fields not included are not enforced. Send `\"\"` to clear a value. Unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. * @type {{ [key: string]: string; }} * @memberof DefectUpdate */ diff --git a/qase-api-client/src/model/run-create.ts b/qase-api-client/src/model/run-create.ts index 126b5940..dbd36178 100644 --- a/qase-api-client/src/model/run-create.ts +++ b/qase-api-client/src/model/run-create.ts @@ -93,7 +93,7 @@ export interface RunCreate { */ 'configurations'?: Array; /** - * A map of custom fields values (id => value) + * Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. * @type {{ [key: string]: string; }} * @memberof RunCreate */ diff --git a/qase-api-client/src/model/runupdate.ts b/qase-api-client/src/model/runupdate.ts index af7998c4..a9b8ae15 100644 --- a/qase-api-client/src/model/runupdate.ts +++ b/qase-api-client/src/model/runupdate.ts @@ -62,7 +62,7 @@ export interface Runupdate { */ 'configurations'?: Array | null; /** - * A map of custom fields values (id => value) + * Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. * @type {{ [key: string]: string; }} * @memberof Runupdate */ diff --git a/qase-api-client/src/model/test-case-create.ts b/qase-api-client/src/model/test-case-create.ts index dbaaf912..bfb937e5 100644 --- a/qase-api-client/src/model/test-case-create.ts +++ b/qase-api-client/src/model/test-case-create.ts @@ -94,11 +94,24 @@ export interface TestCaseCreate { */ 'milestone_id'?: number; /** - * + * Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. * @type {number} * @memberof TestCaseCreate + * @deprecated */ 'automation'?: number; + /** + * `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. + * @type {number} + * @memberof TestCaseCreate + */ + 'isManual'?: number; + /** + * `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. + * @type {number} + * @memberof TestCaseCreate + */ + 'isToBeAutomated'?: number; /** * * @type {number} @@ -143,7 +156,7 @@ export interface TestCaseCreate { */ 'parameters'?: Array | null; /** - * A map of custom fields values (id => value) + * Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. * @type {{ [key: string]: string; }} * @memberof TestCaseCreate */ diff --git a/qase-api-client/src/model/test-case-update.ts b/qase-api-client/src/model/test-case-update.ts index fdb76028..0bd9e2c8 100644 --- a/qase-api-client/src/model/test-case-update.ts +++ b/qase-api-client/src/model/test-case-update.ts @@ -94,11 +94,24 @@ export interface TestCaseUpdate { */ 'milestone_id'?: number; /** - * + * Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. * @type {number} * @memberof TestCaseUpdate + * @deprecated */ 'automation'?: number; + /** + * `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. + * @type {number} + * @memberof TestCaseUpdate + */ + 'isManual'?: number; + /** + * `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. + * @type {number} + * @memberof TestCaseUpdate + */ + 'isToBeAutomated'?: number; /** * * @type {number} @@ -143,7 +156,7 @@ export interface TestCaseUpdate { */ 'parameters'?: Array | null; /** - * A map of custom fields values (id => value) + * Custom field values keyed by the field\'s project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Partial update: only fields present in the payload are validated; required fields not included are not enforced. Send `\"\"` to clear a value. Unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. * @type {{ [key: string]: string; }} * @memberof TestCaseUpdate */ diff --git a/qase-api-client/src/model/test-case.ts b/qase-api-client/src/model/test-case.ts index a226b61b..dad30b1a 100644 --- a/qase-api-client/src/model/test-case.ts +++ b/qase-api-client/src/model/test-case.ts @@ -99,11 +99,24 @@ export interface TestCase { */ 'behavior'?: number; /** - * + * Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. * @type {number} * @memberof TestCase + * @deprecated */ 'automation'?: number; + /** + * `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. + * @type {number} + * @memberof TestCase + */ + 'isManual'?: number; + /** + * `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. + * @type {number} + * @memberof TestCase + */ + 'isToBeAutomated'?: number; /** * * @type {number}