Class: TencentCloud::Ess::V20201111::DescribeUserFlowTypeRequest

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

Overview

DescribeUserFlowType请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator = nil, agent = nil, filters = nil, querybindtemplate = nil) ⇒ DescribeUserFlowTypeRequest

Returns a new instance of DescribeUserFlowTypeRequest.



11854
11855
11856
11857
11858
11859
# File 'lib/v20201111/models.rb', line 11854

def initialize(operator=nil, agent=nil, filters=nil, querybindtemplate=nil)
  @Operator = operator
  @Agent = agent
  @Filters = filters
  @QueryBindTemplate = querybindtemplate
end

Instance Attribute Details

#AgentObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

  • 模板 IDKey设置为 template-idValues为您想要查询的 模板 ID 列表。
  • 主企业模板 IDKey设置为 share-template-idValues为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 Agent.ProxyOrganizationId(子企业的组织ID)为必填项。
  • 模板名称Key设置为 template-nameValues为您想要查询的模板名称列表。
  • 模板的用户合同类型Key设置为 user-flow-type-idValues为您想要查询的用户模板类型id列表。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • Agent:

    代理企业和员工的信息。

  • Filters:

    搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。

  • QueryBindTemplate:

    查询绑定了模板的用户合同类型

    • false(默认值),查询用户合同类型
    • true,查询绑定了模板的用户合同类型



11852
11853
11854
# File 'lib/v20201111/models.rb', line 11852

def Agent
  @Agent
end

#FiltersObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

  • 模板 IDKey设置为 template-idValues为您想要查询的 模板 ID 列表。
  • 主企业模板 IDKey设置为 share-template-idValues为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 Agent.ProxyOrganizationId(子企业的组织ID)为必填项。
  • 模板名称Key设置为 template-nameValues为您想要查询的模板名称列表。
  • 模板的用户合同类型Key设置为 user-flow-type-idValues为您想要查询的用户模板类型id列表。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • Agent:

    代理企业和员工的信息。

  • Filters:

    搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。

  • QueryBindTemplate:

    查询绑定了模板的用户合同类型

    • false(默认值),查询用户合同类型
    • true,查询绑定了模板的用户合同类型



11852
11853
11854
# File 'lib/v20201111/models.rb', line 11852

def Filters
  @Filters
end

#OperatorObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

  • 模板 IDKey设置为 template-idValues为您想要查询的 模板 ID 列表。
  • 主企业模板 IDKey设置为 share-template-idValues为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 Agent.ProxyOrganizationId(子企业的组织ID)为必填项。
  • 模板名称Key设置为 template-nameValues为您想要查询的模板名称列表。
  • 模板的用户合同类型Key设置为 user-flow-type-idValues为您想要查询的用户模板类型id列表。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • Agent:

    代理企业和员工的信息。

  • Filters:

    搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。

  • QueryBindTemplate:

    查询绑定了模板的用户合同类型

    • false(默认值),查询用户合同类型
    • true,查询绑定了模板的用户合同类型



11852
11853
11854
# File 'lib/v20201111/models.rb', line 11852

def Operator
  @Operator
end

#QueryBindTemplateObject

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

  • 模板 IDKey设置为 template-idValues为您想要查询的 模板 ID 列表。
  • 主企业模板 IDKey设置为 share-template-idValues为您想要查询的 主企业模板 ID 列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 Agent.ProxyOrganizationId(子企业的组织ID)为必填项。
  • 模板名称Key设置为 template-nameValues为您想要查询的模板名称列表。
  • 模板的用户合同类型Key设置为 user-flow-type-idValues为您想要查询的用户模板类型id列表。

Parameters:

  • Operator:

    执行本接口操作的员工信息。

  • Agent:

    代理企业和员工的信息。

  • Filters:

    搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。

  • QueryBindTemplate:

    查询绑定了模板的用户合同类型

    • false(默认值),查询用户合同类型
    • true,查询绑定了模板的用户合同类型



11852
11853
11854
# File 'lib/v20201111/models.rb', line 11852

def QueryBindTemplate
  @QueryBindTemplate
end

Instance Method Details

#deserialize(params) ⇒ Object



11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
# File 'lib/v20201111/models.rb', line 11861

def deserialize(params)
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
  unless params['Filters'].nil?
    @Filters = []
    params['Filters'].each do |i|
      filter_tmp = Filter.new
      filter_tmp.deserialize(i)
      @Filters << filter_tmp
    end
  end
  @QueryBindTemplate = params['QueryBindTemplate']
end