tencentcloud-sdk-ess 3.0.656 → 3.0.657

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8f9b6ac1e67e0e1ff834c6f218d0caac5ec68d6d
4
- data.tar.gz: fa6f05f00450a8405c3f924b7a5c6f5f0c085e14
3
+ metadata.gz: d37dd475bff07a1197cddcdc7f860704644098a1
4
+ data.tar.gz: 10c8ea48f302c10cea8931ec57bc6dc22e8f402c
5
5
  SHA512:
6
- metadata.gz: e90c630b3276311411c515dbe63a214dcc86a7cf504dd5797a87dee3179d092f39a39bf8bbcae880b93488bdc7681a14265bda45b479b7efa6e0de9ed619a3ba
7
- data.tar.gz: 447ff4c821bba7e132091114a224e8c5da05e1aa0bbf728eee657e134af20d2ca0729c293a7a0e950ae92a8224471452c5ce94cfc47725347add3d0e15523509
6
+ metadata.gz: 5b2ca2793677ae0c899ee7606c40cc3c1c9fa18966620701be7255746e224e1e75d38ea0a5b7d488959922e8c2dea93bae7a714cfe21a399899e92d22d9d9ef1
7
+ data.tar.gz: 3e5d78958dbb03b3b428c1ece35c1de3495b7f19e9fc5a2f1f304a7e6d80b556a6d1db81877357558a57a53ebb94e889904ade18ed8f02f0abdc5e178583f22f
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.656
1
+ 3.0.657
@@ -496,7 +496,8 @@ module TencentCloud
496
496
  # `注意:`<br/>
497
497
  # `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
498
498
  # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
499
- # `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
499
+ # `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
500
+ # `4. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
500
501
  # 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
501
502
 
502
503
  # @param request: Request instance for CreateFlowSignUrl.
@@ -689,7 +690,13 @@ module TencentCloud
689
690
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
690
691
  end
691
692
 
692
- # 本接口(CreatePersonAuthCertificateImage)用于创建个人用户证书证明图片
693
+ # 获取个人用户认证证书图片下载URL
694
+
695
+ # 个人用户认证证书图片样式如下图
696
+
697
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
698
+
699
+ # 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
693
700
 
694
701
  # @param request: Request instance for CreatePersonAuthCertificateImage.
695
702
  # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
@@ -763,14 +770,16 @@ module TencentCloud
763
770
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
764
771
  end
765
772
 
766
- # 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
773
+ # 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
774
+ # 解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
767
775
 
768
- # `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
769
- # `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
770
- # `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
771
- # `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
772
- # `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
773
- # `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
776
+ # 注意:
777
+ # <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
778
+ # <li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
779
+ # <li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
780
+ # <li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
781
+ # <li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
782
+ # <li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
774
783
 
775
784
  # @param request: Request instance for CreateReleaseFlow.
776
785
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest`
@@ -1086,7 +1095,8 @@ module TencentCloud
1086
1095
 
1087
1096
  # 查询流程基础信息
1088
1097
  # 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
1089
- # 每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误
1098
+
1099
+ # 注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
1090
1100
 
1091
1101
  # @param request: Request instance for DescribeFlowBriefs.
1092
1102
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -1366,7 +1376,14 @@ module TencentCloud
1366
1376
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1367
1377
  end
1368
1378
 
1369
- # 通过AuthCode查询用户是否实名
1379
+ # 通过AuthCode查询个人用户是否实名
1380
+
1381
+
1382
+ # 注意:
1383
+ # <ul>
1384
+ # <li>此接口为合作引流场景使用,使用`有白名单限制`,使用前请联系对接的客户经理沟通。</li>
1385
+ # <li>`AuthCode 只能使用一次`,查询一次再次查询会返回错误</li>
1386
+ # </ul>
1370
1387
 
1371
1388
  # @param request: Request instance for DescribeThirdPartyAuthCode.
1372
1389
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeThirdPartyAuthCodeRequest`
@@ -173,10 +173,14 @@ module TencentCloud
173
173
 
174
174
  # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
175
175
  # @type ApproverNeedSignReview: Boolean
176
+ # @param AddSignComponentsLimits: [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
176
177
 
177
- attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview
178
+ # 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
179
+ # @type AddSignComponentsLimits: Array
178
180
 
