tencentcloud-sdk-essbasic 3.0.689 → 3.0.691

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: 8137a4e60a258742266b0b2aae0dc8e49e7a0cb0
4
- data.tar.gz: fc1ccdf855324823e57267e4dd95532ca2638119
3
+ metadata.gz: 5c6ed753c0f6607f428e6e636db8671c21afd27d
4
+ data.tar.gz: 1d91782b479fd49f21e31ce8410467befb7966fc
5
5
  SHA512:
6
- metadata.gz: 2998ddb2b75e6cf36301f0c8ad86c374d4964bb171ddfb892448baafaf35a62b5abc9a44328ec90e07b62529604cfebb42737b13dfe82795d1a3b8635d2b54b2
7
- data.tar.gz: 7b2017efcbb87ab726f7b41e8ee1272c177605f5ad008eef4ddd2a509c789df1ce107bede8d04ded1b80d6be14535584b1b1f656aa79ba1140245edbf5486063
6
+ metadata.gz: 9088c1718b81faf0ac57e8cd755e890e8ff0f38f839d4ae222b8ed5bfb8f8ed1d338ff40c43484a195f5f5679051547d7a6bf58cd9c044f44f4ad23b5fdce42e
7
+ data.tar.gz: 1d8119f2f9a6135b1b34259cbd9952e9f0e06a77c48b2189b7959802d764429c363c96fecccdeaca991d939ba495764ca31d5f800a3d772e982a052a85648050
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.689
1
+ 3.0.691
@@ -2,12 +2,12 @@
2
2
 
3
3
  require 'tencentcloud-sdk-common'
4
4
 
5
- require_relative 'v20210526/client'
6
- require_relative 'v20210526/models'
7
-
8
5
  require_relative 'v20201222/client'
9
6
  require_relative 'v20201222/models'
10
7
 
8
+ require_relative 'v20210526/client'
9
+ require_relative 'v20210526/models'
10
+
11
11
  module TencentCloud
12
12
  module Essbasic
13
13
  end
@@ -181,6 +181,37 @@ module TencentCloud
181
181
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
182
182
  end
183
183
 
184
+ # 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
185
+ # `注意:`<br/>
186
+ # `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
187
+ # `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
188
+ # `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
189
+ # `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
190
+ # `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
191
+ # 跳转到小程序的实现,参考微信官方文档(分为<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>
192
+
193
+ # @param request: Request instance for ChannelCreateBatchQuickSignUrl.
194
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlRequest`
195
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlResponse`
196
+ def ChannelCreateBatchQuickSignUrl(request)
197
+ body = send_request('ChannelCreateBatchQuickSignUrl', request.serialize)
198
+ response = JSON.parse(body)
199
+ if response['Response'].key?('Error') == false
200
+ model = ChannelCreateBatchQuickSignUrlResponse.new
201
+ model.deserialize(response['Response'])
202
+ model
203
+ else
204
+ code = response['Response']['Error']['Code']
205
+ message = response['Response']['Error']['Message']
206
+ reqid = response['Response']['RequestId']
207
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
208
+ end
209
+ rescue TencentCloud::Common::TencentCloudSDKException => e
210
+ raise e
211
+ rescue StandardError => e
212
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
213
+ end
214
+
184
215
  # 通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。
185
216
  # 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
186
217
 
@@ -235,7 +266,14 @@ module TencentCloud
235
266
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
236
267
  end
237
268
 
238
- # 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将wordexcel、图片文件转换为pdf文件。
269
+ # 此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
270
+ # 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
271
+ # 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
272
+ # 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
273
+ # 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
274
+ # 注:
275
+ # 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
276
+ # 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
239
277
 
240
278
  # @param request: Request instance for ChannelCreateConvertTaskApi.
