@satorijs/adapter-lark 3.10.6 → 3.11.0

package/src/types/okr.ts

@@ -1,293 +1,341 @@
-import { ContentBlock, OkrBatch, OkrReview, Period, PeriodRule } from '.'
-import { Internal } from '../internal'
+import * as Lark from '.'
+import { Internal, Paginated, Pagination } from '../internal'
 
 declare module '../internal' {
   interface Internal {
-    /**
-     * 创建 OKR 周期
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create
-     */
-    createOkrPeriod(body: CreateOkrPeriodRequest): Promise<CreateOkrPeriodResponse>
-    /**
-     * 修改 OKR 周期状态
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch
-     */
-    patchOkrPeriod(period_id: string, body: PatchOkrPeriodRequest): Promise<PatchOkrPeriodResponse>
-    /**
-     * 获取 OKR 周期列表
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list
-     */
-    listOkrPeriod(query?: Pagination): Paginated<Period>
-    /**
-     * 获取 OKR 周期规则
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list
-     */
-    listOkrPeriodRule(): Promise<ListOkrPeriodRuleResponse>
-    /**
-     * 获取用户的 OKR 列表
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list
-     */
-    listOkrUserOkr(user_id: string, query?: ListOkrUserOkrQuery): Promise<ListOkrUserOkrResponse>
+    okr: Okr.Methods
+  }
+}
+
+export namespace Okr {
+  export interface Methods {
+    period: Period.Methods
+    periodRule: PeriodRule.Methods
+    user: User.Methods
+    progressRecord: ProgressRecord.Methods
+    image: Image.Methods
+    review: Review.Methods
     /**
      * 批量获取 OKR
      * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/okr/batch_get
      */
-    batchGetOkr(query?: BatchGetOkrQuery): Promise<BatchGetOkrResponse>
-    /**
-     * 创建 OKR 进展记录
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create
-     */
-    createOkrProgressRecord(body: CreateOkrProgressRecordRequest, query?: CreateOkrProgressRecordQuery): Promise<CreateOkrProgressRecordResponse>
-    /**
-     * 删除 OKR 进展记录
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete
-     */
-    deleteOkrProgressRecord(progress_id: string): Promise<void>
-    /**
-     * 更新 OKR 进展记录
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update
-     */
-    updateOkrProgressRecord(progress_id: string, body: UpdateOkrProgressRecordRequest, query?: UpdateOkrProgressRecordQuery): Promise<UpdateOkrProgressRecordResponse>
-    /**
-     * 获取 OKR 进展记录
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get
-     */
-    getOkrProgressRecord(progress_id: string, query?: GetOkrProgressRecordQuery): Promise<GetOkrProgressRecordResponse>
-    /**
-     * 上传进展记录图片
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload
-     */
-    uploadOkrImage(form: UploadOkrImageForm): Promise<UploadOkrImageResponse>
-    /**
-     * 查询复盘信息
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query
-     */
-    queryOkrReview(query?: QueryOkrReviewQuery): Promise<QueryOkrReviewResponse>
+    batchGet(query?: BatchGetQuery): Promise<BatchGetResponse>
   }
-}
 
-export interface CreateOkrPeriodRequest {
-  /** 周期规则 id */
-  period_rule_id: string
-  /** 周期起始年月 */
-  start_month: string
-}
+  export interface BatchGetQuery {
+    /** 此次调用中使用的用户ID的类型 */
+    user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
+    /** OKR ID 列表，最多10个 */
+    okr_ids: string[]
+    /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn，请求 Query中 */
+    lang?: string
+  }
 
-export interface CreateOkrPeriodResponse {
-  /** 周期id */
-  period_id?: string
-  /** 周期起始年月 */
-  start_month?: string
-  /** 周期结束年月 */
-  end_month?: string
-}
+  export interface BatchGetResponse {
+    /** OKR 列表 */
+    okr_list?: Lark.OkrBatch[]
+  }
 
