tencentcloud-sdk-essbasic 3.0.692 → 3.0.693

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b050ac52b1afe4fa59435fc53f5a7e99d2f32b99
4
- data.tar.gz: c1ab636d1d630d2c343cff9df501e6ea3fea9f65
3
+ metadata.gz: 92122df741bad1ea9f788e2ae1cb6c6472745879
4
+ data.tar.gz: f1efbb685b40827eae5b25856dd6f19c29255d6c
5
5
  SHA512:
6
- metadata.gz: 9955fddbfca773f02cd38d98701d7f5c2d842368e9db7017d5b343a644144cca6023576eb3306fafcb631eb04b30aa812cab076bdcc6e1270b2fbd25f3e6c783
7
- data.tar.gz: 1444f8779bf83ee44ed1550703cc87a93b7f446f5a723926f3d6b68f68a9f124684696c933034122bcc6ac14a2febb45b7389c0a711283fd48566c28e1ae1514
6
+ metadata.gz: e88a6ba347e69dcab1080753b7365246212eaadf481b5a52c45da80dd59527dcd02116ea56bafeede50a84493462eab74d2a85e1bd4fd536773c2dd854eb0341
7
+ data.tar.gz: 8f834d517c5955c554e08b3c315cee2678978c53d9c7429ec94136c06ac3e4a8de59fd4b3ac69f0e8fa1d214b895cba7fa8c3638ec9546899cd9a3b04b6c15d3
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.692
1
+ 3.0.693
@@ -1695,7 +1695,11 @@ module TencentCloud
1695
1695
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1696
1696
  end
1697
1697
 
1698
- # 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。
1698
+ # 此接口用于查询合同或者合同组的详情信息,支持查询多个(数量不能超过100)。
1699
+
1700
+ # 适用场景:可用于主动查询某个合同或者合同组的详情信息。
1701
+
1702
+ # 注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
1699
1703
 
1700
1704
  # @param request: Request instance for DescribeFlowDetailInfo.
1701
1705
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeFlowDetailInfoRequest`
@@ -1999,7 +2003,17 @@ module TencentCloud
1999
2003
  end
2000
2004
 
2001
2005
  # 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
2002
- # 若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
2006
+
2007
+ # - **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
2008
+
2009
+ # - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
2010
+
2011
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_SyncProxyOrganizationOperators.png)
2012
+
2013
+ # **注**:
2014
+ # - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
2015
+ # - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
2016
+ # - 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
2003
2017
 
2004
2018
  # @param request: Request instance for SyncProxyOrganizationOperators.
2005
2019
  # @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationOperatorsRequest`
@@ -2030,8 +2044,8 @@ module TencentCloud
2030
2044
  # 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
2031
2045
 
2032
2046
  # 注:
2033
- # 1. `图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下`
2034
- # 2. `联调开发环境调用时需要设置Domain接口请求域名为 file.test.ess.tencent.cn,正式环境需要设置为file.ess.tencent.cn,代码示例`
2047
+ # 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
2048
+ # 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
2035
2049
  # ```
2036
2050
  # HttpProfile httpProfile = new HttpProfile();
2037
2051
  # httpProfile.setEndpoint("file.test.ess.tencent.cn");
@@ -5029,13 +5029,22 @@ module TencentCloud
5029
5029
 
5030
5030
  # DescribeFlowDetailInfo请求参数结构体
5031
5031
  class DescribeFlowDetailInfoRequest < TencentCloud::Common::AbstractModel
5032
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5032
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5033
+
5034
+ # 此接口下面信息必填。
5035
+ # <ul>
5036
+ # <li>渠道应用标识: Agent.AppId</li>
5037
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5038
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5039
+ # </ul>
5040
+ # 第三方平台子客企业和员工必须已经经过实名认证
5033
5041
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
5034
- # @param FlowIds: 合同(流程)编号数组,最多支持100个。
5035
- # <br/>备注:该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参
5042
+ # @param FlowIds: 需要查询的流程ID列表,最多可传入100个ID。
5043
+ # 如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。
5036
5044
  # @type FlowIds: Array
5037
- # @param FlowGroupId: 合同组编号
5038
- # <br/>备注:该参数和合同(流程)编号数组必须二选一
5045
+ # @param FlowGroupId: 需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。
5046
+
5047
+ # 合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
5039
5048
  # @type FlowGroupId: String