179
- def initialize(approvertype=nil, approvername=nil, approvermobile=nil, organizationname=nil, signcomponents=nil, approveridcardtype=nil, approveridcardnumber=nil, notifytype=nil, approverrole=nil, verifychannel=nil, prereadtime=nil, userid=nil, approversource=nil, customapprovertag=nil, approveroption=nil, approververifytypes=nil, approversigntypes=nil, approverneedsignreview=nil)
181
+ attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview, :AddSignComponentsLimits
182
+
183
+ def initialize(approvertype=nil, approvername=nil, approvermobile=nil, organizationname=nil, signcomponents=nil, approveridcardtype=nil, approveridcardnumber=nil, notifytype=nil, approverrole=nil, verifychannel=nil, prereadtime=nil, userid=nil, approversource=nil, customapprovertag=nil, approveroption=nil, approververifytypes=nil, approversigntypes=nil, approverneedsignreview=nil, addsigncomponentslimits=nil)
180
184
  @ApproverType = approvertype
181
185
  @ApproverName = approvername
182
186
  @ApproverMobile = approvermobile
@@ -195,6 +199,7 @@ module TencentCloud
195
199
  @ApproverVerifyTypes = approververifytypes
196
200
  @ApproverSignTypes = approversigntypes
197
201
  @ApproverNeedSignReview = approverneedsignreview
202
+ @AddSignComponentsLimits = addsigncomponentslimits
198
203
  end
199
204
 
200
205
  def deserialize(params)
@@ -226,6 +231,14 @@ module TencentCloud
226
231
  @ApproverVerifyTypes = params['ApproverVerifyTypes']
227
232
  @ApproverSignTypes = params['ApproverSignTypes']
228
233
  @ApproverNeedSignReview = params['ApproverNeedSignReview']
234
+ unless params['AddSignComponentsLimits'].nil?
235
+ @AddSignComponentsLimits = []
236
+ params['AddSignComponentsLimits'].each do |i|
237
+ componentlimit_tmp = ComponentLimit.new
238
+ componentlimit_tmp.deserialize(i)
239
+ @AddSignComponentsLimits << componentlimit_tmp
240
+ end
241
+ end
229
242
  end
230
243
  end
231
244
 
@@ -945,6 +958,41 @@ module TencentCloud
945
958
  end
946
959
  end
947
960
 
961
+ # 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
962
+ class ComponentLimit < TencentCloud::Common::AbstractModel
963
+ # @param ComponentType: 控件类型,支持以下类型
964
+ # <ul><li>SIGN_SEAL : 印章控件</li>
965
+ # <li>SIGN_PAGING_SEAL : 骑缝章控件</li>
966
+ # <li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
967
+ # <li>SIGN_SIGNATURE : 用户签名控件</li></ul>
968
+ # @type ComponentType: String
969
+ # @param ComponentValue: 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
970
+
971
+ # 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
972
+
973
+ # 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
974
+
975
+ # <ul><li>HANDWRITE : 手写签名</li>
976
+ # <li>OCR_ESIGN : OCR印章(智慧手写签名)</li>
977
+ # <li>ESIGN : 个人印章</li>
978
+ # <li>SYSTEM_ESIGN : 系统印章</li></ul>
979
+
980
+ # 3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
981
+ # @type ComponentValue: Array
982
+
983
+ attr_accessor :ComponentType, :ComponentValue
984
+
985
+ def initialize(componenttype=nil, componentvalue=nil)
986
+ @ComponentType = componenttype
987
+ @ComponentValue = componentvalue
988
+ end
989
+
990
+ def deserialize(params)
991
+ @ComponentType = params['ComponentType']
992
+ @ComponentValue = params['ComponentValue']
993
+ end
994
+ end
995
+
948
996
  # CreateBatchCancelFlowUrl请求参数结构体
949
997
  class CreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
950
998
  # @param Operator: 调用方用户信息,userId 必填
@@ -2728,20 +2776,25 @@ module TencentCloud
2728
2776
 
2729
2777
  # CreatePersonAuthCertificateImage请求参数结构体
2730
2778
  class CreatePersonAuthCertificateImageRequest < TencentCloud::Common::AbstractModel
2731
- # @param Operator: 操作人信息
2779
+ # @param Operator: 执行本接口操作的员工信息。
2780
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2732
2781
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2733
2782
  # @param UserName: 个人用户名称
2734
2783
  # @type UserName: String
