tencentcloud-sdk-ess 3.0.646 → 3.0.647

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cd0f35f95b4a3f72c05e2278cc05197f404f3cb
-  data.tar.gz: 1c375a12ca0f0a2b97481b37a07a9708e722efc1
+  metadata.gz: 7094c506b8bd8b4154c84c120b9aef167698fee9
+  data.tar.gz: ed87f58ebdb89ab48ba8c1a7528ef9488dd789e2
 SHA512:
-  metadata.gz: e2333a12a8bdbfe9f126b5142889e94825d831a647b682deded066d78a7e2304b2f242c7a73c4ca0923687b43c3ac0a2ed5ba28ac386fa5ebf51790d41d51341
-  data.tar.gz: a7ff4f59c9a7bd95f351eba2dda17c07fcb6bad978bd0b4d9e46da806fc91d622e2b2ef441e51c9e1e1289a9559b7affbe6248bf93c24b3f7aed6806233370cd
+  metadata.gz: a11977ac5aac958d620fce31cf16ec137c4b8740c486fc66ade838e70c6f2953cd8f6aa54932980c6baf2e6e5f94ec1e3e1bb6f6f818059b8cc0cd2240c594ab
+  data.tar.gz: 848c78e751f2391fe3212bb057cf2a63f5b0af0a2a1435314003ff7a9381398de73c6c863b124f2fd144a7b6ba9cdfa79944910dbdbacae2f66191f8f9440d9a

data/lib/VERSION

@@ -1 +1 @@
-3.0.646
+3.0.647

data/lib/v20201111/client.rb