241
279
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateConvertTaskApiRequest`
@@ -1199,8 +1237,12 @@ module TencentCloud
1199
1237
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1200
1238
  end
1201
1239
 
1202
- # 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
1203
- # 注意:大文件转换所需的时间可能会比较长。
1240
+ # 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
1241
+ # 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
1242
+
1243
+ # 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
1244
+ # 注:
1245
+ # 1. `大文件转换所需的时间可能会比较长`
1204
1246
 
1205
1247
  # @param request: Request instance for ChannelGetTaskResultApi.
1206
1248
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelGetTaskResultApiRequest`
@@ -1718,6 +1760,11 @@ module TencentCloud
1718
1760
  # >- 签署控件 SignComponents
1719
1761
  # >- 生成模板的文件基础信息 FileInfos
1720
1762
 
1763
+ # 注意:
1764
+
1765
+ # >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
1766
+ # >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
1767
+
1721
1768
  # @param request: Request instance for DescribeTemplates.
1722
1769
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesRequest`
1723
1770
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesResponse`
@@ -1888,7 +1935,7 @@ module TencentCloud
1888
1935
 
1889
1936
  # 该接口 (PrepareFlows) 用于创建待发起文件
1890
1937
  # 用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
1891
- # 目前该接口只支持B2C,不建议使用,将会废弃。
1938
+ # 目前该接口只支持B2C,不建议使用,将会**废弃**。
1892
1939
 
1893
1940
  # @param request: Request instance for PrepareFlows.
1894
1941
  # @type request: :class:`Tencentcloud::essbasic::V20210526::PrepareFlowsRequest`
@@ -116,6 +116,8 @@ module TencentCloud
116
116
 
117
117
  # 签署人个性化能力信息
118
118
  class ApproverOption < TencentCloud::Common::AbstractModel
119
+ # @param NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
120
+ # @type NoRefuse: Boolean
119
121
  # @param HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏
120
122
  # @type HideOneKeySign: Boolean
121
123
  # @param FillType: 签署人信息补充类型,默认无需补充。
@@ -133,15 +135,17 @@ module TencentCloud
133
135
  # </ul>
134
136
  # @type FlowReadLimit: String
135
137
 
136
- attr_accessor :HideOneKeySign, :FillType, :FlowReadLimit
138
+ attr_accessor :NoRefuse, :HideOneKeySign, :FillType, :FlowReadLimit
137
139
 
138
- def initialize(hideonekeysign=nil, filltype=nil, flowreadlimit=nil)
140
+ def initialize(norefuse=nil, hideonekeysign=nil, filltype=nil, flowreadlimit=nil)
141
+ @NoRefuse = norefuse
139
142
  @HideOneKeySign = hideonekeysign
140
143
  @FillType = filltype
141
144
  @FlowReadLimit = flowreadlimit
142
145
  end
143
146
 
144
147
  def deserialize(params)
148
+ @NoRefuse = params['NoRefuse']
145
149
  @HideOneKeySign = params['HideOneKeySign']
146
150
  @FillType = params['FillType']
147
151
  @FlowReadLimit = params['FlowReadLimit']
@@ -709,6 +713,86 @@ module TencentCloud
709
713
  end
710
714
  end
711
715
 
