tccli 3.0.1121.1__py2.py3-none-any.whl → 3.0.1123.1__py2.py3-none-any.whl

tccli/services/ess/ess_client.py

@@ -277,6 +277,58 @@ def doStartFlow(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doCreateUserMobileChangeUrl(args, parsed_globals):
+    g_param = parse_global_arg(parsed_globals)
+
+    if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
+        cred = credential.CVMRoleCredential()
+    elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
+        cred = credential.STSAssumeRoleCredential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
+            g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
+        )
+    elif os.getenv(OptionsDefine.ENV_TKE_REGION)             and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID)             and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE)             and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
+        cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
+    else:
+        cred = credential.Credential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
+        )
+    http_profile = HttpProfile(
+        reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
+        reqMethod="POST",
+        endpoint=g_param[OptionsDefine.Endpoint],
+        proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
+    )
+    profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.CreateUserMobileChangeUrlRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.CreateUserMobileChangeUrl(model)
+        result = rsp.to_json_string()
+        try:
+            json_obj = json.loads(result)
+        except TypeError as e:
+            json_obj = json.loads(result.decode('utf-8'))  # python3.3
+        if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
+            break
+        cur_time = time.time()
+        if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
+            raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
+            (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
+            search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
+        else:
+            print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
+        time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
+    FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
+
+
 def doCancelFlow(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -4349,6 +4401,7 @@ ACTION_MAP = {
     "DescribeOrganizationGroupOrganizations": doDescribeOrganizationGroupOrganizations,
     "ModifyApplicationCallbackInfo": doModifyApplicationCallbackInfo,
     "StartFlow": doStartFlow,
+    "CreateUserMobileChangeUrl": doCreateUserMobileChangeUrl,
     "CancelFlow": doCancelFlow,
     "DescribeFlowTemplates": doDescribeFlowTemplates,
     "DeleteSealPolicies": doDeleteSealPolicies,

tccli/services/ess/v20201111/api.json

@@ -287,6 +287,13 @@
       "output": "CreateUserAutoSignSealUrlResponse",
       "status": "online"
     },
+    "CreateUserMobileChangeUrl": {
+      "document": "该接口会生成一个手机号变更的链接，用户可以通过该链接进入电子签系统进行手机号的变更。\n该接口支持员工和个人端手机号的变更。",
+      "input": "CreateUserMobileChangeUrlRequest",
+      "name": "生成修改用户手机号链接",
+      "output": "CreateUserMobileChangeUrlResponse",
+      "status": "online"
+    },
     "CreateUserVerifyUrl": {
       "document": "客户可以主动调用生成实名链接去做C端用户实名，会对实名的用户进行打标记为调用链接客户的用户\n使用场景：\n用户集成场景\n使用限制：\n此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估",
       "input": "CreateUserVerifyUrlRequest",
@@ -6322,6 +6329,125 @@
       ],
       "type": "object"
     },
+    "CreateUserMobileChangeUrlRequest": {
+      "document": "CreateUserMobileChangeUrl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。",
+          "example": "无",
+          "member": "UserInfo",
+          "name": "Operator",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。",
+          "example": "无",
+          "member": "Agent",
+          "name": "Agent",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。\n\n[点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)",
+          "example": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
+          "member": "string",
+          "name": "UserId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要修改手机号用户的类型。\n<ul><li>0：员工 （默认）</li><li>1：个人</li>\n</ul>\n如果是员工类型，<b>只能修改本方员工，而不能修改其他企业的员工</b>。\n如果是个人类型，可<b>不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。</b>\n",
+          "example": "1",
+          "member": "uint64",
+          "name": "UserAccountType",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。\n\n如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为<b>必填项。</b>",
+          "example": "典子谦",
+          "member": "string",
+          "name": "Name",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要修改手机号用户的证件类型，\n目前支持的账号类型如下：\n\n<ul><li><b>ID_CARD </b>: （默认）中国大陆居民身份证 </li>\n<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>\n<li><b>HONGKONG_MACAO_AND_TAIWAN </b>: 港澳台居民居住证(格式同居民身份证)</li></ul>\n",
+          "example": "ID_CARD ",
+          "member": "string",
+          "name": "IdCardType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要修改手机号用户的身份证号码，应符合以下规则\n<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>\n<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>\n<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>\n如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为<b>必填项。</b>",
+          "example": "620000198802020000",
+          "member": "string",
+          "name": "IdCardNumber",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要跳转的链接类型\n\n<ul>\n<li><b>HTTP</b>：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)</li>\n<li><b>HTTP_SHORT_URL</b>：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链</li>\n<li><b>APP</b>：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>\n</ul>\n\n",
+          "example": "APP",
+          "member": "string",
+          "name": "Endpoint",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。\n\n请注意：\n此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。",
+          "example": "MTIzNDU2Nzg5",
+          "member": "string",
+          "name": "UserData",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateUserMobileChangeUrlResponse": {
+      "document": "CreateUserMobileChangeUrl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "腾讯电子签小程序的实名认证链接。\n如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。\n\n- 如果EndPoint是APP，\n得到的链接类似于pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n- 如果EndPoint是HTTP，\n得到的链接类似于https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcChrfpaswT0d，点击后会跳转到腾讯电子签小程序进行签署\n\n- 如果EndPoint是HTTP_SHORT_URL，\n得到的链接类似于https://essurl.cn/2n**42Nd，点击后会跳转到腾讯电子签小程序进行签署\n\n\n注： 生成的链路后面不能再增加参数\n示例值：https://essurl.cn/2n**42Nd",
+          "example": "无",
+          "member": "string",
+          "name": "Url",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "链接失效期限如下：\n\n<ul>\n<li>如果指定更换绑定手机号的用户(指定用户ID或姓名等信息)，则设定的链接失效期限为7天后。</li>\n<li>如果没有指定更换绑定手机号的用户，则生成通用跳转到个人换手机号的界面，链接不会过期。</li>\n</ul>",
+          "example": "无",
+          "member": "int64",
+          "name": "ExpireTime",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateUserVerifyUrlRequest": {
       "document": "CreateUserVerifyUrl请求参数结构体",
       "members": [

tccli/services/ess/v20201111/examples.json

@@ -1012,6 +1012,26 @@
         "title": "错误示例-获取设置自动签印章的小程序链接。"
       }
     ],
