tccli 3.0.923.1__py2.py3-none-any.whl → 3.0.924.1__py2.py3-none-any.whl

tccli/services/essbasic/v20210526/api.json

@@ -183,7 +183,7 @@
       "status": "online"
     },
     "ChannelGetTaskResultApi": {
-      "document": "通过发起转换任务接口（ChannelCreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。",
+      "document": "查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。\n注意：大文件转换所需的时间可能会比较长。",
       "input": "ChannelGetTaskResultApiRequest",
       "name": "查询转换任务状态",
       "output": "ChannelGetTaskResultApiResponse",
@@ -267,7 +267,7 @@
       "status": "online"
     },
     "DescribeTemplates": {
-      "document": "通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板",
+      "document": "通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。\n\n> **适用场景** \n>\n>  该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 \n>  一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents\n>- 生成模板的文件基础信息 FileInfos",
       "input": "DescribeTemplatesRequest",
       "name": "查询模板信息列表",
       "output": "DescribeTemplatesResponse",
@@ -2798,6 +2798,7 @@
           "disabled": false,
           "document": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。",
           "example": "无",
+          "is_base64": false,
           "member": "Agent",
           "name": "Agent",
           "required": true,
@@ -2807,6 +2808,7 @@
           "disabled": false,
           "document": "任务Id，通过ChannelCreateConvertTaskApi接口获得",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "TaskId",
           "required": true,
@@ -2816,6 +2818,7 @@
           "disabled": true,
           "document": "操作者的信息，不用传",
           "example": "无",
+          "is_base64": false,
           "member": "UserInfo",
           "name": "Operator",
           "required": false,
@@ -2825,6 +2828,7 @@
           "disabled": true,
           "document": "暂未开放",
           "example": "无",
+          "is_base64": false,
           "member": "OrganizationInfo",
           "name": "Organization",
           "required": false,
@@ -3212,7 +3216,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "控件编号\n\nCreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充\n\n注：\n当GenerateMode=KEYWORD时，通过\"^\"来决定是否使用关键字整词匹配能力。\n例：\n当GenerateMode=KEYWORD时，如果传入关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的地方进行对应操作。\n如传入的关键字为\"甲方签署\"，则PDF文件中每个出现关键字的位置都会执行相应操作。\n\n创建控件时，此值为空\n查询时返回完整结构",
+          "document": "控件编号\n\nCreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充\n\n注：\n当GenerateMode=KEYWORD时，通过\"^\"来决定是否使用关键字整词匹配能力。\n例：当GenerateMode=KEYWORD时，如果传入关键字\"^甲方签署^\"，则会在PDF文件中有且仅有\"甲方签署\"关键字的地方进行对应操作。\n如传入的关键字为\"甲方签署\"，则PDF文件中每个出现关键字的位置都会执行相应操作。\n\n创建控件时，此值为空\n查询时返回完整结构",
           "example": "ComponentId",
           "is_base64": false,
           "member": "string",
@@ -3236,7 +3240,7 @@
         },
         {
           "disabled": false,
-          "document": "控件简称，不能超过30个字符",
+          "document": "控件简称，不超过30个字符",
           "example": "ComponentName",
           "is_base64": false,
           "member": "string",
@@ -3248,7 +3252,7 @@
         },
         {
           "disabled": false,
-          "document": "定义控件是否为必填项，默认为false",
+          "document": "控件是否为必填项，\n默认为false-非必填",
           "example": "false",
           "member": "bool",
           "name": "ComponentRequired",
@@ -3259,7 +3263,7 @@
         },
         {
           "disabled": false,
-          "document": "控件关联的签署方id",
+          "document": "控件关联的参与方ID，对应Recipient结构体中的RecipientId\t",
           "example": "ComponentRecipientId",
           "is_base64": false,
           "member": "string",
@@ -3384,7 +3388,7 @@
         },
         {
           "disabled": false,
-          "document": "控件所属文档的Id, 模块相关接口为空值",
+          "document": "控件所属文档的Id, 模板相关接口为空值",
           "example": "c17bdf9c2a7bdcb32611f4d0200fee3d",
           "is_base64": false,
           "member": "string",
@@ -3396,7 +3400,7 @@
         },
         {
           "disabled": false,
-          "document": "控件描述，不能超过30个字符",
+          "document": "控件描述，不超过30个字符",
           "example": "Desc",
           "is_base64": false,
           "member": "string",
@@ -3442,7 +3446,7 @@
         },
         {
           "disabled": false,
-          "document": "指定关键字排序规则，Positive-正序，Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。",
+          "document": "指定关键字排序规则，\nPositive-正序，\nReverse-倒序。\n传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。\n传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。",
           "example": "Positive\\Reverse",
           "is_base64": false,
           "member": "string",
@@ -3454,7 +3458,7 @@
         },
         {
           "disabled": false,
-          "document": "指定关键字页码，可选参数，指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来",
+          "document": "指定关键字页码。\n指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来",
           "example": "无",
           "member": "int64",
           "name": "KeywordPage",
@@ -3465,7 +3469,7 @@
         },
         {
           "disabled": false,
-          "document": "关键字位置模式，Middle-居中，Below-正下方，Right-正右方，LowerRight-右上角，UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
+          "document": "关键字位置模式，\nMiddle-居中，\nBelow-正下方，\nRight-正右方，\nLowerRight-右上角，\nUpperRight-右下角。\n示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方",
           "example": "无",
           "is_base64": false,
           "member": "string",
@@ -3477,7 +3481,7 @@
         },
         {
           "disabled": false,
-          "document": "关键字索引，可选参数，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。",
+          "document": "关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。\n示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。",
           "example": "无",
           "member": "int64",
           "name": "KeywordIndexes",
@@ -4452,8 +4456,9 @@
       "members": [
         {
           "disabled": false,
-          "document": "应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。",
+          "document": "应用相关信息。 \n此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。",
           "example": "无",
+          "is_base64": false,
           "member": "Agent",
           "name": "Agent",
           "required": true,
@@ -4463,6 +4468,7 @@
           "disabled": false,
           "document": "模板唯一标识，查询单个模板时使用",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "TemplateId",
           "required": false,
@@ -4470,8 +4476,9 @@
         },
         {
           "disabled": false,
-          "document": "查询内容：0-模板列表及详情（默认），1-仅模板列表",
+          "document": "查询内容：\n0-模板列表及详情（默认），\n1-仅模板列表",
           "example": "无",
+          "is_base64": false,
           "member": "int64",
           "name": "ContentType",
           "required": false,
@@ -4479,8 +4486,9 @@
         },
         {
           "disabled": false,
-          "document": "查询个数，默认20，最大100；在查询列表的时候有效",
+          "document": "指定每页多少条数据，如果不传默认为20，单页最大100。",
           "example": "无",
+          "is_base64": false,
           "member": "uint64",
           "name": "Limit",
           "required": false,
@@ -4488,8 +4496,9 @@
         },
         {
           "disabled": false,
-          "document": "查询偏移位置，默认0；在查询列表的时候有效",
+          "document": "查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。",
           "example": "无",
+          "is_base64": false,
           "member": "uint64",
           "name": "Offset",
           "required": false,
@@ -4497,8 +4506,9 @@
         },
         {
           "disabled": false,
-          "document": "是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件",
+          "document": "是否返回所有组件信息。\n默认false，只返回发起方控件；\ntrue，返回所有签署方控件",
           "example": "无",
+          "is_base64": false,
           "member": "bool",
           "name": "QueryAllComponents",
           "required": false,
@@ -4508,6 +4518,7 @@
           "disabled": false,
           "document": "模糊搜索模板名称，最大长度200",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "TemplateName",
           "required": false,
@@ -4515,8 +4526,9 @@
         },
         {
           "disabled": false,
-          "document": "是否获取模板预览链接",
+          "document": "是否获取模板预览链接，\n默认false-不获取\ntrue-获取",
           "example": "无",
+          "is_base64": false,
           "member": "bool",
           "name": "WithPreviewUrl",
           "required": false,
@@ -4524,8 +4536,9 @@
         },
         {
           "disabled": false,
-          "document": "是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。",
+          "document": "是否获取模板的PDF文件链接。\n默认false-不获取\ntrue-获取\n请联系客户经理开白后使用。",
           "example": "无",
+          "is_base64": false,
           "member": "bool",
           "name": "WithPdfUrl",
           "required": false,
@@ -4535,6 +4548,7 @@
           "disabled": false,
           "document": "对应第三方应用平台企业的模板ID",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "ChannelTemplateId",
           "required": false,
@@ -4544,6 +4558,7 @@
           "disabled": true,
           "document": "操作者的信息",
           "example": "无",
+          "is_base64": false,
           "member": "UserInfo",
           "name": "Operator",
           "required": false,
@@ -4557,7 +4572,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "模板详情",
+          "document": "模板列表",
           "example": "无",
           "member": "TemplateInfo",
           "name": "Templates",
@@ -4567,7 +4582,7 @@
         },
         {
           "disabled": false,
-          "document": "查询总数",
+          "document": "查询到的总数",
           "example": "无",
           "member": "int64",
           "name": "TotalCount",
@@ -4577,7 +4592,7 @@
         },
         {
           "disabled": false,
-          "document": "查询数量",
+          "document": "每页多少条数据",
           "example": "无",
           "member": "uint64",
           "name": "Limit",
@@ -4587,7 +4602,7 @@
         },
         {
           "disabled": false,
-          "document": "查询起始偏移",
+          "document": "查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。",
           "example": "无",
           "member": "uint64",
           "name": "Offset",
@@ -5975,8 +5990,9 @@
       "members": [
         {
           "disabled": false,
-          "document": "应用相关信息。 此接口Agent.AppId必填。",
+          "document": "应用相关信息。 \n此接口Agent.AppId必填。",
           "example": "无",
+          "is_base64": false,
           "member": "Agent",
           "name": "Agent",
           "required": true,
@@ -5984,8 +6000,9 @@
         },
         {
           "disabled": false,
-          "document": "操作类型，查询:\"SELECT\"，删除:\"DELETE\"，更新:\"UPDATE\"",
+          "document": "操作类型，\n查询:\"SELECT\"，\n删除:\"DELETE\"，\n更新:\"UPDATE\"",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "OperateType",
           "required": true,
@@ -5995,6 +6012,7 @@
           "disabled": false,
           "document": "第三方应用平台模板库模板唯一标识",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "TemplateId",
           "required": true,
@@ -6002,8 +6020,9 @@
         },
         {
           "disabled": false,
-          "document": "合作企业方第三方机构唯一标识数据，支持多个， 用\",\"进行分隔",
+          "document": "合作企业方第三方机构唯一标识数据.\n支持多个， 用\",\"进行分隔",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "ProxyOrganizationOpenIds",
           "required": false,
@@ -6011,30 +6030,33 @@
         },
         {
           "disabled": false,
-          "document": "模板可见性, 全部可见-\"all\", 部分可见-\"part\"",
+          "document": "模板可见性, \n全部可见-\"all\",\n 部分可见-\"part\"",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "AuthTag",
           "required": false,
           "type": "string"
         },
+        {
+          "disabled": false,
+          "document": "当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。\n若此字段值为0，则不会修改模板Available，\n1为启用模板，\n2为停用模板。\n启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。",
+          "example": "无",
+          "is_base64": false,
+          "member": "int64",
+          "name": "Available",
+          "required": false,
+          "type": "int"
+        },
         {
           "disabled": true,
           "document": "暂未开放",
           "example": "无",
+          "is_base64": false,
           "member": "UserInfo",
           "name": "Operator",
           "required": false,
           "type": "object"
-        },
-        {
-          "disabled": false,
-          "document": "当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。若此字段值为0，则不会修改模板Available，1为启用模板，2为停用模板。\n启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。",
-          "example": "无",
-          "member": "int64",
-          "name": "Available",
-          "required": false,
-          "type": "int"
         }
       ],
       "type": "object"
@@ -6064,7 +6086,7 @@
         },
         {
           "disabled": false,
-          "document": "描述模板可见性更改的结果，和参数中Available无关，全部成功-\"all-success\",部分成功-\"part-success\", 全部失败-\"fail\"失败的会在FailMessageList中展示。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "描述模板可见性更改的结果，和参数中Available无关。\n全部成功-\"all-success\",\n部分成功-\"part-success\", \n全部失败-\"fail\"，失败的会在FailMessageList中展示。\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "all-success",
           "member": "string",
           "name": "OperateResult",
@@ -6074,7 +6096,7 @@
         },
         {
           "disabled": false,
-          "document": "模板可见性, 全部可见-\"all\", 部分可见-\"part\"\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "模板可见性, \n全部可见-\"all\", \n部分可见-\"part\"\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "SELECT",
           "member": "string",
           "name": "AuthTag",
@@ -6448,74 +6470,85 @@
       "usage": "in"
     },
     "Recipient": {
-      "document": "签署参与者信息",
+      "document": "流程中参与方的信息结构",
       "members": [
         {
           "disabled": false,
-          "document": "签署人唯一标识，在通过模板发起合同的时候对应签署方Id",
+          "document": "签署人唯一标识，在通过模板发起合同的时候对应签署方ID",
           "example": "ed68bc6904fbd4795b4658c480214e4e",
+          "is_base64": false,
           "member": "string",
           "name": "RecipientId",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "参与者类型。默认为空。ENTERPRISE-企业；INDIVIDUAL-个人；PROMOTER-发起方",
+          "document": "参与者类型，默认为空。\nENTERPRISE-企业；\nINDIVIDUAL-个人；\nPROMOTER-发起方",
           "example": "ENTERPRISE",
+          "is_base64": false,
           "member": "string",
           "name": "RecipientType",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "描述",
+          "document": "描述信息\t",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "Description",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "签署方备注角色名",
+          "document": "角色名称\t",
           "example": "无",
+          "is_base64": false,
           "member": "string",
           "name": "RoleName",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "是否需要校验，true-是，false-否",
+          "document": "是否需要校验，\ntrue-是，\nfalse-否",
           "example": "true",
           "member": "bool",
           "name": "RequireValidation",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "是否必须填写，true-是，false-否",
+          "document": "是否必须填写，\ntrue-是，\nfalse-否",
           "example": "true",
           "member": "bool",
           "name": "RequireSign",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "签署类型",
+          "document": "内部字段，签署类型",
           "example": "0",
           "member": "int64",
           "name": "SignType",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": false
@@ -6526,16 +6559,18 @@
           "example": "0",
           "member": "int64",
           "name": "RoutingOrder",
+          "output_required": true,
           "required": false,
           "type": "int",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "是否是发起方",
+          "document": "是否是发起方，\ntrue-是 \nfalse-否",
           "example": "true",
           "member": "bool",
           "name": "IsPromoter",
+          "output_required": true,
           "required": false,
           "type": "bool",
           "value_allowed_null": false
@@ -7387,25 +7422,25 @@
       "usage": "out"
     },
     "TemplateInfo": {
-      "document": "此结构体 (TemplateInfo) 用于描述模板的信息。",
+      "document": "此结构体 (TemplateInfo) 用于描述模板的信息。\n\n> **模板组成** \n>\n>  一个模板通常会包含以下结构信息\n>- 模板基本信息\n>- 签署参与方 Recipients，在模板发起合同时用于指定参与方\n>- 填写控件 Components\n>- 签署控件 SignComponents",
       "members": [
         {
           "disabled": false,
-          "document": "模板ID",
+          "document": "模板ID，模板的唯一标识",
           "example": "无",
           "member": "string",
           "name": "TemplateId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "模板名字",
+          "document": "模板名",
           "example": "无",
           "member": "string",
           "name": "TemplateName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -7415,37 +7450,37 @@
           "example": "无",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "模板的填充控件信息结构",
+          "document": "模板的填充控件列表",
           "example": "无",
           "member": "Component",
           "name": "Components",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "模板中的流程参与人信息",
+          "document": "模板中的签署参与方列表",
           "example": "无",
           "member": "Recipient",
           "name": "Recipients",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "模板中的签署控件信息结构",
+          "document": "模板中的签署控件列表",
           "example": "无",
           "member": "Component",
           "name": "SignComponents",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -7455,7 +7490,7 @@
           "example": "3",
           "member": "int64",
           "name": "TemplateType",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -7465,7 +7500,7 @@
           "example": "true",
           "member": "bool",
           "name": "IsPromoter",
-          "required": false,
+          "output_required": true,
           "type": "bool",
           "value_allowed_null": false
         },
@@ -7475,87 +7510,87 @@
           "example": "无",
           "member": "string",
           "name": "Creator",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "模板创建的时间戳，单位秒",
+          "document": "模板创建的时间戳，格式为Unix标准时间戳（秒）",
           "example": "无",
           "member": "int64",
           "name": "CreatedOn",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "模板的H5预览链接,可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回，有效期5分钟。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "模板的H5预览链接,有效期5分钟。\n可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。\n（此功能开放需要联系客户经理）\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "string",
           "name": "PreviewUrl",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
           "disabled": false,
-          "document": "第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理），有效期5分钟。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "第三方应用集成-模板PDF文件链接，有效期5分钟。\n请求参数WithPdfUrl=true时返回\n（此功能开放需要联系客户经理）。\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "string",
           "name": "PdfUrl",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
           "disabled": false,
-          "document": "关联的第三方应用平台企业模板ID",
+          "document": "本模板关联的第三方应用平台企业模板ID",
           "example": "无",
           "member": "string",
           "name": "ChannelTemplateId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
-          "document": "关联的三方应用平台平台企业模板名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "本模板关联的三方应用平台平台企业模板名称\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "string",
           "name": "ChannelTemplateName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
           "disabled": false,
-          "document": "0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "0-需要子客企业手动领取平台企业的模板(默认); \n1-平台自动设置子客模板\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "int64",
           "name": "ChannelAutoSave",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
         {
           "disabled": false,
-          "document": "模板版本，全数字字符。默认为空，初始版本为yyyyMMdd001。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "模板版本，全数字字符。\n默认为空，初始版本为yyyyMMdd001。\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "string",
           "name": "TemplateVersion",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
           "disabled": false,
-          "document": "模板可用状态，取值：1启用（默认），2停用\n注意：此字段可能返回 null，表示取不到有效值。",
+          "document": "模板可用状态：\n1启用（默认）\n2停用\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "int64",
           "name": "Available",
-          "required": false,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         }