import { GetToken } from 'wecom-common'; import { GetSheet } from './smart-sheet-sheet'; /** * 定义字段类型的枚举 */ export declare enum FieldType { /** * 文本类型 */ FIELD_TYPE_TEXT = "FIELD_TYPE_TEXT", /** * 数字类型 */ FIELD_TYPE_NUMBER = "FIELD_TYPE_NUMBER", /** * 复选框类型 */ FIELD_TYPE_CHECKBOX = "FIELD_TYPE_CHECKBOX", /** * 日期时间类型 */ FIELD_TYPE_DATE_TIME = "FIELD_TYPE_DATE_TIME", /** * 图片类型 */ FIELD_TYPE_IMAGE = "FIELD_TYPE_IMAGE", /** * 文件类型 */ FIELD_TYPE_ATTACHMENT = "FIELD_TYPE_ATTACHMENT", /** * 成员类型 */ FIELD_TYPE_USER = "FIELD_TYPE_USER", /** * 超链接类型 */ FIELD_TYPE_URL = "FIELD_TYPE_URL", /** * 多选类型 */ FIELD_TYPE_SELECT = "FIELD_TYPE_SELECT", /** * 创建人类型 */ FIELD_TYPE_CREATED_USER = "FIELD_TYPE_CREATED_USER", /** * 最后编辑人类型 */ FIELD_TYPE_MODIFIED_USER = "FIELD_TYPE_MODIFIED_USER", /** * 创建时间类型 */ FIELD_TYPE_CREATED_TIME = "FIELD_TYPE_CREATED_TIME", /** * 最后编辑时间类型 */ FIELD_TYPE_MODIFIED_TIME = "FIELD_TYPE_MODIFIED_TIME", /** * 进度类型 */ FIELD_TYPE_PROGRESS = "FIELD_TYPE_PROGRESS", /** * 电话类型 */ FIELD_TYPE_PHONE_NUMBER = "FIELD_TYPE_PHONE_NUMBER", /** * 邮件类型 */ FIELD_TYPE_EMAIL = "FIELD_TYPE_EMAIL", /** * 单选类型 */ FIELD_TYPE_SINGLE_SELECT = "FIELD_TYPE_SINGLE_SELECT", /** * 关联类型 */ FIELD_TYPE_REFERENCE = "FIELD_TYPE_REFERENCE", /** * 地理位置类型 */ FIELD_TYPE_LOCATION = "FIELD_TYPE_LOCATION", /** * 货币类型 */ FIELD_TYPE_CURRENCY = "FIELD_TYPE_CURRENCY", /** * 群组类型 */ FIELD_TYPE_WWGROUP = "FIELD_TYPE_WWGROUP", /** * 自动编号类型 */ FIELD_TYPE_AUTONUMBER = "FIELD_TYPE_AUTONUMBER" } /** * 定义小数点后的位数 */ export declare enum DecimalPlaces { /** * 显示原值 */ MINUS_ONE = -1, /** * 代表整数 */ ZERO = 0, /** * 精确到小数点后一位(1.0) */ ONE = 1, /** * 精确到小数点后一位(1.0) */ TWO = 2, /** * 精确到小数点后一位(1.0) */ THREE = 3, /** * 精确到小数点后一位(1.0) */ FOUR = 4 } /** * 展示样式的枚举 */ export declare enum DisplayMode { /** * 列表样式 */ DISPLAY_MODE_LIST = "DISPLAY_MODE_LIST", /** * 宫格样式 */ DISPLAY_MODE_GRID = "DISPLAY_MODE_GRID" } /** * 超链接展示样式的枚举 */ export declare enum LinkType { /** * 纯文本 */ LINK_TYPE_PURE_TEXT = "LINK_TYPE_PURE_TEXT", /** * 图标文字 */ LINK_TYPE_ICON_TEXT = "LINK_TYPE_ICON_TEXT" } /** * 自动编号类型的枚举 */ export declare enum NumberType { /** * 自增数字类型 */ NUMBER_TYPE_INCR = "NUMBER_TYPE_INCR", /** * 自定义类型 */ NUMBER_TYPE_CUSTOM = "NUMBER_TYPE_CUSTOM" } /** * 数字规则类型的枚举 */ export declare enum NumberRuleType { /** * 自增数字类型 */ NUMBER_RULE_TYPE_INCR = "NUMBER_RULE_TYPE_INCR", /** * 固定字符 */ NUMBER_RULE_TYPE_FIXED_CHAR = "NUMBER_RULE_TYPE_FIXED_CHAR", /** * 创建时间 */ NUMBER_RULE_TYPE_TIME = "NUMBER_RULE_TYPE_TIME" } /** * 货币符号类型的枚举 */ export declare enum CurrencyType { /** * 人民币 */ CNY = "CURRENCY_TYPE_CNY", /** * 美元 */ USD = "CURRENCY_TYPE_USD", /** * 欧元 */ EUR = "CURRENCY_TYPE_EUR", /** * 英镑 */ GBP = "CURRENCY_TYPE_GBP", /** * 日元 */ JPY = "CURRENCY_TYPE_JPY", /** * 韩元 */ KRW = "CURRENCY_TYPE_KRW", /** * 港元 */ HKD = "CURRENCY_TYPE_HKD", /** * 澳门元 */ MOP = "CURRENCY_TYPE_MOP", /** * 新台币 */ TWD = "CURRENCY_TYPE_TWD", /** * 阿联酋迪拉姆 */ AED = "CURRENCY_TYPE_AED", /** * 澳大利亚元 */ AUD = "CURRENCY_TYPE_AUD", /** * 巴西雷亚尔 */ BRL = "CURRENCY_TYPE_BRL", /** * 加拿大元 */ CAD = "CURRENCY_TYPE_CAD", /** * 瑞士法郎 */ CHF = "CURRENCY_TYPE_CHF", /** * 印尼卢比 */ IDR = "CURRENCY_TYPE_IDR", /** * 印度卢比 */ INR = "CURRENCY_TYPE_INR", /** * 墨西哥比索 */ MXN = "CURRENCY_TYPE_MXN", /** * 马来西亚林吉特 */ MYR = "CURRENCY_TYPE_MYR", /** * 菲律宾比索 */ PHP = "CURRENCY_TYPE_PHP", /** * 波兰兹罗提 */ PLN = "CURRENCY_TYPE_PLN", /** * 俄罗斯卢布 */ RUB = "CURRENCY_TYPE_RUB", /** * 新加坡元 */ SGD = "CURRENCY_TYPE_SGD", /** * 泰国铢 */ THB = "CURRENCY_TYPE_THB", /** * 土耳其里拉 */ TRY = "CURRENCY_TYPE_TRY", /** * 越南盾 */ VND = "CURRENCY_TYPE_VND" } /** * 自动编号规则 */ export type NumberRule = { /** * 数字规则类型的枚举 */ type: NumberRuleType; /** * 存放创建时间格式CreateTimeFormat 或固定字符,自增数字位数 */ value: string; }; /** * 创建时间格式的枚举,目前应用于自动编号规则中的value字段。 */ export declare enum CreateTimeFormat { /** * 格式说明:20240301 */ YYYYMMDD = "YYYYMMDD", /** * 格式说明:202403 */ YYYYMM = "YYYYMM", /** * 格式说明:0301 */ MMDD = "MMDD", /** * 格式说明:2024 */ YYYY = "YYYY", /** * 格式说明:03 */ MM = "MM", /** * 格式说明:01 */ DD = "DD" } /** * 选项颜色的枚举。 */ export declare enum Style { /** * 浅红 */ ONE = 1, /** * 浅橙 */ TWO = 2, /** * 浅天蓝 */ THREE = 3, /** * 浅绿 */ FOUR = 4, /** * 浅紫 */ FIVE = 5, /** * 浅粉红 */ SIX = 6, /** * 浅灰 */ SEVEN = 7, /** * 白 */ EIGHT = 8 } /** * 地理位置输入类型的枚举。 */ export declare enum LocationInputType { /** * 手动输入 */ LOCATION_INPUT_TYPE_MANUAL = "LOCATION_INPUT_TYPE_MANUAL", /** * 自动定位 */ LOCATION_INPUT_TYPE_AUTO = "LOCATION_INPUT_TYPE_AUTO" } /** * 多选和单选的选项参数类型。 */ export type Option = { /** * 选项ID(可选) */ id?: string; /** * 要填写的选项内容 */ text: string; /** * 选项颜色 */ style: Style; }; /** * 设置日期格式 * "yyyy"年"m"月"d"日"" 2018 年 4 月 20 日 * "yyyy-mm-dd" 2018-04-20 * "yyyy/m/d" 2018/4/20 * "m"月"d"日"" 4 月 20 日 * "yyyy"年"m"月"d"日" dddd" 2018 年 4 月 20 日 星期五 * "yyyy"年"m"月"d"日" hh:mm" 2018 年 4 月 20 日 14:00 * "yyyy-mm-dd hh:mm" 2018-04-20 14:00 * "m/d/yyyy" 4/20/2018 * "d/m/yyyy" 20/4/2018 */ export type Format = string; /** * 添加字段 */ export type AddField = { /** * 字段标题 */ field_title: string; /** * 字段类型 */ field_type: FieldType; /** * 其它 */ [key: string]: any; }; /** * 添加字段 */ export type AddFields = { /** * 添加字段对象数组 */ fields: AddField[]; } & GetSheet; export type DelFields = { /** * 字段id数组 */ field_ids: string[]; } & GetSheet; /** * 修改字段 */ export type UpdateFields = { fields: { /** * 字段ID */ field_id: string; /** * 字段标题 */ field_title?: string; field_type: FieldType; [key: string]: any; }[]; } & GetSheet; /** * 查询字段 * 本接口用于获取智能表中某个子表下字段信息,该接口可以完成下面三种功能:获取全部字段信息、依据字段名获取对应字段、依据字段 ID 获取对应字段信息。 * @see https://developer.work.weixin.qq.com/document/path/99914 */ export declare const fields: (params: GetSheet, options: GetToken) => Promise; /** * 添加字段 * 字段名不能同名,否则报错 */ export declare const add: (params: AddFields, options: GetToken) => Promise; /** * 删除字段 */ export declare const del: (params: DelFields, options: GetToken) => Promise; /** * 更新字段 * 该接口只能更新字段名、字段属性,不能更新字段类型 * 字段名不能修改为已存在的字段名,否则报错 */ export declare const update: (params: UpdateFields, options: GetToken) => Promise; export type NumberFieldProperty = { /** * 表示小数点的位数,即数字精度 */ decimal_places: DecimalPlaces; /** * 是否使用千位符,设置此属性后数字字段将以英文逗号分隔千分位,如 1,000 */ use_separate: boolean; }; export type AddNumberField = { field_title: string; } & NumberFieldProperty & GetSheet; export declare const addNumberField: (params: AddNumberField, options: GetToken) => Promise; export type UpdateNumberField = { field_id: string; field_title?: string; } & NumberFieldProperty & GetSheet; export declare const updateNumberField: (params: UpdateNumberField, options: GetToken) => Promise; export type CheckboxFieldProperty = { /** * 新增时是否默认勾选 */ checked: boolean; }; export type AddCheckboxField = { field_title: string; } & CheckboxFieldProperty & GetSheet; export declare const addCheckboxField: (params: AddCheckboxField, options: GetToken) => Promise; export type UpdateCheckboxField = { field_id: string; field_title?: string; } & CheckboxFieldProperty & GetSheet; export declare const updateCheckboxField: (params: UpdateCheckboxField, options: GetToken) => Promise; export type DateTimeFieldProperty = { format: Format; /** * 新建记录时,是否自动填充时间 */ auto_fill: boolean; }; export type AddDateTimeField = { field_title: string; } & DateTimeFieldProperty & GetSheet; export declare const addDateTimeField: (params: AddDateTimeField, options: GetToken) => Promise; export type UpdateDateTimeField = { field_id: string; field_title?: string; } & DateTimeFieldProperty & GetSheet; export declare const updateDateTimeField: (params: UpdateDateTimeField, options: GetToken) => Promise; export type AttachmentFieldProperty = { /** * 设置文件展示方式 */ display_mode: DisplayMode; }; export type AddAttachmentField = { field_title: string; } & AttachmentFieldProperty & GetSheet; export declare const addAttachmentField: (params: AddAttachmentField, options: GetToken) => Promise; export type UpdateAttachmentField = { field_id: string; field_title?: string; } & AttachmentFieldProperty & GetSheet; export declare const updateAttachmentField: (params: UpdateAttachmentField, options: GetToken) => Promise; export type UserFieldProperty = { /** * 允许添加多个人员 */ is_multiple: boolean; /** * 添加人员时通知用户 */ is_notified: boolean; }; export type AddUserField = { field_title: string; } & UserFieldProperty & GetSheet; export declare const addUserField: (params: AddUserField, options: GetToken) => Promise; export type UpdateUserField = { field_id: string; field_title?: string; } & UserFieldProperty & GetSheet; export declare const updateUserField: (params: UpdateUserField, options: GetToken) => Promise; export type UrlFieldProperty = { /** * 超链接展示样式 */ type: LinkType; }; export type AddUrlField = { field_title: string; } & UrlFieldProperty & GetSheet; export declare const addUrlField: (params: AddUrlField, options: GetToken) => Promise; export type UpdateUrlField = { field_id: string; field_title?: string; } & UrlFieldProperty & GetSheet; export declare const updateUrlField: (params: UpdateUrlField, options: GetToken) => Promise; export type SelectFieldProperty = { /** * 是否允许填写时新增选项 */ is_quick_add: boolean; /** * 多选选项的格式设置 */ options: Array