@satorijs/adapter-lark 3.9.0 → 3.9.2

package/src/types/ehr.ts

@@ -16,13 +16,39 @@ declare module '../internal' {
   }
 }
 
+export const enum ListEhrEmployeeQueryStatus {
+  /** 待入职 */
+  ToBeOnboarded = 1,
+  /** 在职 */
+  Active = 2,
+  /** 已取消入职 */
+  OnboardingCancelled = 3,
+  /** 待离职 */
+  Offboarding = 4,
+  /** 已离职 */
+  Offboarded = 5,
+}
+
+export const enum ListEhrEmployeeQueryType {
+  /** 全职 */
+  Regular = 1,
+  /** 实习 */
+  Intern = 2,
+  /** 顾问 */
+  Consultant = 3,
+  /** 外包 */
+  Outsourcing = 4,
+  /** 劳务 */
+  Contractor = 5,
+}
+
 export interface ListEhrEmployeeQuery extends Pagination {
   /** 返回数据类型 */
   view?: 'basic' | 'full'
   /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */
-  status?: (1 | 2 | 3 | 4 | 5)[]
+  status?: ListEhrEmployeeQueryStatus[]
   /** 雇员类型，不传代表查询所有雇员类型 */
-  type?: (1 | 2 | 3 | 4 | 5)[]
+  type?: ListEhrEmployeeQueryType[]
   /** 查询开始时间（创建时间 >= 此时间） */
   start_time?: string
   /** 查询结束时间（创建时间 <= 此时间） */

package/src/types/helpdesk.ts

@@ -142,7 +142,7 @@ declare module '../internal' {
      * 获取全部工单自定义字段
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields
      */
-    listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Paginated<TicketCustomizedField>
+    listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Promise<ListHelpdeskTicketCustomizedFieldResponse> & AsyncIterableIterator<TicketCustomizedField>
     /**
      * 创建知识库
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create
@@ -167,7 +167,7 @@ declare module '../internal' {
      * 获取全部知识库详情
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list
      */
-    listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise<ListHelpdeskFaqResponse>
+    listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise<ListHelpdeskFaqResponse> & AsyncIterableIterator<Faq>
     /**
      * 获取知识库图像
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image
@@ -261,6 +261,11 @@ export interface PatchHelpdeskAgentRequest {
   status?: number
 }
 
+export interface AgentEmailHelpdeskAgentResponse {
+  /** agent emails */
+  agents?: string
+}
+
 export interface CreateHelpdeskAgentScheduleRequest {
   /** 新客服日程 */
   agent_schedules?: AgentScheduleUpdateInfo[]
@@ -271,11 +276,21 @@ export interface PatchHelpdeskAgentSchedulesRequest {
   agent_schedule?: AgentScheduleUpdateInfo
 }
 
+export interface GetHelpdeskAgentSchedulesResponse {
+  /** schedules of an agent */
+  agent_schedule?: AgentSchedule
+}
+
 export interface ListHelpdeskAgentScheduleQuery {
   /** 筛选条件, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)客服, 4 - 移除客服 */
   status: number[]
 }
 
+export interface ListHelpdeskAgentScheduleResponse {
+  /** schedule of all agent */
+  agent_schedules?: AgentSchedule[]
+}
+
 export interface CreateHelpdeskAgentSkillRequest {
   /** 技能名 */
   name?: string
@@ -285,11 +300,30 @@ export interface CreateHelpdeskAgentSkillRequest {
   agent_ids?: string[]
 }
 
+export interface CreateHelpdeskAgentSkillResponse {
+  agent_skill_id?: string
+}
+
 export interface PatchHelpdeskAgentSkillRequest {
   /** 更新技能 */
   agent_skill?: AgentSkill
 }
 
+export interface GetHelpdeskAgentSkillResponse {
+  /** agent skill */
+  agent_skill?: AgentSkill
+}
+
+export interface ListHelpdeskAgentSkillResponse {
+  /** list of agent groups */
+  agent_skills?: AgentSkill[]
+}
+
+export interface ListHelpdeskAgentSkillRuleResponse {
+  /** all rules for agent skill */
+  rules?: AgentSkillRule[]
+}
+
 export interface StartServiceHelpdeskTicketRequest {
   /** 是否直接进入人工(若appointed_agents填写了，该值为必填) */
   human_service?: boolean
@@ -301,6 +335,16 @@ export interface StartServiceHelpdeskTicketRequest {
   customized_info?: string
 }
 
+export interface StartServiceHelpdeskTicketResponse {
+  /** chat id */
+  chat_id: string
+}
+
+export interface GetHelpdeskTicketResponse {
+  /** ticket detail */
+  ticket?: Ticket
+}
+
 export interface UpdateHelpdeskTicketRequest {
   /** new status, 1: 已创建, 2: 处理中, 3: 排队中, 5: 待定, 50: 机器人关闭工单, 51: 关闭工单 */
   status?: number
@@ -355,6 +399,12 @@ export interface ListHelpdeskTicketQuery {
   update_time_end?: number
 }
 
+export interface ListHelpdeskTicketResponse {
+  /** the total count */
+  total?: number
+  tickets?: Ticket[]
+}
+
 export interface TicketImageHelpdeskTicketQuery {
   /** 工单ID */
   ticket_id: string
@@ -376,6 +426,13 @@ export interface CustomizedFieldsHelpdeskTicketQuery {
   visible_only?: boolean
 }
 
+export interface CustomizedFieldsHelpdeskTicketResponse {
+  /** user customized fields */
+  user_customized_fields?: UserCustomizedField[]
+  /** ticket customized fields */
+  ticket_customized_fields?: TicketCustomizedField[]
+}
+
 export interface CreateHelpdeskTicketMessageRequest {
   /** 消息类型；text：纯文本；post：富文本 */
   msg_type: string
@@ -383,6 +440,11 @@ export interface CreateHelpdeskTicketMessageRequest {
   content: string
 }
 
+export interface CreateHelpdeskTicketMessageResponse {
+  /** chat消息open ID */
+  message_id?: string
+}
+
 export interface ListHelpdeskTicketMessageQuery {
   /** 起始时间 */
   time_start?: number
@@ -394,6 +456,13 @@ export interface ListHelpdeskTicketMessageQuery {
   page_size?: number
 }
 
+export interface ListHelpdeskTicketMessageResponse {
+  /** list of ticket messages */
+  messages?: TicketMessage[]
+  /** total number of messages */
+  total?: number
+}
+
 export interface CreateHelpdeskBotMessageRequest {
   /** 消息类型 */
   msg_type: 'text' | 'post' | 'image' | 'interactive'
@@ -410,6 +479,10 @@ export interface CreateHelpdeskBotMessageQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateHelpdeskBotMessageResponse {
+  message_id?: string
+}
+
 export interface CreateHelpdeskTicketCustomizedFieldRequest {
   /** help desk id */
   helpdesk_id: string
@@ -446,21 +519,73 @@ export interface PatchHelpdeskTicketCustomizedFieldRequest {
   required?: boolean
 }
 
+export interface GetHelpdeskTicketCustomizedFieldResponse {
+  /** ticket customized field id */
+  ticket_customized_field_id: string
+  /** help desk id */
+  helpdesk_id: string
+  /** key name */
+  key_name: string
+  /** display name */
+  display_name: string
+  /** the position of ticket customized field in the page */
+  position: string
+  /** type of the field */
+  field_type: string
+  /** description of the field */
+  description: string
+  /** if the field is visible */
+  visible: boolean
+  /** if the field is editable */
+  editable: boolean
+  /** if the field is required */
+  required: boolean
+  /** the time when the field is created */
+  created_at?: string
+  /** the time when the field is updated */
+  updated_at?: string
+  /** the user who created the ticket customized field */
+  created_by?: TicketUser
+  /** the user who recently updated the ticket customized field */
+  updated_by?: TicketUser
+  /** if the dropdown field supports multi-select */
+  dropdown_allow_multiple?: boolean
+}
+
 export interface ListHelpdeskTicketCustomizedFieldRequest {
   /** 是否可见 */
   visible?: boolean
 }
 
+export interface ListHelpdeskTicketCustomizedFieldResponse {
+  /** whether there is more data */
+  has_more?: boolean
+  /** the next page token */
+  next_page_token?: string
+  /** all the ticket customized fields */
+  items?: TicketCustomizedField[]
+}
+
 export interface CreateHelpdeskFaqRequest {
   /** 知识库详情 */
   faq?: FaqCreateInfo
 }
 
+export interface CreateHelpdeskFaqResponse {
+  /** faq detail */
+  faq?: Faq
+}
+
 export interface PatchHelpdeskFaqRequest {
   /** 修改的知识库内容 */
   faq?: FaqUpdateInfo
 }
 
+export interface GetHelpdeskFaqResponse {
+  /** faq detail */
+  faq?: Faq
+}
+
 export interface ListHelpdeskFaqQuery extends Pagination {
   /** 知识库分类ID */
   category_id?: string
@@ -470,6 +595,18 @@ export interface ListHelpdeskFaqQuery extends Pagination {
   search?: string
 }
 
+export interface ListHelpdeskFaqResponse {
+  /** if there's next page */
+  has_more?: boolean
+  /** the next page token */
+  page_token?: string
+  /** the page size */
+  page_size?: number
+  /** the total count */
+  total?: number
+  items?: Faq[]
+}
+
 export interface SearchHelpdeskFaqQuery extends Pagination {
   /** 搜索query，query内容如果不是英文，包含中文空格等有两种编码策略：1. url编码 2. base64编码，同时加上base64=true参数 */
   query: string
@@ -486,6 +623,24 @@ export interface CreateHelpdeskCategoryRequest {
   language?: string
 }
 
+export interface CreateHelpdeskCategoryResponse {
+  /** category */
+  category?: Category
+}
+
+export interface GetHelpdeskCategoryResponse {
+  /** category id */
+  category_id: string
+  /** category id, for backward compatibility */
+  id: string
+  /** category name */
+  name: string
+  /** helpdesk id */
+  helpdesk_id: string
+  /** category language */
+  language?: string
+}
+
 export interface PatchHelpdeskCategoryRequest {
   /** category name */
   name?: string
@@ -502,6 +657,11 @@ export interface ListHelpdeskCategoryQuery {
   asc?: boolean
 }
 
+export interface ListHelpdeskCategoryResponse {
+  /** list of categories */
+  categories?: Category[]
+}
+
 export interface CreateHelpdeskNotificationRequest {
   /** 唯一ID */
   id?: string
@@ -550,6 +710,13 @@ export interface CreateHelpdeskNotificationQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateHelpdeskNotificationResponse {
+  /** 创建成功后的唯一id */
+  notification_id?: string
+  /** 当前状态 */
+  status?: number
+}
+
 export interface PatchHelpdeskNotificationRequest {
   /** 唯一ID */
   id?: string
@@ -603,11 +770,23 @@ export interface GetHelpdeskNotificationQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface GetHelpdeskNotificationResponse {
+  /** push任务详情 */
+  notification?: Notification
+  /** 审批链接 */
+  approval_app_link?: string
+}
+
 export interface SubmitApproveHelpdeskNotificationRequest {
   /** 提交审批理由 */
   reason: string
 }
 
+export interface SubmitApproveHelpdeskNotificationResponse {
+  /** 是否有权限创建或者管理审批流程 （有两种情况会导致没有权限： 1：用户没有安装服务台小程序，需要在https://app.feishu.cn/app/cli_9f9f8825d53b900d或者https://ftest.feishu.cn/admin/appCenter/manage/cli_9f9f8825d53b900d?lang=zh-CN 安装小程序 2：用户安装的服务台小程序版本过低） */
+  has_access?: boolean
+}
+
 export interface ExecuteSendHelpdeskNotificationRequest {
   /** 发送时间戳(毫秒) */
   send_at: string
@@ -628,176 +807,6 @@ export interface UnsubscribeHelpdeskEventRequest {
   events: Event[]
 }
 
-export interface AgentEmailHelpdeskAgentResponse {
-  /** agent emails */
-  agents?: string
-}
-
-export interface GetHelpdeskAgentSchedulesResponse {
-  /** schedules of an agent */
-  agent_schedule?: AgentSchedule
-}
-
-export interface ListHelpdeskAgentScheduleResponse {
-  /** schedule of all agent */
-  agent_schedules?: AgentSchedule[]
-}
-
-export interface CreateHelpdeskAgentSkillResponse {
-  agent_skill_id?: string
-}
-
-export interface GetHelpdeskAgentSkillResponse {
-  /** agent skill */
-  agent_skill?: AgentSkill
-}
-
-export interface ListHelpdeskAgentSkillResponse {
-  /** list of agent groups */
-  agent_skills?: AgentSkill[]
-}
-
-export interface ListHelpdeskAgentSkillRuleResponse {
-  /** all rules for agent skill */
-  rules?: AgentSkillRule[]
-}
-
-export interface StartServiceHelpdeskTicketResponse {
-  /** chat id */
-  chat_id: string
-}
-
-export interface GetHelpdeskTicketResponse {
-  /** ticket detail */
-  ticket?: Ticket
-}
-
-export interface ListHelpdeskTicketResponse {
-  /** the total count */
-  total?: number
-  tickets?: Ticket[]
-}
-
-export interface CustomizedFieldsHelpdeskTicketResponse {
-  /** user customized fields */
-  user_customized_fields?: UserCustomizedField[]
-  /** ticket customized fields */
-  ticket_customized_fields?: TicketCustomizedField[]
-}
-
-export interface CreateHelpdeskTicketMessageResponse {
-  /** chat消息open ID */
-  message_id?: string
-}
-
-export interface ListHelpdeskTicketMessageResponse {
-  /** list of ticket messages */
-  messages?: TicketMessage[]
-  /** total number of messages */
-  total?: number
-}
-
-export interface CreateHelpdeskBotMessageResponse {
-  message_id?: string
-}
-
-export interface GetHelpdeskTicketCustomizedFieldResponse {
-  /** ticket customized field id */
-  ticket_customized_field_id: string
-  /** help desk id */
-  helpdesk_id: string
-  /** key name */
-  key_name: string
-  /** display name */
-  display_name: string
-  /** the position of ticket customized field in the page */
-  position: string
-  /** type of the field */
-  field_type: string
-  /** description of the field */
-  description: string
-  /** if the field is visible */
-  visible: boolean
-  /** if the field is editable */
-  editable: boolean
-  /** if the field is required */
-  required: boolean
-  /** the time when the field is created */
-  created_at?: string
-  /** the time when the field is updated */
-  updated_at?: string
-  /** the user who created the ticket customized field */
-  created_by?: TicketUser
-  /** the user who recently updated the ticket customized field */
-  updated_by?: TicketUser
-  /** if the dropdown field supports multi-select */
-  dropdown_allow_multiple?: boolean
-}
-
-export interface CreateHelpdeskFaqResponse {
-  /** faq detail */
-  faq?: Faq
-}
-
-export interface GetHelpdeskFaqResponse {
-  /** faq detail */
-  faq?: Faq
-}
-
-export interface ListHelpdeskFaqResponse {
-  /** if there's next page */
-  has_more?: boolean
-  /** the next page token */
-  page_token?: string
-  /** the page size */
-  page_size?: number
-  /** the total count */
-  total?: number
-  items?: Faq[]
-}
-
-export interface CreateHelpdeskCategoryResponse {
-  /** category */
-  category?: Category
-}
-
-export interface GetHelpdeskCategoryResponse {
-  /** category id */
-  category_id: string
-  /** category id, for backward compatibility */
-  id: string
-  /** category name */
-  name: string
-  /** helpdesk id */
-  helpdesk_id: string
-  /** category language */
-  language?: string
-}
-
-export interface ListHelpdeskCategoryResponse {
-  /** list of categories */
-  categories?: Category[]
-}
-
-export interface CreateHelpdeskNotificationResponse {
-  /** 创建成功后的唯一id */
-  notification_id?: string
-  /** 当前状态 */
-  status?: number
-}
-
-export interface GetHelpdeskNotificationResponse {
-  /** push任务详情 */
-  notification?: Notification
-  /** 审批链接 */
-  approval_app_link?: string
-}
-
-export interface SubmitApproveHelpdeskNotificationResponse {
-  /** 是否有权限创建或者管理审批流程 （有两种情况会导致没有权限： 1：用户没有安装服务台小程序，需要在https://app.feishu.cn/app/cli_9f9f8825d53b900d或者https://ftest.feishu.cn/admin/appCenter/manage/cli_9f9f8825d53b900d?lang=zh-CN 安装小程序 2：用户安装的服务台小程序版本过低） */
-  has_access?: boolean
-}
-
 Internal.define({
   '/helpdesk/v1/agents/{agent_id}': {
     PATCH: 'patchHelpdeskAgent',
@@ -863,7 +872,7 @@ Internal.define({
   },
   '/helpdesk/v1/faqs': {
     POST: 'createHelpdeskFaq',
-    GET: 'listHelpdeskFaq',
+    GET: { name: 'listHelpdeskFaq', pagination: { argIndex: 0 } },
   },
   '/helpdesk/v1/faqs/{id}': {
     DELETE: 'deleteHelpdeskFaq',