tencentcloud-sdk-essbasic 3.0.585 → 3.0.587

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: 7edd4829fc1965a1a5722c920decf9d37b53e22e
4
- data.tar.gz: 8fcbb554a0d5c78627a0b7230b8dde689cb7367a
3
+ metadata.gz: 18ce791aae25fa5f1fa5de4b46d1ee9ee5fb219c
4
+ data.tar.gz: 7eadc90d000e67d0df4fef1e4fd215336afba8ec
5
5
  SHA512:
6
- metadata.gz: 9f1519f94060a83a727fe282aa6a1df961ac0e1e31420ebd0d3cf59629f33aa02a439a34ef950226ab83e9860cd8a2c3baff495c90d85fab29d93787d3a1e6ce
7
- data.tar.gz: de52a8409095b88e9bd04f3bb2bab2fc7c949fb0ecca4dfbfe54b9f615eb8994de1c218ce90fd2b505001bbc9fa050cdb83079bd2d9530dafeb0a0824376d5b8
6
+ metadata.gz: 159a50f00a670383819cd65b9f765410a5b476697ddc10a58f827094bd77734950d0926c7cee156555344522fa67e46741382d2ebd8ce1410a821690faa59371
7
+ data.tar.gz: 37253ce563099fbf980be185eb7a41715ac5fbc036284e4cb0c934c9884d78806ec5b8b52038cc9db7ac085a8350230d569a9496abcd65fc843b693bd5c55c58
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.585
1
+ 3.0.587
@@ -967,6 +967,7 @@ module TencentCloud
967
967
 
968
968
  # 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
969
969
  # 当前接口限制最多合同(流程)50个.
970
+ # 返回的链接只能使用一次
970
971
 
971
972
  # @param request: Request instance for GetDownloadFlowUrl.
972
973
  # @type request: :class:`Tencentcloud::essbasic::V20210526::GetDownloadFlowUrlRequest`
@@ -70,13 +70,13 @@ module TencentCloud
70
70
 
71
71
  # 指定签署人限制项
72
72
  class ApproverRestriction < TencentCloud::Common::AbstractModel
73
- # @param Name: 指定签署人名字
73
+ # @param Name: 指定签署人姓名
74
74
  # @type Name: String
75
- # @param Mobile: 指定签署人手机号
75
+ # @param Mobile: 指定签署人手机号,11位数字
76
76
  # @type Mobile: String
77
- # @param IdCardType: 指定签署人证件类型
77
+ # @param IdCardType: 指定签署人证件类型,ID_CARD-身份证,HONGKONG_AND_MACAO-港澳居民来往内地通行证,HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证
78
78
  # @type IdCardType: String
79
- # @param IdCardNumber: 指定签署人证件号码
79
+ # @param IdCardNumber: 指定签署人证件号码,其中字母大写
80
80
  # @type IdCardNumber: String
81
81
 
82
82
  attr_accessor :Name, :Mobile, :IdCardType, :IdCardNumber
@@ -98,9 +98,9 @@ module TencentCloud
98
98
 
99
99
  # 授权出错信息
100
100
  class AuthFailMessage < TencentCloud::Common::AbstractModel
101
- # @param ProxyOrganizationOpenId: 合作企业Id
101
+ # @param ProxyOrganizationOpenId: 第三方应用平台的子客企业OpenId
102
102
  # @type ProxyOrganizationOpenId: String
103
- # @param Message: 出错信息
103
+ # @param Message: 错误信息
104
104
  # @type Message: String
105
105
 
106
106
  attr_accessor :ProxyOrganizationOpenId, :Message
@@ -118,7 +118,7 @@ module TencentCloud
118
118
 
119
119
  # 授权用户
120
120
  class AuthorizedUser < TencentCloud::Common::AbstractModel
121
- # @param OpenId: 用户openid
121
+ # @param OpenId: 第三方应用平台的用户openid
122
122
  # @type OpenId: String
123
123
 
124
124
  attr_accessor :OpenId
@@ -140,15 +140,15 @@ module TencentCloud
140
140
  # @type FlowType: String
141
141
  # @param FlowDescription: 合同流程描述信息
142
142
  # @type FlowDescription: String
143
- # @param Deadline: 合同流程截止时间,unix时间戳
143
+ # @param Deadline: 合同流程截止时间,unix时间戳,单位秒
144
144
  # @type Deadline: Integer
145
145
  # @param Unordered: 是否顺序签署(true:无序签,false:顺序签)
146
146
  # @type Unordered: Boolean
147
- # @param IntelligentStatus: 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
147
+ # @param IntelligentStatus: 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
148
148
  # @type IntelligentStatus: String
149
149
  # @param FormFields: 填写控件内容
150
150
  # @type FormFields: Array
151
- # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批
151
+ # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
152
152
  # @type NeedSignReview: Boolean
153
153
  # @param UserData: 用户流程自定义数据参数
154
154
  # @type UserData: String
