tencentcloud-sdk-ess 3.0.765 → 3.0.767

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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20201111/client.rb +11 -8
  4. data/lib/v20201111/models.rb +14 -10
  5. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 752b8ccdc8769b77e02da9e960b2fc5fc57c6044
4
- data.tar.gz: 94eb800abeb019970916e7ebf1c7479c22e8d3ee
3
+ metadata.gz: 202261b2d838049eaf5fd5bdf60414dba89db51f
4
+ data.tar.gz: 602766b9e7f4ae879d9e195d79e9008a3bcdd49c
5
5
  SHA512:
6
- metadata.gz: 95f99e86083d87c5d96d1b308047970c0bf935aab49df43134d56836bc272a698fc3aba83097d106ffa6bfe701f446007150cccbda640a9ed62f8c428d571732
7
- data.tar.gz: c818839d901862a1892eb4f286492c4eabfb7ecf9ab975435212307714884028db9a754b09c7a31dc3a5a279c661326a35edbd86c33fea71ca501151127ae2ee
6
+ metadata.gz: e32dfc5ede8f30d2a32120340ea0a65a4e09bb7c27f03d0dbf922e8d05bdc219070412d78f411e172cdac155b781e8525dd01b22984c7c53b7bd1b35971b9f03
7
+ data.tar.gz: 77ebb2109178b441be0237e061d8494611c22b192bb8d72a399637c40f8fceaefbb450d7c910abcaeb5bde70abe203040407f3a522934a485f4d1688e0e7e431
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.765
1
+ 3.0.767
data/lib/v20201111/client.rb CHANGED
@@ -31,6 +31,8 @@ module TencentCloud
31
31
 
32
32
  # 此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
33
33
 
34
+ # 此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
35
+
34
36
  # @param request: Request instance for BindEmployeeUserIdWithClientOpenId.
35
37
  # @type request: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdRequest`
36
38
  # @rtype: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdResponse`
@@ -281,8 +283,8 @@ module TencentCloud
281
283
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
282
284
 
283
285
 
284
- # ### 填充模版中定义的填写控件
285
- # 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
286
+ # ### 填充模板中定义的填写控件
287
+ # 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
286
288
 
287
289
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
288
290
 
@@ -433,7 +435,7 @@ module TencentCloud
433
435
 
434
436
  # <font color="red">相关视频指引</font> <br>
435
437
  # 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4" target="_blank">创建静默（自动）签署模板和开通自动签署</a><br>
436
- # 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模版创建发起合同</a><br>
438
+ # 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模板创建发起合同</a><br>
437
439
 
438
440
  # @param request: Request instance for CreateFlow.
439
441
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest`
@@ -678,6 +680,7 @@ module TencentCloud
678
680
  # 3. **每个合同只能催办一次**
679
681
 
680
682
  # **催办的效果**: 对方会收到如下的短信通知
683
+
681
684
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
682
685
 
683
686
  # 注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
@@ -823,18 +826,18 @@ module TencentCloud
823
826
  # </tr>
824
827
  # <tr>
825
828
  # <td>普通saas员工</td>
826
- # <td>不需要传递 InvitationNotifyType</td>
827
- # <td>短信</td>
829
+ # <td>将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号</td>
830
+ # <td>发送短信通知员工（短信中带有认证加入企业的链接）</td>
828
831
  # </tr>
829
832
  # <tr>
830
833
  # <td>企微员工</td>
831
- # <td>不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
834
+ # <td>将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需<font color="red">确保该企微员工在应用的可见范围内</font></td>
832
835
  # <td>企微内部实名消息</td>
833
836
  # </tr>
834
837
  # <tr>
835
838
  # <td>H5端 saas员工</td>
836
- # <td>传递 InvitationNotifyType = H5，不支持企微</td>
837
- # <td>生成H5链接</td>
839
+ # <td>传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，<font color="red">此场景不支持企微</font></td>
840
+ # <td>生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工</td>
838
841
  # </tr>
839
842
  # </tbody>
840
843
  # </table>
data/lib/v20201111/models.rb CHANGED
@@ -623,7 +623,9 @@ module TencentCloud
623
623
  # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
624
624
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
625
625
  # @param UserId: 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
626
- # 可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)；或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
626
+
627
+ # 通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取，也可登录腾讯电子签控制台查看
628
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)
627
629
  # @type UserId: String
628
630
  # @param OpenId: 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
629
631
  # @type OpenId: String
@@ -748,11 +750,11 @@ module TencentCloud
748
750
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
749
751
  # @param FlowId: 合同流程ID, 为32位字符串。
750
752
 
751
- # 可登录腾讯电子签控制台，[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
753
+ # 可登录腾讯电子签控制台，[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
752
754
  # @type FlowId: String
753
755
  # @param CancelMessage: 撤销此合同流程的**撤销理由**，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
754
756
 
755
- # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
757
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
756
758
  # @type CancelMessage: String
757
759
  # @param Agent: 代理企业和员工的信息。
758
760
  # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -2177,7 +2179,7 @@ module TencentCloud
2177
2179
 
2178
2180
  # 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
2179
2181
 
2180
- # [点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
2182
+ # [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
2181
2183
  # @type FlowId: String
2182
2184
  # @param PreviewUrl: 合同预览链接URL。
2183
2185
 
@@ -2807,7 +2809,7 @@ module TencentCloud
2807
2809
  # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
2808
2810
 
2809
2811
  # 注:
2810
- # 此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节，[点击产看FlowId在控制台中的位置（只在进如签署环节后有效）](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
2812
+ # 此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节，[点击查看FlowId在控制台中的位置（只在进入签署环节后有效）](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
2811
2813
 
2812
2814
  # @type FlowId: String
2813
2815
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -5389,7 +5391,7 @@ module TencentCloud
5389
5391
 
5390
5392
  # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
5391
5393
 
5392
- # [点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
5394
+ # [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
5393
5395
  # @type FlowIds: Array
5394
5396
  # @param Agent: 代理企业和员工的信息。
5395
5397
  # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -5583,7 +5585,7 @@ module TencentCloud
5583
5585
 
5584
5586
  # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
5585
5587
 
5586
- # [点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
5588
+ # [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
5587
5589
  # @type FlowIds: Array
5588
5590
  # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
5589
5591
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -7799,11 +7801,11 @@ module TencentCloud
7799
7801
  # @type ComponentValue: String
7800
7802
  # @param ComponentId: 控件id，和ComponentName选择一项传入即可
7801
7803
 
7802
- # <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件ID的方式</a>
7804
+ # <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模板中找到控件ID的方式</a>
7803
7805
  # @type ComponentId: String
7804
7806
  # @param ComponentName: 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
7805
7807
 
7806
- # <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件名字的方式</a>
7808
+ # <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模板中找到控件名字的方式</a>
7807
7809
  # @type ComponentName: String
7808
7810
 
7809
7811
  attr_accessor :ComponentValue, :ComponentId, :ComponentName
@@ -9670,7 +9672,9 @@ module TencentCloud
9670
9672
  # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
9671
9673
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
9672
9674
  # @param UserId: 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
9673
- # 可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
9675
+
9676
+ # 通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取，也可登录腾讯电子签控制台查看
9677
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)
9674
9678
  # @type UserId: String
9675
9679
  # @param OpenId: 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
9676
9680
  # 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
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.765
4
+ version: 3.0.767
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-20 00:00:00.000000000 Z
11
+ date: 2024-02-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common