-export const enum PatchOkrPeriodRequestStatus {
-  /** 正常状态 */
-  NormalStatus = 1,
-  /** 标记失效 */
-  MarkInvalid = 2,
-  /** 隐藏周期 */
-  HiddenPeriod = 3,
-}
+  export namespace Period {
+    export interface Methods {
+      /**
+       * 创建 OKR 周期
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create
+       */
+      create(body: CreateRequest): Promise<CreateResponse>
+      /**
+       * 修改 OKR 周期状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch
+       */
+      patch(period_id: string, body: PatchRequest): Promise<PatchResponse>
+      /**
+       * 获取 OKR 周期列表
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list
+       */
+      list(query?: Pagination): Paginated<Lark.Period>
+    }
 
-export interface PatchOkrPeriodRequest {
-  /** 周期显示状态 */
-  status: PatchOkrPeriodRequestStatus
-}
+    export interface CreateRequest {
+      /** 周期规则 id */
+      period_rule_id: string
+      /** 周期起始年月 */
+      start_month: string
+    }
 
-export const enum PatchOkrPeriodResponseStatus {
-  /** 正常状态 */
-  NormalStatus = 1,
-  /** 标记失效 */
-  MarkInvalid = 2,
-  /** 隐藏周期 */
-  HiddenPeriod = 3,
-}
+    export interface CreateResponse {
+      /** 周期id */
+      period_id?: string
+      /** 周期起始年月 */
+      start_month?: string
+      /** 周期结束年月 */
+      end_month?: string
+    }
 
-export interface PatchOkrPeriodResponse {
-  /** 周期规则id */
-  period_id?: string
-  /** 周期显示状态 */
-  status?: PatchOkrPeriodResponseStatus
-}
+    export const enum PatchRequestStatus {
+      /** 正常状态 */
+      NormalStatus = 1,
+      /** 标记失效 */
+      MarkInvalid = 2,
+      /** 隐藏周期 */
+      HiddenPeriod = 3,
+    }
 
-export interface ListOkrPeriodRuleResponse {
-  /** 指标库列表 */
-  period_rules?: PeriodRule[]
-}
+    export interface PatchRequest {
+      /** 周期显示状态 */
+      status: PatchRequestStatus
+    }
 
-export interface ListOkrUserOkrQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
-  /** 请求列表的偏移，offset>=0 */
-  offset: string
-  /** 列表长度，0-10 */
-  limit: string
-  /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn */
-  lang?: string
-  /** period_id列表，最多10个 */
-  period_ids?: string[]
-}
+    export const enum PatchResponseStatus {
+      /** 正常状态 */
+      NormalStatus = 1,
+      /** 标记失效 */
+      MarkInvalid = 2,
+      /** 隐藏周期 */
+      HiddenPeriod = 3,
+    }
 
-export interface ListOkrUserOkrResponse {
-  /** OKR周期总数 */
-  total?: number
-  /** OKR 列表 */
-  okr_list?: OkrBatch[]
-}
+    export interface PatchResponse {
+      /** 周期规则id */
+      period_id?: string
+      /** 周期显示状态 */
+      status?: PatchResponseStatus
+    }
+  }
 
-export interface BatchGetOkrQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
-  /** OKR ID 列表，最多10个 */
-  okr_ids: string[]
-  /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn，请求 Query中 */
-  lang?: string
-}
+  export namespace PeriodRule {
+    export interface Methods {
+      /**
+       * 获取 OKR 周期规则
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list
+       */
+      list(): Promise<ListResponse>
+    }
 
-export interface BatchGetOkrResponse {
-  /** OKR 列表 */
-  okr_list?: OkrBatch[]
-}
+    export interface ListResponse {
+      /** 指标库列表 */
+      period_rules?: Lark.PeriodRule[]
+    }
+  }
 
-export const enum CreateOkrProgressRecordRequestTargetType {
-  /** okr的O */
-  Objective = 2,
-  /** okr的KR */
-  KeyResult = 3,
-}
+  export namespace User {
+    export interface Methods {
+      okr: Okr.Methods
+    }
 
-export interface CreateOkrProgressRecordRequest {
-  /** 进展来源 */
-  source_title: string
-  /** 进展来源链接 */
-  source_url: string
-  /** 目标id，与target_type对应 */
-  target_id: string
-  /** 目标类型 */
-  target_type: CreateOkrProgressRecordRequestTargetType
-  /** 进展详情 富文本格式 */
-  content: ContentBlock
-  /** pc进展来源链接 */
-  source_url_pc?: string
-  /** mobile进展来源链接 */
-  source_url_mobile?: string
-}
+    export namespace Okr {
+      export interface Methods {
+        /**
+         * 获取用户的 OKR 列表
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list
+         */
+        list(user_id: string, query?: ListQuery): Promise<ListResponse>
+      }
 
-export interface CreateOkrProgressRecordQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+      export interface ListQuery {
+        /** 此次调用中使用的用户ID的类型 */
+        user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
+        /** 请求列表的偏移，offset>=0 */
+        offset: string
+        /** 列表长度，0-10 */
+        limit: string
+        /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn */
+        lang?: string
+        /** period_id列表，最多10个 */
+        period_ids?: string[]
+      }
 
-export interface CreateOkrProgressRecordResponse {
-  /** OKR 进展ID */
-  progress_id?: string
-  /** 进展更新时间 毫秒 */
-  modify_time?: string
-  /** 进展 对应的 Content 详细内容 */
-  content?: ContentBlock
-}
+      export interface ListResponse {
+        /** OKR周期总数 */
+        total?: number
+        /** OKR 列表 */
+        okr_list?: Lark.OkrBatch[]
+      }
+    }
+  }
 