5040
5049
  # @param Operator: 暂未开放
5041
5050
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -5068,17 +5077,18 @@ module TencentCloud
5068
5077
 
5069
5078
  # DescribeFlowDetailInfo返回参数结构体
5070
5079
  class DescribeFlowDetailInfoResponse < TencentCloud::Common::AbstractModel
5071
- # @param ApplicationId: 第三方平台应用号Id
5080
+ # @param ApplicationId: 合同归属的第三方平台应用号ID
5072
5081
  # @type ApplicationId: String
5073
- # @param ProxyOrganizationOpenId: 第三方平台子客企业OpenId
5082
+ # @param ProxyOrganizationOpenId: 合同归属的第三方平台子客企业OpenId
5074
5083
  # @type ProxyOrganizationOpenId: String
5075
- # @param FlowInfo: 合同(签署流程)的具体详细描述信息
5084
+ # @param FlowInfo: 合同流程的详细信息。
5085
+ # 如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。
5076
5086
  # 注意:此字段可能返回 null,表示取不到有效值。
5077
5087
  # @type FlowInfo: Array
5078
- # @param FlowGroupId: 合同组编号
5088
+ # @param FlowGroupId: 合同组ID,只有在查询合同组信息时才会返回。
5079
5089
  # 注意:此字段可能返回 null,表示取不到有效值。
5080
5090
  # @type FlowGroupId: String
5081
- # @param FlowGroupName: 合同组名称
5091
+ # @param FlowGroupName: 合同组名称,只有在查询合同组信息时才会返回。
5082
5092
  # 注意:此字段可能返回 null,表示取不到有效值。
5083
5093
  # @type FlowGroupName: String
5084
5094
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -6017,36 +6027,38 @@ module TencentCloud
6017
6027
 
6018
6028
  # 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
6019
6029
  class FlowDetailInfo < TencentCloud::Common::AbstractModel
6020
- # @param FlowId: 合同(流程)的Id
6030
+ # @param FlowId: 合同流程ID,为32位字符串。
6021
6031
  # @type FlowId: String
6022
- # @param FlowName: 合同(流程)的名字
6032
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
6023
6033
  # @type FlowName: String
6024
- # @param FlowType: 合同(流程)的类型
6034
+ # @param FlowType: 合同流程的类别分类(如销售合同/入职合同等)。
6025
6035
  # @type FlowType: String
6026
- # @param FlowStatus: 合同(流程)的状态, 状态如下
6027
-
6028
- # INIT 合同创建
6029
- # PART 合同签署中
6030
- # REJECT 合同拒签
6031
- # ALL 合同签署完成
6032
- # DEADLINE 合同流签(合同过期)
6033
- # CANCEL 合同撤回
6034
- # RELIEVED 解除协议(已解除)
6036
+ # @param FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
6037
+ # <ul><li> **INIT** :合同创建</li>
6038
+ # <li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
6039
+ # <li> **REJECT** :合同拒签</li>
6040
+ # <li> **ALL** :合同签署完成</li>
6041
+ # <li> **DEADLINE** :合同流签(合同过期)</li>
6042
+ # <li> **CANCEL** :合同撤回</li>
6043
+ # <li> **RELIEVED** :解除协议(已解除)</li></ul>
6035
6044
 
6036
6045
  # @type FlowStatus: String
6037
- # @param FlowMessage: 合同(流程)的信息
6046
+ # @param FlowMessage: 当合同流程状态为已拒签(即 FlowStatus=REJECT)或已撤销(即 FlowStatus=CANCEL )时,此字段 FlowMessage 为拒签或撤销原因。
6038
6047
  # @type FlowMessage: String
6039
- # @param CreateOn: 合同(流程)的创建时间戳,单位秒
6048
+ # @param CreateOn: 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
6040
6049
  # @type CreateOn: Integer
6041
- # @param DeadLine: 合同(流程)的签署截止时间戳,单位秒
6050
+ # @param DeadLine: 签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
6042
6051
  # @type DeadLine: Integer
6043
- # @param CustomData: 用户自定义数据
6052
+ # @param CustomData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 1000长度。
6053
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
6044
6054
  # @type CustomData: String
6045
- # @param FlowApproverInfos: 合同(流程)的签署人数组
6055
+ # @param FlowApproverInfos: 合同流程的签署方数组
6046
6056
  # @type FlowApproverInfos: Array
