tencentcloud-sdk-ess 3.0.552 → 3.0.554

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06e905696f6dc3966379948a53f5bbf6d692eea1
-  data.tar.gz: 6b88b2afc0ebb7da8346c6451584ddcf7831cb0d
+  metadata.gz: 72033f085acab6ae01708d843794928430dd1de2
+  data.tar.gz: d5bc1a30ad5946de18507d8cafb7443d44f9c0cb
 SHA512:
-  metadata.gz: 9461eb67f4ec8a4f6c9a6a3e23c3649633eb6d6dbba6c5c2f7c09c29b99b454aa22772800285ac84b017aacaa26a6ec1a56fb4fd54086941c74f8a0e0ce7ff1f
-  data.tar.gz: 556dfb314543833feda600887e6a1794aa01bac5f580eb316753e6922f5b43d83f471afbd2a89189bfbc27eb8232870b3dc5894d7df3c14eeef23e6a5795cb67
+  metadata.gz: d97a0419a80533e621839f4e8602fb4fd176abc1641770b89b1033f8e7f7f59e5629011f149451f862a0a939a315d7ea453d9f043d4c5f1fec418120c9cdef6c
+  data.tar.gz: f4ad2cc7599013e495338a742be7f54f3430a1779a73944685599b2a614c5f947983609638d011416537712df3d8a745804e9c03b953d126ac7490ebb6851748

data/lib/VERSION

@@ -1 +1 @@
-3.0.552
+3.0.554

data/lib/v20201111/client.rb

@@ -29,6 +29,30 @@ module TencentCloud
         end
 
 