-export interface UpdateOkrProgressRecordRequest {
-  /** 进展详情 富文本格式 */
-  content: ContentBlock
-}
+  export namespace ProgressRecord {
+    export interface Methods {
+      /**
+       * 创建 OKR 进展记录
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create
+       */
+      create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
+      /**
+       * 删除 OKR 进展记录
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete
+       */
+      delete(progress_id: string): Promise<void>
+      /**
+       * 更新 OKR 进展记录
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update
+       */
+      update(progress_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
+      /**
+       * 获取 OKR 进展记录
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get
+       */
+      get(progress_id: string, query?: GetQuery): Promise<GetResponse>
+    }
 
-export interface UpdateOkrProgressRecordQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export const enum CreateRequestTargetType {
+      /** okr的O */
+      Objective = 2,
+      /** okr的KR */
+      KeyResult = 3,
+    }
 
-export interface UpdateOkrProgressRecordResponse {
-  /** OKR 进展ID */
-  progress_id?: string
-  /** 进展更新时间 毫秒 */
-  modify_time?: string
-  /** 进展 对应的 Content 详细内容 */
-  content?: ContentBlock
-}
+    export interface CreateRequest {
+      /** 进展来源 */
+      source_title: string
+      /** 进展来源链接 */
+      source_url: string
+      /** 目标id，与target_type对应 */
+      target_id: string
+      /** 目标类型 */
+      target_type: CreateRequestTargetType
+      /** 进展详情 富文本格式 */
+      content: Lark.ContentBlock
+      /** pc进展来源链接 */
+      source_url_pc?: string
+      /** mobile进展来源链接 */
+      source_url_mobile?: string
+    }
 
-export interface GetOkrProgressRecordQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface CreateQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface GetOkrProgressRecordResponse {
-  /** OKR 进展ID */
-  progress_id?: string
-  /** 进展更新时间 毫秒 */
-  modify_time?: string
-  /** 进展 对应的 Content 详细内容 */
-  content?: ContentBlock
-}
+    export interface CreateResponse {
+      /** OKR 进展ID */
+      progress_id?: string
+      /** 进展更新时间 毫秒 */
+      modify_time?: string
+      /** 进展 对应的 Content 详细内容 */
+      content?: Lark.ContentBlock
+    }
 
-export const enum UploadOkrImageFormTargetType {
-  /** okr的O */
-  Objective = 2,
-  /** okr的KR */
-  KeyResult = 3,
-}
+    export interface UpdateRequest {
+      /** 进展详情 富文本格式 */
+      content: Lark.ContentBlock
+    }
 
-export interface UploadOkrImageForm {
-  /** 图片 */
-  data: Blob
-  /** 图片的目标ID */
-  target_id: string
-  /** 图片使用的目标类型 */
-  target_type: UploadOkrImageFormTargetType
-}
+    export interface UpdateQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface UploadOkrImageResponse {
-  /** 图片token */
-  file_token?: string
-  /** 图片下载链接 */
-  url?: string
-}
+    export interface UpdateResponse {
+      /** OKR 进展ID */
+      progress_id?: string
+      /** 进展更新时间 毫秒 */
+      modify_time?: string
+      /** 进展 对应的 Content 详细内容 */
+      content?: Lark.ContentBlock
+    }
 
-export interface QueryOkrReviewQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
-  /** 目标用户id列表，最多5个 */
-  user_ids: string[]
-  /** period_id列表，最多5个 */
-  period_ids: string[]
-}
+    export interface GetQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export interface GetResponse {
+      /** OKR 进展ID */
+      progress_id?: string
+      /** 进展更新时间 毫秒 */
+      modify_time?: string
+      /** 进展 对应的 Content 详细内容 */
+      content?: Lark.ContentBlock
+    }
+  }
 