6047
- # @param CcInfos: 合同(流程)关注方信息列表
6057
+ # @param CcInfos: 合同流程的关注方信息数组
6048
6058
  # @type CcInfos: Array
6049
- # @param NeedCreateReview: 是否需要发起前审批,当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程
6059
+ # @param NeedCreateReview: 是否需要发起前审批
6060
+ # <ul><li>当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程</li>
6061
+ # <li>当NeedCreateReview为false,不需要发起前审核的合同</li></ul>
6050
6062
  # @type NeedCreateReview: Boolean
6051
6063
 
6052
6064
  attr_accessor :FlowId, :FlowName, :FlowType, :FlowStatus, :FlowMessage, :CreateOn, :DeadLine, :CustomData, :FlowApproverInfos, :CcInfos, :NeedCreateReview
@@ -7307,25 +7319,24 @@ module TencentCloud
7307
7319
  end
7308
7320
  end
7309
7321
 
7310
- # 合作企业经办人列表信息
7322
+ # 同步的员工的信息
7311
7323
  class ProxyOrganizationOperator < TencentCloud::Common::AbstractModel
7312
- # @param Id: 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
7324
+ # @param Id: 员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
7313
7325
  # @type Id: String
7314
- # @param Name: 经办人姓名,最大长度50个字符
7326
+ # @param Name: 员工的姓名,最大长度50个字符
7327
+ # 员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
7315
7328
  # @type Name: String
7316
- # @param IdCardType: 经办人身份证件类型
7317
- # 1.ID_CARD 居民身份证
7318
- # 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
7319
- # 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
7329
+ # @param IdCardType: 签署方经办人的证件类型,支持以下类型
7330
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
7331
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
7332
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
7320
7333
  # @type IdCardType: String
7321
7334
  # @param IdCardNumber: 经办人证件号
7322
7335
  # @type IdCardNumber: String
7323
- # @param Mobile: 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
7336
+ # @param Mobile: 员工的手机号,支持国内手机号11位数字(无需加+86前缀或其他字符),不支持海外手机号。
7324
7337
  # @type Mobile: String
7325
- # @param DefaultRole: 默认角色,值为以下三个对应的英文:
7326
- # 业务管理员:admin
7327
- # 经办人:channel-normal-operator
7328
- # 业务员:channel-sales-man
7338
+ # @param DefaultRole: 预先分配员工的角色, 可以分配的角色如下:
7339
+ # <table> <thead> <tr> <th>可以分配的角色</th> <th>角色名称</th> <th>角色描述</th> </tr> </thead> <tbody> <tr> <td>admin</td> <td>业务管理员(IT 系统负责人,e.g. CTO)</td> <td>有企业合同模块、印章模块、模板模块等全量功能及数据权限。</td> </tr> <tr> <td>channel-normal-operator</td> <td>经办人(企业法务负责人)</td> <td>有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。</td> </tr> <tr> <td>channel-sales-man</td> <td>业务员(一般为销售员、采购员)</td> <td>有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。</td> </tr> </tbody> </table>
7329
7340
  # @type DefaultRole: String
7330
7341
 
7331
7342
  attr_accessor :Id, :Name, :IdCardType, :IdCardNumber, :Mobile, :DefaultRole
@@ -7445,58 +7456,68 @@ module TencentCloud
7445
7456
  end
7446
7457
  end
7447
7458
 
7448
- # 解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。
7449
- # 注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
7450
- # 注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
7451
- # 注意:当指定C端签署人的签署方自定义控件别名不空时,除参数ApproverNumber外,可以只参数ApproverSignRole
7459
+ # 解除协议的签署人,如不指定,默认使用待解除流程(原流程)中的签署人。</br>
7460
+ # `注意`:
7461
+ # - 不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
7462
+ # - 目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
7463
+ # - 当指定C端签署人的签署方自定义控件别名不空时,除参数ApproverNumber外,可以只传参数ApproverSignRole。
7452
7464
 
