tencentcloud-sdk-ess 3.0.749 → 3.0.751

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f954217436d56b120a5374fabc61e95c2db8b591
-  data.tar.gz: 8548c59a83e9e6fcd555ae5a0e51abf9fb1b2f80
+  metadata.gz: 0a857c022caa9b689889489976bbb713cc9c40d5
+  data.tar.gz: 768842becd12c23b37a5ce3dcfad6d5f47d8f613
 SHA512:
-  metadata.gz: f7f8a3bd9deb2f444c1a7837232dab5a2cdf3f688e78aba2c9ceed057bdd5b1f172215925da4e96bff3bbe458e6a3b021bb764030a8b38026462a9003bb05794
-  data.tar.gz: 049dd0f883ddf6f7b8c5521f21e02d27a3483b1958e0692feb4c702c24ee882e6f6e735c6119b06494f906dd10f377e0fe1dc219be03bbba557722c53a0e4083
+  metadata.gz: f02bd878b8e80c123ecf4b98175cb025a9f9d27f925c06809ec13a007ff2bf1101612885b78eb6352d9da3103cb0fc396d2f7542bf20df78bd0af49840ae244e
+  data.tar.gz: 5a4b4321996d64ccd08dad3bc224c33ac552032cac4a384515dc02c2fa85d93303ca35d37d9f206c2da3b6b45498e478d1202aafc40d1b656093a72001e1cabb

data/lib/VERSION

@@ -1 +1 @@
-3.0.749
+3.0.751

data/lib/v20201111/client.rb

@@ -700,15 +700,14 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
+        # 该接口用于发起合同后，生成用户的签署链接 <br/>
 
         # **注意**
-        # 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
-        # 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，**不支持填写控件** 。
-        # 3. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
-        # 4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        # 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。
+        # 2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
+        # 3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
         # 跳转到小程序的实现，参考微信官方文档（分为<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>。
-        # 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        # 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
 
         # @param request: Request instance for CreateFlowSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlRequest`
@@ -756,7 +755,36 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
+        # 此接口（CreateIntegrationEmployees）用于创建企业员工。
+        # 支持以下场景
+        # <table>
+        # <tbody>
+        # <tr>
+        # <td>生成端</td>
+        # <td >入参</td>
+        # <td>提醒方式</td>
+        # </tr>
+        # <tr>
+        # <td>普通saas员工</td>
+        # <td>不需要传递 InvitationNotifyType</td>
+        # <td>短信</td>
+        # </tr>
+        # <tr>
+        # <td>企微员工</td>
+        # <td>不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
+        # <td>企微内部实名消息</td>
+        # </tr>
+        # <tr>
+        # <td>H5端 saas员工</td>
+        # <td>传递 InvitationNotifyType = H5，不支持企微</td>
+        # <td>生成H5链接</td>
+        # </tr>
+        # </tbody>
+        # </table>
+        # 注意：
+
+        # - <b>若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。</b>
+        # - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
 
         # @param request: Request instance for CreateIntegrationEmployees.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationEmployeesRequest`
@@ -2100,8 +2128,35 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 更新员工信息(姓名，手机号，邮件、部门)，用户实名后无法更改姓名与手机号。
-        # 可进行批量操作，Employees中的userID与openID二选一必填
+        # 此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。
+        # 修改手机号的时候,支持以下场景进行提醒通知
+        # <table>
+        # <tbody>
+        # <tr>
+        # <td>生成端</td>
+        # <td>入参</td>
+        # <td>提醒方式</td>
+        # </tr>
+        # <tr>
+        # <td>普通saas员工</td>
+        # <td>不需要传递 InvitationNotifyType</td>
+        # <td>短信</td>
+        # </tr>
+        # <tr>
+        # <td>企微员工</td>
+        # <td>不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
+        # <td>企微内部实名消息</td>
+        # </tr>
+        # <tr>
+        # <td>H5端 saas员工</td>
+        # <td>传递 InvitationNotifyType = H5，不支持企微</td>
+        # <td>生成H5链接</td>
+        # </tr>
+        # </tbody>
+        # </table>
+        # 注意：
+
+        # - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
 
         # @param request: Request instance for UpdateIntegrationEmployees.
         # @type request: :class:`Tencentcloud::ess::V20201111::UpdateIntegrationEmployeesRequest`

data/lib/v20201111/models.rb

