@satorijs/adapter-lark 3.10.6 → 3.11.0

package/src/types/acs.ts

@@ -1,236 +1,284 @@
-import { AccessRecord, Device, Feature, Rule, User, UserExternal } 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/acs-v1/user/patch
-     */
-    patchAcsUser(user_id: string, body: PatchAcsUserRequest, query?: PatchAcsUserQuery): Promise<void>
-    /**
-     * 获取单个用户信息
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get
-     */
-    getAcsUser(user_id: string, query?: GetAcsUserQuery): Promise<GetAcsUserResponse>
-    /**
-     * 获取用户列表
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list
-     */
-    listAcsUser(query?: ListAcsUserQuery): Paginated<User>
-    /**
-     * 上传人脸图片
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update
-     */
-    updateAcsUserFace(user_id: string, form: UpdateAcsUserFaceForm, query?: UpdateAcsUserFaceQuery): Promise<void>
-    /**
-     * 下载人脸图片
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get
-     */
-    getAcsUserFace(user_id: string, query?: GetAcsUserFaceQuery): Promise<ArrayBuffer>
-    /**
-     * 设备绑定权限组
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind
-     */
-    deviceBindAcsRuleExternal(body: DeviceBindAcsRuleExternalRequest): Promise<void>
-    /**
-     * 获取权限组信息
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
-     */
-    getAcsRuleExternal(query?: GetAcsRuleExternalQuery): Promise<GetAcsRuleExternalResponse>
-    /**
-     * 删除权限组
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete
-     */
-    deleteAcsRuleExternal(query?: DeleteAcsRuleExternalQuery): Promise<void>
-    /**
-     * 创建或更新权限组
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create
-     */
-    createAcsRuleExternal(body: CreateAcsRuleExternalRequest, query?: CreateAcsRuleExternalQuery): Promise<CreateAcsRuleExternalResponse>
-    /**
-     * 删除访客
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete
-     */
-    deleteAcsVisitor(visitor_id: string, query?: DeleteAcsVisitorQuery): Promise<void>
-    /**
-     * 添加访客
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create
-     */
-    createAcsVisitor(body: CreateAcsVisitorRequest, query?: CreateAcsVisitorQuery): Promise<CreateAcsVisitorResponse>
-    /**
-     * 获取门禁设备列表
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list
-     */
-    listAcsDevice(): Promise<ListAcsDeviceResponse>
-    /**
-     * 获取门禁记录列表
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list
-     */
-    listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Paginated<AccessRecord>
-    /**
-     * 下载开门时的人脸识别图片
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get
-     */
-    getAcsAccessRecordAccessPhoto(access_record_id: string): Promise<ArrayBuffer>
+    acs: Acs.Methods
   }
 }
 