@@ -571,39 +571,39 @@ module TencentCloud
571
571
 
572
572
  # ChannelCreateEmbedWebUrl请求参数结构体
573
573
  class ChannelCreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel
574
- # @param EmbedType: WEB嵌入资源类型,取值范围:CREATE_SEAL创建印章,CREATE_TEMPLATE创建模板,MODIFY_TEMPLATE修改模板,PREVIEW_TEMPLATE预览模板,PREVIEW_FLOW预览流程
575
- # @type EmbedType: String
576
574
  # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
577
575
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
578
- # @param Operator: 渠道操作者信息
579
- # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
576
+ # @param EmbedType: WEB嵌入资源类型,取值范围:CREATE_SEAL创建印章,CREATE_TEMPLATE创建模板,MODIFY_TEMPLATE修改模板,PREVIEW_TEMPLATE预览模板,PREVIEW_FLOW预览流程
577
+ # @type EmbedType: String
580
578
  # @param BusinessId: WEB嵌入的业务资源ID,EmbedType取值MODIFY_TEMPLATE或PREVIEW_TEMPLATE或 PREVIEW_FLOW时BusinessId必填
581
579
  # @type BusinessId: String
582
580
  # @param HiddenComponents: 是否隐藏控件,只有预览模板时生效
583
581
  # @type HiddenComponents: Boolean
582
+ # @param Operator: 渠道操作者信息
583
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
584
584
 
585
- attr_accessor :EmbedType, :Agent, :Operator, :BusinessId, :HiddenComponents
585
+ attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator
586
586
 
587
- def initialize(embedtype=nil, agent=nil, operator=nil, businessid=nil, hiddencomponents=nil)
588
- @EmbedType = embedtype
587
+ def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil)
589
588
  @Agent = agent
590
- @Operator = operator
589
+ @EmbedType = embedtype
591
590
  @BusinessId = businessid
592
591
  @HiddenComponents = hiddencomponents
592
+ @Operator = operator
593
593
  end
594
594
 
595
595
  def deserialize(params)
596
- @EmbedType = params['EmbedType']
597
596
  unless params['Agent'].nil?
598
597
  @Agent = Agent.new
599
598
  @Agent.deserialize(params['Agent'])
600
599
  end
600
+ @EmbedType = params['EmbedType']
601
+ @BusinessId = params['BusinessId']
602
+ @HiddenComponents = params['HiddenComponents']
601
603
  unless params['Operator'].nil?
602
604
  @Operator = UserInfo.new
603
605
  @Operator.deserialize(params['Operator'])
604
606
  end
605
- @BusinessId = params['BusinessId']
606
- @HiddenComponents = params['HiddenComponents']
607
607
  end
608
608
  end
609
609
 
@@ -662,18 +662,18 @@ module TencentCloud
662
662
  # @type ApproverVerifyType: String
663
663
  # @param SignBeanTag: 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
664
664
  # @type SignBeanTag: Integer
665
- # @param Operator: 操作者的信息,不用传
666
- # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
667
665
  # @param CcInfos: 被抄送人信息列表
668
666
  # @type CcInfos: Array
669
667
  # @param CcNotifyType: 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
670
668
  # @type CcNotifyType: Integer
671
669
  # @param AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
672
670
  # @type AutoSignScene: String
671
+ # @param Operator: 操作者的信息,不用传
672
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
673
673
 
674
- attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :Operator, :CcInfos, :CcNotifyType, :AutoSignScene
674
+ attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :CcInfos, :CcNotifyType, :AutoSignScene, :Operator
675
675
 
676
- def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, operator=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil)
676
+ def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil)
677
677
  @Agent = agent
678
678
  @FlowName = flowname
679
679
  @FlowApprovers = flowapprovers
@@ -689,10 +689,10 @@ module TencentCloud
689
689
  @NeedSignReview = needsignreview
690
690
  @ApproverVerifyType = approververifytype
691
691
  @SignBeanTag = signbeantag
692
- @Operator = operator
693
692
  @CcInfos = ccinfos
694
693
  @CcNotifyType = ccnotifytype
695
694
  @AutoSignScene = autosignscene
695
+ @Operator = operator
696
696
  end
697
697
 
698
698
  def deserialize(params)
@@ -728,10 +728,6 @@ module TencentCloud
728
728
  @NeedSignReview = params['NeedSignReview']
729
729
  @ApproverVerifyType = params['ApproverVerifyType']
730
730
  @SignBeanTag = params['SignBeanTag']
731
- unless params['Operator'].nil?
732
- @Operator = UserInfo.new
733
- @Operator.deserialize(params['Operator'])
734
- end
735
731
  unless params['CcInfos'].nil?
736
732
  @CcInfos = []
737
733
  params['CcInfos'].each do |i|
@@ -742,6 +738,10 @@ module TencentCloud
742
738
  end
743
739
  @CcNotifyType = params['CcNotifyType']
744
740
  @AutoSignScene = params['AutoSignScene']