2735
- # @param IdCardType: 身份证件类型取值:
2736
- # ID_CARD 身居民身份证
2737
- # PASSPORT 护照
2738
- # HONGKONG_AND_MACAO 港澳居民来往内地通行证
2739
- # FOREIGN_ID_CARD 外国人永久居留身份证
2740
- # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2784
+ # @param IdCardType: 证件类型,支持以下类型
2785
+ # <ul><li> ID_CARD : 居民身份证 (默认值)</li>
2786
+ # <li> PASSPORT : 护照</li>
2787
+ # <li> FOREIGN_ID_CARD : 外国人永久居留身份证</li>
2788
+ # <li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
2789
+ # <li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
2741
2790
  # @type IdCardType: String
2742
- # @param IdCardNumber: 身份证件号码
2791
+ # @param IdCardNumber: 证件号码,应符合以下规则
2792
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
2793
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
2794
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
2743
2795
  # @type IdCardNumber: String
2744
- # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2796
+ # @param Agent: 代理企业和员工的信息。
2797
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2745
2798
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2746
2799
 
2747
2800
  attr_accessor :Operator, :UserName, :IdCardType, :IdCardNumber, :Agent
@@ -2771,18 +2824,25 @@ module TencentCloud
2771
2824
 
2772
2825
  # CreatePersonAuthCertificateImage返回参数结构体
2773
2826
  class CreatePersonAuthCertificateImageResponse < TencentCloud::Common::AbstractModel
2774
- # @param AuthCertUrl: 个人用户证明证书的下载链接
2827
+ # @param AuthCertUrl: 个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
2775
2828
  # @type AuthCertUrl: String
2776
- # @param ImageCertId: 证书图片上的证书编号,20位数字
2829
+ # @param ImageCertId: 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
2830
+ # 该编号会合成到个人用户证书证明图片。
2831
+
2832
+ # 注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
2777
2833
  # 注意:此字段可能返回 null,表示取不到有效值。
2778
2834
  # @type ImageCertId: String
2779
- # @param SerialNumber: 图片证明对应的CA证书序列号
2835
+ # @param SerialNumber: CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。
2836
+
2837
+ # 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`
2780
2838
  # 注意:此字段可能返回 null,表示取不到有效值。
2781
2839
  # @type SerialNumber: String
2782
- # @param ValidFrom: CA证书颁发时间戳
2840
+ # @param ValidFrom: CA证书颁发时间,格式为Unix标准时间戳(秒)
2841
+ # 该时间格式化后会合成到个人用户证书证明图片
2783
2842
  # 注意:此字段可能返回 null,表示取不到有效值。
2784
2843
  # @type ValidFrom: Integer
2785
- # @param ValidTo: CA证书有效截止时间戳
2844
+ # @param ValidTo: CA证书有效截止时间,格式为Unix标准时间戳(秒)
2845
+ # 该时间格式化后会合成到个人用户证书证明图片
2786
2846
  # 注意:此字段可能返回 null,表示取不到有效值。
2787
2847
  # @type ValidTo: Integer
2788
2848
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3072,16 +3132,16 @@ module TencentCloud
3072
3132
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3073
3133
  # @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
3074
3134
  # @type NeedRelievedFlowId: String
3075
- # @param ReliveInfo: 解除协议内容。
3135
+ # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
3076
3136
  # @type ReliveInfo: :class:`Tencentcloud::Ess.v20201111.models.RelieveInfo`
3077
3137
  # @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3078
3138
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3079
- # @param ReleasedApprovers: 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3080
- # 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3081
- # 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3139
+ # @param ReleasedApprovers: 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
3140
+ # 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3082
3141
 
3083
- # `注意:只能更换同企业的签署人。`<br/>
3084
- # `注意:不支持更换个人类型的签署人。`<br/>
3142
+ # 注意:
3143
+ # `只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。`
3144
+ # `可以不指定替换签署人, 使用原流程的签署人 `
3085
3145
  # @type ReleasedApprovers: Array
3086
3146
  # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
3087
3147
  # 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
@@ -4114,11 +4174,16 @@ module TencentCloud
4114
4174
 
4115
4175
  # DescribeFlowBriefs请求参数结构体
4116
4176
  class DescribeFlowBriefsRequest < TencentCloud::Common::AbstractModel
4117
- # @param Operator: 调用方用户信息,userId 必填
4177
+ # @param Operator: 执行本接口操作的员工信息。
4178
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4118
4179
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4119
- # @param FlowIds: 需要查询的流程ID列表,限制最大100
4180
+ # @param FlowIds: 查询的合同流程ID列表最多支持100个流程ID。
4181
+ # 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
4182
+
4183
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4120
4184
  # @type FlowIds: Array