716
+ # ChannelCreateBatchQuickSignUrl请求参数结构体
717
+ class ChannelCreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel
718
+ # @param FlowIds: 批量签署的合同流程ID数组。
719
+ # 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
720
+ # @type FlowIds: Array
721
+ # @param FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
722
+ # 注:
723
+ # `1. ApproverType目前只支持个人类型的签署人。`
724
+ # `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
725
+ # `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
726
+ # @type FlowApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverInfo`
727
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
728
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
729
+ # @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
730
+ # @type JumpUrl: String
731
+ # @param SignatureTypes: 指定批量签署合同的签名类型,可传递以下值:
732
+ # <ul><li>**0**:手写签名(默认)</li>
733
+ # <li>**1**:OCR楷体</li></ul>
734
+ # 注:
735
+ # <ul><li>默认情况下,签名类型为手写签名</li>
736
+ # <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
737
+ # @type SignatureTypes: Array
738
+ # @param ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
739
+ # <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
740
+ # <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
741
+ # 注:
742
+ # <ul><li>默认情况下,认证校验方式为人脸认证</li>
743
+ # <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
744
+ # @type ApproverSignTypes: Array
745
+
746
+ attr_accessor :FlowIds, :FlowApproverInfo, :Agent, :JumpUrl, :SignatureTypes, :ApproverSignTypes
747
+
748
+ def initialize(flowids=nil, flowapproverinfo=nil, agent=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil)
749
+ @FlowIds = flowids
750
+ @FlowApproverInfo = flowapproverinfo
751
+ @Agent = agent
752
+ @JumpUrl = jumpurl
753
+ @SignatureTypes = signaturetypes
754
+ @ApproverSignTypes = approversigntypes
755
+ end
756
+
757
+ def deserialize(params)
758
+ @FlowIds = params['FlowIds']
759
+ unless params['FlowApproverInfo'].nil?
760
+ @FlowApproverInfo = FlowApproverInfo.new
761
+ @FlowApproverInfo.deserialize(params['FlowApproverInfo'])
762
+ end
763
+ unless params['Agent'].nil?
764
+ @Agent = Agent.new
765
+ @Agent.deserialize(params['Agent'])
766
+ end
767
+ @JumpUrl = params['JumpUrl']
768
+ @SignatureTypes = params['SignatureTypes']
769
+ @ApproverSignTypes = params['ApproverSignTypes']
770
+ end
771
+ end
772
+
773
+ # ChannelCreateBatchQuickSignUrl返回参数结构体
774
+ class ChannelCreateBatchQuickSignUrlResponse < TencentCloud::Common::AbstractModel
775
+ # @param FlowApproverUrlInfo: 签署人签署链接信息
776
+ # @type FlowApproverUrlInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverUrlInfo`
777
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
778
+ # @type RequestId: String
779
+
780
+ attr_accessor :FlowApproverUrlInfo, :RequestId
781
+
782
+ def initialize(flowapproverurlinfo=nil, requestid=nil)
783
+ @FlowApproverUrlInfo = flowapproverurlinfo
784
+ @RequestId = requestid
785
+ end
786
+
787
+ def deserialize(params)
788
+ unless params['FlowApproverUrlInfo'].nil?
789
+ @FlowApproverUrlInfo = FlowApproverUrlInfo.new
790
+ @FlowApproverUrlInfo.deserialize(params['FlowApproverUrlInfo'])
791
+ end
792
+ @RequestId = params['RequestId']
793
+ end
794
+ end
795
+
712
796
  # ChannelCreateBatchSignUrl请求参数结构体
713
797
  class ChannelCreateBatchSignUrlRequest < TencentCloud::Common::AbstractModel
714
798
  # @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -884,13 +968,35 @@ module TencentCloud
884
968
 
885
969
  # ChannelCreateConvertTaskApi请求参数结构体
886
970
  class ChannelCreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
887
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
971
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
972
+
973
+ # 此接口下面信息必填。
974
+ # <ul>
975
+ # <li>渠道应用标识: Agent.AppId</li>
976
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
977
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
978
+ # </ul>
979
+ # 第三方平台子客企业和员工必须已经经过实名认证
888
980
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
889
- # @param ResourceType: 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
981
+ # @param ResourceType: 需要进行转换的资源文件类型
982
+ # 支持的文件类型如下:
983
+ # <ul><li>doc</li>
984
+ # <li>docx</li>
985
+ # <li>xls</li>
986
+ # <li>xlsx</li>
987
+ # <li>jpg</li>
988
+ # <li>jpeg</li>
989
+ # <li>png</li>
990
+ # <li>bmp</li>
991
+ # <li>txt</li></ul>
890
992
  # @type ResourceType: String
891
- # @param ResourceName: 资源名称,长度限制为256字符
993
+ # @param ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
994
+
995
+ # 注: `资源名称长度限制为256个字符`
892
996
  # @type ResourceName: String
893
- # @param ResourceId: 文件Id,通过UploadFiles获取
997
+ # @param ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
998
+
999
+ # 注: `目前,此接口仅支持单个文件进行转换。`
894
1000
  # @type ResourceId: String
895
1001
  # @param Operator: 调用方用户信息,不用传