741
+ unless params['Operator'].nil?
742
+ @Operator = UserInfo.new
743
+ @Operator.deserialize(params['Operator'])
744
+ end
745
745
  end
746
746
  end
747
747
 
@@ -1311,21 +1311,21 @@ module TencentCloud
1311
1311
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1312
1312
  # @param SealId: 指定印章ID
1313
1313
  # @type SealId: String
1314
- # @param UserIds: 指定待授权的用户ID数组
1314
+ # @param UserIds: 指定待授权的用户ID数组,电子签的用户ID
1315
1315
  # @type UserIds: Array
1316
- # @param Organization: 企业机构信息,不用传
1317
- # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
1318
1316
  # @param Operator: 操作人(用户)信息,不用传
1319
1317
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
1318
+ # @param Organization: 企业机构信息,不用传
1319
+ # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
1320
1320
 
1321
- attr_accessor :Agent, :SealId, :UserIds, :Organization, :Operator
1321
+ attr_accessor :Agent, :SealId, :UserIds, :Operator, :Organization
1322
1322
 
1323
- def initialize(agent=nil, sealid=nil, userids=nil, organization=nil, operator=nil)
1323
+ def initialize(agent=nil, sealid=nil, userids=nil, operator=nil, organization=nil)
1324
1324
  @Agent = agent
1325
1325
  @SealId = sealid
1326
1326
  @UserIds = userids
1327
- @Organization = organization
1328
1327
  @Operator = operator
1328
+ @Organization = organization
1329
1329
  end
1330
1330
 
1331
1331
  def deserialize(params)
@@ -1335,20 +1335,20 @@ module TencentCloud
1335
1335
  end
1336
1336
  @SealId = params['SealId']
1337
1337
  @UserIds = params['UserIds']
1338
- unless params['Organization'].nil?
1339
- @Organization = OrganizationInfo.new
1340
- @Organization.deserialize(params['Organization'])
1341
- end
1342
1338
  unless params['Operator'].nil?
1343
1339
  @Operator = UserInfo.new
1344
1340
  @Operator.deserialize(params['Operator'])
1345
1341
  end
1342
+ unless params['Organization'].nil?
1343
+ @Organization = OrganizationInfo.new
1344
+ @Organization.deserialize(params['Organization'])
1345
+ end
1346
1346
  end
1347
1347
  end
1348
1348
 
1349
1349
  # ChannelCreateSealPolicy返回参数结构体
1350
1350
  class ChannelCreateSealPolicyResponse < TencentCloud::Common::AbstractModel
1351
- # @param UserIds: 最终授权成功的用户ID数组。其他的跳过的是已经授权了的
1351
+ # @param UserIds: 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的
1352
1352
  # @type UserIds: Array
1353
1353
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1354
1354
  # @type RequestId: String
@@ -1370,7 +1370,7 @@ module TencentCloud
1370
1370
  class ChannelCreateUserRolesRequest < TencentCloud::Common::AbstractModel
1371
1371
  # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
1372
1372
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1373
- # @param UserIds: 绑定角色的员工id列表
1373
+ # @param UserIds: 绑定角色的员工id列表,电子签的UserId
1374
1374
  # @type UserIds: Array
1375
1375
  # @param RoleIds: 绑定角色的角色id列表
1376
1376
  # @type RoleIds: Array
@@ -1433,7 +1433,7 @@ module TencentCloud
1433
1433
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1434
1434
  # @param RoleId: 角色Id(非超管或法人角色Id)
1435
1435
  # @type RoleId: String
1436
- # @param UserIds: 用户列表
1436
+ # @param UserIds: 用户列表,电子签系统的UserId
1437
1437
  # @type UserIds: Array
1438
1438
  # @param Operator: 操作人信息
1439
1439
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1487,7 +1487,7 @@ module TencentCloud
1487
1487
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1488
1488
  # @param SealId: 指定印章ID
1489
1489
  # @type SealId: String
1490
- # @param UserIds: 指定用户ID数组
1490
+ # @param UserIds: 指定用户ID数组,电子签系统用户ID
1491
1491
  # @type UserIds: Array
1492
1492
  # @param Organization: 组织机构信息,不用传
1493
1493
  # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
@@ -1911,19 +1911,19 @@ module TencentCloud
1911
1911
  # @type Status: String
1912
1912
  # @param SealId: 印章ID
1913
1913
  # @type SealId: String
1914
- # @param Operator: 操作者的信息
1915
- # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
1916
1914
  # @param Reason: 更新印章状态原因说明
1917
1915
  # @type Reason: String
1916
+ # @param Operator: 操作者的信息
1917
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
1918
1918
 
1919
- attr_accessor :Agent, :Status, :SealId, :Operator, :Reason
1919
+ attr_accessor :Agent, :Status, :SealId, :Reason, :Operator
1920
1920
 
