tencentcloud-sdk-ess 3.0.553 → 3.0.554

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: 7f8017a09cb23668aeed1f6e5399001ab239257a
4
- data.tar.gz: 4d3de809771036781216a6def25fc16f6407bdcd
3
+ metadata.gz: 72033f085acab6ae01708d843794928430dd1de2
4
+ data.tar.gz: d5bc1a30ad5946de18507d8cafb7443d44f9c0cb
5
5
  SHA512:
6
- metadata.gz: 8c46bf077469d115e1a45650bff827e5a0947d9397a6d5c48e0e43a312fd6368b2db89e2eb47a33f9b82ab89a42695cf103c5e714771d50ea9d4192feef1eeb5
7
- data.tar.gz: eda3a2cd18f954813d05abe9f61cb98f666a8b5cea4e94ba0cf0323934aa7b12f3fdd8bf137b15d36b6fd1dd2b61d2442649c3033591c5906ba9ded8073bea3e
6
+ metadata.gz: d97a0419a80533e621839f4e8602fb4fd176abc1641770b89b1033f8e7f7f59e5629011f149451f862a0a939a315d7ea453d9f043d4c5f1fec418120c9cdef6c
7
+ data.tar.gz: f4ad2cc7599013e495338a742be7f54f3430a1779a73944685599b2a614c5f947983609638d011416537712df3d8a745804e9c03b953d126ac7490ebb6851748
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.553
1
+ 3.0.554
@@ -103,8 +103,9 @@ module TencentCloud
103
103
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
104
104
  end
105
105
 
106
- # 指定需要批量撤回的签署流程Id,获取批量撤销链接
107
- # 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
106
+ # 注:此接口建会废弃,请使用撤销单个签署流程(CancelFlow)接口。
107
+ # 指定需要批量撤回的签署流程Id,获取批量撤销链接。
108
+ # 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。
108
109
 
109
110
  # @param request: Request instance for CreateBatchCancelFlowUrl.
