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

// GetCalendarExchangeBinding 调用该接口获取 Exchange 账户的绑定状态, 包括 Exchange 日历的同步状态。
//
// 当前身份需要是企业超级管理员。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/get
// new doc: https://open.feishu.cn/document/server-docs/calendar-v4/exchange_binding/get
func (r *CalendarService) GetCalendarExchangeBinding(ctx context.Context, request *GetCalendarExchangeBindingReq, options ...MethodOptionFunc) (*GetCalendarExchangeBindingResp, *Response, error) {
	if r.cli.mock.mockCalendarGetCalendarExchangeBinding != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] Calendar#GetCalendarExchangeBinding mock enable")
		return r.cli.mock.mockCalendarGetCalendarExchangeBinding(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:               "Calendar",
		API:                 "GetCalendarExchangeBinding",
		Method:              "GET",
		URL:                 r.cli.openBaseURL + "/open-apis/calendar/v4/exchange_bindings/:exchange_binding_id",
		Body:                request,
		MethodOption:        newMethodOption(options),
		NeedUserAccessToken: true,
	}
	resp := new(getCalendarExchangeBindingResp)

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

// MockCalendarGetCalendarExchangeBinding mock CalendarGetCalendarExchangeBinding method
func (r *Mock) MockCalendarGetCalendarExchangeBinding(f func(ctx context.Context, request *GetCalendarExchangeBindingReq, options ...MethodOptionFunc) (*GetCalendarExchangeBindingResp, *Response, error)) {
	r.mockCalendarGetCalendarExchangeBinding = f
}

// UnMockCalendarGetCalendarExchangeBinding un-mock CalendarGetCalendarExchangeBinding method
func (r *Mock) UnMockCalendarGetCalendarExchangeBinding() {
	r.mockCalendarGetCalendarExchangeBinding = nil
}

// GetCalendarExchangeBindingReq ...
type GetCalendarExchangeBindingReq struct {
	ExchangeBindingID string  `path:"exchange_binding_id" json:"-"` // Exchange 绑定的唯一标识 ID。调用 [将 Exchange 账户绑定到飞书账户](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/create) 绑定时, 可从返回结果中获取 exchange_binding_id, 示例值: "ZW1haWxfYWRtaW5fZXhhbXBsZUBvdXRsb29rLmNvbSBlbWFpbF9hY2NvdW50X2V4YW1wbGVAb3V0bG9vay5jb20="
	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
}

// GetCalendarExchangeBindingResp ...
type GetCalendarExchangeBindingResp struct {
	AdminAccount      string `json:"admin_account,omitempty"`       // Exchange 的 admin 账户, 字段权限要求: 获取用户邮箱信息
	ExchangeAccount   string `json:"exchange_account,omitempty"`    // 需绑定的 Exchange 账户, 字段权限要求: 获取用户邮箱信息
	UserID            string `json:"user_id,omitempty"`             // 用户 ID, 即 Exchange 账户绑定的飞书账户 ID。关于用户 ID 可参见[用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。
	Status            string `json:"status,omitempty"`              // Exchange 账户的同步状态, 可选值有: doing: 日历正在同步, cal_done: 日历同步完成, timespan_done: 近期时间段同步完成, done: 日程同步完成, err: 同步错误
	ExchangeBindingID string `json:"exchange_binding_id,omitempty"` // Exchange 绑定的唯一标识 ID。
}

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