1921
- def initialize(agent=nil, status=nil, sealid=nil, operator=nil, reason=nil)
1921
+ def initialize(agent=nil, status=nil, sealid=nil, reason=nil, operator=nil)
1922
1922
  @Agent = agent
1923
1923
  @Status = status
1924
1924
  @SealId = sealid
1925
- @Operator = operator
1926
1925
  @Reason = reason
1926
+ @Operator = operator
1927
1927
  end
1928
1928
 
1929
1929
  def deserialize(params)
@@ -1933,11 +1933,11 @@ module TencentCloud
1933
1933
  end
1934
1934
  @Status = params['Status']
1935
1935
  @SealId = params['SealId']
1936
+ @Reason = params['Reason']
1936
1937
  unless params['Operator'].nil?
1937
1938
  @Operator = UserInfo.new
1938
1939
  @Operator.deserialize(params['Operator'])
1939
1940
  end
1940
- @Reason = params['Reason']
1941
1941
  end
1942
1942
  end
1943
1943
 
@@ -2042,7 +2042,7 @@ module TencentCloud
2042
2042
  # @type ApproverType: Integer
2043
2043
  # @param OrganizationId: 企业id
2044
2044
  # @type OrganizationId: String
2045
- # @param OrganizationOpenId: 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同毕传
2045
+ # @param OrganizationOpenId: 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
2046
2046
  # @type OrganizationOpenId: String
2047
2047
  # @param OrganizationName: 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
2048
2048
  # @type OrganizationName: String
@@ -2507,7 +2507,7 @@ module TencentCloud
2507
2507
  # 4. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接)
2508
2508
  # 5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
2509
2509
  # @type ConsoleUrl: String
2510
- # @param IsActivated: 子客企业是否已开通腾讯电子签
2510
+ # @param IsActivated: 子客企业是否已开通腾讯电子签,true-是,false-否
2511
2511
  # @type IsActivated: Boolean
2512
2512
  # @param ProxyOperatorIsVerified: 当前经办人是否已认证(false:未认证 true:已认证)
2513
2513
  # @type ProxyOperatorIsVerified: Boolean
@@ -2533,7 +2533,7 @@ module TencentCloud
2533
2533
 
2534
2534
  # 创建合同配置信息
2535
2535
  class CreateFlowOption < TencentCloud::Common::AbstractModel
2536
- # @param CanEditFlow: 是否允许修改合同信息
2536
+ # @param CanEditFlow: 是否允许修改合同信息,true-是,false-否
2537
2537
  # @type CanEditFlow: Boolean
2538
2538
 
2539
2539
  attr_accessor :CanEditFlow
@@ -3088,18 +3088,18 @@ module TencentCloud
3088
3088
  # @type QueryAllComponents: Boolean
3089
3089
  # @param TemplateName: 模糊搜索模板名称,最大长度200
3090
3090
  # @type TemplateName: String
3091
- # @param Operator: 操作者的信息
3092
- # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3093
3091
  # @param WithPreviewUrl: 是否获取模板预览链接
3094
3092
  # @type WithPreviewUrl: Boolean
3095
3093
  # @param WithPdfUrl: 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
3096
3094
  # @type WithPdfUrl: Boolean
3097
- # @param ChannelTemplateId: 模板ID
3095
+ # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID
3098
3096
  # @type ChannelTemplateId: String
3097
+ # @param Operator: 操作者的信息
3098
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3099
3099
 
3100
- attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :Operator, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId
3100
+ attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId, :Operator
3101
3101
 
3102
- def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, operator=nil, withpreviewurl=nil, withpdfurl=nil, channeltemplateid=nil)
3102
+ def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, withpreviewurl=nil, withpdfurl=nil, channeltemplateid=nil, operator=nil)
3103
3103
  @Agent = agent
3104
3104
  @TemplateId = templateid
3105
3105
  @ContentType = contenttype
@@ -3107,10 +3107,10 @@ module TencentCloud
3107
3107
  @Offset = offset
3108
3108
  @QueryAllComponents = queryallcomponents
3109
3109
  @TemplateName = templatename
3110
- @Operator = operator
3111
3110
  @WithPreviewUrl = withpreviewurl
3112
3111
  @WithPdfUrl = withpdfurl
3113
3112
  @ChannelTemplateId = channeltemplateid
3113
+ @Operator = operator
3114
3114
  end
3115
3115
 
3116
3116
  def deserialize(params)
@@ -3124,13 +3124,13 @@ module TencentCloud
3124
3124
  @Offset = params['Offset']
3125
3125
  @QueryAllComponents = params['QueryAllComponents']
3126
3126
  @TemplateName = params['TemplateName']
3127
+ @WithPreviewUrl = params['WithPreviewUrl']
3128
+ @WithPdfUrl = params['WithPdfUrl']
3129
+ @ChannelTemplateId = params['ChannelTemplateId']
3127
3130
  unless params['Operator'].nil?
3128
3131
  @Operator = UserInfo.new
