// 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"
)

// GetPrimaryCalendar 调用该接口获取当前身份（应用或用户）的主日历信息。
//
// 说明
// - 当前身份由 Header Authorization 的 Token 类型决定。tenant_access_token 指应用身份, user_access_token 指用户身份。
// - 使用应用身份调用该接口前, 需要确保该应用开启了[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。
// - 使用应用身份调用该接口时, 查询参数 user_id_type 不能设置为 user_id。你可以选择 open_id 或者 union_id, 在返回结果中, user_id 参数值会包含应用机器人对应的 open_id 或 union_id。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary
// new doc: https://open.feishu.cn/document/server-docs/calendar-v4/calendar/primary
func (r *CalendarService) GetPrimaryCalendar(ctx context.Context, request *GetPrimaryCalendarReq, options ...MethodOptionFunc) (*GetPrimaryCalendarResp, *Response, error) {
	if r.cli.mock.mockCalendarGetPrimaryCalendar != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] Calendar#GetPrimaryCalendar mock enable")
		return r.cli.mock.mockCalendarGetPrimaryCalendar(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "Calendar",
		API:                   "GetPrimaryCalendar",
		Method:                "POST",
		URL:                   r.cli.openBaseURL + "/open-apis/calendar/v4/calendars/primary",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
		NeedUserAccessToken:   true,
	}
	resp := new(getPrimaryCalendarResp)

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

// MockCalendarGetPrimaryCalendar mock CalendarGetPrimaryCalendar method
func (r *Mock) MockCalendarGetPrimaryCalendar(f func(ctx context.Context, request *GetPrimaryCalendarReq, options ...MethodOptionFunc) (*GetPrimaryCalendarResp, *Response, error)) {
	r.mockCalendarGetPrimaryCalendar = f
}

// UnMockCalendarGetPrimaryCalendar un-mock CalendarGetPrimaryCalendar method
func (r *Mock) UnMockCalendarGetPrimaryCalendar() {
	r.mockCalendarGetPrimaryCalendar = nil
}

// GetPrimaryCalendarReq ...
type GetPrimaryCalendarReq struct {
	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
}

// GetPrimaryCalendarResp ...
type GetPrimaryCalendarResp struct {
	Calendars []*GetPrimaryCalendarRespCalendar `json:"calendars,omitempty"` // 主日历列表。
}

// GetPrimaryCalendarRespCalendar ...
type GetPrimaryCalendarRespCalendar struct {
	Calendar *GetPrimaryCalendarRespCalendarCalendar `json:"calendar,omitempty"` // 日历实体信息。
	UserID   string                                  `json:"user_id,omitempty"`  // 日历创建者的 User ID。了解用户不同类型的 ID, 可参见[用户身份概述](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。
}

// GetPrimaryCalendarRespCalendarCalendar ...
type GetPrimaryCalendarRespCalendarCalendar struct {
	CalendarID   string             `json:"calendar_id,omitempty"`    // 日历 ID。你可以通过该 ID 查询、更新主日历信息。更多信息可参见[日历 ID 字段说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/introduction)。
	Summary      string             `json:"summary,omitempty"`        // 日历标题。
	Description  string             `json:"description,omitempty"`    // 日历描述。
	Permissions  CalendarPermission `json:"permissions,omitempty"`    // 日历公开范围, 可选值有: private: 私密, show_only_free_busy: 仅展示忙闲信息, public: 公开, 他人可查看日程详情
	Color        int64              `json:"color,omitempty"`          // 日历颜色, 由颜色 RGB 值的 int32 表示。实际在客户端展示时会映射到色板上最接近的一种颜色, 且该字段仅对当前身份生效。
	Type         CalendarType       `json:"type,omitempty"`           // 日历类型, 可选值有: unknown: 未知类型, primary: 用户或应用的主日历, shared: 由用户或应用创建的共享日历, google: 用户绑定的谷歌日历, resource: 会议室日历, exchange: 用户绑定的 Exchange 日历
	SummaryAlias string             `json:"summary_alias,omitempty"`  // 日历备注名, 仅对当前身份生效。
	IsDeleted    bool               `json:"is_deleted,omitempty"`     // 对于当前身份, 日历是否已经被标记为删除。
	IsThirdParty bool               `json:"is_third_party,omitempty"` // 当前日历是否是第三方数据。三方日历及日程只支持读, 不支持写入。
	Role         CalendarRole       `json:"role,omitempty"`           // 当前身份对于该日历的访问权限, 可选值有: unknown: 未知权限, free_busy_reader: 游客, 只能看到忙碌、空闲信息, reader: 订阅者, 可查看所有日程详情, writer: 编辑者, 可创建及修改日程, owner: 管理员, 可管理日历及共享设置
}

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