896
1002
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -934,7 +1040,7 @@ module TencentCloud
934
1040
 
935
1041
  # ChannelCreateConvertTaskApi返回参数结构体
936
1042
  class ChannelCreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
937
- # @param TaskId: 任务id
1043
+ # @param TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
938
1044
  # @type TaskId: String
939
1045
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
940
1046
  # @type RequestId: String
@@ -3241,9 +3347,17 @@ module TencentCloud
3241
3347
 
3242
3348
  # ChannelGetTaskResultApi请求参数结构体
3243
3349
  class ChannelGetTaskResultApiRequest < TencentCloud::Common::AbstractModel
3244
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
3350
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3351
+
3352
+ # 此接口下面信息必填。
3353
+ # <ul>
3354
+ # <li>渠道应用标识: Agent.AppId</li>
3355
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3356
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3357
+ # </ul>
3358
+ # 第三方平台子客企业和员工必须已经经过实名认证
3245
3359
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3246
- # @param TaskId: 任务Id,通过ChannelCreateConvertTaskApi接口获得
3360
+ # @param TaskId: 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
3247
3361
  # @type TaskId: String
3248
3362
  # @param Operator: 操作者的信息,不用传
3249
3363
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -3286,22 +3400,22 @@ module TencentCloud
3286
3400
  # @param TaskId: 任务Id
3287
3401
  # @type TaskId: String
3288
3402
  # @param TaskStatus: 任务状态,需要关注的状态
3289
- # 0 :NeedTranform - 任务已提交
3290
- # 4 :Processing - 文档转换中
3291
- # 8 :TaskEnd - 任务处理完成
3292
- # -2 :DownloadFailed - 下载失败
3293
- # -6 :ProcessFailed - 转换失败
3294
- # -13:ProcessTimeout - 转换文件超时
3403
+ # <ul><li>**0** :NeedTranform - 任务已提交</li>
3404
+ # <li>**4** :Processing - 文档转换中</li>
3405
+ # <li>**8** :TaskEnd - 任务处理完成</li>
3406
+ # <li>**-2** :DownloadFailed - 下载失败</li>
3407
+ # <li>**-6** :ProcessFailed - 转换失败</li>
3408
+ # <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
3295
3409
  # @type TaskStatus: Integer
3296
3410
  # @param TaskMessage: 状态描述,需要关注的状态
3297
- # NeedTranform - 任务已提交
3298
- # Processing - 文档转换中
3299
- # TaskEnd - 任务处理完成
3300
- # DownloadFailed - 下载失败
3301
- # ProcessFailed - 转换失败
3302
- # ProcessTimeout - 转换文件超时
3411
+ # <ul><li> **NeedTranform** : 任务已提交</li>
3412
+ # <li> **Processing** : 文档转换中</li>
3413
+ # <li> **TaskEnd** : 任务处理完成</li>
3414
+ # <li> **DownloadFailed** : 下载失败</li>
3415
+ # <li> **ProcessFailed** : 转换失败</li>
3416
+ # <li> **ProcessTimeout** : 转换文件超时</li></ul>
3303
3417
  # @type TaskMessage: String
3304
- # @param ResourceId: 资源Id,也是FileId,用于文件发起使用
3418
+ # @param ResourceId: 资源Id,也是FileId,用于文件发起时使用
3305
3419
  # @type ResourceId: String
3306
3420
  # @param PreviewUrl: 预览文件Url,有效期30分钟
3307
3421
  # 当前字段返回为空,发起的时候,将ResourceId 放入发起即可
@@ -5013,55 +5127,88 @@ module TencentCloud
5013
5127
 
5014
5128
  # DescribeTemplates请求参数结构体
5015
5129
  class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
5016
- # @param Agent: 应用相关信息。
5017
- # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
5130
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5131
+
5132
+ # 此接口下面信息必填。
5133
+ # <ul>
5134
+ # <li>渠道应用标识: Agent.AppId</li>
5135
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5136
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5137
+ # </ul>
5138
+ # 第三方平台子客企业和员工必须已经经过实名认证
5018
5139
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
5019
- # @param TemplateId: 模板唯一标识,查询单个模板时使用
5140
+ # @param TemplateId: 合同模板ID,为32位字符串。
5141
+ # 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
5020
5142
  # @type TemplateId: String