@@ -954,8 +954,9 @@ module TencentCloud
         # <li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
         # <li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
 
-        # **如果是SignComponent签署控件类型，则可选的字段为**
-
+        # **如果是SignComponent签署控件类型，
+        # 需要根据签署人的类型可选的字段为**
+        # * 企业方
         # <ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
         # <li> <b>SIGN_DATE</b> : 签署日期控件；</li>
         # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
@@ -963,6 +964,12 @@ module TencentCloud
         # <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
         # <li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
         # <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
+
+        # * 个人方
+        # <ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
+        # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
+        # <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li></ul>
+
         # 注：` 表单域的控件不能作为印章和签名控件`
         # @type ComponentType: String
         # @param ComponentHeight: **在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。
@@ -2878,47 +2885,47 @@ module TencentCloud
         # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
         # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         # @type FlowId: String
-        # @param FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，
-
-        # 注:
-        # `1. ApproverType目前只支持个人类型的签署人。`
-        # `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
-        # @type FlowApproverInfos: Array
         # @param Operator: 执行本接口操作的员工信息。
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。
+
+        # 注:
+        # `1. 签署人只能有手写签名、时间类型和印章类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+        # `2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
+        # @type FlowApproverInfos: Array
         # @param Organization: 机构信息，暂未开放
         # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
         # @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
         # @type JumpUrl: String
+        # @param UrlType: 链接类型，支持指定以下类型
+        # <ul><li>0 : 签署链接 (默认值)</li>
+        # <li>1 : 预览链接</li></ul>
+        # 注:
+        # `1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
+        # `2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
+        # @type UrlType: Integer
 
-        attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
+        attr_accessor :FlowId, :Operator, :Agent, :FlowApproverInfos, :Organization, :JumpUrl, :UrlType
         extend Gem::Deprecate
         deprecate :Organization, :none, 2024, 1
         deprecate :Organization=, :none, 2024, 1
 
-        def initialize(flowid=nil, flowapproverinfos=nil, operator=nil, agent=nil, organization=nil, jumpurl=nil)
+        def initialize(flowid=nil, operator=nil, agent=nil, flowapproverinfos=nil, organization=nil, jumpurl=nil, urltype=nil)
           @FlowId = flowid
-          @FlowApproverInfos = flowapproverinfos
           @Operator = operator
           @Agent = agent
+          @FlowApproverInfos = flowapproverinfos
           @Organization = organization
           @JumpUrl = jumpurl
+          @UrlType = urltype
         end
 
         def deserialize(params)
           @FlowId = params['FlowId']
-          unless params['FlowApproverInfos'].nil?
-            @FlowApproverInfos = []
-            params['FlowApproverInfos'].each do |i|
-              flowcreateapprover_tmp = FlowCreateApprover.new
-              flowcreateapprover_tmp.deserialize(i)
-              @FlowApproverInfos << flowcreateapprover_tmp
-            end
-          end
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
@@ -2927,11 +2934,20 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
+          unless params['FlowApproverInfos'].nil?
+            @FlowApproverInfos = []
+            params['FlowApproverInfos'].each do |i|
+              flowcreateapprover_tmp = FlowCreateApprover.new
+              flowcreateapprover_tmp.deserialize(i)
+              @FlowApproverInfos << flowcreateapprover_tmp
+            end
+          end
           unless params['Organization'].nil?
             @Organization = OrganizationInfo.new
             @Organization.deserialize(params['Organization'])
           end
           @JumpUrl = params['JumpUrl']
+          @UrlType = params['UrlType']
         end
       end
 
@@ -3043,13 +3059,23 @@ module TencentCloud
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param InvitationNotifyType: 员工邀请方式
+        # 如果是来自H5的，参数需要传递H5
+        # 短信或者企微 请传递SMS，或者不传递
+        # @type InvitationNotifyType: String
+        # @param JumpUrl: 回跳地址，
+        # 在认证成功之后，进行回跳，请保证回跳地址的可用性。
+        # 使用前请联系对接的客户经理沟通，提供回跳地址的域名，进行域名配置
+        # @type JumpUrl: String
 
-        attr_accessor :Operator, :Employees, :Agent
+        attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl
 
-        def initialize(operator=nil, employees=nil, agent=nil)
+        def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil)
           @Operator = operator
           @Employees = employees
           @Agent = agent