3129
3132
  @Operator.deserialize(params['Operator'])
3130
3133
  end
3131
- @WithPreviewUrl = params['WithPreviewUrl']
3132
- @WithPdfUrl = params['WithPdfUrl']
3133
- @ChannelTemplateId = params['ChannelTemplateId']
3134
3134
  end
3135
3135
  end
3136
3136
 
@@ -3281,7 +3281,7 @@ module TencentCloud
3281
3281
  # OVERSEA_SIGN 企业与港澳台居民*签署合同
3282
3282
  # MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
3283
3283
  # PAGING_SEAL 骑缝章
3284
- # DOWNLOAD_FLOW 授权渠道下载合同
3284
+ # DOWNLOAD_FLOW 授权平台企业下载合同
3285
3285
  # @type Type: String
3286
3286
  # @param Name: 扩展服务名称
3287
3287
  # @type Name: String
@@ -3289,10 +3289,10 @@ module TencentCloud
3289
3289
  # ENABLE 开启
3290
3290
  # DISABLE 关闭
3291
3291
  # @type Status: String
3292
- # @param OperatorOpenId: 最近操作人openid(经办人openid)
3292
+ # @param OperatorOpenId: 最近操作人第三方应用平台的用户openid
3293
3293
  # 注意:此字段可能返回 null,表示取不到有效值。
3294
3294
  # @type OperatorOpenId: String
3295
- # @param OperateOn: 最近操作时间
3295
+ # @param OperateOn: 最近操作时间戳,单位秒
3296
3296
  # 注意:此字段可能返回 null,表示取不到有效值。
3297
3297
  # @type OperateOn: Integer
3298
3298
 
@@ -3395,7 +3395,7 @@ module TencentCloud
3395
3395
  # @param ApproveMessage: 签署人信息
3396
3396
  # 注意:此字段可能返回 null,表示取不到有效值。
3397
3397
  # @type ApproveMessage: String
3398
- # @param ApproveTime: 签署人签署时间
3398
+ # @param ApproveTime: 签署人签署时间戳,单位秒
3399
3399
  # @type ApproveTime: Integer
3400
3400
  # @param ApproveType: 参与者类型 (ORGANIZATION企业/PERSON个人)
3401
3401
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -3473,7 +3473,7 @@ module TencentCloud
3473
3473
  # @type ApproverType: String
3474
3474
  # @param RecipientId: 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
3475
3475
  # @type RecipientId: String
3476
- # @param Deadline: 签署截止时间,默认一年
3476
+ # @param Deadline: 签署截止时间戳,默认一年
3477
3477
  # @type Deadline: Integer
3478
3478
  # @param CallbackUrl: 签署完回调url,最大长度1000个字符
3479
3479
  # @type CallbackUrl: String
@@ -3484,7 +3484,7 @@ module TencentCloud
3484
3484
  # @type ComponentLimitType: Array
3485
3485
  # @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
3486
3486
  # @type PreReadTime: Integer
3487
- # @param JumpUrl: 签署完前端跳转的url,暂未使用
3487
+ # @param JumpUrl: 签署完前端跳转的url,此字段的用法场景请联系客户经理确认
3488
3488
  # @type JumpUrl: String
3489
3489
  # @param ApproverOption: 签署人个性化能力值
3490
3490
  # @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverOption`
@@ -3496,10 +3496,14 @@ module TencentCloud
3496
3496
  # @param ApproverSignTypes: 签署人签署合同时的认证方式
3497
3497
  # 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3498
3498
  # @type ApproverSignTypes: Array
3499
+ # @param SignId: 签署ID
3500
+ # - 发起流程时系统自动补充
3501
+ # - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
3502
+ # @type SignId: String
3499
3503
 
3500
- attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes
3504
+ attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId
3501
3505
 
3502
- def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil, approveroption=nil, approverneedsignreview=nil, approververifytypes=nil, approversigntypes=nil)
3506
+ def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil, approveroption=nil, approverneedsignreview=nil, approververifytypes=nil, approversigntypes=nil, signid=nil)
3503
3507
  @Name = name
3504
3508
  @IdCardType = idcardtype
3505
3509
  @IdCardNumber = idcardnumber
@@ -3520,6 +3524,7 @@ module TencentCloud
3520
3524
  @ApproverNeedSignReview = approverneedsignreview
3521
3525
  @ApproverVerifyTypes = approververifytypes
3522
3526
  @ApproverSignTypes = approversigntypes
3527
+ @SignId = signid
3523
3528
  end
3524
3529
 
3525
3530
  def deserialize(params)
@@ -3553,6 +3558,7 @@ module TencentCloud
3553
3558
  @ApproverNeedSignReview = params['ApproverNeedSignReview']
3554
3559
  @ApproverVerifyTypes = params['ApproverVerifyTypes']
3555
3560
  @ApproverSignTypes = params['ApproverSignTypes']
3561
+ @SignId = params['SignId']
3556
3562
  end