+    "CreateUserMobileChangeUrl": [
+      {
+        "document": "生成修改个人手机号链接，\n此用户是通过 获取c端用户实名链接实名的，\n调用方知道用户的 userId， 所以使用 UserId 的方式生成手机号变更链接\n生成的链接是 APP 的方式，所以参数中 Endpoint 为 APP",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserMobileChangeUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\",\n        \"ClientIp\": \"8.8.8.8\"\n    },\n    \"UserId\": \"yDCZmUUckpy1jpdxUBBx43i4P29qekYx\",\n    \"Endpoint\": \"APP\",\n    \"UserData\": \"MjMwMDAwMTM4Mw==\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ExpireTime\": 1717751037,\n        \"RequestId\": \"s1717146237659391990\",\n        \"Url\": \"pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZiUv2ByIvoFcoDTfb&autoJumpBack=true\"\n    }\n}",
+        "title": "生成修改个人手机号链接"
+      },
+      {
+        "document": "使用二要素（姓名/证件号）生成修改个人手机号链接\n此用户是通过 获取c端用户实名链接实名的，\n调用方不知道用户的 userId，但是有用户的二要素信息（姓名和证件号）\n此时需要传递参数UserAccountType 为 1，表示个人\n生成的链接是 短链的方式，所以参数中 Endpoint 为 HTTP_SHORT_URL",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserMobileChangeUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\",\n        \"ClientIp\": \"8.8.8.8\"\n    },\n    \"UserAccountType\": 1,\n    \"Name\": \"典子谦\",\n    \"IdCardType\": \"ID_CARD\",\n    \"IdCardNumber\": \"620000198802020000\",\n    \"Endpoint\": \"HTTP_SHORT_URL\",\n    \"UserData\": \"MjMwMDAwMTM4Mw==\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ExpireTime\": 1717754432,\n        \"RequestId\": \"s1717149632556325434\",\n        \"Url\": \"https://test.essurl.cn/qLAEUBG2s4\"\n    }\n}",
+        "title": "使用二要素生成修改个人手机号链接"
+      },
+      {
+        "document": "使用二要素（姓名/证件号）生成修改员工手机号链接\n此用户是通过 获取c端用户实名链接实名的，\n调用方不知道用户的 userId，但是有用户的二要素信息（姓名和证件号）\n此时需要传递参数UserAccountType 为 0，表示员工\n生成的链接是 短链的方式，所以参数中 Endpoint 为 HTTP_SHORT_URL",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserMobileChangeUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\",\n        \"ClientIp\": \"8.8.8.8\"\n    },\n    \"UserAccountType\": 0,\n    \"Name\": \"典子谦\",\n    \"IdCardType\": \"ID_CARD\",\n    \"IdCardNumber\": \"620000198802020000\",\n    \"Endpoint\": \"HTTP_SHORT_URL\",\n    \"UserData\": \"MjMwMDAwMTM4Mw==\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ExpireTime\": 1717754432,\n        \"RequestId\": \"s1717149632556325434\",\n        \"Url\": \"https://test.essurl.cn/qHAEUjG2s4\"\n    }\n}",
+        "title": "使用二要素生成修改员工手机号链接"
+      }
+    ],
     "CreateUserVerifyUrl": [
       {
         "document": "获取c端用户实名链接",

tccli/services/faceid/v20180301/api.json

@@ -2521,7 +2521,7 @@
         },
         {
           "disabled": false,
-          "document": "意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。",
+          "document": "意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认开启。",
           "example": "true",
           "member": "bool",
           "name": "IntentionRecognition",
@@ -5033,7 +5033,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认不开启。",
+          "document": "意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认开启。",
           "example": "true",
           "member": "bool",
           "name": "IntentionRecognition",

tccli/services/iotcloud/v20210408/api.json

@@ -2489,7 +2489,7 @@
           "example": "1.0.3",
           "member": "string",
           "name": "Version",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2499,7 +2499,7 @@
           "example": "7ZISKXPJVU",
           "member": "string",
           "name": "ProductId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2509,7 +2509,7 @@
           "example": "name",
           "member": "string",
           "name": "Name",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2519,7 +2519,7 @@
           "example": "desc",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2529,7 +2529,7 @@
           "example": "md5",
           "member": "string",
           "name": "Md5sum",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -2539,7 +2539,7 @@
           "example": "1597047368",
           "member": "uint64",
           "name": "Createtime",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -2549,7 +2549,7 @@
           "example": "ABC",
           "member": "string",
           "name": "ProductName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2559,10 +2559,20 @@
           "example": "mcu",
           "member": "string",
           "name": "FwType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "固件用户自定义配置信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "{\"key1\":\"value1\", \"key2\":\"支持中文\"}",
+          "member": "string",
+          "name": "UserDefined",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",
@@ -4447,7 +4457,7 @@
           "example": "1.0.1",
           "member": "string",
           "name": "Version",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -4457,7 +4467,7 @@
           "example": "2f8222b4f275c4f18e69c34f66d2631b",
           "member": "string",
           "name": "Md5sum",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -4467,7 +4477,7 @@
           "example": "1617801604",
           "member": "uint64",
           "name": "CreateTime",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -4477,7 +4487,7 @@
           "example": "ABCDE12345",
           "member": "string",
           "name": "ProductName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -4487,7 +4497,7 @@
           "example": "固件名称",
           "member": "string",
           "name": "Name",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -4497,7 +4507,7 @@
           "example": "固件信息描述",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -4507,7 +4517,7 @@
           "example": "ABCDE12345",
           "member": "string",
           "name": "ProductId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -4517,7 +4527,7 @@
           "example": "mcu",
           "member": "string",
           "name": "FwType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -4527,9 +4537,19 @@
           "example": "0",
           "member": "uint64",
           "name": "CreateUserId",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "固件用户自定义配置信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "{\"key1\":\"value1\", \"key2\":\"支持中文\"}",
+          "member": "string",
+          "name": "UserDefined",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"

tccli/services/iotexplorer/v20190423/api.json

@@ -7645,7 +7645,7 @@
           "example": "1.0.0",
           "member": "string",
           "name": "Version",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -7655,7 +7655,7 @@
           "example": "bd9dc3549a0d75bb242d9d4f5842f221",
           "member": "string",
           "name": "Md5sum",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -7665,7 +7665,7 @@
           "example": "1619322032",
           "member": "uint64",
           "name": "CreateTime",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -7675,7 +7675,7 @@
           "example": "productName",
           "member": "string",
           "name": "ProductName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -7685,7 +7685,7 @@
           "example": "firmwareName",
           "member": "string",
           "name": "Name",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -7695,7 +7695,7 @@
           "example": "firmwareDesc",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -7705,7 +7705,7 @@
           "example": "productId",
           "member": "string",
           "name": "ProductId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -7715,7 +7715,7 @@
           "example": "mcu",
           "member": "string",
           "name": "FwType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -7725,7 +7725,7 @@
           "example": "123",
           "member": "int64",
           "name": "CreateUserId",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -7735,7 +7735,17 @@
           "example": "喵喵",
           "member": "string",
           "name": "CreatorNickName",
-          "required": true,
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "固件用户自定义配置信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "{\"key1\":\"value1\", \"key2\":\"支持中文\"}",
+          "member": "string",
+          "name": "UserDefined",
+          "output_required": false,
           "type": "string",
           "value_allowed_null": true
         }