tencentcloud-sdk-essbasic 3.0.523 → 3.0.524

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: d9bb6c93e08eabea6b272e2f1537eb8d4554f6db
4
- data.tar.gz: b20f0b18a4f53e27d7cd6dfd6648d85b16562151
3
+ metadata.gz: 7bb1f89998446d339b4f86a9a63f82725981f9e3
4
+ data.tar.gz: ea16493b218b773ff9867ef83978a925f0dd0079
5
5
  SHA512:
6
- metadata.gz: ed3b05974d879101ddf233f4644ac7c580678c94c97cb65cfe1b954c679976a0e39dd85334ac6a028594aa25b9c4555252f4ef0f271c84c9d1447b397297cbe0
7
- data.tar.gz: 3cfaa213ff8c5ef09a3b8c89fda68ec94de1d3409eee16296f0b291c6036f88de3562e0f8a363b293bb24518d6a1f7d479647f46fabe1fed066d39b3d8ea3290
6
+ metadata.gz: 8627363aa7f2c968590bb2f4d3caa73c6fb86517c2b045058bd3245e372a994fb233a2f08f7cf6fe39efd0312bb70986e8b9ae97089d6557e73ba374ae4ad6a7
7
+ data.tar.gz: 7f0df18c74519d9e5977db560593834bf08c058706a7d6b2a3a4b6e04e17e6755d111c1e9cfd5f029dd923883f75523039d0f1b5788a60ad418ee3d81a049bb3
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.523
1
+ 3.0.524
@@ -333,6 +333,30 @@ module TencentCloud
333
333
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
334
334
  end
335
335
 
336
+ # 创建预发起合同
337
+
338
+ # @param request: Request instance for ChannelCreatePrepareFlow.
339
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreatePrepareFlowRequest`
340
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreatePrepareFlowResponse`
341
+ def ChannelCreatePrepareFlow(request)
342
+ body = send_request('ChannelCreatePrepareFlow', request.serialize)
343
+ response = JSON.parse(body)
344
+ if response['Response'].key?('Error') == false
345
+ model = ChannelCreatePrepareFlowResponse.new
346
+ model.deserialize(response['Response'])
347
+ model
348
+ else
349
+ code = response['Response']['Error']['Code']
350
+ message = response['Response']['Error']['Message']
351
+ reqid = response['Response']['RequestId']
352
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
353
+ end
354
+ rescue TencentCloud::Common::TencentCloudSDKException => e
355
+ raise e
356
+ rescue StandardError => e
357
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
358
+ end
359
+
336
360
  # 发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
337
361
  # 合同发起人必须在电子签已经进行实名。
338
362
 
@@ -132,6 +132,65 @@ module TencentCloud
132
132
  end
133
133
  end
134
134
 
135
+ # 基础流程信息
136
+ class BaseFlowInfo < TencentCloud::Common::AbstractModel
137
+ # @param FlowName: 合同流程名称
138
+ # 注意:此字段可能返回 null,表示取不到有效值。
139
+ # @type FlowName: String
140
+ # @param FlowType: 合同流程类型
141
+ # 注意:此字段可能返回 null,表示取不到有效值。
142
+ # @type FlowType: String
143
+ # @param FlowDescription: 合同流程描述信息
144
+ # 注意:此字段可能返回 null,表示取不到有效值。
145
+ # @type FlowDescription: String
146
+ # @param Deadline: 合同流程截止时间,unix时间戳
147
+ # 注意:此字段可能返回 null,表示取不到有效值。
148
+ # @type Deadline: Integer
149
+ # @param Unordered: 是否顺序签署(true:无序签,false:顺序签)
150
+ # 注意:此字段可能返回 null,表示取不到有效值。
151
+ # @type Unordered: Boolean
152
+ # @param IntelligentStatus: 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
153
+ # 注意:此字段可能返回 null,表示取不到有效值。
154
+ # @type IntelligentStatus: String
155
+ # @param FormFields: 填写控件内容
156
+ # 注意:此字段可能返回 null,表示取不到有效值。
157
+ # @type FormFields: Array
158
+ # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批
159
+ # 注意:此字段可能返回 null,表示取不到有效值。
160
+ # @type NeedSignReview: Boolean
161
+
162
+ attr_accessor :FlowName, :FlowType, :FlowDescription, :Deadline, :Unordered, :IntelligentStatus, :FormFields, :NeedSignReview
163
+
164
+ def initialize(flowname=nil, flowtype=nil, flowdescription=nil, deadline=nil, unordered=nil, intelligentstatus=nil, formfields=nil, needsignreview=nil)
165
+ @FlowName = flowname
166
+ @FlowType = flowtype
167
+ @FlowDescription = flowdescription
168
+ @Deadline = deadline
169
+ @Unordered = unordered
170
+ @IntelligentStatus = intelligentstatus
171
+ @FormFields = formfields
172
+ @NeedSignReview = needsignreview
173
+ end
174
+
175
+ def deserialize(params)
176
+ @FlowName = params['FlowName']
177
+ @FlowType = params['FlowType']
178
+ @FlowDescription = params['FlowDescription']
179
+ @Deadline = params['Deadline']
180
+ @Unordered = params['Unordered']
181
+ @IntelligentStatus = params['IntelligentStatus']
182
+ unless params['FormFields'].nil?
183
+ @FormFields = []
184
+ params['FormFields'].each do |i|
185
+ formfield_tmp = FormField.new
186
+ formfield_tmp.deserialize(i)
187
+ @FormFields << formfield_tmp
188
+ end
189
+ end
190
+ @NeedSignReview = params['NeedSignReview']
191
+ end
192
+ end
193
+
135
194
  # 抄送信息