3557
3563
  end
3558
3564
 
@@ -3610,9 +3616,9 @@ module TencentCloud
3610
3616
  # @type FlowStatus: String
3611
3617
  # @param FlowMessage: 合同(流程)的信息
3612
3618
  # @type FlowMessage: String
3613
- # @param CreateOn: 合同(流程)的创建时间戳
3619
+ # @param CreateOn: 合同(流程)的创建时间戳,单位秒
3614
3620
  # @type CreateOn: Integer
3615
- # @param DeadLine: 合同(流程)的签署截止时间戳
3621
+ # @param DeadLine: 合同(流程)的签署截止时间戳,单位秒
3616
3622
  # @type DeadLine: Integer
3617
3623
  # @param CustomData: 用户自定义数据
3618
3624
  # @type CustomData: String
@@ -3973,7 +3979,7 @@ module TencentCloud
3973
3979
  # CHECK_BOX - true/false
3974
3980
  # FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
3975
3981
  # SELECTOR - 选项值
3976
- # DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
3982
+ # DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo
3977
3983
  # @type ComponentValue: String
3978
3984
  # @param ComponentId: 表单域或控件的ID,跟ComponentName二选一,不能全为空;
3979
3985
  # CreateFlowsByTemplates 接口不使用此字段。
@@ -4121,9 +4127,9 @@ module TencentCloud
4121
4127
  # @type SealId: String
4122
4128
  # @param SealName: 电子印章名称
4123
4129
  # @type SealName: String
4124
- # @param CreateOn: 电子印章授权时间戳
4130
+ # @param CreateOn: 电子印章授权时间戳,单位秒
4125
4131
  # @type CreateOn: Integer
4126
- # @param Creator: 电子印章授权人
4132
+ # @param Creator: 电子印章授权人,电子签的UserId
4127
4133
  # @type Creator: String
4128
4134
  # @param SealPolicyId: 电子印章策略Id
4129
4135
  # @type SealPolicyId: String
@@ -4134,7 +4140,7 @@ module TencentCloud
4134
4140
  # @type FailReason: String
4135
4141
  # @param Url: 印章图片url,5分钟内有效
4136
4142
  # @type Url: String
4137
- # @param SealType: 印章类型
4143
+ # @param SealType: 印章类型,OFFICIAL-企业公章,CONTRACT-合同专用章,LEGAL_PERSON_SEAL-法人章
4138
4144
  # @type SealType: String
4139
4145
  # @param IsAllTime: 用印申请是否为永久授权
4140
4146
  # @type IsAllTime: Boolean
@@ -4278,31 +4284,31 @@ module TencentCloud
4278
4284
  class OrganizationInfo < TencentCloud::Common::AbstractModel
4279
4285
  # @param OrganizationOpenId: 用户在渠道的机构编号
4280
4286
  # @type OrganizationOpenId: String
4281
- # @param ClientIp: 用户真实的IP
4282
- # @type ClientIp: String
4283
- # @param ProxyIp: 机构的代理IP
4284
- # @type ProxyIp: String
4285
4287
  # @param OrganizationId: 机构在平台的编号
4286
4288
  # @type OrganizationId: String
4287
4289
  # @param Channel: 用户渠道
4288
4290
  # @type Channel: String
4291
+ # @param ClientIp: 用户真实的IP
4292
+ # @type ClientIp: String
4293
+ # @param ProxyIp: 机构的代理IP
4294
+ # @type ProxyIp: String
4289
4295
 
4290
- attr_accessor :OrganizationOpenId, :ClientIp, :ProxyIp, :OrganizationId, :Channel
4296
+ attr_accessor :OrganizationOpenId, :OrganizationId, :Channel, :ClientIp, :ProxyIp
4291
4297
 
4292
- def initialize(organizationopenid=nil, clientip=nil, proxyip=nil, organizationid=nil, channel=nil)
4298
+ def initialize(organizationopenid=nil, organizationid=nil, channel=nil, clientip=nil, proxyip=nil)
4293
4299
  @OrganizationOpenId = organizationopenid
4294
- @ClientIp = clientip
4295
- @ProxyIp = proxyip
4296
4300
  @OrganizationId = organizationid
4297
4301
  @Channel = channel
4302
+ @ClientIp = clientip
4303
+ @ProxyIp = proxyip
4298
4304
  end
4299
4305
 
4300
4306
  def deserialize(params)
4301
4307
  @OrganizationOpenId = params['OrganizationOpenId']
4302
- @ClientIp = params['ClientIp']
4303
- @ProxyIp = params['ProxyIp']
4304
4308
  @OrganizationId = params['OrganizationId']
4305
4309
  @Channel = params['Channel']
4310
+ @ClientIp = params['ClientIp']
4311
+ @ProxyIp = params['ProxyIp']
4306
4312
  end
4307
4313
  end
4308
4314
 
@@ -4314,27 +4320,27 @@ module TencentCloud
4314
4320
  # @type SignPlatform: String
