// 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 (
	"github.com/chyroc/lark/internal"
)

// OpenWorkbench 打开工作台
//
// 打开工作台（定制工作台）或打开网页工作台的特定页面。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/uYjL24iN/applink-protocol/supported-protocol/open-a-workplace
// new doc: https://open.feishu.cn/document/common-capabilities/applink-protocol/supported-protocol/open-a-workplace
func (r *AppLinkService) OpenWorkbench(req *OpenWorkbenchReq) string {
	return internal.JoinAppLinkURL("https://applink.feishu.cn/client/workplace/open", req)
}

// OpenWorkbenchReq ...
type OpenWorkbenchReq struct {
	ID          *string `json:"id,omitempty"`           // 工作台 ID。仅定制工作台支持该字段, 默认工作台不识别该字段 如何获取 ID: 可前往 [飞书管理后台](https://feishu.cn/admin) > 工作台 > 定制工作台, 点击指定工作台的 设置 进入设置页面；鼠标连续点击三次顶部的 设置 字样即可出现 ID, 复制 ID 即可
	Path        *string `json:"path,omitempty"`         // 访问网页工作台某个具体页面。  path 参数将替换网页工作台 URL 的 path 部分。支持在 path 参数后携带自定义查询参数。
	PathAndroid *string `json:"path_android,omitempty"` // 访问 Android 端网页工作台某个具体页面。Android 端会优先使用该参数, 如果该参数不存在, 则会使用 path 参数
	PathIos     *string `json:"path_ios,omitempty"`     // 访问 iOS 端网页工作台某个具体页面。iOS 端会优先使用该参数, 如果该参数不存在, 则会使用 path 参数
	PathPc      *string `json:"path_pc,omitempty"`      // 访问 PC 端网页工作台某个具体页面。PC 端会优先使用该参数, 如果该参数不存在, 则会使用 path 参数
}