-export interface QueryOkrReviewResponse {
-  /** OKR复盘 列表 */
-  review_list?: OkrReview[]
+  export namespace Image {
+    export interface Methods {
+      /**
+       * 上传进展记录图片
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload
+       */
+      upload(form: UploadForm): Promise<UploadResponse>
+    }
+
+    export const enum UploadFormTargetType {
+      /** okr的O */
+      Objective = 2,
+      /** okr的KR */
+      KeyResult = 3,
+    }
+
+    export interface UploadForm {
+      /** 图片 */
+      data: Blob
+      /** 图片的目标ID */
+      target_id: string
+      /** 图片使用的目标类型 */
+      target_type: UploadFormTargetType
+    }
+
+    export interface UploadResponse {
+      /** 图片token */
+      file_token?: string
+      /** 图片下载链接 */
+      url?: string
+    }
+  }
+
+  export namespace Review {
+    export interface Methods {
+      /**
+       * 查询复盘信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query
+       */
+      query(query?: QueryQuery): Promise<QueryResponse>
+    }
+
+    export interface QueryQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
+      /** 目标用户id列表，最多5个 */
+      user_ids: string[]
+      /** period_id列表，最多5个 */
+      period_ids: string[]
+    }
+
+    export interface QueryResponse {
+      /** OKR复盘 列表 */
+      review_list?: Lark.OkrReview[]
+    }
+  }
 }
 
 Internal.define({
   '/okr/v1/periods': {
-    POST: 'createOkrPeriod',
-    GET: { name: 'listOkrPeriod', pagination: { argIndex: 0 } },
+    POST: 'okr.period.create',
+    GET: { name: 'okr.period.list', pagination: { argIndex: 0 } },
   },
   '/okr/v1/periods/{period_id}': {
-    PATCH: 'patchOkrPeriod',
+    PATCH: 'okr.period.patch',
   },
   '/okr/v1/period_rules': {
-    GET: 'listOkrPeriodRule',
+    GET: 'okr.periodRule.list',
   },
   '/okr/v1/users/{user_id}/okrs': {
-    GET: 'listOkrUserOkr',
+    GET: 'okr.user.okr.list',
   },
   '/okr/v1/okrs/batch_get': {
-    GET: 'batchGetOkr',
+    GET: 'okr.batchGet',
   },
   '/okr/v1/progress_records': {
-    POST: 'createOkrProgressRecord',
+    POST: 'okr.progressRecord.create',
   },
   '/okr/v1/progress_records/{progress_id}': {
-    DELETE: 'deleteOkrProgressRecord',
-    PUT: 'updateOkrProgressRecord',
-    GET: 'getOkrProgressRecord',
+    DELETE: 'okr.progressRecord.delete',
+    PUT: 'okr.progressRecord.update',
+    GET: 'okr.progressRecord.get',
   },
   '/okr/v1/images/upload': {
-    POST: { name: 'uploadOkrImage', multipart: true },
+    POST: { name: 'okr.image.upload', multipart: true },
   },
   '/okr/v1/reviews/query': {
-    GET: 'queryOkrReview',
+    GET: 'okr.review.query',
   },
 })

package/src/types/optical_char_recognition.ts

@@ -2,26 +2,38 @@ import { Internal } from '../internal'
 
 declare module '../internal' {
   interface Internal {
-    /**
-     * 识别图片中的文字
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize
-     */
-    basicRecognizeOpticalCharRecognitionImage(body: BasicRecognizeOpticalCharRecognitionImageRequest): Promise<BasicRecognizeOpticalCharRecognitionImageResponse>
+    opticalCharRecognition: OpticalCharRecognition.Methods
   }
 }
 
-export interface BasicRecognizeOpticalCharRecognitionImageRequest {
-  /** base64 后的图片数据 */
-  image?: string
-}
+export namespace OpticalCharRecognition {
+  export interface Methods {
+    image: Image.Methods
+  }
+
+  export namespace Image {
+    export interface Methods {
+      /**
+       * 识别图片中的文字
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize
+       */
+      basicRecognize(body: BasicRecognizeRequest): Promise<BasicRecognizeResponse>
+    }
 
-export interface BasicRecognizeOpticalCharRecognitionImageResponse {
-  /** 按区域识别，返回文本列表 */
-  text_list: string[]
+    export interface BasicRecognizeRequest {
+      /** base64 后的图片数据 */
+      image?: string
+    }
+
+    export interface BasicRecognizeResponse {
+      /** 按区域识别，返回文本列表 */
+      text_list: string[]
+    }
+  }
 }
 
 Internal.define({
   '/optical_char_recognition/v1/image/basic_recognize': {
-    POST: 'basicRecognizeOpticalCharRecognitionImage',
+    POST: 'opticalCharRecognition.image.basicRecognize',
   },
 })