5021
- # @param ContentType: 查询内容:
5022
- # 0-模板列表及详情(默认),
5023
- # 1-仅模板列表
5143
+ # @param ContentType: 查询内容控制
5144
+
5145
+ # <ul><li>**0**:模板列表及详情(默认)</li>
5146
+ # <li>**1**:仅模板列表</li></ul>
5024
5147
  # @type ContentType: Integer
5025
- # @param Limit: 指定每页多少条数据,如果不传默认为20,单页最大100。
5148
+ # @param TemplateIds: 合同模板ID数组,每一个合同模板ID为32位字符串。
5149
+ # 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
5150
+
5151
+ # ```注意:
5152
+ # 1. 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。
5153
+ # 2. 请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。
5154
+ # 3. 最多支持200个模板。
5155
+ # 4. 若传递此参数,分页参数(Limit,Offset)无效```
5156
+ # @type TemplateIds: Array
5157
+ # @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
5158
+
5159
+ # 注:`1.默认值为20,单页做大值为200。`
5026
5160
  # @type Limit: Integer
5027
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
5161
+ # @param Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
5162
+
5163
+ # 注:`1.offset从0开始,即第一页为0。`
5164
+ # `2.默认从第一页返回。`
5028
5165
  # @type Offset: Integer
5029
- # @param QueryAllComponents: 是否返回所有组件信息。
5030
- # 默认false,只返回发起方控件;
5031
- # true,返回所有签署方控件
5032
- # @type QueryAllComponents: Boolean
5033
- # @param TemplateName: 模糊搜索模板名称,最大长度200
5166
+ # @param TemplateName: 模糊搜索的模板名称,注意是模板名的连续部分,最大长度200
5034
5167
  # @type TemplateName: String
5035
- # @param WithPreviewUrl: 是否获取模板预览链接,
5036
- # 默认false-不获取
5037
- # true-获取
5168
+ # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
5169
+ # @type ChannelTemplateId: String
5170
+ # @param QueryAllComponents: 是否返回所有控件信息。
5171
+
5172
+ # <ul><li>**false**:只返回发起方控件(默认)</li>
5173
+ # <li>**true**:返回所有签署方控件</li></ul>
5174
+ # @type QueryAllComponents: Boolean
5175
+ # @param WithPreviewUrl: 是否获取模板预览链接。
5176
+
5177
+ # <ul><li>**false**:不获取(默认)</li>
5178
+ # <li>**true**:获取</li></ul>
5179
+
5180
+ # 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接,有效期5分钟。
5181
+ # 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
5182
+ # (此功能开放需要联系客户经理)
5038
5183
  # @type WithPreviewUrl: Boolean
5039
5184
  # @param WithPdfUrl: 是否获取模板的PDF文件链接。
5040
- # 默认false-不获取
5041
- # true-获取
5042
- # 请联系客户经理开白后使用。
5185
+
5186
+ # <ul><li>**false**:不获取(默认)</li>
5187
+ # <li>**true**:获取</li></ul>
5188
+
5189
+ # 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟。
5190
+ # (此功能开放需要联系客户经理)
5043
5191
  # @type WithPdfUrl: Boolean
5044
- # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID
5045
- # @type ChannelTemplateId: String
5046
5192
  # @param Operator: 操作者的信息
5047
5193
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
5048
5194
 
5049
- attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId, :Operator
5195
+ attr_accessor :Agent, :TemplateId, :ContentType, :TemplateIds, :Limit, :Offset, :TemplateName, :ChannelTemplateId, :QueryAllComponents, :WithPreviewUrl, :WithPdfUrl, :Operator
5050
5196
  extend Gem::Deprecate
5051
5197
  deprecate :Operator, :none, 2023, 11
5052
5198
  deprecate :Operator=, :none, 2023, 11
5053
5199
 