110
111
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`
@@ -273,7 +273,7 @@ module TencentCloud
273
273
 
274
274
  # BindEmployeeUserIdWithClientOpenId请求参数结构体
275
275
  class BindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
276
- # @param Operator: OpenId与UserId二选一必填一个,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且渠道channel必填,channel值为INTEGRATE,否则传入userId
276
+ # @param Operator: 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定
277
277
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
278
278
  # @param UserId: 电子签系统员工UserId
279
279
  # @type UserId: String
@@ -838,7 +838,7 @@ module TencentCloud
838
838
  # @type FlowId: String
839
839
  # @param TemplateId: 用户上传的模板ID
840
840
  # @type TemplateId: String
841
- # @param FileNames: 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起
841
+ # @param FileNames: 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
842
842
  # @type FileNames: Array
843
843
  # @param FormFields: 内容控件信息数组
844
844
  # @type FormFields: Array
@@ -2112,14 +2112,20 @@ module TencentCloud
2112
2112
  # @type AutoSignConfig: :class:`Tencentcloud::Ess.v20201111.models.AutoSignConfig`
2113
2113
  # @param UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
2114
2114
  # @type UrlType: String
2115
+ # @param NotifyType: 通知类型,默认不填为不通知开通方,填写 SMS 为短息通知。
2116
+ # @type NotifyType: String
2117
+ # @param NotifyAddress: 若上方填写为 SMS,则此处为手机号
2118
+ # @type NotifyAddress: String
2115
2119
 
2116
- attr_accessor :Operator, :SceneKey, :AutoSignConfig, :UrlType
2120
+ attr_accessor :Operator, :SceneKey, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress
2117
2121
 
2118
- def initialize(operator=nil, scenekey=nil, autosignconfig=nil, urltype=nil)
2122
+ def initialize(operator=nil, scenekey=nil, autosignconfig=nil, urltype=nil, notifytype=nil, notifyaddress=nil)
2119
2123
  @Operator = operator
2120
2124
  @SceneKey = scenekey
2121
2125
  @AutoSignConfig = autosignconfig
2122
2126
  @UrlType = urltype
2127
+ @NotifyType = notifytype
2128
+ @NotifyAddress = notifyaddress
2123
2129
  end
2124
2130
 
2125
2131
  def deserialize(params)
@@ -2133,6 +2139,8 @@ module TencentCloud
2133
2139
  @AutoSignConfig.deserialize(params['AutoSignConfig'])
2134
2140
  end
2135
2141
  @UrlType = params['UrlType']
2142
+ @NotifyType = params['NotifyType']
2143
+ @NotifyAddress = params['NotifyAddress']
2136
2144
  end
2137
2145
  end
2138
2146
 
@@ -2182,7 +2190,7 @@ module TencentCloud
2182
2190
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2183
2191
  # @param Employees: 待移除员工的信息,userId和openId二选一,必填一个
2184
2192
  # @type Employees: Array
2185
- # @param Agent: 代理信息
2193
+ # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
2186
2194
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2187
2195
 
2188
2196
  attr_accessor :Operator, :Employees, :Agent
@@ -2673,8 +2681,6 @@ module TencentCloud
2673
2681
  class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
2674
2682
  # @param Operator: 调用方用户信息,userId 必填
2675
2683
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2676
- # @param Organization: 企业组织相关信息,一般不用填
2677
- # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
2678
2684
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2679
2685
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2680
2686
  # @param Offset: 查询偏移位置,默认0
@@ -2691,24 +2697,26 @@ module TencentCloud
2691
2697
  # @param IsChannel: 默认为false,查询SaaS模板库列表;
2692
2698
  # 为true,查询第三方应用集成平台企业模板库管理列表
2693
2699
  # @type IsChannel: Boolean
2694
- # @param GenerateSource: 暂未开放
2695
- # @type GenerateSource: Integer
2696
2700
  # @param ContentType: 查询内容:0-模板列表及详情(默认),1-仅模板列表
2697
2701
  # @type ContentType: Integer
2702
+ # @param Organization: 暂未开放
2703
+ # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
2704
+ # @param GenerateSource: 暂未开放
2705
+ # @type GenerateSource: Integer
2698
2706
 
2699
- attr_accessor :Operator, :Organization, :Agent, :Offset, :Limit, :Filters, :ApplicationId, :IsChannel, :GenerateSource, :ContentType
2707
+ attr_accessor :Operator, :Agent, :Offset, :Limit, :Filters, :ApplicationId, :IsChannel, :ContentType, :Organization, :GenerateSource
2700
2708
 
2701
- def initialize(operator=nil, organization=nil, agent=nil, offset=nil, limit=nil, filters=nil, applicationid=nil, ischannel=nil, generatesource=nil, contenttype=nil)
2709
+ def initialize(operator=nil, agent=nil, offset=nil, limit=nil, filters=nil, applicationid=nil, ischannel=nil, contenttype=nil, organization=nil, generatesource=nil)
2702
2710
  @Operator = operator
2703
- @Organization = organization
2704
2711
  @Agent = agent
2705
2712
  @Offset = offset
2706
2713
  @Limit = limit
2707
2714
  @Filters = filters
2708
2715
  @ApplicationId = applicationid
2709
2716
  @IsChannel = ischannel
2710
- @GenerateSource = generatesource
2711
2717
  @ContentType = contenttype
2718
+ @Organization = organization
2719
+ @GenerateSource = generatesource
2712
2720
  end
2713
2721
 
2714
2722
  def deserialize(params)
@@ -2716,10 +2724,6 @@ module TencentCloud
2716
2724
  @Operator = UserInfo.new
2717
2725
  @Operator.deserialize(params['Operator'])
2718
2726
  end
2719
- unless params['Organization'].nil?
2720
- @Organization = OrganizationInfo.new
2721
- @Organization.deserialize(params['Organization'])
2722
- end
2723
2727
  unless params['Agent'].nil?
2724
2728
  @Agent = Agent.new
2725
2729
  @Agent.deserialize(params['Agent'])
@@ -2736,8 +2740,12 @@ module TencentCloud
2736
2740
  end
2737
2741
  @ApplicationId = params['ApplicationId']
2738
2742
  @IsChannel = params['IsChannel']
2739
- @GenerateSource = params['GenerateSource']
2740
2743
  @ContentType = params['ContentType']
2744
+ unless params['Organization'].nil?
2745
+ @Organization = OrganizationInfo.new
2746
+ @Organization.deserialize(params['Organization'])
2747
+ end
2748
+ @GenerateSource = params['GenerateSource']
2741
2749
  end
2742
2750
  end
2743
2751
 
@@ -2994,7 +3002,7 @@ module TencentCloud
2994
3002
  # @type Name: String
2995
3003
  # @param Status: 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
2996
3004
  # @type Status: Integer
2997
- # @param Export: 是否到处当前成员企业数据
3005
+ # @param Export: 是否导出当前成员企业数据
2998
3006
  # @type Export: Boolean
2999
3007
  # @param Id: 成员企业id
3000
3008
  # @type Id: String
@@ -4060,7 +4068,7 @@ module TencentCloud
4060
4068
  # @param UpdateTime: 更新时间
4061
4069
  # 注意:此字段可能返回 null,表示取不到有效值。
4062
4070
  # @type UpdateTime: Integer
4063
- # @param Status: 成员企业状态
4071
+ # @param Status: 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
4064
4072
  # 注意:此字段可能返回 null,表示取不到有效值。
4065
4073
  # @type Status: Integer
4066
4074
  # @param IsMainOrganization: 是否为集团主企业
@@ -4298,15 +4306,15 @@ module TencentCloud
4298
4306
 
4299
4307
  # 机构信息
4300
4308
  class OrganizationInfo < TencentCloud::Common::AbstractModel
4301
- # @param OrganizationId: 机构在平台的编号
4309
+ # @param OrganizationId: 机构在平台的编号,内部字段,暂未开放
4302
4310
  # @type OrganizationId: String
4303
- # @param Channel: 用户渠道
4311
+ # @param Channel: 用户渠道,内部字段,暂未开放
4304
4312
  # @type Channel: String
4305
- # @param OrganizationOpenId: 用户在渠道的机构编号
4313
+ # @param OrganizationOpenId: 用户在渠道的机构编号,内部字段,暂未开放
4306
4314
  # @type OrganizationOpenId: String
4307
- # @param ClientIp: 用户真实的IP
4315
+ # @param ClientIp: 用户真实的IP,内部字段,暂未开放
4308
4316
  # @type ClientIp: String
4309
- # @param ProxyIp: 机构的代理IP
4317
+ # @param ProxyIp: 机构的代理IP,内部字段,暂未开放
4310
4318
  # @type ProxyIp: String
4311
4319
 
4312
4320
  attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
@@ -4330,9 +4338,9 @@ module TencentCloud
4330
4338
 
4331
4339
  # 合同文件验签单个结果结构体
4332
4340
  class PdfVerifyResult < TencentCloud::Common::AbstractModel
4333
- # @param VerifyResult: 验签结果
4341
+ # @param VerifyResult: 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
4334
4342
  # @type VerifyResult: Integer
4335
- # @param SignPlatform: 签署平台
4343
+ # @param SignPlatform: 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
4336
4344
  # @type SignPlatform: String
4337
4345
  # @param SignerName: 签署人名称
4338
4346
  # @type SignerName: String
@@ -4396,7 +4404,7 @@ module TencentCloud
4396
4404
  class Recipient < TencentCloud::Common::AbstractModel
4397
4405
  # @param RecipientId: 签署参与者ID
4398
4406
  # @type RecipientId: String
4399
- # @param RecipientType: 参与者类型(ENTERPRISE/INDIVIDUAL
4407
+ # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
4400
4408
  # @type RecipientType: String
4401
4409
  # @param Description: 描述信息
4402
4410
  # @type Description: String
@@ -4416,7 +4424,7 @@ module TencentCloud
4416
4424
  # @type Mobile: String
4417
4425
  # @param UserId: 关联的用户ID
4418
4426
  # @type UserId: String
4419
- # @param DeliveryMethod: 发送方式(EMAIL/MOBILE
4427
+ # @param DeliveryMethod: 发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知
4420
4428
  # @type DeliveryMethod: String
4421
4429
  # @param RecipientExtra: 附属信息
4422
4430
  # @type RecipientExtra: String
@@ -4872,7 +4880,7 @@ module TencentCloud
4872
4880
  # @type CreatedOn: Integer
4873
4881
  # @param Promoter: 发起人角色信息
4874
4882
  # @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
4875
- # @param Available: 模板可用状态,取值:0未知,但默认会被转成启用;1启用(默认),2停用
4883
+ # @param Available: 模板可用状态,取值:1启用(默认),2停用
4876
4884
  # @type Available: Integer
4877
4885
  # @param OrganizationId: 模板创建组织id
4878
4886
  # @type OrganizationId: String
@@ -4966,7 +4974,7 @@ module TencentCloud
4966
4974
 
4967
4975
  # UnbindEmployeeUserIdWithClientOpenId请求参数结构体
4968
4976
  class UnbindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
4969
- # @param Operator: OpenId与UserId二选一必填一个,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且渠道channel必填,channel值为INTEGRATE,否则传入userId
4977
+ # @param Operator: 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定
4970
4978
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4971
4979
  # @param UserId: 电子签系统员工UserId
4972
4980
  # @type UserId: String
@@ -5015,17 +5023,17 @@ module TencentCloud
5015
5023
  class UpdateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
5016
5024
  # @param Operator: 操作人信息
5017
5025
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
5018
- # @param Agent: 代理信息
5019
- # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
5020
5026
  # @param Employees: 员工信息
5021
5027
  # @type Employees: Array
5028
+ # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
5029
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
5022
5030
 
5023
- attr_accessor :Operator, :Agent, :Employees
5031
+ attr_accessor :Operator, :Employees, :Agent
5024
5032
 
5025
- def initialize(operator=nil, agent=nil, employees=nil)
5033
+ def initialize(operator=nil, employees=nil, agent=nil)
5026
5034
  @Operator = operator
5027
- @Agent = agent
5028
5035
  @Employees = employees
5036
+ @Agent = agent
5029
5037
  end
5030
5038
 
5031
5039
  def deserialize(params)
@@ -5033,10 +5041,6 @@ module TencentCloud
5033
5041
  @Operator = UserInfo.new
5034
5042
  @Operator.deserialize(params['Operator'])
5035
5043
  end
5036
- unless params['Agent'].nil?
5037
- @Agent = Agent.new
5038
- @Agent.deserialize(params['Agent'])
5039
- end
5040
5044
  unless params['Employees'].nil?
5041
5045
  @Employees = []
5042
5046
  params['Employees'].each do |i|
@@ -5045,6 +5049,10 @@ module TencentCloud
5045
5049
  @Employees << staff_tmp
5046
5050
  end
5047
5051
  end
5052
+ unless params['Agent'].nil?
5053
+ @Agent = Agent.new
5054
+ @Agent.deserialize(params['Agent'])
5055
+ end
5048
5056
  end
5049
5057
  end
5050
5058
 
@@ -5190,13 +5198,13 @@ module TencentCloud
5190
5198
  class UserInfo < TencentCloud::Common::AbstractModel
5191
5199
  # @param UserId: 用户在平台的编号
5192
5200
  # @type UserId: String
5193
- # @param Channel: 用户的来源渠道
5201
+ # @param Channel: 用户的来源渠道,一般不用传,特定场景根据接口说明传值
5194
5202
  # @type Channel: String
5195
- # @param OpenId: 用户在渠道的编号
5203
+ # @param OpenId: 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
5196
5204
  # @type OpenId: String
5197
- # @param ClientIp: 用户真实IP
5205
+ # @param ClientIp: 用户真实IP,内部字段,暂未开放
5198
5206
  # @type ClientIp: String
5199
- # @param ProxyIp: 用户代理IP
5207
+ # @param ProxyIp: 用户代理IP,内部字段,暂未开放
5200
5208
  # @type ProxyIp: String
5201
5209
 
5202
5210
  attr_accessor :UserId, :Channel, :OpenId, :ClientIp, :ProxyIp
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.553
4
+ version: 3.0.554
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-04-18 00:00:00.000000000 Z
11
+ date: 2023-04-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common