7453
- # 如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
7454
- # ApproverNumber, OrganizationName, ApproverType必传。
7455
- # 对于其他身份标识
7456
- # - 子客企业指定经办人:OpenId必传,OrganizationOpenId必传;
7457
- # - 非子客企业:Name、Mobile必传。
7465
+ # 如果需要指定B端(企业身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
7466
+ # `ApproverNumber`, `OrganizationName`, `ApproverType`必传。</br>
7467
+ # 对于其他身份标识:
7468
+ # - **子客企业指定经办人**:OpenId必传,OrganizationOpenId必传;
7469
+ # - **非子客企业经办人**:Name、Mobile必传。
7458
7470
  class ReleasedApprover < TencentCloud::Common::AbstractModel
7459
- # @param OrganizationName: 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符
7460
- # @type OrganizationName: String
7461
- # @param ApproverNumber: 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
7471
+ # @param ApproverNumber: 签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。</br>
7472
+ # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
7462
7473
  # @type ApproverNumber: Integer
7463
- # @param ApproverType: 签署人类型,目前仅支持
7464
- # ORGANIZATION-企业
7465
- # ENTERPRISESERVER-企业静默签
7474
+ # @param ApproverType: 指定签署人类型,目前支持
7475
+ # <ul><li> **ORGANIZATION**:企业(默认值)</li>
7476
+ # <li> **ENTERPRISESERVER**:企业静默签</li></ul>
7466
7477
  # @type ApproverType: String
7467
- # @param Name: 签署人姓名,最大长度50个字符
7478
+ # @param Name: 签署人姓名,最大长度50个字。
7468
7479
  # @type Name: String
7469
- # @param IdCardType: 签署人身份证件类型
7470
- # 1.ID_CARD 居民身份证
7471
- # 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
7472
- # 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
7480
+ # @param IdCardType: 签署方经办人的证件类型,支持以下类型
7481
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
7482
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
7483
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
7473
7484
  # @type IdCardType: String
7474
- # @param IdCardNumber: 签署人证件号
7485
+ # @param IdCardNumber: 证件号码,应符合以下规则
7486
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
7487
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
7488
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
7475
7489
  # @type IdCardNumber: String
7476
- # @param Mobile: 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号
7490
+ # @param Mobile: 签署人手机号。
7477
7491
  # @type Mobile: String
7478
- # @param OrganizationOpenId: 企业签署方在同一第三方应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
7492
+ # @param OrganizationName: 组织机构名称。
7493
+ # 请确认该名称与企业营业执照中注册的名称一致。
7494
+ # 如果名称中包含英文括号(),请使用中文括号()代替。
7495
+ # 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
7496
+ # @type OrganizationName: String
7497
+ # @param OrganizationOpenId: 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br>
7498
+ # 当为子客企业指定经办人时,此OrganizationOpenId必传。
7479
7499
  # @type OrganizationOpenId: String
7480
- # @param OpenId: 用户侧第三方id,最大长度64个字符
7481
- # 当签署方为同一第三方应用下的员工时,该字必传
7500
+ # @param OpenId: 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。</br>
7501
+ # 当签署方为同一第三方平台下的员工时,此OpenId必传。
7482
7502
  # @type OpenId: String
7483
- # @param ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件为“印章”或“签名”
7484
- # - SIGN_SEAL-默认为印章控件类型
7485
- # - SIGN_SIGNATURE-手写签名控件类型
7503
+ # @param ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
7504
+ # <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
7505
+ # <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
7486
7506
  # @type ApproverSignComponentType: String
7487
- # @param ApproverSignRole: 签署方自定义控件别名,最大长度20个字符
7507
+ # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。</br>
7508
+ # 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
7488
7509
  # @type ApproverSignRole: String
7489
7510
 
7490
- attr_accessor :OrganizationName, :ApproverNumber, :ApproverType, :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationOpenId, :OpenId, :ApproverSignComponentType, :ApproverSignRole
7511
+ attr_accessor :ApproverNumber, :ApproverType, :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :OrganizationOpenId, :OpenId, :ApproverSignComponentType, :ApproverSignRole
7491
7512
 
7492
- def initialize(organizationname=nil, approvernumber=nil, approvertype=nil, name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationopenid=nil, openid=nil, approversigncomponenttype=nil, approversignrole=nil)
7493
- @OrganizationName = organizationname
7513
+ def initialize(approvernumber=nil, approvertype=nil, name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, organizationopenid=nil, openid=nil, approversigncomponenttype=nil, approversignrole=nil)
7494
7514
  @ApproverNumber = approvernumber
7495
7515
  @ApproverType = approvertype
7496
7516
  @Name = name
