diff --git a/api-reference/on-call.openapi.en.json b/api-reference/on-call.openapi.en.json index 3192671e..d99d082c 100644 --- a/api-reference/on-call.openapi.en.json +++ b/api-reference/on-call.openapi.en.json @@ -16889,7 +16889,8 @@ "created_at": 0, "updated_at": 0 } - ] + ], + "release_limited": false } } } @@ -18319,7 +18320,8 @@ "description": "People with active fixed or temporary On-call licenses.", "required": [ "total", - "items" + "items", + "release_limited" ], "properties": { "total": { @@ -18333,6 +18335,10 @@ "items": { "$ref": "#/components/schemas/LicensePersonItem" } + }, + "release_limited": { + "type": "boolean", + "description": "Whether the account has used up its license release quota for the current 30-day window. While `true`, releasing a seat fails with error code `NoLicense`." } } }, @@ -27727,14 +27733,24 @@ "properties": { "cycle": { "type": "string", - "description": "Notification cycle; only `day` is supported.", + "description": "Notification cycle: `day` sends every day; `week` sends on the weekdays listed in `days`; `month` sends on the day-of-month values listed in `days`.", "enum": [ - "day" + "day", + "week", + "month" ] }, "start": { "type": "string", "description": "Time of day to send, format `HH:MM` (24-hour)." + }, + "days": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "description": "Days the notification fires on, read in the schedule's timezone. For `week`, weekday numbers 0-6 (0 = Sunday); for `month`, day-of-month numbers 1-31, and a month without that date is skipped. Required when `cycle` is `week` or `month`; ignored when `cycle` is `day`." } } }, @@ -33607,8 +33623,14 @@ }, "status": { "type": "string", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, - "description": "Optional client-defined initial status (max 64 characters)." + "description": "Initial status. One of `open`, `in_progress`, `done`, `cancelled`; defaults to `open` when omitted or blank." }, "priority": { "type": "string", @@ -33687,7 +33709,13 @@ "string", "null" ], - "description": "New client-defined status (max 64 characters).", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], + "description": "New status. One of `open`, `in_progress`, `done`, `cancelled`.", "maxLength": 64 }, "priority": { @@ -33742,8 +33770,11 @@ }, "target_status": { "type": "string", + "enum": [ + "done" + ], "maxLength": 64, - "description": "Client-defined status to set (max 64 characters). There is no fixed state machine." + "description": "Target status. Must be `done`; any other value is rejected." }, "idempotency_key": { "type": "string", @@ -33777,7 +33808,13 @@ "string", "null" ], - "description": "Optional client-defined status to set on the converted follow-up (max 64 characters).", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], + "description": "Optional status to set on the converted follow-up. One of `open`, `in_progress`, `done`, `cancelled`.", "maxLength": 64 }, "idempotency_key": { diff --git a/api-reference/on-call.openapi.zh.json b/api-reference/on-call.openapi.zh.json index 40acd1d6..c9bc1158 100644 --- a/api-reference/on-call.openapi.zh.json +++ b/api-reference/on-call.openapi.zh.json @@ -16889,7 +16889,8 @@ "created_at": 0, "updated_at": 0 } - ] + ], + "release_limited": false } } } @@ -18319,7 +18320,8 @@ "description": "当前账户中持有固定或临时 On-call 许可的人员。", "required": [ "total", - "items" + "items", + "release_limited" ], "properties": { "total": { @@ -18333,6 +18335,10 @@ "items": { "$ref": "#/components/schemas/LicensePersonItem" } + }, + "release_limited": { + "type": "boolean", + "description": "当前 30 天窗口内的许可释放配额是否已用尽。为 `true` 时释放席位会返回错误码 `NoLicense`。" } } }, @@ -27727,14 +27733,24 @@ "properties": { "cycle": { "type": "string", - "description": "通知周期,仅支持 `day`(按天)。", + "description": "通知周期:`day` 每天发送;`week` 在 `days` 列出的星期发送;`month` 在 `days` 列出的每月日期发送。", "enum": [ - "day" + "day", + "week", + "month" ] }, "start": { "type": "string", "description": "发送时间,格式 `HH:MM`(24 小时制)。" + }, + "days": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "description": "通知发送日,按值班表时区的墙钟计算。`week` 为星期几(0-6,0 表示周日);`month` 为每月第几日(1-31,当月没有该日则跳过)。`cycle` 为 `week` 或 `month` 时必填,为 `day` 时忽略。" } } }, @@ -33607,8 +33623,14 @@ }, "status": { "type": "string", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, - "description": "可选的客户端自定义初始状态(最长 64 字符)。" + "description": "可选,客户端自定义的初始状态,取 `open`、`in_progress`、`done`、`cancelled` 之一;省略或为空时默认为 `open`。" }, "priority": { "type": "string", @@ -33687,7 +33709,13 @@ "string", "null" ], - "description": "新的客户端自定义状态(最长 64 字符)。", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], + "description": "新的客户端自定义状态,取 `open`、`in_progress`、`done`、`cancelled` 之一。", "maxLength": 64 }, "priority": { @@ -33742,8 +33770,11 @@ }, "target_status": { "type": "string", + "enum": [ + "done" + ], "maxLength": 64, - "description": "要设置的客户端自定义状态(最长 64 字符),没有固定状态机。" + "description": "要设置的目标状态,必须为 `done`,其他取值一律拒绝。" }, "idempotency_key": { "type": "string", @@ -33777,7 +33808,13 @@ "string", "null" ], - "description": "可选,设置在转化后后续行动上的客户端自定义状态(最长 64 字符)。", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], + "description": "可选,设置在转化后后续行动上的状态,取 `open`、`in_progress`、`done`、`cancelled` 之一。", "maxLength": 64 }, "idempotency_key": { diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index 1a797fbb..25a09cd4 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -4991,7 +4991,10 @@ "type": "string" }, "target_status": { - "description": "Client-defined status to set (max 64 characters). There is no fixed state machine.", + "description": "Target status. Must be `done`; any other value is rejected.", + "enum": [ + "done" + ], "maxLength": 64, "type": "string" }, @@ -5057,7 +5060,13 @@ "type": "string" }, "target_status": { - "description": "Optional client-defined status to set on the converted follow-up (max 64 characters).", + "description": "Optional status to set on the converted follow-up. One of `open`, `in_progress`, `done`, `cancelled`.", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, "type": [ "string", @@ -6649,7 +6658,13 @@ "type": "string" }, "status": { - "description": "Optional client-defined initial status (max 64 characters).", + "description": "Initial status. One of `open`, `in_progress`, `done`, `cancelled`; defaults to `open` when omitted or blank.", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, "type": "string" }, @@ -13348,6 +13363,10 @@ }, "type": "array" }, + "release_limited": { + "description": "Whether the account has used up its license release quota for the current 30-day window. While `true`, releasing a seat fails with error code `NoLicense`.", + "type": "boolean" + }, "total": { "description": "Number of people holding an active license.", "format": "int64", @@ -13356,7 +13375,8 @@ }, "required": [ "total", - "items" + "items", + "release_limited" ], "type": "object" }, @@ -22640,12 +22660,22 @@ "description": "Fixed-time notification config.", "properties": { "cycle": { - "description": "Notification cycle; only `day` is supported.", + "description": "Notification cycle: `day` sends every day; `week` sends on the weekdays listed in `days`; `month` sends on the day-of-month values listed in `days`.", "enum": [ - "day" + "day", + "week", + "month" ], "type": "string" }, + "days": { + "description": "Days the notification fires on, read in the schedule's timezone. For `week`, weekday numbers 0-6 (0 = Sunday); for `month`, day-of-month numbers 1-31, and a month without that date is skipped. Required when `cycle` is `week` or `month`; ignored when `cycle` is `day`.", + "items": { + "format": "int64", + "type": "integer" + }, + "type": "array" + }, "start": { "description": "Time of day to send, format `HH:MM` (24-hour).", "type": "string" @@ -27760,7 +27790,13 @@ ] }, "status": { - "description": "New client-defined status (max 64 characters).", + "description": "New status. One of `open`, `in_progress`, `done`, `cancelled`.", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, "type": [ "string", @@ -48975,6 +49011,7 @@ "updated_by": 0 } ], + "release_limited": false, "total": 2 }, "request_id": "01J0D5Y31GY2TWAHRP3Q8K4M6N" diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index d2df26db..281ea240 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -4991,7 +4991,10 @@ "type": "string" }, "target_status": { - "description": "要设置的客户端自定义状态(最长 64 字符),没有固定状态机。", + "description": "要设置的目标状态,必须为 `done`,其他取值一律拒绝。", + "enum": [ + "done" + ], "maxLength": 64, "type": "string" }, @@ -5057,7 +5060,13 @@ "type": "string" }, "target_status": { - "description": "可选,设置在转化后后续行动上的客户端自定义状态(最长 64 字符)。", + "description": "可选,设置在转化后后续行动上的状态,取 `open`、`in_progress`、`done`、`cancelled` 之一。", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, "type": [ "string", @@ -6649,7 +6658,13 @@ "type": "string" }, "status": { - "description": "可选的客户端自定义初始状态(最长 64 字符)。", + "description": "可选,客户端自定义的初始状态,取 `open`、`in_progress`、`done`、`cancelled` 之一;省略或为空时默认为 `open`。", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, "type": "string" }, @@ -13348,6 +13363,10 @@ }, "type": "array" }, + "release_limited": { + "description": "当前 30 天窗口内的许可释放配额是否已用尽。为 `true` 时释放席位会返回错误码 `NoLicense`。", + "type": "boolean" + }, "total": { "description": "持有有效许可的人员数量。", "format": "int64", @@ -13356,7 +13375,8 @@ }, "required": [ "total", - "items" + "items", + "release_limited" ], "type": "object" }, @@ -22640,12 +22660,22 @@ "description": "固定时间通知配置。", "properties": { "cycle": { - "description": "通知周期,仅支持 `day`(按天)。", + "description": "通知周期:`day` 每天发送;`week` 在 `days` 列出的星期发送;`month` 在 `days` 列出的每月日期发送。", "enum": [ - "day" + "day", + "week", + "month" ], "type": "string" }, + "days": { + "description": "通知发送日,按值班表时区的墙钟计算。`week` 为星期几(0-6,0 表示周日);`month` 为每月第几日(1-31,当月没有该日则跳过)。`cycle` 为 `week` 或 `month` 时必填,为 `day` 时忽略。", + "items": { + "format": "int64", + "type": "integer" + }, + "type": "array" + }, "start": { "description": "发送时间,格式 `HH:MM`(24 小时制)。", "type": "string" @@ -27760,7 +27790,13 @@ ] }, "status": { - "description": "新的客户端自定义状态(最长 64 字符)。", + "description": "新的客户端自定义状态,取 `open`、`in_progress`、`done`、`cancelled` 之一。", + "enum": [ + "open", + "in_progress", + "done", + "cancelled" + ], "maxLength": 64, "type": [ "string", @@ -48975,6 +49011,7 @@ "updated_by": 0 } ], + "release_limited": false, "total": 2 }, "request_id": "01J0D5Y31GY2TWAHRP3Q8K4M6N"