Class: TencentCloud::Ess::V20201111::UpdateIntegrationEmployeesRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20201111/models.rb

Overview

UpdateIntegrationEmployees请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator = nil, employees = nil, agent = nil, invitationnotifytype = nil, jumpurl = nil, endpoint = nil) ⇒ UpdateIntegrationEmployeesRequest

Returns a new instance of UpdateIntegrationEmployeesRequest.



17902
17903
17904
17905
17906
17907
17908
17909
 
# File 'lib/v20201111/models.rb', line 17902

def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil, endpoint=nil)
  @Operator = operator
  @Employees = employees
  @Agent = agent
  @InvitationNotifyType = invitationnotifytype
  @JumpUrl = jumpurl
  @Endpoint = endpoint
end

Instance Attribute Details

#Agent ⇒ Object

可更新以下字段，其他字段暂不支持

参数 含义
DisplayName 用户的真实名字
Mobile 用户手机号码
Email 用户的邮箱
Department.DepartmentId 用户进入后的部门ID
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • Agent: —

    代理企业和员工的信息。

  • InvitationNotifyType: —

    员工邀请方式可通过以下途径进行设置：

    • SMS（默认）：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
    • H5：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
    • NONE：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

  • JumpUrl: —

    回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。

  • Endpoint: —

    要跳转的链接类型

    • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
    • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    • H5： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月
    注意：InvitationNotifyType 和 Endpoint 的关系图
    通知类型（InvitationNotifyType）Endpoint
    SMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
    H5不需要传递，会将 Endpoint 默认设置为 H5
    NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL



17900
17901
17902
 
# File 'lib/v20201111/models.rb', line 17900

def Agent
  @Agent
end

#Employees ⇒ Object

可更新以下字段，其他字段暂不支持

参数 含义
DisplayName 用户的真实名字
Mobile 用户手机号码
Email 用户的邮箱
Department.DepartmentId 用户进入后的部门ID
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • Agent: —

    代理企业和员工的信息。

  • InvitationNotifyType: —

    员工邀请方式可通过以下途径进行设置：

    • SMS（默认）：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
    • H5：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
    • NONE：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

  • JumpUrl: —

    回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。

  • Endpoint: —

    要跳转的链接类型

    • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
    • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    • H5： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月
    注意：InvitationNotifyType 和 Endpoint 的关系图
    通知类型（InvitationNotifyType）Endpoint
    SMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
    H5不需要传递，会将 Endpoint 默认设置为 H5
    NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL



17900
17901
17902
 
# File 'lib/v20201111/models.rb', line 17900

def Employees
  @Employees
end

#Endpoint ⇒ Object

可更新以下字段，其他字段暂不支持

参数 含义
DisplayName 用户的真实名字
Mobile 用户手机号码
Email 用户的邮箱
Department.DepartmentId 用户进入后的部门ID
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • Agent: —

    代理企业和员工的信息。

  • InvitationNotifyType: —

    员工邀请方式可通过以下途径进行设置：

    • SMS（默认）：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
    • H5：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
    • NONE：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

  • JumpUrl: —

    回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。

  • Endpoint: —

    要跳转的链接类型

    • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
    • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    • H5： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月
    注意：InvitationNotifyType 和 Endpoint 的关系图
    通知类型（InvitationNotifyType）Endpoint
    SMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
    H5不需要传递，会将 Endpoint 默认设置为 H5
    NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL



17900
17901
17902
 
# File 'lib/v20201111/models.rb', line 17900

def Endpoint
  @Endpoint
end

#InvitationNotifyType ⇒ Object

可更新以下字段，其他字段暂不支持

参数 含义
DisplayName 用户的真实名字
Mobile 用户手机号码
Email 用户的邮箱
Department.DepartmentId 用户进入后的部门ID
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • Agent: —

    代理企业和员工的信息。

  • InvitationNotifyType: —

    员工邀请方式可通过以下途径进行设置：

    • SMS（默认）：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
    • H5：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
    • NONE：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

  • JumpUrl: —

    回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。

  • Endpoint: —

    要跳转的链接类型

    • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
    • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    • H5： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月
    注意：InvitationNotifyType 和 Endpoint 的关系图
    通知类型（InvitationNotifyType）Endpoint
    SMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
    H5不需要传递，会将 Endpoint 默认设置为 H5
    NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL



17900
17901
17902
 
# File 'lib/v20201111/models.rb', line 17900

def InvitationNotifyType
  @InvitationNotifyType
end

#JumpUrl ⇒ Object

可更新以下字段，其他字段暂不支持

参数 含义
DisplayName 用户的真实名字
Mobile 用户手机号码
Email 用户的邮箱
Department.DepartmentId 用户进入后的部门ID
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • Agent: —

    代理企业和员工的信息。

  • InvitationNotifyType: —

    员工邀请方式可通过以下途径进行设置：

    • SMS（默认）：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
    • H5：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
    • NONE：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

  • JumpUrl: —

    回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。

  • Endpoint: —

    要跳转的链接类型

    • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
    • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    • H5： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月
    注意：InvitationNotifyType 和 Endpoint 的关系图
    通知类型（InvitationNotifyType）Endpoint
    SMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
    H5不需要传递，会将 Endpoint 默认设置为 H5
    NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL



17900
17901
17902
 
# File 'lib/v20201111/models.rb', line 17900

def JumpUrl
  @JumpUrl
end

#Operator ⇒ Object

可更新以下字段，其他字段暂不支持

参数 含义
DisplayName 用户的真实名字
Mobile 用户手机号码
Email 用户的邮箱
Department.DepartmentId 用户进入后的部门ID
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • Agent: —

    代理企业和员工的信息。

  • InvitationNotifyType: —

    员工邀请方式可通过以下途径进行设置：

    • SMS（默认）：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。
    • H5：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。
    • NONE：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。

  • JumpUrl: —

    回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。

  • Endpoint: —

    要跳转的链接类型

    • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
    • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
    • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
    • H5： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月
    注意：InvitationNotifyType 和 Endpoint 的关系图
    通知类型（InvitationNotifyType）Endpoint
    SMS（默认）不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL
    H5不需要传递，会将 Endpoint 默认设置为 H5
    NONE所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL



17900
17901
17902
 
# File 'lib/v20201111/models.rb', line 17900

def Operator
  @Operator
end

Instance Method Details

#deserialize(params) ⇒ Object 



17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
 
# File 'lib/v20201111/models.rb', line 17911

def deserialize(params)
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  unless params['Employees'].nil?
    @Employees = []
    params['Employees'].each do |i|
      staff_tmp = Staff.new
      staff_tmp.deserialize(i)
      @Employees << staff_tmp
    end
  end
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
  @InvitationNotifyType = params['InvitationNotifyType']
  @JumpUrl = params['JumpUrl']
  @Endpoint = params['Endpoint']
end