4315
4321
  # @param SignerName: 签署人名称
4316
4322
  # @type SignerName: String
4317
- # @param SignTime: 签署时间
4323
+ # @param SignTime: 签署时间戳,单位秒
4318
4324
  # @type SignTime: Integer
4319
4325
  # @param SignAlgorithm: 签名算法
4320
4326
  # @type SignAlgorithm: String
4321
4327
  # @param CertSn: 签名证书序列号
4322
4328
  # @type CertSn: String
4323
- # @param CertNotBefore: 证书起始时间
4329
+ # @param CertNotBefore: 证书起始时间戳,单位秒
4324
4330
  # @type CertNotBefore: Integer
4325
- # @param CertNotAfter: 证书过期时间
4331
+ # @param CertNotAfter: 证书过期时间戳,单位秒
4326
4332
  # @type CertNotAfter: Integer
4327
4333
  # @param SignType: 签名类型
4328
4334
  # @type SignType: Integer
4329
- # @param ComponentPosX: 签名域横坐标
4335
+ # @param ComponentPosX: 签名域横坐标,单位px
4330
4336
  # @type ComponentPosX: Float
4331
- # @param ComponentPosY: 签名域纵坐标
4337
+ # @param ComponentPosY: 签名域纵坐标,单位px
4332
4338
  # @type ComponentPosY: Float
4333
- # @param ComponentWidth: 签名域宽度
4339
+ # @param ComponentWidth: 签名域宽度,单位px
4334
4340
  # @type ComponentWidth: Float
4335
- # @param ComponentHeight: 签名域高度
4341
+ # @param ComponentHeight: 签名域高度,单位px
4336
4342
  # @type ComponentHeight: Float
4337
- # @param ComponentPage: 签名域所在页码
4343
+ # @param ComponentPage: 签名域所在页码,1~N
4338
4344
  # @type ComponentPage: Integer
4339
4345
 
4340
4346
  attr_accessor :VerifyResult, :SignPlatform, :SignerName, :SignTime, :SignAlgorithm, :CertSn, :CertNotBefore, :CertNotAfter, :SignType, :ComponentPosX, :ComponentPosY, :ComponentWidth, :ComponentHeight, :ComponentPage
@@ -4479,17 +4485,17 @@ module TencentCloud
4479
4485
 
4480
4486
  # 签署参与者信息
4481
4487
  class Recipient < TencentCloud::Common::AbstractModel
4482
- # @param RecipientId: 签署人唯一标识
4488
+ # @param RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方Id
4483
4489
  # @type RecipientId: String
4484
4490
  # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
4485
4491
  # @type RecipientType: String
4486
4492
  # @param Description: 描述
4487
4493
  # @type Description: String
4488
- # @param RoleName: 签署方备注信息
4494
+ # @param RoleName: 签署方备注角色名
4489
4495
  # @type RoleName: String
4490
- # @param RequireValidation: 是否需要校验
4496
+ # @param RequireValidation: 是否需要校验,true-是,false-否
4491
4497
  # @type RequireValidation: Boolean
4492
- # @param RequireSign: 是否必须填写
4498
+ # @param RequireSign: 是否必须填写,true-是,false-否
4493
4499
  # @type RequireSign: Boolean
4494
4500
  # @param SignType: 签署类型
4495
4501
  # @type SignType: Integer
@@ -4540,6 +4546,7 @@ module TencentCloud
4540
4546
  # @type ApproverNumber: Integer
4541
4547
  # @param ApproverType: 签署人类型,目前仅支持
4542
4548
  # ORGANIZATION-企业
4549
+ # ENTERPRISESERVER-企业静默签
4543
4550
  # @type ApproverType: String
4544
4551
  # @param Name: 签署人姓名,最大长度50个字符
4545
4552
  # @type Name: String
@@ -4619,11 +4626,11 @@ module TencentCloud
4619
4626
 
4620
4627
  # 催办接口返回详细信息
4621
4628
  class RemindFlowRecords < TencentCloud::Common::AbstractModel
4622
- # @param CanRemind: 是否能够催办
4629
+ # @param CanRemind: 是否能够催办,true-是,false-否
4623
4630
  # @type CanRemind: Boolean
4624
4631
  # @param FlowId: 合同id
4625
4632
  # @type FlowId: String
4626
- # @param RemindMessage: 催办详情
4633
+ # @param RemindMessage: 催办详情信息
4627
4634
  # @type RemindMessage: String
4628
4635
 
4629
4636
  attr_accessor :CanRemind, :FlowId, :RemindMessage
@@ -4721,7 +4728,7 @@ module TencentCloud
4721
4728
  # @param SignUrl: 签署链接,过期时间为30天
4722
4729
  # 注意:此字段可能返回 null,表示取不到有效值。
4723
4730
  # @type SignUrl: String
4724
- # @param Deadline: 合同过期时间
4731
+ # @param Deadline: 合同过期时间戳,单位秒
4725
4732
  # 注意:此字段可能返回 null,表示取不到有效值。