5054
- def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, withpreviewurl=nil, withpdfurl=nil, channeltemplateid=nil, operator=nil)
5200
+ def initialize(agent=nil, templateid=nil, contenttype=nil, templateids=nil, limit=nil, offset=nil, templatename=nil, channeltemplateid=nil, queryallcomponents=nil, withpreviewurl=nil, withpdfurl=nil, operator=nil)
5055
5201
  @Agent = agent
5056
5202
  @TemplateId = templateid
5057
5203
  @ContentType = contenttype
5204
+ @TemplateIds = templateids
5058
5205
  @Limit = limit
5059
5206
  @Offset = offset
5060
- @QueryAllComponents = queryallcomponents
5061
5207
  @TemplateName = templatename
5208
+ @ChannelTemplateId = channeltemplateid
5209
+ @QueryAllComponents = queryallcomponents
5062
5210
  @WithPreviewUrl = withpreviewurl
5063
5211
  @WithPdfUrl = withpdfurl
5064
- @ChannelTemplateId = channeltemplateid
5065
5212
  @Operator = operator
5066
5213
  end
5067
5214
 
@@ -5072,13 +5219,14 @@ module TencentCloud
5072
5219
  end
5073
5220
  @TemplateId = params['TemplateId']
5074
5221
  @ContentType = params['ContentType']
5222
+ @TemplateIds = params['TemplateIds']
5075
5223
  @Limit = params['Limit']
5076
5224
  @Offset = params['Offset']
5077
- @QueryAllComponents = params['QueryAllComponents']
5078
5225
  @TemplateName = params['TemplateName']
5226
+ @ChannelTemplateId = params['ChannelTemplateId']
5227
+ @QueryAllComponents = params['QueryAllComponents']
5079
5228
  @WithPreviewUrl = params['WithPreviewUrl']
5080
5229
  @WithPdfUrl = params['WithPdfUrl']
5081
- @ChannelTemplateId = params['ChannelTemplateId']
5082
5230
  unless params['Operator'].nil?
5083
5231
  @Operator = UserInfo.new
5084
5232
  @Operator.deserialize(params['Operator'])
@@ -5088,11 +5236,11 @@ module TencentCloud
5088
5236
 
5089
5237
  # DescribeTemplates返回参数结构体
5090
5238
  class DescribeTemplatesResponse < TencentCloud::Common::AbstractModel
5091
- # @param Templates: 模板列表
5239
+ # @param Templates: 模板详情列表数据
5092
5240
  # @type Templates: Array
5093
- # @param TotalCount: 查询到的总数
5241
+ # @param TotalCount: 查询到的模板总数
5094
5242
  # @type TotalCount: Integer
5095
- # @param Limit: 每页多少条数据
5243
+ # @param Limit: 每页返回的数据条数
5096
5244
  # @type Limit: Integer
5097
5245
  # @param Offset: 查询结果分页返回,此处指定第几页。页码从0开始,即首页为0。
5098
5246
  # @type Offset: Integer
@@ -5632,9 +5780,13 @@ module TencentCloud
5632
5780
  # @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverOption`
5633
5781
  # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
5634
5782
  # @type ApproverNeedSignReview: Boolean
5635
- # @param ApproverVerifyTypes: 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
5636
- # 查看合同的认证方式 Flow层级的优先于approver层级的
5637
- # (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
5783
+ # @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
5784
+ # <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
5785
+ # <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
5786
+ # </li></ul>
5787
+ # 注:
5788
+ # <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
5789
+ # <li>此字段可传多个校验方式</li></ul>
5638
5790
  # @type ApproverVerifyTypes: Array
5639
5791
  # @param ApproverSignTypes: 签署人签署合同时的认证方式
5640
5792
  # <ul><li> **1** :人脸认证</li>
@@ -5659,7 +5811,9 @@ module TencentCloud
5659
5811
 
5660
5812
  # 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
5661
5813
  # @type AddSignComponentsLimits: Array
5662
- # @param ApproverRoleName: 自定义签署人角色名,如收款人、开具人、见证人等
5814
+ # @param ApproverRoleName: 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
5815
+
5816
+ # 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
5663
5817
  # @type ApproverRoleName: String