+          @InvitationNotifyType = invitationnotifytype
+          @JumpUrl = jumpurl
         end
 
         def deserialize(params)
@@ -3069,6 +3095,8 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
+          @InvitationNotifyType = params['InvitationNotifyType']
+          @JumpUrl = params['JumpUrl']
         end
       end
 
@@ -9249,7 +9277,8 @@ module TencentCloud
         end
       end
 
-      # 创建员工的成功数据
+      # 创建员工成功返回的信息
+      # 支持saas/企微/H5端进行加入。
       class SuccessCreateStaffData < TencentCloud::Common::AbstractModel
         # @param DisplayName: 员工名
         # @type DisplayName: String
@@ -9262,15 +9291,20 @@ module TencentCloud
         # @type Note: String
         # @param WeworkOpenId: 传入的企微账号id
         # @type WeworkOpenId: String
+        # @param Url: H5端员工加入\实名链接
+
+        # 只有入参 InvitationNotifyType = H5的时候才会进行返回。
+        # @type Url: String
 
-        attr_accessor :DisplayName, :Mobile, :UserId, :Note, :WeworkOpenId
+        attr_accessor :DisplayName, :Mobile, :UserId, :Note, :WeworkOpenId, :Url
 
-        def initialize(displayname=nil, mobile=nil, userid=nil, note=nil, weworkopenid=nil)
+        def initialize(displayname=nil, mobile=nil, userid=nil, note=nil, weworkopenid=nil, url=nil)
           @DisplayName = displayname
           @Mobile = mobile
           @UserId = userid
           @Note = note
           @WeworkOpenId = weworkopenid
+          @Url = url
         end
 
         def deserialize(params)
@@ -9279,6 +9313,7 @@ module TencentCloud
           @UserId = params['UserId']
           @Note = params['Note']
           @WeworkOpenId = params['WeworkOpenId']
+          @Url = params['Url']
         end
       end
 
@@ -9306,7 +9341,9 @@ module TencentCloud
         end
       end
 
-      # 更新员工信息成功返回的数据信息
+      # 更新员工信息成功返回的数据信息， 仅支持未实名的用户进行更新
+      # 会通过短信、企微消息或者H5Url 链接
+      # 如果是通过H5邀请加入的方式，会返回H5 链接
       class SuccessUpdateStaffData < TencentCloud::Common::AbstractModel
         # @param DisplayName: 传入的用户名称
         # @type DisplayName: String
@@ -9315,19 +9352,25 @@ module TencentCloud
         # @param UserId: 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
         # 可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
         # @type UserId: String
+        # @param Url: H5端员工实名链接
 
-        attr_accessor :DisplayName, :Mobile, :UserId
+        # 只有入参 InvitationNotifyType = H5的时候才会进行返回。
+        # @type Url: String
 
-        def initialize(displayname=nil, mobile=nil, userid=nil)
+        attr_accessor :DisplayName, :Mobile, :UserId, :Url
+
+        def initialize(displayname=nil, mobile=nil, userid=nil, url=nil)
           @DisplayName = displayname
           @Mobile = mobile
           @UserId = userid
+          @Url = url
         end
 
         def deserialize(params)
           @DisplayName = params['DisplayName']
           @Mobile = params['Mobile']
           @UserId = params['UserId']
+          @Url = params['Url']
         end
       end
 
@@ -9581,13 +9624,23 @@ module TencentCloud
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param InvitationNotifyType: 员工邀请方式
+        # 如果是来自H5的，参数需要传递H5
+        # 短信或者企微 请传递SMS，或者不传递
+        # @type InvitationNotifyType: String
+        # @param JumpUrl: 回跳地址，
+        # 在认证成功之后，进行回跳，请保证回跳地址的可用性。
+        # 使用前请联系对接的客户经理沟通，提供回跳地址的域名，进行域名配置。
+        # @type JumpUrl: String
 
-        attr_accessor :Operator, :Employees, :Agent
+        attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl
 
-        def initialize(operator=nil, employees=nil, agent=nil)
+        def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil)
           @Operator = operator
           @Employees = employees
           @Agent = agent
+          @InvitationNotifyType = invitationnotifytype
+          @JumpUrl = jumpurl
         end
 
         def deserialize(params)
@@ -9607,6 +9660,8 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
+          @InvitationNotifyType = params['InvitationNotifyType']
+          @JumpUrl = params['JumpUrl']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.749
+  version: 3.0.751
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common