@@ -550,6 +550,39 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。
+
+        # 适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
+
+        # 适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。
+        # 适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。
+
+        # 适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。
+
+        # 注意事项：SaaS角色和集团角色对应的权限树是不一样的。
+
+        # @param request: Request instance for CreateIntegrationRole.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationRoleRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateIntegrationRoleResponse`
+        def CreateIntegrationRole(request)
+          body = send_request('CreateIntegrationRole', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateIntegrationRoleResponse.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 CreateIntegrationUserRoles.
@@ -1440,6 +1473,39 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。
+
+        # 适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。
+
+        # 适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。
+        # 适用场景3：更新集团角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。
+
+        # 适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。
+
+        # 注意事项：SaaS角色和集团角色对应的权限树是不一样的。
+
+        # @param request: Request instance for ModifyIntegrationRole.
+        # @type request: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationRoleRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationRoleResponse`
+        def ModifyIntegrationRole(request)
+          body = send_request('ModifyIntegrationRole', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ModifyIntegrationRoleResponse.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
+
         # 此接口用于发起流程
         # 适用场景：见创建签署流程接口。
         # 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。

data/lib/v20201111/models.rb

@@ -87,10 +87,8 @@ module TencentCloud
         # @param ApproverName: 签署方经办人的姓名。
         # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
         # @type ApproverName: String
-        # @param ApproverMobile: 本企业的签署方经办人的员工UserId
-        # 可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
-
-        # 注: `若传该字段，则签署方经办人的其他信息（如签署方经办人的姓名、证件号码、手机号码等）将被忽略。`
+        # @param ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
+        # 请确认手机号所有方为此合同签署方。
         # @type ApproverMobile: String
         # @param OrganizationName: 组织机构名称。
         # 请确认该名称与企业营业执照中注册的名称一致。
@@ -2305,6 +2303,84 @@ module TencentCloud
         end
       end
 
+      # CreateIntegrationRole请求参数结构体
+      class CreateIntegrationRoleRequest < TencentCloud::Common::AbstractModel
+        # @param Name: 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
+        # @type Name: String
+        # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+        # 支持填入集团子公司经办人 userId 代发合同。
+
+        # 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param Description: 角色描述，最大长度为50个字符
+        # @type Description: String
+        # @param IsGroupRole: 角色类型，0:saas角色，1:集团角色
+        # 默认0，saas角色
+        # @type IsGroupRole: Integer
+        # @param PermissionGroups: 权限树
+        # @type PermissionGroups: Array
+        # @param SubOrganizationIds: 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
+        # @type SubOrganizationIds: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Name, :Operator, :Description, :IsGroupRole, :PermissionGroups, :SubOrganizationIds, :Agent
+
+        def initialize(name=nil, operator=nil, description=nil, isgrouprole=nil, permissiongroups=nil, suborganizationids=nil, agent=nil)
+          @Name = name
+          @Operator = operator
+          @Description = description
+          @IsGroupRole = isgrouprole
+          @PermissionGroups = permissiongroups
+          @SubOrganizationIds = suborganizationids
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          @Name = params['Name']
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @Description = params['Description']
+          @IsGroupRole = params['IsGroupRole']
+          unless params['PermissionGroups'].nil?
+            @PermissionGroups = []
+            params['PermissionGroups'].each do |i|
+              permissiongroup_tmp = PermissionGroup.new
+              permissiongroup_tmp.deserialize(i)
+              @PermissionGroups << permissiongroup_tmp
+            end
+          end
+          @SubOrganizationIds = params['SubOrganizationIds']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # CreateIntegrationRole返回参数结构体
+      class CreateIntegrationRoleResponse < TencentCloud::Common::AbstractModel
+        # @param RoleId: 角色id
+        # @type RoleId: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RoleId, :RequestId
+
+        def initialize(roleid=nil, requestid=nil)
+          @RoleId = roleid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RoleId = params['RoleId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateIntegrationUserRoles请求参数结构体
       class CreateIntegrationUserRolesRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 操作人信息，UserId必填
@@ -2593,18 +2669,38 @@ module TencentCloud
       class CreatePersonAuthCertificateImageResponse < TencentCloud::Common::AbstractModel
         # @param AuthCertUrl: 个人用户证明证书的下载链接
         # @type AuthCertUrl: String
+        # @param ImageCertId: 证书图片上的证书编号，20位数字
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ImageCertId: String
+        # @param SerialNumber: 图片证明对应的CA证书序列号
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type SerialNumber: String
+        # @param ValidFrom: CA证书颁发时间戳
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ValidFrom: Integer
+        # @param ValidTo: CA证书有效截止时间戳
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ValidTo: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :AuthCertUrl, :RequestId
+        attr_accessor :AuthCertUrl, :ImageCertId, :SerialNumber, :ValidFrom, :ValidTo, :RequestId
 
-        def initialize(authcerturl=nil, requestid=nil)
+        def initialize(authcerturl=nil, imagecertid=nil, serialnumber=nil, validfrom=nil, validto=nil, requestid=nil)
           @AuthCertUrl = authcerturl
+          @ImageCertId = imagecertid
+          @SerialNumber = serialnumber
+          @ValidFrom = validfrom
+          @ValidTo = validto
           @RequestId = requestid
         end
 
         def deserialize(params)
           @AuthCertUrl = params['AuthCertUrl']
+          @ImageCertId = params['ImageCertId']
+          @SerialNumber = params['SerialNumber']
+          @ValidFrom = params['ValidFrom']
+          @ValidTo = params['ValidTo']
           @RequestId = params['RequestId']
         end
       end
@@ -2613,7 +2709,7 @@ module TencentCloud
       class CreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 调用方用户信息，userId 必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param ResourceId: 资源Id，通过多文件上传（UploadFiles）接口获得
+        # @param ResourceId: 资源id，与ResourceType对应
         # @type ResourceId: String
         # @param FlowName: 合同名称
         # @type FlowName: String
@@ -2626,19 +2722,24 @@ module TencentCloud
         # 不传默认为当前时间一年后
         # @type Deadline: Integer
         # @param UserFlowTypeId: 用户自定义合同类型Id
-        # 该id为电子签企业内的合同类型id
+
+        # 该id为电子签企业内的合同类型id， 可以在自定义合同类型处获取
         # @type UserFlowTypeId: String
+        # @param FlowType: 合同类型名称
+        # 该字段用于客户自定义合同类型
+        # 建议使用时指定合同类型，便于之后合同分类以及查看
+        # 如果合同类型与自定义的合同类型描述一致，会自动归类到自定义的合同类型处，如果不一致，则会创建一个新的自定义合同类型
+        # @type FlowType: String
         # @param Approvers: 签署流程参与者信息，最大限制50方
         # @type Approvers: Array
         # @param IntelligentStatus: 打开智能添加填写区
-        # (默认开启，打开:"OPEN"
+        # 默认开启，打开:"OPEN"
         #  关闭："CLOSE"
         # @type IntelligentStatus: String
         # @param ResourceType: 资源类型，
-        # 1：文件，
-        # 2：模板
-        # 不传默认为1：文件
-        # 目前仅支持文件
+        # 1：模板
+        # 2：文件，
+        # 不传默认为2：文件
         # @type ResourceType: Integer
         # @param Components: 发起方填写控件
         # 该类型控件由发起方完成填写
@@ -2661,22 +2762,19 @@ module TencentCloud
         # @type UserData: String
         # @param FlowId: 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
         # @type FlowId: String
-        # @param FlowType: 合同类型名称
-        # 该字段用于客户自定义合同类型
-        # 建议使用时指定合同类型，便于之后合同分类以及查看
-        # @type FlowType: String
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
-        attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :FlowType, :Agent
+        attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :Agent
 
-        def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, flowtype=nil, agent=nil)
+        def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, agent=nil)
           @Operator = operator
           @ResourceId = resourceid
           @FlowName = flowname
           @Unordered = unordered
           @Deadline = deadline
           @UserFlowTypeId = userflowtypeid
+          @FlowType = flowtype
           @Approvers = approvers
           @IntelligentStatus = intelligentstatus
           @ResourceType = resourcetype
@@ -2686,7 +2784,6 @@ module TencentCloud
           @NeedCreateReview = needcreatereview
           @UserData = userdata
           @FlowId = flowid
-          @FlowType = flowtype
           @Agent = agent
         end
 
@@ -2700,6 +2797,7 @@ module TencentCloud
           @Unordered = params['Unordered']
           @Deadline = params['Deadline']
           @UserFlowTypeId = params['UserFlowTypeId']
+          @FlowType = params['FlowType']
           unless params['Approvers'].nil?
             @Approvers = []
             params['Approvers'].each do |i|
@@ -2722,7 +2820,6 @@ module TencentCloud
           @NeedCreateReview = params['NeedCreateReview']
           @UserData = params['UserData']
           @FlowId = params['FlowId']
-          @FlowType = params['FlowType']
           unless params['Agent'].nil?
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
@@ -5428,7 +5525,7 @@ module TencentCloud
         # 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
         # @type ApproverType: Integer
         # @param OrganizationName: 签署人企业名称
-        # <br/>当approverType=1 或 approverType=3时，必须指定
+        # 当approverType=0 或 approverType=3时，必须指定
 
         # @type OrganizationName: String
         # @param ApproverName: 签署方经办人姓名
@@ -5504,8 +5601,12 @@ module TencentCloud
         # 	SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
         # @type ComponentLimitType: Array
         # @param ApproverVerifyTypes: 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
+
+        # > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
         # @type ApproverVerifyTypes: Array
         # @param ApproverSignTypes: 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
+
+        # > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
         # @type ApproverSignTypes: Array
 
         attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes
@@ -6396,6 +6497,83 @@ module TencentCloud
         end
       end
 
+      # ModifyIntegrationRole请求参数结构体
+      class ModifyIntegrationRoleRequest < TencentCloud::Common::AbstractModel
+        # @param RoleId: 角色Id，可通过接口 DescribeIntegrationRoles 查询获取
+        # @type RoleId: String
+        # @param Name: 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
+        # @type Name: String
+        # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+        # 支持填入集团子公司经办人 userId 代发合同。
+
+        # 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param Description: 角色描述，最大长度为50个字符
+        # @type Description: String
+        # @param PermissionGroups: 权限树
+        # @type PermissionGroups: Array
+        # @param SubOrganizationIds: 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
+        # @type SubOrganizationIds: Array
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :RoleId, :Name, :Operator, :Description, :PermissionGroups, :SubOrganizationIds, :Agent
+
+        def initialize(roleid=nil, name=nil, operator=nil, description=nil, permissiongroups=nil, suborganizationids=nil, agent=nil)
+          @RoleId = roleid
+          @Name = name
+          @Operator = operator
+          @Description = description
+          @PermissionGroups = permissiongroups
+          @SubOrganizationIds = suborganizationids
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          @RoleId = params['RoleId']
+          @Name = params['Name']
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @Description = params['Description']
+          unless params['PermissionGroups'].nil?
+            @PermissionGroups = []
+            params['PermissionGroups'].each do |i|
+              permissiongroup_tmp = PermissionGroup.new
+              permissiongroup_tmp.deserialize(i)
+              @PermissionGroups << permissiongroup_tmp
+            end
+          end
+          @SubOrganizationIds = params['SubOrganizationIds']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # ModifyIntegrationRole返回参数结构体
+      class ModifyIntegrationRoleResponse < TencentCloud::Common::AbstractModel
+        # @param RoleId: 角色id
+        # @type RoleId: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RoleId, :RequestId
+
+        def initialize(roleid=nil, requestid=nil)
+          @RoleId = roleid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RoleId = params['RoleId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 持有的电子印章信息
       class OccupiedSeal < TencentCloud::Common::AbstractModel
         # @param SealId: 电子印章编号

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.646
+  version: 3.0.647
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common