+        # 将电子签系统员工userId与客户系统员工openId进行绑定
+
+        # @param request: Request instance for BindEmployeeUserIdWithClientOpenId.
+        # @type request: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdResponse`
+        def BindEmployeeUserIdWithClientOpenId(request)
+          body = send_request('BindEmployeeUserIdWithClientOpenId', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = BindEmployeeUserIdWithClientOpenIdResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 用于撤销签署流程
         # 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
         # 注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
@@ -79,8 +103,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 指定需要批量撤回的签署流程Id，获取批量撤销链接
-        # 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
+        # 注：此接口建会废弃，请使用撤销单个签署流程（CancelFlow）接口。
+        # 指定需要批量撤回的签署流程Id，获取批量撤销链接。
+        # 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
 
         # @param request: Request instance for CreateBatchCancelFlowUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`
@@ -1034,6 +1059,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
+
+        # @param request: Request instance for UnbindEmployeeUserIdWithClientOpenId.
+        # @type request: :class:`Tencentcloud::ess::V20201111::UnbindEmployeeUserIdWithClientOpenIdRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::UnbindEmployeeUserIdWithClientOpenIdResponse`
+        def UnbindEmployeeUserIdWithClientOpenId(request)
+          body = send_request('UnbindEmployeeUserIdWithClientOpenId', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = UnbindEmployeeUserIdWithClientOpenIdResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 更新员工信息(姓名，手机号，邮件)，用户实名后无法更改姓名与手机号
 
         # @param request: Request instance for UpdateIntegrationEmployees.

data/lib/v20201111/models.rb

@@ -271,6 +271,53 @@ module TencentCloud
         end
       end
 
+      # BindEmployeeUserIdWithClientOpenId请求参数结构体
+      class BindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为INTEGRATE；当传入参数UserId，Channel无需指定
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param UserId: 电子签系统员工UserId
+        # @type UserId: String
+        # @param OpenId: 客户系统OpenId
+        # @type OpenId: String
+
+        attr_accessor :Operator, :UserId, :OpenId
+        
+        def initialize(operator=nil, userid=nil, openid=nil)
+          @Operator = operator
+          @UserId = userid
+          @OpenId = openid
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @UserId = params['UserId']
+          @OpenId = params['OpenId']
+        end
+      end
+
+      # BindEmployeeUserIdWithClientOpenId返回参数结构体
+      class BindEmployeeUserIdWithClientOpenIdResponse < TencentCloud::Common::AbstractModel
+        # @param Status: 绑定是否成功，1表示成功，0表示失败
+        # @type Status: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :Status, :RequestId
+        
+        def initialize(status=nil, requestid=nil)
+          @Status = status
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Status = params['Status']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 应用回调信息
       class CallbackInfo < TencentCloud::Common::AbstractModel
         # @param CallbackUrl: 回调url
@@ -791,7 +838,7 @@ module TencentCloud
         # @type FlowId: String
         # @param TemplateId: 用户上传的模板ID
         # @type TemplateId: String
-        # @param FileNames: 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起
+        # @param FileNames: 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
         # @type FileNames: Array
         # @param FormFields: 内容控件信息数组
         # @type FormFields: Array
@@ -2065,14 +2112,20 @@ module TencentCloud
         # @type AutoSignConfig: :class:`Tencentcloud::Ess.v20201111.models.AutoSignConfig`
         # @param UrlType: 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
         # @type UrlType: String
+        # @param NotifyType: 通知类型，默认不填为不通知开通方，填写 SMS 为短息通知。
+        # @type NotifyType: String
+        # @param NotifyAddress: 若上方填写为 SMS，则此处为手机号
+        # @type NotifyAddress: String
 
-        attr_accessor :Operator, :SceneKey, :AutoSignConfig, :UrlType
+        attr_accessor :Operator, :SceneKey, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress
         
-        def initialize(operator=nil, scenekey=nil, autosignconfig=nil, urltype=nil)
+        def initialize(operator=nil, scenekey=nil, autosignconfig=nil, urltype=nil, notifytype=nil, notifyaddress=nil)
           @Operator = operator
           @SceneKey = scenekey
           @AutoSignConfig = autosignconfig
           @UrlType = urltype
+          @NotifyType = notifytype
+          @NotifyAddress = notifyaddress
         end
 
         def deserialize(params)
@@ -2086,6 +2139,8 @@ module TencentCloud
             @AutoSignConfig.deserialize(params['AutoSignConfig'])
           end
           @UrlType = params['UrlType']
+          @NotifyType = params['NotifyType']
+          @NotifyAddress = params['NotifyAddress']
         end
       end
 
@@ -2135,7 +2190,7 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param Employees: 待移除员工的信息，userId和openId二选一，必填一个
         # @type Employees: Array
-        # @param Agent: 代理信息
+        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :Employees, :Agent
@@ -2626,8 +2681,6 @@ module TencentCloud
       class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 调用方用户信息，userId 必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Organization: 企业组织相关信息，一般不用填
-        # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
         # @param Offset: 查询偏移位置，默认0
@@ -2644,24 +2697,26 @@ module TencentCloud
         # @param IsChannel: 默认为false，查询SaaS模板库列表；
         # 为true，查询第三方应用集成平台企业模板库管理列表
         # @type IsChannel: Boolean
-        # @param GenerateSource: 暂未开放
-        # @type GenerateSource: Integer
         # @param ContentType: 查询内容：0-模板列表及详情（默认），1-仅模板列表
         # @type ContentType: Integer
+        # @param Organization: 暂未开放
+        # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
+        # @param GenerateSource: 暂未开放
+        # @type GenerateSource: Integer
 
-        attr_accessor :Operator, :Organization, :Agent, :Offset, :Limit, :Filters, :ApplicationId, :IsChannel, :GenerateSource, :ContentType
+        attr_accessor :Operator, :Agent, :Offset, :Limit, :Filters, :ApplicationId, :IsChannel, :ContentType, :Organization, :GenerateSource
         
-        def initialize(operator=nil, organization=nil, agent=nil, offset=nil, limit=nil, filters=nil, applicationid=nil, ischannel=nil, generatesource=nil, contenttype=nil)
+        def initialize(operator=nil, agent=nil, offset=nil, limit=nil, filters=nil, applicationid=nil, ischannel=nil, contenttype=nil, organization=nil, generatesource=nil)
           @Operator = operator
-          @Organization = organization
           @Agent = agent
           @Offset = offset
           @Limit = limit
           @Filters = filters
           @ApplicationId = applicationid
           @IsChannel = ischannel
-          @GenerateSource = generatesource
           @ContentType = contenttype
+          @Organization = organization
+          @GenerateSource = generatesource
         end
 
         def deserialize(params)
@@ -2669,10 +2724,6 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
-          unless params['Organization'].nil?
-            @Organization = OrganizationInfo.new
-            @Organization.deserialize(params['Organization'])
-          end
           unless params['Agent'].nil?
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
@@ -2689,8 +2740,12 @@ module TencentCloud
           end
           @ApplicationId = params['ApplicationId']
           @IsChannel = params['IsChannel']
-          @GenerateSource = params['GenerateSource']
           @ContentType = params['ContentType']
+          unless params['Organization'].nil?
+            @Organization = OrganizationInfo.new
+            @Organization.deserialize(params['Organization'])
+          end
+          @GenerateSource = params['GenerateSource']
         end
       end
 
@@ -2947,7 +3002,7 @@ module TencentCloud
         # @type Name: String
         # @param Status: 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
         # @type Status: Integer
-        # @param Export: 是否到处当前成员企业数据
+        # @param Export: 是否导出当前成员企业数据
         # @type Export: Boolean
         # @param Id: 成员企业id
         # @type Id: String
@@ -4013,7 +4068,7 @@ module TencentCloud
         # @param UpdateTime: 更新时间
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type UpdateTime: Integer
-        # @param Status: 成员企业状态
+        # @param Status: 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Status: Integer
         # @param IsMainOrganization: 是否为集团主企业
@@ -4251,15 +4306,15 @@ module TencentCloud
 
       # 机构信息
       class OrganizationInfo < TencentCloud::Common::AbstractModel
-        # @param OrganizationId: 机构在平台的编号
+        # @param OrganizationId: 机构在平台的编号，内部字段，暂未开放
         # @type OrganizationId: String
-        # @param Channel: 用户渠道
+        # @param Channel: 用户渠道，内部字段，暂未开放
         # @type Channel: String
-        # @param OrganizationOpenId: 用户在渠道的机构编号
+        # @param OrganizationOpenId: 用户在渠道的机构编号，内部字段，暂未开放
         # @type OrganizationOpenId: String
-        # @param ClientIp: 用户真实的IP
+        # @param ClientIp: 用户真实的IP，内部字段，暂未开放
         # @type ClientIp: String
-        # @param ProxyIp: 机构的代理IP
+        # @param ProxyIp: 机构的代理IP，内部字段，暂未开放
         # @type ProxyIp: String
 
         attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
@@ -4283,9 +4338,9 @@ module TencentCloud
 
       # 合同文件验签单个结果结构体
       class PdfVerifyResult < TencentCloud::Common::AbstractModel
-        # @param VerifyResult: 验签结果
+        # @param VerifyResult: 验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。
         # @type VerifyResult: Integer
-        # @param SignPlatform: 签署平台
+        # @param SignPlatform: 签署平台，如果文件是在腾讯电子签平台签署，则返回腾讯电子签，如果文件不在腾讯电子签平台签署，则返回其他平台。
         # @type SignPlatform: String
         # @param SignerName: 签署人名称
         # @type SignerName: String
@@ -4349,7 +4404,7 @@ module TencentCloud
       class Recipient < TencentCloud::Common::AbstractModel
         # @param RecipientId: 签署参与者ID
         # @type RecipientId: String
-        # @param RecipientType: 参与者类型（ENTERPRISE/INDIVIDUAL）
+        # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业；INDIVIDUAL-个人；PROMOTER-发起方
         # @type RecipientType: String
         # @param Description: 描述信息
         # @type Description: String
@@ -4369,7 +4424,7 @@ module TencentCloud
         # @type Mobile: String
         # @param UserId: 关联的用户ID
         # @type UserId: String
-        # @param DeliveryMethod: 发送方式（EMAIL/MOBILE）
+        # @param DeliveryMethod: 发送方式。默认为EMAIL。EMAIL-邮件；MOBILE-手机短信；WECHAT-微信通知
         # @type DeliveryMethod: String
         # @param RecipientExtra: 附属信息
         # @type RecipientExtra: String
@@ -4825,7 +4880,7 @@ module TencentCloud
         # @type CreatedOn: Integer
         # @param Promoter: 发起人角色信息
         # @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
-        # @param Available: 模板可用状态，取值：0未知，但默认会被转成启用；1启用（默认），2停用
+        # @param Available: 模板可用状态，取值：1启用（默认），2停用
         # @type Available: Integer
         # @param OrganizationId: 模板创建组织id
         # @type OrganizationId: String
@@ -4917,21 +4972,68 @@ module TencentCloud
         end
       end
 
+      # UnbindEmployeeUserIdWithClientOpenId请求参数结构体
+      class UnbindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 用户信息，OpenId与UserId二选一必填一个，OpenId是第三方客户ID，userId是用户实名后的电子签生成的ID,当传入客户系统openId，传入的openId需与电子签员工userId绑定，且参数Channel必填，Channel值为INTEGRATE；当传入参数UserId，Channel无需指定
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param UserId: 电子签系统员工UserId
+        # @type UserId: String
+        # @param OpenId: 客户系统OpenId
+        # @type OpenId: String
+
+        attr_accessor :Operator, :UserId, :OpenId
+        
+        def initialize(operator=nil, userid=nil, openid=nil)
+          @Operator = operator
+          @UserId = userid
+          @OpenId = openid
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @UserId = params['UserId']
+          @OpenId = params['OpenId']
+        end
+      end
+
+      # UnbindEmployeeUserIdWithClientOpenId返回参数结构体
+      class UnbindEmployeeUserIdWithClientOpenIdResponse < TencentCloud::Common::AbstractModel
+        # @param Status: 解绑是否成功，1表示成功，0表示失败
+        # @type Status: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :Status, :RequestId
+        
+        def initialize(status=nil, requestid=nil)
+          @Status = status
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Status = params['Status']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # UpdateIntegrationEmployees请求参数结构体
       class UpdateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 操作人信息
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Agent: 代理信息
-        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
         # @param Employees: 员工信息
         # @type Employees: Array
+        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
-        attr_accessor :Operator, :Agent, :Employees
+        attr_accessor :Operator, :Employees, :Agent
         
-        def initialize(operator=nil, agent=nil, employees=nil)
+        def initialize(operator=nil, employees=nil, agent=nil)
           @Operator = operator
-          @Agent = agent
           @Employees = employees
+          @Agent = agent
         end
 
         def deserialize(params)
@@ -4939,10 +5041,6 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
-          unless params['Agent'].nil?
-            @Agent = Agent.new
-            @Agent.deserialize(params['Agent'])
-          end
           unless params['Employees'].nil?
             @Employees = []
             params['Employees'].each do |i|
@@ -4951,6 +5049,10 @@ module TencentCloud
               @Employees << staff_tmp
             end
           end
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
         end
       end
 
@@ -5096,13 +5198,13 @@ module TencentCloud
       class UserInfo < TencentCloud::Common::AbstractModel
         # @param UserId: 用户在平台的编号
         # @type UserId: String
-        # @param Channel: 用户的来源渠道
+        # @param Channel: 用户的来源渠道，一般不用传，特定场景根据接口说明传值
         # @type Channel: String
-        # @param OpenId: 用户在渠道的编号
+        # @param OpenId: 用户在渠道的编号，一般不用传，特定场景根据接口说明传值
         # @type OpenId: String
-        # @param ClientIp: 用户真实IP
+        # @param ClientIp: 用户真实IP，内部字段，暂未开放
         # @type ClientIp: String
-        # @param ProxyIp: 用户代理IP
+        # @param ProxyIp: 用户代理IP，内部字段，暂未开放
         # @type ProxyIp: String
 
         attr_accessor :UserId, :Channel, :OpenId, :ClientIp, :ProxyIp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.552
+  version: 3.0.554
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common