4726
4733
  # @type Deadline: Integer
4727
4734
  # @param SignOrder: 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
@@ -4797,7 +4804,7 @@ module TencentCloud
4797
4804
 
4798
4805
  # 企业员工信息
4799
4806
  class Staff < TencentCloud::Common::AbstractModel
4800
- # @param UserId: 员工在电子签平台的id
4807
+ # @param UserId: 员工在电子签平台的用户ID
4801
4808
  # @type UserId: String
4802
4809
  # @param DisplayName: 显示的员工名
4803
4810
  # @type DisplayName: String
@@ -4806,7 +4813,7 @@ module TencentCloud
4806
4813
  # @param Email: 员工邮箱
4807
4814
  # 注意:此字段可能返回 null,表示取不到有效值。
4808
4815
  # @type Email: String
4809
- # @param OpenId: 员工在第三方平台id
4816
+ # @param OpenId: 员工在第三方应用平台的用户ID
4810
4817
  # 注意:此字段可能返回 null,表示取不到有效值。
4811
4818
  # @type OpenId: String
4812
4819
  # @param Roles: 员工角色
@@ -4817,9 +4824,9 @@ module TencentCloud
4817
4824
  # @type Department: :class:`Tencentcloud::Essbasic.v20210526.models.Department`
4818
4825
  # @param Verified: 员工是否实名
4819
4826
  # @type Verified: Boolean
4820
- # @param CreatedOn: 员工创建时间戳
4827
+ # @param CreatedOn: 员工创建时间戳,单位秒
4821
4828
  # @type CreatedOn: Integer
4822
- # @param VerifiedOn: 员工实名时间戳
4829
+ # @param VerifiedOn: 员工实名时间戳,单位秒
4823
4830
  # @type VerifiedOn: Integer
4824
4831
  # @param QuiteJob: 员工是否离职:0-未离职,1-离职
4825
4832
  # @type QuiteJob: Integer
@@ -4889,7 +4896,7 @@ module TencentCloud
4889
4896
 
4890
4897
  # 同步经办人失败原因
4891
4898
  class SyncFailReason < TencentCloud::Common::AbstractModel
4892
- # @param Id: 经办人Id
4899
+ # @param Id: 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
4893
4900
  # @type Id: String
4894
4901
  # @param Message: 失败原因
4895
4902
  # 例如:Id不符合规范、证件号码不合法等
@@ -5074,29 +5081,29 @@ module TencentCloud
5074
5081
  # @type TemplateName: String
5075
5082
  # @param Description: 模板描述信息
5076
5083
  # @type Description: String
5077
- # @param Components: 模板控件信息结构
5084
+ # @param Components: 模板的填充控件信息结构
5078
5085
  # @type Components: Array
5079
5086
  # @param Recipients: 模板中的流程参与人信息
5080
5087
  # @type Recipients: Array
5081
- # @param SignComponents: 签署区模板信息结构
5088
+ # @param SignComponents: 模板中的签署控件信息结构
5082
5089
  # @type SignComponents: Array
5083
5090
  # @param TemplateType: 模板类型:1-静默签;3-普通模板
5084
5091
  # @type TemplateType: Integer
5085
5092
  # @param IsPromoter: 是否是发起人 ,已弃用
5086
5093
  # @type IsPromoter: Boolean
5087
- # @param Creator: 模板的创建者信息
5094
+ # @param Creator: 模板的创建者信息,电子签系统用户ID
5088
5095
  # @type Creator: String
5089
- # @param CreatedOn: 模板创建的时间戳(精确到秒)
5096
+ # @param CreatedOn: 模板创建的时间戳,单位秒
5090
5097
  # @type CreatedOn: Integer
5091
- # @param PreviewUrl: 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
5098
+ # @param PreviewUrl: 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
5092
5099
  # 注意:此字段可能返回 null,表示取不到有效值。
5093
5100
  # @type PreviewUrl: String
5094
- # @param PdfUrl: 第三方应用集成-模板PDF文件链接
5101
+ # @param PdfUrl: 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
5095
5102
  # 注意:此字段可能返回 null,表示取不到有效值。
5096
5103
  # @type PdfUrl: String
5097
- # @param ChannelTemplateId: 关联的平台企业模板ID
5104
+ # @param ChannelTemplateId: 关联的第三方应用平台企业模板ID
5098
5105
  # @type ChannelTemplateId: String
5099
- # @param ChannelTemplateName: 关联的平台企业模板名称
5106
+ # @param ChannelTemplateName: 关联的三方应用平台平台企业模板名称
5100
5107
  # 注意:此字段可能返回 null,表示取不到有效值。
5101
5108
  # @type ChannelTemplateName: String
5102
5109
  # @param ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
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.585
4
+ version: 3.0.587
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-06-06 00:00:00.000000000 Z
11
+ date: 2023-06-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common