7497
7517
  @IdCardType = idcardtype
7498
7518
  @IdCardNumber = idcardnumber
7499
7519
  @Mobile = mobile
7520
+ @OrganizationName = organizationname
7500
7521
  @OrganizationOpenId = organizationopenid
7501
7522
  @OpenId = openid
7502
7523
  @ApproverSignComponentType = approversigncomponenttype
@@ -7504,13 +7525,13 @@ module TencentCloud
7504
7525
  end
7505
7526
 
7506
7527
  def deserialize(params)
7507
- @OrganizationName = params['OrganizationName']
7508
7528
  @ApproverNumber = params['ApproverNumber']
7509
7529
  @ApproverType = params['ApproverType']
7510
7530
  @Name = params['Name']
7511
7531
  @IdCardType = params['IdCardType']
7512
7532
  @IdCardNumber = params['IdCardNumber']
7513
7533
  @Mobile = params['Mobile']
7534
+ @OrganizationName = params['OrganizationName']
7514
7535
  @OrganizationOpenId = params['OrganizationOpenId']
7515
7536
  @OpenId = params['OpenId']
7516
7537
  @ApproverSignComponentType = params['ApproverSignComponentType']
@@ -7828,12 +7849,11 @@ module TencentCloud
7828
7849
  end
7829
7850
  end
7830
7851
 
7831
- # 同步经办人失败原因
7852
+ # 同步员工失败原因
7832
7853
  class SyncFailReason < TencentCloud::Common::AbstractModel
7833
- # @param Id: 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
7854
+ # @param Id: 企业员工标识(即OpenId)
7834
7855
  # @type Id: String
7835
- # @param Message: 失败原因
7836
- # 例如:Id不符合规范、证件号码不合法等
7856
+ # @param Message: 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
7837
7857
  # 注意:此字段可能返回 null,表示取不到有效值。
7838
7858
  # @type Message: String
7839
7859
 
@@ -7852,11 +7872,21 @@ module TencentCloud
7852
7872
 
7853
7873
  # SyncProxyOrganizationOperators请求参数结构体
7854
7874
  class SyncProxyOrganizationOperatorsRequest < TencentCloud::Common::AbstractModel
7855
- # @param Agent: 应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
7875
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7876
+
7877
+ # 此接口下面信息必填。
7878
+ # <ul>
7879
+ # <li>渠道应用标识: Agent.AppId</li>
7880
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7881
+ # </ul>
7882
+ # 第三方平台子客企业必须已经经过实名认证
7856
7883
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
7857
- # @param OperatorType: 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
7884
+ # @param OperatorType: 操作类型,对应的操作
7885
+ # <ul><li> **CREATE** :新增员工</li>
7886
+ # <li> **UPDATE** :修改员工</li>
7887
+ # <li> **RESIGN** :离职员工</li></ul>
7858
7888
  # @type OperatorType: String
7859
- # @param ProxyOrganizationOperators: 经办人信息列表,最大长度200
7889
+ # @param ProxyOrganizationOperators: 员工信息列表,最多支持200
7860
7890
  # @type ProxyOrganizationOperators: Array
7861
7891
  # @param Operator: 暂未开放
7862
7892
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -7896,12 +7926,13 @@ module TencentCloud
7896
7926
 
7897
7927
  # SyncProxyOrganizationOperators返回参数结构体
7898
7928
  class SyncProxyOrganizationOperatorsResponse < TencentCloud::Common::AbstractModel
7899
- # @param Status: Status 同步状态,全部同步失败接口会直接报错
7900
- # 1-成功
7901
- # 2-部分成功
7929
+ # @param Status: 同步的状态, 全部同步失败接口是接口会直接报错
7930
+
7931
+ # <ul><li> **1** :全部成功</li>
7932
+ # <li> **2** :部分成功</li></ul>
7902
7933
  # 注意:此字段可能返回 null,表示取不到有效值。
7903
7934
  # @type Status: Integer
7904
- # @param FailedList: 同步失败经办人及其失败原因
7935
+ # @param FailedList: 同步失败员工ID及其失败原因
7905
7936
  # 注意:此字段可能返回 null,表示取不到有效值。
7906
7937
  # @type FailedList: Array
7907
7938
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.692
4
+ version: 3.0.693
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-02 00:00:00.000000000 Z
11
+ date: 2023-11-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common