136
195
  class CcInfo < TencentCloud::Common::AbstractModel
137
196
  # @param Mobile: 被抄送人手机号,大陆11位手机号
@@ -959,6 +1018,104 @@ module TencentCloud
959
1018
  end
960
1019
  end
961
1020
 
1021
+ # ChannelCreatePrepareFlow请求参数结构体
1022
+ class ChannelCreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
1023
+ # @param ResourceId: 资源id,与ResourceType对应
1024
+ # @type ResourceId: String
1025
+ # @param ResourceType: 资源类型,1:模版,目前仅支持模版,与ResourceId对应
1026
+ # @type ResourceType: Integer
1027
+ # @param FlowInfo: 合同流程基础信息
1028
+ # @type FlowInfo: :class:`Tencentcloud::Essbasic.v20210526.models.BaseFlowInfo`
1029
+ # @param FlowApproverList: 合同签署人信息
1030
+ # @type FlowApproverList: Array
1031
+ # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填
1032
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1033
+ # @param FlowOption: 合同流程配置信息
1034
+ # @type FlowOption: :class:`Tencentcloud::Essbasic.v20210526.models.CreateFlowOption`
1035
+ # @param FlowId: 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
1036
+ # @type FlowId: String
1037
+ # @param NeedPreview: 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
1038
+ # @type NeedPreview: Boolean
1039
+ # @param Organization: 企业机构信息,不用传
1040
+ # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
1041
+ # @param Operator: 操作人(用户)信息,不用传
1042
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
1043
+
1044
+ attr_accessor :ResourceId, :ResourceType, :FlowInfo, :FlowApproverList, :Agent, :FlowOption, :FlowId, :NeedPreview, :Organization, :Operator
1045
+
1046
+ def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, flowapproverlist=nil, agent=nil, flowoption=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil)
1047
+ @ResourceId = resourceid
1048
+ @ResourceType = resourcetype
1049
+ @FlowInfo = flowinfo
1050
+ @FlowApproverList = flowapproverlist
1051
+ @Agent = agent
1052
+ @FlowOption = flowoption
1053
+ @FlowId = flowid
1054
+ @NeedPreview = needpreview
1055
+ @Organization = organization
1056
+ @Operator = operator
1057
+ end
1058
+
1059
+ def deserialize(params)
1060
+ @ResourceId = params['ResourceId']
1061
+ @ResourceType = params['ResourceType']
1062
+ unless params['FlowInfo'].nil?
1063
+ @FlowInfo = BaseFlowInfo.new
1064
+ @FlowInfo.deserialize(params['FlowInfo'])
1065
+ end
1066
+ unless params['FlowApproverList'].nil?
1067
+ @FlowApproverList = []
1068
+ params['FlowApproverList'].each do |i|
1069
+ commonflowapprover_tmp = CommonFlowApprover.new
1070
+ commonflowapprover_tmp.deserialize(i)
1071
+ @FlowApproverList << commonflowapprover_tmp
1072
+ end
1073
+ end
1074
+ unless params['Agent'].nil?
1075
+ @Agent = Agent.new
1076
+ @Agent.deserialize(params['Agent'])
1077
+ end
1078
+ unless params['FlowOption'].nil?
1079
+ @FlowOption = CreateFlowOption.new
1080
+ @FlowOption.deserialize(params['FlowOption'])
1081
+ end
1082
+ @FlowId = params['FlowId']
1083
+ @NeedPreview = params['NeedPreview']
1084
+ unless params['Organization'].nil?
1085
+ @Organization = OrganizationInfo.new
1086
+ @Organization.deserialize(params['Organization'])
1087
+ end
1088
+ unless params['Operator'].nil?
1089
+ @Operator = UserInfo.new
1090
+ @Operator.deserialize(params['Operator'])
1091
+ end
1092
+ end
1093
+ end
1094
+
1095
+ # ChannelCreatePrepareFlow返回参数结构体
1096
+ class ChannelCreatePrepareFlowResponse < TencentCloud::Common::AbstractModel
1097
+ # @param PrepareFlowUrl: 预发起的合同链接
1098
+ # @type PrepareFlowUrl: String
1099
+ # @param PreviewFlowUrl: 合同发起后预览链接
1100
+ # @type PreviewFlowUrl: String
1101
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1102
+ # @type RequestId: String
1103
+
1104
+ attr_accessor :PrepareFlowUrl, :PreviewFlowUrl, :RequestId
1105
+
1106
+ def initialize(prepareflowurl=nil, previewflowurl=nil, requestid=nil)
1107
+ @PrepareFlowUrl = prepareflowurl
1108
+ @PreviewFlowUrl = previewflowurl
1109
+ @RequestId = requestid
1110
+ end
1111
+
1112
+ def deserialize(params)
1113
+ @PrepareFlowUrl = params['PrepareFlowUrl']
1114
+ @PreviewFlowUrl = params['PreviewFlowUrl']
1115
+ @RequestId = params['RequestId']
1116
+ end
1117
+ end
1118
+
962
1119
  # ChannelCreateReleaseFlow请求参数结构体