-export interface PatchAcsUserRequest {
-  /** 用户特征 */
-  feature?: Feature
-}
+export namespace Acs {
+  export interface Methods {
+    user: User.Methods
+    ruleExternal: RuleExternal.Methods
+    visitor: Visitor.Methods
+    device: Device.Methods
+    accessRecord: AccessRecord.Methods
+  }
 
-export interface PatchAcsUserQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+  export namespace User {
+    export interface Methods {
+      face: Face.Methods
+      /**
+       * 修改用户部分信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch
+       */
+      patch(user_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>
+      /**
+       * 获取单个用户信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get
+       */
+      get(user_id: string, query?: GetQuery): Promise<GetResponse>
+      /**
+       * 获取用户列表
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list
+       */
+      list(query?: ListQuery): Paginated<Lark.User>
+    }
 
-export interface GetAcsUserQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface PatchRequest {
+      /** 用户特征 */
+      feature?: Lark.Feature
+    }
 
-export interface GetAcsUserResponse {
-  /** 门禁用户信息 */
-  user?: User
-}
+    export interface PatchQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface ListAcsUserQuery extends Pagination {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface GetQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface UpdateAcsUserFaceForm {
-  /** 人脸图片内容 */
-  files: Blob
-  /** 文件类型,可选的类型有jpg,png */
-  file_type: string
-  /** 带后缀的文件名 */
-  file_name: string
-}
+    export interface GetResponse {
+      /** 门禁用户信息 */
+      user?: Lark.User
+    }
 
-export interface UpdateAcsUserFaceQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface ListQuery extends Pagination {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface GetAcsUserFaceQuery {
-  /** 裁剪图 */
-  is_cropped?: boolean
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export namespace Face {
+      export interface Methods {
+        /**
+         * 上传人脸图片
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update
+         */
+        update(user_id: string, form: UpdateForm, query?: UpdateQuery): Promise<void>
+        /**
+         * 下载人脸图片
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get
+         */
+        get(user_id: string, query?: GetQuery): Promise<ArrayBuffer>
+      }
 
-export interface DeviceBindAcsRuleExternalRequest {
-  /** 设备id */
-  device_id: string
-  /** 权限组id列表 */
-  rule_ids: string[]
-}
+      export interface UpdateForm {
+        /** 人脸图片内容 */
+        files: Blob
+        /** 文件类型,可选的类型有jpg,png */
+        file_type: string
+        /** 带后缀的文件名 */
+        file_name: string
+      }
 
-export interface GetAcsRuleExternalQuery {
-  /** 设备id */
-  device_id?: string
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+      export interface UpdateQuery {
+        /** 此次调用中使用的用户ID的类型 */
+        user_id_type?: 'user_id' | 'union_id' | 'open_id'
+      }
 
-export interface GetAcsRuleExternalResponse {
-  /** 设备权限组信息 */
-  rules: Rule[]
-}
+      export interface GetQuery {
+        /** 裁剪图 */
+        is_cropped?: boolean
+        /** 此次调用中使用的用户ID的类型 */
+        user_id_type?: 'user_id' | 'union_id' | 'open_id'
+      }
+    }
+  }
 
-export interface DeleteAcsRuleExternalQuery {
-  /** 权限组id */
-  rule_id: string
-}
+  export namespace RuleExternal {
+    export interface Methods {
+      /**
+       * 设备绑定权限组
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind
+       */
+      deviceBind(body: DeviceBindRequest): Promise<void>
+      /**
+       * 获取权限组信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
+       */
+      get(query?: GetQuery): Promise<GetResponse>
+      /**
+       * 删除权限组
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete
+       */
+      delete(query?: DeleteQuery): Promise<void>
+      /**
+       * 创建或更新权限组
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create
+       */
+      create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
+    }
 
-export interface CreateAcsRuleExternalRequest {
-  /** 权限组信息 */
-  rule: Rule
-}
+    export interface DeviceBindRequest {
+      /** 设备id */
+      device_id: string
+      /** 权限组id列表 */
+      rule_ids: string[]
+    }
 
-export interface CreateAcsRuleExternalQuery {
-  /** 权限组id-为空创建,不为空则更新 */
-  rule_id?: string
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface GetQuery {
+      /** 设备id */
+      device_id?: string
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface CreateAcsRuleExternalResponse {
-  /** 权限组id */
-  rule_id: string
-}
+    export interface GetResponse {
+      /** 设备权限组信息 */
+      rules: Lark.Rule[]
+    }
 
-export interface DeleteAcsVisitorQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface DeleteQuery {
+      /** 权限组id */
+      rule_id: string
+    }
 
-export interface CreateAcsVisitorRequest {
-  /** 访客信息 */
-  user: UserExternal
-}
+    export interface CreateRequest {
+      /** 权限组信息 */
+      rule: Lark.Rule
+    }
 
-export interface CreateAcsVisitorQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface CreateQuery {
+      /** 权限组id-为空创建,不为空则更新 */
+      rule_id?: string
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface CreateAcsVisitorResponse {
-  /** 访客的id */
-  visitor_id: string
-}
+    export interface CreateResponse {
+      /** 权限组id */
+      rule_id: string
+    }
+  }
 
-export interface ListAcsDeviceResponse {
-  items?: Device[]
-}
+  export namespace Visitor {
+    export interface Methods {
+      /**
+       * 删除访客
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete
+       */
+      delete(visitor_id: string, query?: DeleteQuery): Promise<void>
+      /**
+       * 添加访客
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create
+       */
+      create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
+    }
+
+    export interface DeleteQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export interface CreateRequest {
+      /** 访客信息 */
+      user: Lark.UserExternal
+    }
+
+    export interface CreateQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface ListAcsAccessRecordQuery extends Pagination {
-  /** 记录开始时间，单位秒 */
-  from: number
-  /** 记录结束时间，单位秒，时间跨度不能超过30天 */
-  to: number
-  /** 门禁设备 ID */
-  device_id?: string
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    export interface CreateResponse {
+      /** 访客的id */
+      visitor_id: string
+    }
+  }
+
+  export namespace Device {
+    export interface Methods {
+      /**
+       * 获取门禁设备列表
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list
+       */
+      list(): Promise<ListResponse>
+    }
+
+    export interface ListResponse {
+      items?: Lark.Device[]
+    }
+  }
+
+  export namespace AccessRecord {
+    export interface Methods {
+      accessPhoto: AccessPhoto.Methods
+      /**
+       * 获取门禁记录列表
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list
+       */
+      list(query?: ListQuery): Paginated<Lark.AccessRecord>
+    }
+
+    export interface ListQuery extends Pagination {
+      /** 记录开始时间，单位秒 */
+      from: number
+      /** 记录结束时间，单位秒，时间跨度不能超过30天 */
+      to: number
+      /** 门禁设备 ID */
+      device_id?: string
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export namespace AccessPhoto {
+      export interface Methods {
+        /**
+         * 下载开门时的人脸识别图片
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get
+         */
+        get(access_record_id: string): Promise<ArrayBuffer>
+      }
+    }
+  }
 }
 
 Internal.define({
   '/acs/v1/users/{user_id}': {
-    PATCH: 'patchAcsUser',
-    GET: 'getAcsUser',
+    PATCH: 'acs.user.patch',
+    GET: 'acs.user.get',
   },
   '/acs/v1/users': {
-    GET: { name: 'listAcsUser', pagination: { argIndex: 0 } },
+    GET: { name: 'acs.user.list', pagination: { argIndex: 0 } },
   },
   '/acs/v1/users/{user_id}/face': {
-    PUT: { name: 'updateAcsUserFace', multipart: true },
-    GET: { name: 'getAcsUserFace', type: 'binary' },
+    PUT: { name: 'acs.user.face.update', multipart: true },
+    GET: { name: 'acs.user.face.get', type: 'binary' },
   },
   '/acs/v1/rule_external/device_bind': {
-    POST: 'deviceBindAcsRuleExternal',
+    POST: 'acs.ruleExternal.deviceBind',
   },
   '/acs/v1/rule_external': {
-    GET: 'getAcsRuleExternal',
-    DELETE: 'deleteAcsRuleExternal',
-    POST: 'createAcsRuleExternal',
+    GET: 'acs.ruleExternal.get',
+    DELETE: 'acs.ruleExternal.delete',
+    POST: 'acs.ruleExternal.create',
   },
   '/acs/v1/visitors/{visitor_id}': {
-    DELETE: 'deleteAcsVisitor',
+    DELETE: 'acs.visitor.delete',
   },
   '/acs/v1/visitors': {
-    POST: 'createAcsVisitor',
+    POST: 'acs.visitor.create',
   },
   '/acs/v1/devices': {
-    GET: 'listAcsDevice',
+    GET: 'acs.device.list',
   },
   '/acs/v1/access_records': {
-    GET: { name: 'listAcsAccessRecord', pagination: { argIndex: 0 } },
+    GET: { name: 'acs.accessRecord.list', pagination: { argIndex: 0 } },
   },
   '/acs/v1/access_records/{access_record_id}/access_photo': {
-    GET: { name: 'getAcsAccessRecordAccessPhoto', type: 'binary' },
+    GET: { name: 'acs.accessRecord.accessPhoto.get', type: 'binary' },
   },
 })