5664
5818
 
5665
5819
  attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType, :AddSignComponentsLimits, :ApproverRoleName
@@ -6093,36 +6247,67 @@ module TencentCloud
6093
6247
  # | widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
6094
6248
  # | content | String | 表头单元格内容,字数不超过100 |
6095
6249
  class FlowInfo < TencentCloud::Common::AbstractModel
6096
- # @param FlowName: 合同名字,最大长度200个字符
6250
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
6097
6251
  # @type FlowName: String
6098
- # @param Deadline: 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
6252
+ # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
6253
+ # 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
6254
+ # 示例值:1604912664
6099
6255
  # @type Deadline: Integer
6100
- # @param TemplateId: 模板ID
6256
+ # @param TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
6257
+
6258
+ # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
6101
6259
  # @type TemplateId: String
6102
6260
  # @param FlowApprovers: 多个签署人信息,最大支持50个签署方
6103
6261
  # @type FlowApprovers: Array
6104
6262
  # @param FormFields: 表单K-V对列表
6105
6263
  # @type FormFields: Array
6106
- # @param CallbackUrl: 回调地址,最大长度1000个字符
6264
+ # @param CallbackUrl: 合同状态变动结的通知回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性,最大长度1000个字符。
6265
+
6266
+ # 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
6267
+ # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块
6107
6268
  # @type CallbackUrl: String
6108
- # @param FlowType: 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
6269
+ # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
6109
6270
  # @type FlowType: String
6110
- # @param FlowDescription: 合同描述,最大长度1000个字符
6271
+ # @param FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
6111
6272
  # @type FlowDescription: String
6112
- # @param CustomerData: 第三方应用平台的业务信息,最大长度1000个字符。
6273
+ # @param CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
6274
+
6275
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
6113
6276
  # @type CustomerData: String
6114
- # @param CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
6277
+ # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
6278
+ # <ul><li>{合同名称} </li>
6279
+ # <li>{发起方企业} </li>
6280
+ # <li>{发起方姓名} </li>
6281
+ # <li>{签署方N企业}</li>
6282
+ # <li>{签署方N姓名}</li></ul>
6283
+ # 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
6284
+
6285
+ # 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
6286
+
6287
+ # 合同名称:租房合同
6288
+ # 发起方:腾讯公司(张三)
6289
+ # 签署方:李四
6290
+
6115
6291
  # @type CustomShowMap: String
6116
- # @param CcInfos: 被抄送人的信息列表,抄送功能暂不开放
6117
- # @type CcInfos: Array
6118
- # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。
6119
- # 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
6292
+ # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
6120
6293
 
6121
- # 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
6294
+ # 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
6295
+ # @type CcInfos: Array
6296
+ # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
6297
+ # <ul><li> **false**:(默认)不需要审批,直接签署。</li>
6298
+ # <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
6299
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
6300
+ # <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
6301
+ # <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
6302
+ # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
6122
6303
  # @type NeedSignReview: Boolean
6123
- # @param CcNotifyType: 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
6304
+ # @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
6305
+ # <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
6306
+ # <li> **1** : 签署完成后通知对方来查看合同</li></ul>
6124
6307
  # @type CcNotifyType: Integer
6125
- # @param AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
6308
+ # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
6309
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
6310
+ # 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
6126
6311
  # @type AutoSignScene: String
6127
6312
 
6128
6313
  attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos, :NeedSignReview, :CcNotifyType, :AutoSignScene
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.689
4
+ version: 3.0.691
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-10-31 00:00:00.000000000 Z
11
+ date: 2023-11-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,11 +33,11 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/v20210526/client.rb
37
- - lib/v20210526/models.rb
38
- - lib/v20201222/client.rb
39
36
  - lib/v20201222/models.rb
37
+ - lib/v20201222/client.rb
40
38
  - lib/tencentcloud-sdk-essbasic.rb
39
+ - lib/v20210526/models.rb
40
+ - lib/v20210526/client.rb
41
41
  - lib/VERSION
42
42
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
43
43
  licenses: