@larksuiteoapi/lark-mcp
Version:
Feishu/Lark OpenAPI MCP
840 lines • 101 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.bitableV1Tools = exports.bitableV1AppWorkflowUpdate = exports.bitableV1AppWorkflowList = exports.bitableV1AppUpdate = exports.bitableV1AppTableViewPatch = exports.bitableV1AppTableViewList = exports.bitableV1AppTableViewGet = exports.bitableV1AppTableViewDelete = exports.bitableV1AppTableViewCreate = exports.bitableV1AppTableRecordUpdate = exports.bitableV1AppTableRecordSearch = exports.bitableV1AppTableRecordList = exports.bitableV1AppTableRecordGet = exports.bitableV1AppTableRecordDelete = exports.bitableV1AppTableRecordCreate = exports.bitableV1AppTableRecordBatchUpdate = exports.bitableV1AppTableRecordBatchGet = exports.bitableV1AppTableRecordBatchDelete = exports.bitableV1AppTableRecordBatchCreate = exports.bitableV1AppTablePatch = exports.bitableV1AppTableList = exports.bitableV1AppTableFormPatch = exports.bitableV1AppTableFormGet = exports.bitableV1AppTableFormFieldPatch = exports.bitableV1AppTableFormFieldList = exports.bitableV1AppTableFieldUpdate = exports.bitableV1AppTableFieldList = exports.bitableV1AppTableFieldDelete = exports.bitableV1AppTableFieldCreate = exports.bitableV1AppTableDelete = exports.bitableV1AppTableCreate = exports.bitableV1AppTableBatchDelete = exports.bitableV1AppTableBatchCreate = exports.bitableV1AppRoleUpdate = exports.bitableV1AppRoleMemberList = exports.bitableV1AppRoleMemberDelete = exports.bitableV1AppRoleMemberCreate = exports.bitableV1AppRoleMemberBatchDelete = exports.bitableV1AppRoleMemberBatchCreate = exports.bitableV1AppRoleList = exports.bitableV1AppRoleDelete = exports.bitableV1AppRoleCreate = exports.bitableV1AppGet = exports.bitableV1AppDashboardList = exports.bitableV1AppDashboardCopy = exports.bitableV1AppCreate = exports.bitableV1AppCopy = void 0;
const zod_1 = require("zod");
exports.bitableV1AppCopy = {
project: 'bitable',
name: 'bitable.v1.app.copy',
sdkName: 'bitable.v1.app.copy',
path: '/open-apis/bitable/v1/apps/:app_token/copy',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-App-Copy App-Copy a base app, you can specify to copy to a folder with permissions',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
name: zod_1.z.string().describe('Base App Name').optional(),
folder_token: zod_1.z
.string()
.describe('')
.optional(),
without_content: zod_1.z
.boolean()
.describe('Whether to copy the Base content, take the value:* true: not copy* false: copy')
.optional(),
time_zone: zod_1.z
.string()
.describe('Base App Time Zone, ')
.optional(),
}),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier') }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppCreate = {
project: 'bitable',
name: 'bitable.v1.app.create',
sdkName: 'bitable.v1.app.create',
path: '/open-apis/bitable/v1/apps',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-App-Create a Base App-Create a base app in user-defined folder',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
name: zod_1.z.string().describe('Base App Name').optional(),
folder_token: zod_1.z
.string()
.describe('Base App Folder Token. The default value is empty, which means that the Base App is created at the root folder. For information on how to obtain folder_token, please refer to ')
.optional(),
time_zone: zod_1.z
.string()
.describe('Base App Time Zone, ')
.optional(),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppDashboardCopy = {
project: 'bitable',
name: 'bitable.v1.appDashboard.copy',
sdkName: 'bitable.v1.appDashboard.copy',
path: '/open-apis/bitable/v1/apps/:app_token/dashboards/:block_id/copy',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-Dashboards-Copy dashboards-This interface is used to duplicate a new dashboard from an existing dashboard',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({ name: zod_1.z.string().describe('Dashboard Name') }),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
block_id: zod_1.z.string().describe('Base block_id'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppDashboardList = {
project: 'bitable',
name: 'bitable.v1.appDashboard.list',
sdkName: 'bitable.v1.appDashboard.list',
path: '/open-apis/bitable/v1/apps/:app_token/dashboards',
httpMethod: 'GET',
description: '[Feishu/Lark]-Docs-Base-Dashboards-List dashboards-According to app_token, get all dashboards under app',
accessTokens: ['tenant', 'user'],
schema: {
params: zod_1.z.object({
page_size: zod_1.z.number().optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
}),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier') }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppGet = {
project: 'bitable',
name: 'bitable.v1.app.get',
sdkName: 'bitable.v1.app.get',
path: '/open-apis/bitable/v1/apps/:app_token',
httpMethod: 'GET',
description: '[Feishu/Lark]-Docs-Base-App-Get App Info-Get App information through app_token',
accessTokens: ['tenant', 'user'],
schema: {
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier') }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleCreate = {
project: 'bitable',
name: 'bitable.v1.appRole.create',
sdkName: 'bitable.v1.appRole.create',
path: '/open-apis/bitable/v1/apps/:app_token/roles',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-Role-Create role-Create a role',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
role_name: zod_1.z.string().describe('Role name'),
table_roles: zod_1.z
.array(zod_1.z.object({
table_name: zod_1.z.string().describe('Table name').optional(),
table_id: zod_1.z.string().describe('Base unique table identifier').optional(),
table_perm: zod_1.z
.number()
.describe('Table perm Options:0(NoPerm No permissions),1(Read View only),2(Edit Can edit records),4(Admin Can edit records and fields)'),
rec_rule: zod_1.z
.object({
conditions: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('Field name'),
operator: zod_1.z
.enum(['is', 'isNot', 'contains', 'doesNotContain', 'isEmpty', 'isNotEmpty'])
.describe('Operator Options:is(Is),isNot(Is not),contains(Contains),doesNotContain(Does not contain),isEmpty(Is empty),isNotEmpty(Is not empty)')
.optional(),
value: zod_1.z.array(zod_1.z.string()).describe('Option id').optional(),
}))
.describe('Coditions'),
conjunction: zod_1.z.enum(['and', 'or']).describe('Conjunction Options:and(And),or(Or)').optional(),
other_perm: zod_1.z
.number()
.describe('Other perm Options:0(NoPerm Cannot view),1(Read View Only)')
.optional(),
})
.describe('Record filter rule')
.optional(),
field_perm: zod_1.z
.object({})
.describe('Permission of fields, only valid when `table_perm` is 2. The type is map, key is field name, value is permission of field.**Optional values are**:- `1`: View only- `2`: Can edit records')
.optional(),
allow_add_record: zod_1.z
.boolean()
.describe('Added record permission, only meaningful when the table_perm is 2, used to set whether the record can be added')
.optional(),
allow_delete_record: zod_1.z
.boolean()
.describe('Delete record permission, meaningful only when the table_perm is 2, used to set whether the record can be deleted')
.optional(),
}))
.describe('Table role'),
block_roles: zod_1.z
.array(zod_1.z.object({
block_id: zod_1.z.string().describe('Block id, Such as dashboard block id in list dashboards method'),
block_perm: zod_1.z.number().describe('Block perm Options:0(NoPerm No permissions),1(Read View only)'),
}))
.describe('Block role')
.optional(),
}),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier').optional() }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleDelete = {
project: 'bitable',
name: 'bitable.v1.appRole.delete',
sdkName: 'bitable.v1.appRole.delete',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id',
httpMethod: 'DELETE',
description: '[Feishu/Lark]-Base-Advanced Permission-Role-Delete role-Delete a role',
accessTokens: ['tenant', 'user'],
schema: {
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier').optional(),
role_id: zod_1.z.string().describe('Role id').optional(),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleList = {
project: 'bitable',
name: 'bitable.v1.appRole.list',
sdkName: 'bitable.v1.appRole.list',
path: '/open-apis/bitable/v1/apps/:app_token/roles',
httpMethod: 'GET',
description: '[Feishu/Lark]-Docs-Base-Role-List roles-Get all roles according to app_token',
accessTokens: ['tenant', 'user'],
schema: {
params: zod_1.z.object({
page_size: zod_1.z.number().describe('paging size').optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
}),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier').optional() }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleMemberBatchCreate = {
project: 'bitable',
name: 'bitable.v1.appRoleMember.batchCreate',
sdkName: 'bitable.v1.appRoleMember.batchCreate',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/batch_create',
httpMethod: 'POST',
description: '[Feishu/Lark]-Base-Advanced Permission-Member-Batch create members-Add role members with custom permissions in bulk',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
member_list: zod_1.z
.array(zod_1.z.object({
type: zod_1.z
.enum(['open_id', 'union_id', 'user_id', 'chat_id', 'department_id', 'open_department_id'])
.describe('member id type Options:open_id(OpenID member ID type is open_id),union_id(UnionID member ID type is union_id),user_id(UserID member ID type is user_id),chat_id(ChatID member ID type is chat_id),department_id(DepartmentID member ID type is department_id),open_department_id(OpenDepartmentID member ID type is open_department_id)')
.optional(),
id: zod_1.z.string().describe('member ID'),
}))
.describe('List of member'),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
role_id: zod_1.z.string().describe('Custom role ID'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleMemberBatchDelete = {
project: 'bitable',
name: 'bitable.v1.appRoleMember.batchDelete',
sdkName: 'bitable.v1.appRoleMember.batchDelete',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/batch_delete',
httpMethod: 'POST',
description: '[Feishu/Lark]-Base-Advanced Permission-Member-Batch delete members-Batch delete role members',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
member_list: zod_1.z
.array(zod_1.z.object({
type: zod_1.z
.enum(['open_id', 'union_id', 'user_id', 'chat_id', 'department_id', 'open_department_id'])
.describe('member id type Options:open_id(OpenID member ID type is open_id),union_id(UnionID member ID type is union_id),user_id(UserID member ID type is user_id),chat_id(ChatID member ID type is chat_id),department_id(DepartmentID member ID type is department_id),open_department_id(OpenDepartmentID member ID type is open_department_id)')
.optional(),
id: zod_1.z.string().describe('member ID'),
}))
.describe('List of members'),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
role_id: zod_1.z.string().describe('Custom role ID'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleMemberCreate = {
project: 'bitable',
name: 'bitable.v1.appRoleMember.create',
sdkName: 'bitable.v1.appRoleMember.create',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members',
httpMethod: 'POST',
description: '[Feishu/Lark]-Base-Advanced Permission-Member-Create member-Create a member',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({ member_id: zod_1.z.string().describe('Member id') }),
params: zod_1.z.object({
member_id_type: zod_1.z
.enum(['open_id', 'union_id', 'user_id', 'chat_id', 'department_id', 'open_department_id'])
.describe('Member id type Options:open_id(OpenID open_id),union_id(UnionID union_id),user_id(UserID user_id),chat_id(ChatID chat_id),department_id(DepartmentID department_id. Before using this parameter, make sure the application has departmental visibility, refer to ),open_department_id(OpenDepartmentID open_department_id. Before using this parameter, make sure the application has departmental visibility, refer to )')
.optional(),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier').optional(),
role_id: zod_1.z.string().describe('Role id').optional(),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleMemberDelete = {
project: 'bitable',
name: 'bitable.v1.appRoleMember.delete',
sdkName: 'bitable.v1.appRoleMember.delete',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/:member_id',
httpMethod: 'DELETE',
description: '[Feishu/Lark]-Base-Advanced Permission-Member-Delete member-Delete a member',
accessTokens: ['tenant', 'user'],
schema: {
params: zod_1.z.object({
member_id_type: zod_1.z
.enum(['open_id', 'union_id', 'user_id', 'chat_id', 'department_id', 'open_department_id'])
.describe('Member id type Options:open_id(OpenID open_id),union_id(UnionID union_id),user_id(UserID user_id),chat_id(ChatID chat_id),department_id(DepartmentID department_id),open_department_id(OpenDepartmentID open_department_id)')
.optional(),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier').optional(),
role_id: zod_1.z.string().describe('Role id').optional(),
member_id: zod_1.z.string().describe('Member id'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleMemberList = {
project: 'bitable',
name: 'bitable.v1.appRoleMember.list',
sdkName: 'bitable.v1.appRoleMember.list',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members',
httpMethod: 'GET',
description: '[Feishu/Lark]-Base-Advanced Permission-Member-List members-Get all members according to app_token and role_id',
accessTokens: ['tenant', 'user'],
schema: {
params: zod_1.z.object({
page_size: zod_1.z.number().describe('Page size').optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
role_id: zod_1.z.string().describe('Role id'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppRoleUpdate = {
project: 'bitable',
name: 'bitable.v1.appRole.update',
sdkName: 'bitable.v1.appRole.update',
path: '/open-apis/bitable/v1/apps/:app_token/roles/:role_id',
httpMethod: 'PUT',
description: '[Feishu/Lark]-Docs-Base-Role-Update role-Update a role',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
role_name: zod_1.z.string().describe('Role name'),
table_roles: zod_1.z
.array(zod_1.z.object({
table_perm: zod_1.z
.number()
.describe('Table perm Options:0(NoPerm No permissions),1(Read View only),2(Edit Can edit records),4(Admin Can edit records and fields)'),
table_name: zod_1.z.string().describe('Table name').optional(),
table_id: zod_1.z.string().describe('Base unique table identifier').optional(),
rec_rule: zod_1.z
.object({
conditions: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('Field name'),
operator: zod_1.z
.enum(['is', 'isNot', 'contains', 'doesNotContain', 'isEmpty', 'isNotEmpty'])
.describe('Operator Options:is(Is),isNot(Is not),contains(Contains),doesNotContain(Does not contain),isEmpty(Is empty),isNotEmpty(Is not empty)')
.optional(),
value: zod_1.z.array(zod_1.z.string()).describe('Option id').optional(),
}))
.describe('Coditions'),
conjunction: zod_1.z.enum(['and', 'or']).describe('Conjunction Options:and(And),or(Or)').optional(),
other_perm: zod_1.z
.number()
.describe('Other perm Options:0(NoPerm Cannot view),1(Read View Only)')
.optional(),
})
.describe('Record filter rule')
.optional(),
field_perm: zod_1.z
.object({})
.catchall(zod_1.z.any())
.describe('Permission of fields, only valid when `table_perm` is 2. The type is map, key is field name, value is permission of field.**Optional values are**:- `1`: View only- `2`: Can edit records')
.optional(),
allow_add_record: zod_1.z
.boolean()
.describe('Added record permission, only meaningful when the table_perm is 2, used to set whether the record can be added')
.optional(),
allow_delete_record: zod_1.z
.boolean()
.describe('Delete record permission, meaningful only when the table_perm is 2, used to set whether the record can be deleted')
.optional(),
}))
.describe('Table role'),
block_roles: zod_1.z
.array(zod_1.z.object({
block_id: zod_1.z.string().describe('Block id, Such as dashboard block id in list dashboards method'),
block_perm: zod_1.z.number().describe('Block perm Options:0(NoPerm No permissions),1(Read View only)'),
}))
.describe('Block role')
.optional(),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier').optional(),
role_id: zod_1.z.string().describe('Role id').optional(),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableBatchCreate = {
project: 'bitable',
name: 'bitable.v1.appTable.batchCreate',
sdkName: 'bitable.v1.appTable.batchCreate',
path: '/open-apis/bitable/v1/apps/:app_token/tables/batch_create',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-Table-Batch create table-Batch create table',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
tables: zod_1.z
.array(zod_1.z.object({
name: zod_1.z
.string()
.describe('Name for the table.Please note:1. The first and last spaces in the name will be removed.2. If the name is empty or the same as the old name, the interface will still return success, but the name will not be changed')
.optional(),
}))
.describe('tables')
.optional(),
}),
params: zod_1.z.object({ user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('User ID type').optional() }),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier') }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableBatchDelete = {
project: 'bitable',
name: 'bitable.v1.appTable.batchDelete',
sdkName: 'bitable.v1.appTable.batchDelete',
path: '/open-apis/bitable/v1/apps/:app_token/tables/batch_delete',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-Table-Batch delete table-Batch delete table',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
table_ids: zod_1.z
.array(zod_1.z.string())
.describe('Base data table unique device identifier,Currently supports up to 50 data tables in one operation')
.optional(),
}),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier') }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableCreate = {
project: 'bitable',
name: 'bitable.v1.appTable.create',
sdkName: 'bitable.v1.appTable.create',
path: '/open-apis/bitable/v1/apps/:app_token/tables',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-Table-Create table-Access this API, you can add an empty data table containing only index columns, or specify some initial fields',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
table: zod_1.z
.object({
name: zod_1.z
.string()
.describe('Name for the table.Please note:1. The first and last spaces in the name will be removed')
.optional(),
default_view_name: zod_1.z
.string()
.describe('Name of the default table viewPlease note:1. The first and last spaces in the name will be removed.2. The characters [ ] are not allowed to be included')
.optional(),
fields: zod_1.z
.array(zod_1.z.object({
field_name: zod_1.z.string().describe('Field name'),
type: zod_1.z
.number()
.describe('Field type Options:1(Text Multiline),2(Number),3(SingleSelect Single option),4(MultiSelect Multiple options),5(DateTime Date),7(Checkbox),11(User Person),13(PhoneNumber),15(Url Link),17(Attachment),18(Link One-way link),20(Formula),21(DuplexLink Two-way link),22(Location),23(GroupChat group),1001(CreatedTime Date created),1002(ModifiedTime Last modified date),1003(CreatedUser Created by),1004(ModifiedUser Modified by),1005(AutoSerial)'),
ui_type: zod_1.z
.enum([
'Text',
'Barcode',
'Number',
'Progress',
'Currency',
'Rating',
'SingleSelect',
'MultiSelect',
'DateTime',
'Checkbox',
'User',
'GroupChat',
'Phone',
'Url',
'Attachment',
'SingleLink',
'Formula',
'DuplexLink',
'Location',
'CreatedTime',
'ModifiedTime',
'CreatedUser',
'ModifiedUser',
'AutoNumber',
])
.describe('Field Property, ref: Options:Text(multiline text),Barcode(barcode),Number(number),Progress(progress),Currency(currency),Rating(score),SingleSelect(radio),MultiSelect(multiple choice),DateTime(date),Checkbox(checkbox),User(Personnel),GroupChat(group),Phone(Phone number),Url(Hyperlink),Attachment(Attachment),SingleLink(one-way association),Formula(formula),DuplexLink(Two-way link),Location(Geographical location),CreatedTime(Creation time),ModifiedTime(Last update time),CreatedUser(creator),ModifiedUser(Modifier),AutoNumber(Automatic numbering)')
.optional(),
property: zod_1.z
.object({
options: zod_1.z
.array(zod_1.z.object({
name: zod_1.z.string().describe('Option name').optional(),
id: zod_1.z.string().describe('Option ID, not allowed to specify ID at creation time').optional(),
color: zod_1.z.number().describe('Option color').optional(),
}))
.describe('Whether to disable synchronization, if true, it means that synchronization of the description content to the problem description of the form is prohibited (only valid when fields are added or modified)')
.optional(),
formatter: zod_1.z.string().describe('Display format of numbers and formula fields').optional(),
date_formatter: zod_1.z
.string()
.describe('The display format of the date, creation time, and last updated time fields')
.optional(),
auto_fill: zod_1.z
.boolean()
.describe('New records in the date field are automatically filled in Creation time')
.optional(),
multiple: zod_1.z
.boolean()
.describe('Multiple members are allowed to be added in the personnel field, and multiple records are allowed in one-way association and two-way association')
.optional(),
table_id: zod_1.z.string().describe('Base unique table identifier').optional(),
table_name: zod_1.z
.string()
.describe('The name of the associated data table in the one-way association, two-way association field')
.optional(),
back_field_name: zod_1.z
.string()
.describe('The name of the corresponding bidirectional association field in the associated data table in the bidirectional association field')
.optional(),
auto_serial: zod_1.z
.object({
type: zod_1.z
.enum(['custom', 'auto_increment_number'])
.describe('Automatic numbering type Options:custom(Custom number),auto_increment_number(AutoIncrementNumber Autoincrement number)'),
options: zod_1.z
.array(zod_1.z.object({
type: zod_1.z
.enum(['system_number', 'fixed_text', 'created_time'])
.describe('Optional rule item types for auto-numbering Options:system_number(SystemNumber Incremental digits, value range 1-9),fixed_text(FixedText Fixed characters, maximum length: 20),created_time(CreatedTime Creation time, supports formats "yyyyMMdd", "yyyyMM", "yyyy", "MMdd", "MM", "dd")'),
value: zod_1.z
.string()
.describe('Values corresponding to auto-numbered optional rule item types'),
}))
.describe('List of auto-numbering rules')
.optional(),
})
.describe('Automatic numbering type')
.optional(),
location: zod_1.z
.object({
input_type: zod_1.z
.enum(['only_mobile', 'not_limit'])
.describe('Geolocation input restrictions Options:only_mobile(OnlyMobile Only allow uploads on mobile ends),not_limit(NotLimit Unlimited)'),
})
.describe('Geolocation input method')
.optional(),
formula_expression: zod_1.z.string().describe('Expression of formula field').optional(),
allowed_edit_modes: zod_1.z
.object({
manual: zod_1.z.boolean().describe('Whether to allow manual entry').optional(),
scan: zod_1.z.boolean().describe('Whether to allow mobile end entry').optional(),
})
.describe('Editing modes supported by the field')
.optional(),
min: zod_1.z.number().describe('Minimum data range for fields such as progress, score, etc').optional(),
max: zod_1.z.number().describe('Maximum data range for fields such as progress, score, etc').optional(),
range_customize: zod_1.z
.boolean()
.describe('Whether fields such as progress support custom ranges')
.optional(),
currency_code: zod_1.z.string().describe('Currency').optional(),
rating: zod_1.z
.object({ symbol: zod_1.z.string().describe('Symbol display for rating fields').optional() })
.describe('Relevant settings for scoring fields')
.optional(),
})
.describe('Field description')
.optional(),
description: zod_1.z
.object({
disable_sync: zod_1.z
.boolean()
.describe('Whether to disable synchronization, if true, it means that synchronization of the description content to the problem description of the form is prohibited (only valid when fields are added or modified)')
.optional(),
text: zod_1.z.string().describe('Field description content').optional(),
})
.describe('Field description')
.optional(),
}))
.describe('The initial fields of the data table.Please note:1. If neither the default_view_name field nor the fields field is filled in, an empty data table containing only index columns will be created.2. If the fields field is specified, a data table containing initial fields will be created and the first field will be the index column by default')
.optional(),
})
.describe('table')
.optional(),
}),
path: zod_1.z.object({ app_token: zod_1.z.string().describe('Base unique App identifier') }),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableDelete = {
project: 'bitable',
name: 'bitable.v1.appTable.delete',
sdkName: 'bitable.v1.appTable.delete',
path: '/open-apis/bitable/v1/apps/:app_token/tables/:table_id',
httpMethod: 'DELETE',
description: '[Feishu/Lark]-Docs-Base-Table-Delete Table-Delete a table',
accessTokens: ['tenant', 'user'],
schema: {
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
table_id: zod_1.z.string().describe('Base unique table identifier'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableFieldCreate = {
project: 'bitable',
name: 'bitable.v1.appTableField.create',
sdkName: 'bitable.v1.appTableField.create',
path: '/open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields',
httpMethod: 'POST',
description: '[Feishu/Lark]-Docs-Base-Field-Create field-Create a field',
accessTokens: ['tenant', 'user'],
schema: {
data: zod_1.z.object({
field_name: zod_1.z
.string()
.describe('Field NamePlease note: 1. The first and last spaces in the name will be removed'),
type: zod_1.z
.number()
.describe('Field Type Options:1(Text Multiline),2(Number),3(SingleSelect Single option),4(MultiSelect Multiple options),5(DateTime Date),7(Checkbox),11(User Person),13(PhoneNumber),15(Url Link),17(Attachment),18(Link One-way link),20(Formula),21(DuplexLink Two-way link),22(Location),23(GroupChat group),1001(CreatedTime Date created),1002(ModifiedTime Last modified date),1003(CreatedUser Created by),1004(ModifiedUser Modified by),1005(AutoSerial)'),
property: zod_1.z
.object({
options: zod_1.z
.array(zod_1.z.object({
name: zod_1.z.string().describe('Option name').optional(),
id: zod_1.z.string().describe('Option ID, not allowed to specify ID at creation time').optional(),
color: zod_1.z.number().describe('Option color').optional(),
}))
.describe('Option information for radio and multi-select fields')
.optional(),
formatter: zod_1.z.string().describe('Display format of numbers and formula fields').optional(),
date_formatter: zod_1.z
.string()
.describe('The display format of the date, creation time, and last updated time fields')
.optional(),
auto_fill: zod_1.z
.boolean()
.describe('New records in the date field are automatically filled in Creation time')
.optional(),
multiple: zod_1.z
.boolean()
.describe('Multiple members are allowed to be added in the personnel field, and multiple records are allowed in one-way association and two-way association')
.optional(),
table_id: zod_1.z.string().describe('Base unique table identifier').optional(),
back_field_name: zod_1.z
.string()
.describe('The name of the corresponding bidirectional association field in the associated data table in the bidirectional association field')
.optional(),
auto_serial: zod_1.z
.object({
type: zod_1.z
.enum(['custom', 'auto_increment_number'])
.describe('Automatic numbering type Options:custom(Custom number),auto_increment_number(AutoIncrementNumber Autoincrement number)'),
options: zod_1.z
.array(zod_1.z.object({
type: zod_1.z
.enum(['system_number', 'fixed_text', 'created_time'])
.describe('Optional rule item types for auto-numbering Options:system_number(SystemNumber Incremental digits, value range 1-9),fixed_text(FixedText Fixed characters, maximum length: 20),created_time(CreatedTime Creation time, supports formats "yyyyMMdd", "yyyyMM", "yyyy", "MMdd", "MM", "dd")'),
value: zod_1.z.string().describe('Values corresponding to auto-numbered optional rule item types'),
}))
.describe('List of auto-numbering rules')
.optional(),
})
.describe('Automatic numbering type')
.optional(),
location: zod_1.z
.object({
input_type: zod_1.z
.enum(['only_mobile', 'not_limit'])
.describe('Geolocation input restrictions Options:only_mobile(OnlyMobile Only allow uploads on mobile ends),not_limit(NotLimit Unlimited)'),
})
.describe('Geolocation input method')
.optional(),
formula_expression: zod_1.z.string().describe('Expression of formula field').optional(),
allowed_edit_modes: zod_1.z
.object({
manual: zod_1.z.boolean().describe('Whether to allow manual entry').optional(),
scan: zod_1.z.boolean().describe('Whether to allow mobile end entry').optional(),
})
.describe('Editing modes supported by the field')
.optional(),
min: zod_1.z.number().describe('Minimum data range for fields such as progress, score, etc').optional(),
max: zod_1.z.number().describe('Maximum data range for fields such as progress, score, etc').optional(),
range_customize: zod_1.z.boolean().describe('Whether fields such as progress support custom ranges').optional(),
currency_code: zod_1.z.string().describe('Currency Currency').optional(),
rating: zod_1.z
.object({ symbol: zod_1.z.string().describe('Symbol display for rating fields').optional() })
.describe('Relevant settings for scoring fields')
.optional(),
type: zod_1.z
.object({
data_type: zod_1.z
.number()
.describe('Set the data type of the formula field Options:1(Text),2(Number),3(SingleSelect),4(MultiSelect),5(DateTime),7(Checkbox),11(User),13(PhoneNumber),15(Url),17(Attachment),18(Link),20(Formula),21(DuplexLink),22(Location),23(GroupChat),1001(CreatedTime),1002(ModifiedTime),1003(CreatedUser),1004(ModifiedUser),1005(AutoSerial)'),
ui_property: zod_1.z
.object({
currency_code: zod_1.z.string().describe('Currency').optional(),
formatter: zod_1.z.string().describe('Display format of numbers and formula fields').optional(),
range_customize: zod_1.z
.boolean()
.describe('Whether fields such as progress support custom ranges')
.optional(),
min: zod_1.z.number().describe('Minimum data range for fields such as progress, score, etc').optional(),
max: zod_1.z.number().describe('Maximum data range for fields such as progress, score, etc').optional(),
date_formatter: zod_1.z
.string()
.describe('The display format of the date, creation time, and last updated time fields')
.optional(),
rating: zod_1.z
.object({ symbol: zod_1.z.string().describe('Symbol display for rating fields').optional() })
.describe('Relevant settings for scoring fields')
.optional(),
})
.describe('Field Property, ref: ')
.optional(),
ui_type: zod_1.z
.enum(['Number', 'Progress', 'Currency', 'Rating', 'DateTime'])
.describe('The type of display of the formula field on the interface, such as the progress field, which is a display form of numbers Options:Number(Number),Progress(Progress),Currency(Currency),Rating(Rating),DateTime(DateTime)')
.optional(),
})
.describe('Set the type of the formula field')
.optional(),
})
.describe('Field Property, ref: ')
.optional(),
description: zod_1.z
.object({
disable_sync: zod_1.z
.boolean()
.describe('Whether to disable synchronization, if true, it means that synchronization of the description content to the problem description of the form is prohibited (only valid when fields are added or modified)')
.optional(),
text: zod_1.z.string().describe('Field description content').optional(),
})
.describe('Field description')
.optional(),
ui_type: zod_1.z
.enum([
'Text',
'Email',
'Barcode',
'Number',
'Progress',
'Currency',
'Rating',
'SingleSelect',
'MultiSelect',
'DateTime',
'Checkbox',
'User',
'GroupChat',
'Phone',
'Url',
'Attachment',
'SingleLink',
'Formula',
'DuplexLink',
'Location',
'CreatedTime',
'ModifiedTime',
'CreatedUser',
'ModifiedUser',
'AutoNumber',
])
.describe('The type of display of the field on the interface, such as the progress field, which is a display form of numbers Options:Text(multiline text),Email(Email),Barcode(barcode),Number(number),Progress(progress),Currency(currency),Rating(score),SingleSelect(radio),MultiSelect(multiple choice),DateTime(date),Checkbox(checkbox),User(Personnel),GroupChat(group),Phone(Phone number),Url(Hyperlink),Attachment(Attachment),SingleLink(one-way association),Formula(formula),DuplexLink(bidirectional association),Location(Geographical location),CreatedTime(Creation time),ModifiedTime(Last update time),CreatedUser(founder),ModifiedUser(Modifier),AutoNumber(Automatic numbering)')
.optional(),
}),
params: zod_1.z.object({
client_token: zod_1.z
.string()
.describe('The format is a standard uuidv4, the unique identifier of the operation, used for idempotent update operations. This value is null to indicate that a new request will be initiated, and this value is non-null to indicate idempotent update operations')
.optional(),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
table_id: zod_1.z.string().describe('Base unique table identifier'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableFieldDelete = {
project: 'bitable',
name: 'bitable.v1.appTableField.delete',
sdkName: 'bitable.v1.appTableField.delete',
path: '/open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields/:field_id',
httpMethod: 'DELETE',
description: '[Feishu/Lark]-Docs-Base-Field-Delete field-Delete a field',
accessTokens: ['tenant', 'user'],
schema: {
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
table_id: zod_1.z.string().describe('Base unique table identifier'),
field_id: zod_1.z.string().describe('Base unique field identifier'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableFieldList = {
project: 'bitable',
name: 'bitable.v1.appTableField.list',
sdkName: 'bitable.v1.appTableField.list',
path: '/open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields',
httpMethod: 'GET',
description: '[Feishu/Lark]-Docs-Base-Field-List fields-Get all fields according to app_token and table_id',
accessTokens: ['tenant', 'user'],
schema: {
params: zod_1.z.object({
view_id: zod_1.z.string().describe('Base unique view identifier').optional(),
text_field_as_array: zod_1.z
.boolean()
.describe('Control the return format of field description (multi-line text format) data, true means return in array rich text form')
.optional(),
page_token: zod_1.z
.string()
.describe('Page identifier. It is not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups')
.optional(),
page_size: zod_1.z.number().describe('paging size').optional(),
}),
path: zod_1.z.object({
app_token: zod_1.z.string().describe('Base unique App identifier'),
table_id: zod_1.z.string().describe('Base unique table identifier'),
}),
useUAT: zod_1.z.boolean().describe('Use user access token, otherwise use tenant access token').optional(),
},
};
exports.bitableV1AppTableFieldUpdate = {
project: 'bitable',
name: 'bitable.v1.appTableField.update',
sdkName: 'bitable.v1.appTableField.update',
path: '/open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields/:field_id',
httpMethod: 'PUT',
description: '[Feishu/Lark]-Docs-Base-Field-Update