@satorijs/adapter-lark 3.10.6 → 3.11.0

package/src/types/ehr.ts

@@ -1,69 +1,87 @@
-import { Employee } from '.'
-import { Internal, Pagination } from '../internal'
+import * as Lark from '.'
+import { Internal, Paginated, Pagination } from '../internal'
 
 declare module '../internal' {
   interface Internal {
-    /**
-     * 批量获取员工花名册信息
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list
-     */
-    listEhrEmployee(query?: ListEhrEmployeeQuery): Paginated<Employee>
-    /**
-     * 下载人员的附件
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/attachment/get
-     */
-    getEhrAttachment(token: string): Promise<ArrayBuffer>
+    ehr: Ehr.Methods
   }
 }
 
-export const enum ListEhrEmployeeQueryStatus {
-  /** 待入职 */
-  ToBeOnboarded = 1,
-  /** 在职 */
-  Active = 2,
-  /** 已取消入职 */
-  OnboardingCancelled = 3,
-  /** 待离职 */
-  Offboarding = 4,
-  /** 已离职 */
-  Offboarded = 5,
-}
+export namespace Ehr {
+  export interface Methods {
+    employee: Employee.Methods
+    attachment: Attachment.Methods
+  }
 
-export const enum ListEhrEmployeeQueryType {
-  /** 全职 */
-  Regular = 1,
-  /** 实习 */
-  Intern = 2,
-  /** 顾问 */
-  Consultant = 3,
-  /** 外包 */
-  Outsourcing = 4,
-  /** 劳务 */
-  Contractor = 5,
-}
+  export namespace Employee {
+    export interface Methods {
+      /**
+       * 批量获取员工花名册信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list
+       */
+      list(query?: ListQuery): Paginated<Lark.Employee>
+    }
+
+    export const enum ListQueryStatus {
+      /** 待入职 */
+      ToBeOnboarded = 1,
+      /** 在职 */
+      Active = 2,
+      /** 已取消入职 */
+      OnboardingCancelled = 3,
+      /** 待离职 */
+      Offboarding = 4,
+      /** 已离职 */
+      Offboarded = 5,
+    }
 
-export interface ListEhrEmployeeQuery extends Pagination {
-  /** 返回数据类型 */
-  view?: 'basic' | 'full'
-  /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */
-  status?: ListEhrEmployeeQueryStatus[]
-  /** 雇员类型，不传代表查询所有雇员类型 */
-  type?: ListEhrEmployeeQueryType[]
-  /** 查询开始时间（创建时间 &gt;= 此时间） */
-  start_time?: string
-  /** 查询结束时间（创建时间 &lt;= 此时间） */
-  end_time?: string
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-  /** user_id、open_id 或 union_id，默认为 open_id。如果传入的值不是 open_id，需要一并传入 user_id_type 参数。可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
-  user_ids?: string[]
+    export const enum ListQueryType {
+      /** 全职 */
+      Regular = 1,
+      /** 实习 */
+      Intern = 2,
+      /** 顾问 */
+      Consultant = 3,
+      /** 外包 */
+      Outsourcing = 4,
+      /** 劳务 */
+      Contractor = 5,
+    }
+
+    export interface ListQuery extends Pagination {
+      /** 返回数据类型 */
+      view?: 'basic' | 'full'
+      /** 员工状态，不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录，如 status=2&status=4 */
+      status?: ListQueryStatus[]
+      /** 雇员类型，不传代表查询所有雇员类型 */
+      type?: ListQueryType[]
+      /** 查询开始时间（创建时间 &gt;= 此时间） */
+      start_time?: string
+      /** 查询结束时间（创建时间 &lt;= 此时间） */
+      end_time?: string
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+      /** user_id、open_id 或 union_id，默认为 open_id。如果传入的值不是 open_id，需要一并传入 user_id_type 参数。可一次查询多个 id 的用户，例如：user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
+      user_ids?: string[]
+    }
+  }
+
+  export namespace Attachment {
+    export interface Methods {
+      /**
+       * 下载人员的附件
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/attachment/get
+       */
+      get(token: string): Promise<ArrayBuffer>
+    }
+  }
 }
 
 Internal.define({
   '/ehr/v1/employees': {
-    GET: { name: 'listEhrEmployee', pagination: { argIndex: 0 } },
+    GET: { name: 'ehr.employee.list', pagination: { argIndex: 0 } },
   },
   '/ehr/v1/attachments/{token}': {
-    GET: { name: 'getEhrAttachment', type: 'binary' },
+    GET: { name: 'ehr.attachment.get', type: 'binary' },
   },
 })

package/src/types/event.ts

@@ -1,17 +1,29 @@
-import { Internal } from '../internal'
+import { Internal, Paginated, Pagination } from '../internal'
 
 declare module '../internal' {
   interface Internal {
-    /**
-     * 获取事件出口 IP
-     * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list
-     */
-    listEventOutboundIp(query?: Pagination): Paginated<string, 'ip_list'>
+    event: Event.Methods
+  }
+}
+
+export namespace Event {
+  export interface Methods {
+    outboundIp: OutboundIp.Methods
+  }
+
+  export namespace OutboundIp {
+    export interface Methods {
+      /**
+       * 获取事件出口 IP
+       * @see https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list
+       */
+      list(query?: Pagination): Paginated<string, 'ip_list'>
+    }
   }
 }
 
 Internal.define({
   '/event/v1/outbound_ip': {
-    GET: { name: 'listEventOutboundIp', pagination: { argIndex: 0, itemsKey: 'ip_list' } },
+    GET: { name: 'event.outboundIp.list', pagination: { argIndex: 0, itemsKey: 'ip_list' } },
   },
 })