4121
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4185
+ # @param Agent: 代理企业和员工的信息。
4186
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4122
4187
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4123
4188
 
4124
4189
  attr_accessor :Operator, :FlowIds, :Agent
@@ -4144,7 +4209,8 @@ module TencentCloud
4144
4209
 
4145
4210
  # DescribeFlowBriefs返回参数结构体
4146
4211
  class DescribeFlowBriefsResponse < TencentCloud::Common::AbstractModel
4147
- # @param FlowBriefs: 流程列表
4212
+ # @param FlowBriefs: 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
4213
+ # 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
4148
4214
  # @type FlowBriefs: Array
4149
4215
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4150
4216
  # @type RequestId: String
@@ -4552,7 +4618,9 @@ module TencentCloud
4552
4618
  # @type Limit: Integer
4553
4619
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4554
4620
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4555
- # @param Filters: 查询过滤实名用户,Key为Status,Values为["IsVerified"]
4621
+ # @param Filters: 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
4622
+ # 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
4623
+ # 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
4556
4624
  # 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
4557
4625
  # @type Filters: Array
4558
4626
  # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
@@ -4959,11 +5027,13 @@ module TencentCloud
4959
5027
 
4960
5028
  # DescribeThirdPartyAuthCode请求参数结构体
4961
5029
  class DescribeThirdPartyAuthCodeRequest < TencentCloud::Common::AbstractModel
4962
- # @param AuthCode: 电子签小程序跳转客户小程序时携带的授权查看码
5030
+ # @param AuthCode: 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
4963
5031
  # @type AuthCode: String
4964
- # @param Operator: 操作人信息
5032
+ # @param Operator: 执行本接口操作的员工信息。
5033
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4965
5034
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4966
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5035
+ # @param Agent: 代理企业和员工的信息。
5036
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4967
5037
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4968
5038
 
4969
5039
  attr_accessor :AuthCode, :Operator, :Agent
@@ -4989,7 +5059,10 @@ module TencentCloud
4989
5059
 
4990
5060
  # DescribeThirdPartyAuthCode返回参数结构体
4991
5061
  class DescribeThirdPartyAuthCodeResponse < TencentCloud::Common::AbstractModel
4992
- # @param VerifyStatus: 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
5062
+ # @param VerifyStatus: AuthCode 中对应个人用户是否实名
5063
+ # <ul>
5064
+ # <li> **VERIFIED** : 此个人已实名</li>
5065
+ # <li> **UNVERIFIED**: 此个人未实名</li></ul>
4993
5066
  # @type VerifyStatus: String
4994
5067
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4995
5068
  # @type RequestId: String
@@ -7230,7 +7303,9 @@ module TencentCloud
7230
7303
  # <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
7231
7304
  # <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
7232
7305
  # @type ApproverSignComponentType: String
7233
- # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
7306
+ # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
7307
+
7308
+ # 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
7234
7309
  # @type ApproverSignRole: String
7235
7310
 
7236
7311
  attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole
@@ -7256,15 +7331,15 @@ module TencentCloud
7256
7331
 
7257
7332
  # 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
7258
7333
  class RelieveInfo < TencentCloud::Common::AbstractModel
7259
- # @param Reason: 解除理由,最大支持200个字
7334
+ # @param Reason: 解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
7260
7335
  # @type Reason: String
7261
- # @param RemainInForceItem: 解除后仍然有效的条款,保留条款,最大支持200个字
7336
+ # @param RemainInForceItem: 解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
7262
7337
  # @type RemainInForceItem: String
7263
- # @param OriginalExpenseSettlement: 原合同事项处理-费用结算,最大支持200个字
7338
+ # @param OriginalExpenseSettlement: 原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
7264
7339
  # @type OriginalExpenseSettlement: String
7265
- # @param OriginalOtherSettlement: 原合同事项处理-其他事项,最大支持200个字
7340
+ # @param OriginalOtherSettlement: 原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
7266
7341
  # @type OriginalOtherSettlement: String
7267
- # @param OtherDeals: 其他约定,最大支持200个字
7342
+ # @param OtherDeals: 其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
7268
7343
  # @type OtherDeals: String
7269
7344
 
7270
7345
  attr_accessor :Reason, :RemainInForceItem, :OriginalExpenseSettlement, :OriginalOtherSettlement, :OtherDeals
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.656
4
+ version: 3.0.657
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-09-11 00:00:00.000000000 Z
11
+ date: 2023-09-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common