api_acs_rule_external_get.go

// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
 * Copyright 2022 chyroc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package lark

import (
	"context"
)

// GetACSRuleExternal 获取权限组信息
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
func (r *ACSService) GetACSRuleExternal(ctx context.Context, request *GetACSRuleExternalReq, options ...MethodOptionFunc) (*GetACSRuleExternalResp, *Response, error) {
	if r.cli.mock.mockACSGetACSRuleExternal != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] ACS#GetACSRuleExternal mock enable")
		return r.cli.mock.mockACSGetACSRuleExternal(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:               "ACS",
		API:                 "GetACSRuleExternal",
		Method:              "GET",
		URL:                 r.cli.openBaseURL + "/open-apis/acs/v1/rule_external",
		Body:                request,
		MethodOption:        newMethodOption(options),
		NeedUserAccessToken: true,
	}
	resp := new(getACSRuleExternalResp)

	response, err := r.cli.RawRequest(ctx, req, resp)
	return resp.Data, response, err
}

// MockACSGetACSRuleExternal mock ACSGetACSRuleExternal method
func (r *Mock) MockACSGetACSRuleExternal(f func(ctx context.Context, request *GetACSRuleExternalReq, options ...MethodOptionFunc) (*GetACSRuleExternalResp, *Response, error)) {
	r.mockACSGetACSRuleExternal = f
}

// UnMockACSGetACSRuleExternal un-mock ACSGetACSRuleExternal method
func (r *Mock) UnMockACSGetACSRuleExternal() {
	r.mockACSGetACSRuleExternal = nil
}

// GetACSRuleExternalReq ...
type GetACSRuleExternalReq struct {
	DeviceID   *string `query:"device_id" json:"-"`    // 设备id, 示例值: 7296700518380863767
	UserIDType *IDType `query:"user_id_type" json:"-"` // 用户 ID 类型, 示例值: open_id, 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), 默认值: `open_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
}

// GetACSRuleExternalResp ...
type GetACSRuleExternalResp struct {
	Rules []*GetACSRuleExternalRespRule `json:"rules,omitempty"` // 设备权限组信息
}

// GetACSRuleExternalRespRule ...
type GetACSRuleExternalRespRule struct {
	ID           string                                 `json:"id,omitempty"`            // 权限组id
	Name         string                                 `json:"name,omitempty"`          // 权限组名称
	Devices      []*GetACSRuleExternalRespRuleDevice    `json:"devices,omitempty"`       // 权限组包含的设备
	UserCount    string                                 `json:"user_count,omitempty"`    // 权限组包含的员工个数
	Users        []*GetACSRuleExternalRespRuleUser      `json:"users,omitempty"`         // 权限组包含的员工列表
	VisitorCount string                                 `json:"visitor_count,omitempty"` // 权限组包含的访客个数
	Visitors     []*GetACSRuleExternalRespRuleVisitor   `json:"visitors,omitempty"`      // 权限组包含的访客列表
	RemindFace   bool                                   `json:"remind_face,omitempty"`   // 是否通知人员录入
	OpeningTime  *GetACSRuleExternalRespRuleOpeningTime `json:"opening_time,omitempty"`  // 开门时间段
	IsTemp       bool                                   `json:"is_temp,omitempty"`       // 是否为临时权限组
}

// GetACSRuleExternalRespRuleDevice ...
type GetACSRuleExternalRespRuleDevice struct {
	ID   string `json:"id,omitempty"`   // 设备id
	Name string `json:"name,omitempty"` // 设备名称
}

// GetACSRuleExternalRespRuleOpeningTime ...
type GetACSRuleExternalRespRuleOpeningTime struct {
	ValidDay *GetACSRuleExternalRespRuleOpeningTimeValidDay  `json:"valid_day,omitempty"` // 有效日期
	Weekdays []int64                                         `json:"weekdays,omitempty"`  // 有效星期
	DayTimes []*GetACSRuleExternalRespRuleOpeningTimeDayTime `json:"day_times,omitempty"` // 有效时间
}

// GetACSRuleExternalRespRuleOpeningTimeDayTime ...
type GetACSRuleExternalRespRuleOpeningTimeDayTime struct {
	StartHhmm int64 `json:"start_hhmm,omitempty"` // 起始时间
	EndHhmm   int64 `json:"end_hhmm,omitempty"`   // 结束时间
}

// GetACSRuleExternalRespRuleOpeningTimeValidDay ...
type GetACSRuleExternalRespRuleOpeningTimeValidDay struct {
	StartDay int64 `json:"start_day,omitempty"` // 权限开始时间
	EndDay   int64 `json:"end_day,omitempty"`   // 权限结束时间
}

// GetACSRuleExternalRespRuleUser ...
type GetACSRuleExternalRespRuleUser struct {
	UserType     int64  `json:"user_type,omitempty"`     // 用户类型, 可选值有: 1: 员工, 2: 部门, 10: 全体员工, 11: 访客
	UserID       string `json:"user_id,omitempty"`       // 用户id
	UserName     string `json:"user_name,omitempty"`     // 用户名称
	PhoneNum     string `json:"phone_num,omitempty"`     // 电话号码
	DepartmentID string `json:"department_id,omitempty"` // 部门id
}

// GetACSRuleExternalRespRuleVisitor ...
type GetACSRuleExternalRespRuleVisitor struct {
	UserType     int64  `json:"user_type,omitempty"`     // 用户类型, 可选值有: 1: 员工, 2: 部门, 10: 全体员工, 11: 访客
	UserID       string `json:"user_id,omitempty"`       // 用户id
	UserName     string `json:"user_name,omitempty"`     // 用户名称
	PhoneNum     string `json:"phone_num,omitempty"`     // 电话号码
	DepartmentID string `json:"department_id,omitempty"` // 部门id
}

// getACSRuleExternalResp ...
type getACSRuleExternalResp struct {
	Code  int64                   `json:"code,omitempty"` // 错误码, 非 0 表示失败
	Msg   string                  `json:"msg,omitempty"`  // 错误描述
	Data  *GetACSRuleExternalResp `json:"data,omitempty"`
	Error *ErrorDetail            `json:"error,omitempty"`
}