963
1120
  class ChannelCreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
964
1121
  # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
@@ -1522,6 +1679,108 @@ module TencentCloud
1522
1679
  end
1523
1680
  end
1524
1681
 
1682
+ # 签署人配置信息
1683
+ class CommonApproverOption < TencentCloud::Common::AbstractModel
1684
+ # @param CanEditApprover: 是否允许修改签署人信息
1685
+ # 注意:此字段可能返回 null,表示取不到有效值。
1686
+ # @type CanEditApprover: Boolean
1687
+
1688
+ attr_accessor :CanEditApprover
1689
+
1690
+ def initialize(caneditapprover=nil)
1691
+ @CanEditApprover = caneditapprover
1692
+ end
1693
+
1694
+ def deserialize(params)
1695
+ @CanEditApprover = params['CanEditApprover']
1696
+ end
1697
+ end
1698
+
1699
+ # 通用签署人信息
1700
+ class CommonFlowApprover < TencentCloud::Common::AbstractModel
1701
+ # @param NotChannelOrganization: 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
1702
+ # 注意:此字段可能返回 null,表示取不到有效值。
1703
+ # @type NotChannelOrganization: Boolean
1704
+ # @param ApproverType: 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
1705
+ # 注意:此字段可能返回 null,表示取不到有效值。
1706
+ # @type ApproverType: Integer
1707
+ # @param OrganizationId: 企业id
1708
+ # 注意:此字段可能返回 null,表示取不到有效值。
1709
+ # @type OrganizationId: String
1710
+ # @param OrganizationOpenId: 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同毕传
1711
+ # 注意:此字段可能返回 null,表示取不到有效值。
1712
+ # @type OrganizationOpenId: String
1713
+ # @param OrganizationName: 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
1714
+ # 注意:此字段可能返回 null,表示取不到有效值。
1715
+ # @type OrganizationName: String
1716
+ # @param UserId: 用户id
1717
+ # 注意:此字段可能返回 null,表示取不到有效值。
1718
+ # @type UserId: String
1719
+ # @param OpenId: 用户openId,第三方应用集成非静默签子客企业签署人必传
1720
+ # 注意:此字段可能返回 null,表示取不到有效值。
1721
+ # @type OpenId: String
1722
+ # @param ApproverName: 签署人名称,saas企业签署人,个人签署人必传
1723
+ # 注意:此字段可能返回 null,表示取不到有效值。
1724
+ # @type ApproverName: String
1725
+ # @param ApproverMobile: 签署人手机号,saas企业签署人,个人签署人必传
1726
+ # 注意:此字段可能返回 null,表示取不到有效值。
1727
+ # @type ApproverMobile: String
1728
+ # @param RecipientId: 签署人Id,使用模版发起是,对应模版配置中的签署人RecipientId
1729
+ # 注意:此字段可能返回 null,表示取不到有效值。
1730
+ # @type RecipientId: String
1731
+ # @param PreReadTime: 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
1732
+ # 注意:此字段可能返回 null,表示取不到有效值。
1733
+ # @type PreReadTime: Integer
1734
+ # @param IsFullText: 签署前置条件:阅读全文限制
1735
+ # 注意:此字段可能返回 null,表示取不到有效值。
1736
+ # @type IsFullText: Boolean
1737
+ # @param NotifyType: 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
1738
+ # 注意:此字段可能返回 null,表示取不到有效值。
1739
+ # @type NotifyType: String
1740
+ # @param ApproverOption: 签署人配置
1741
+ # 注意:此字段可能返回 null,表示取不到有效值。
1742
+ # @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.CommonApproverOption`
1743
+
1744
+ attr_accessor :NotChannelOrganization, :ApproverType, :OrganizationId, :OrganizationOpenId, :OrganizationName, :UserId, :OpenId, :ApproverName, :ApproverMobile, :RecipientId, :PreReadTime, :IsFullText, :NotifyType, :ApproverOption
1745
+
1746
+ def initialize(notchannelorganization=nil, approvertype=nil, organizationid=nil, organizationopenid=nil, organizationname=nil, userid=nil, openid=nil, approvername=nil, approvermobile=nil, recipientid=nil, prereadtime=nil, isfulltext=nil, notifytype=nil, approveroption=nil)
1747
+ @NotChannelOrganization = notchannelorganization
1748
+ @ApproverType = approvertype
1749
+ @OrganizationId = organizationid
1750
+ @OrganizationOpenId = organizationopenid
1751
+ @OrganizationName = organizationname
1752
+ @UserId = userid
1753
+ @OpenId = openid
1754
+ @ApproverName = approvername
1755
+ @ApproverMobile = approvermobile
1756
+ @RecipientId = recipientid
1757
+ @PreReadTime = prereadtime
1758
+ @IsFullText = isfulltext
1759
+ @NotifyType = notifytype
1760
+ @ApproverOption = approveroption
1761
+ end
1762
+
1763
+ def deserialize(params)
1764
+ @NotChannelOrganization = params['NotChannelOrganization']
1765
+ @ApproverType = params['ApproverType']
1766
+ @OrganizationId = params['OrganizationId']
1767
+ @OrganizationOpenId = params['OrganizationOpenId']
1768
+ @OrganizationName = params['OrganizationName']
1769
+ @UserId = params['UserId']
1770
+ @OpenId = params['OpenId']
1771
+ @ApproverName = params['ApproverName']
1772
+ @ApproverMobile = params['ApproverMobile']
1773
+ @RecipientId = params['RecipientId']
1774
+ @PreReadTime = params['PreReadTime']
1775
+ @IsFullText = params['IsFullText']
1776
+ @NotifyType = params['NotifyType']
1777
+ unless params['ApproverOption'].nil?
1778
+ @ApproverOption = CommonApproverOption.new
1779
+ @ApproverOption.deserialize(params['ApproverOption'])
1780
+ end
1781
+ end
1782
+ end
1783
+
1525
1784
  # 此结构体 (Component) 用于描述控件属性。
1526
1785
 
1527
1786
  # 在通过文件发起合同时,对应的component有三种定位方式
@@ -1931,6 +2190,23 @@ module TencentCloud
1931
2190
  end
1932
2191
  end
1933
2192
 
2193
+ # 创建合同配置信息
2194
+ class CreateFlowOption < TencentCloud::Common::AbstractModel
2195
+ # @param CanEditFlow: 是否允许修改合同信息
2196
+ # 注意:此字段可能返回 null,表示取不到有效值。
2197
+ # @type CanEditFlow: Boolean
2198
+
2199
+ attr_accessor :CanEditFlow
2200
+
2201
+ def initialize(caneditflow=nil)
2202
+ @CanEditFlow = caneditflow
2203
+ end
2204
+
2205
+ def deserialize(params)
2206
+ @CanEditFlow = params['CanEditFlow']
2207
+ end
2208
+ end
2209
+
1934
2210
  # CreateFlowsByTemplates请求参数结构体
1935
2211
  class CreateFlowsByTemplatesRequest < TencentCloud::Common::AbstractModel
1936
2212
  # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
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.523
4
+ version: 3.0.524
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-03-07 00:00:00.000000000 Z
11
+ date: 2023-03-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common