@satorijs/adapter-lark 3.10.6 → 3.11.0

package/src/types/personal_settings.ts

@@ -1,116 +1,128 @@
-import { SystemStatus, SystemStatusI18nName, SystemStatusSyncSetting, SystemStatusUserCloseResultEntity, SystemStatusUserOpenParam, SystemStatusUserOpenResultEntity } from '.'
-import { Internal } 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/personal_settings-v1/system_status/create
-     */
-    createPersonalSettingsSystemStatus(body: CreatePersonalSettingsSystemStatusRequest): Promise<CreatePersonalSettingsSystemStatusResponse>
-    /**
-     * 删除系统状态
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete
-     */
-    deletePersonalSettingsSystemStatus(system_status_id: string): Promise<void>
-    /**
-     * 修改系统状态
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch
-     */
-    patchPersonalSettingsSystemStatus(system_status_id: string, body: PatchPersonalSettingsSystemStatusRequest): Promise<PatchPersonalSettingsSystemStatusResponse>
-    /**
-     * 获取系统状态
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list
-     */
-    listPersonalSettingsSystemStatus(query?: Pagination): Paginated<SystemStatus>
-    /**
-     * 批量开启系统状态
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open
-     */
-    batchOpenPersonalSettingsSystemStatus(system_status_id: string, body: BatchOpenPersonalSettingsSystemStatusRequest, query?: BatchOpenPersonalSettingsSystemStatusQuery): Promise<BatchOpenPersonalSettingsSystemStatusResponse>
-    /**
-     * 批量关闭系统状态
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close
-     */
-    batchClosePersonalSettingsSystemStatus(system_status_id: string, body: BatchClosePersonalSettingsSystemStatusRequest, query?: BatchClosePersonalSettingsSystemStatusQuery): Promise<BatchClosePersonalSettingsSystemStatusResponse>
+    personalSettings: PersonalSettings.Methods
   }
 }
 
-export interface CreatePersonalSettingsSystemStatusRequest {
-  /** 系统状态名称，名称字符数要在1到20范围内。 */
-  title: string
-  /** 系统状态国际化名称，名称字符数要在1到20范围内。 */
-  i18n_title?: SystemStatusI18nName
-  /** 图标 */
-  icon_key: 'GeneralDoNotDisturb' | 'GeneralInMeetingBusy' | 'Coffee' | 'GeneralBusinessTrip' | 'GeneralWorkFromHome' | 'StatusEnjoyLife' | 'GeneralTravellingCar' | 'StatusBus' | 'StatusInFlight' | 'Typing' | 'EatingFood' | 'SICK' | 'GeneralSun' | 'GeneralMoonRest' | 'StatusReading' | 'Status_PrivateMessage' | 'StatusFlashOfInspiration' | 'GeneralVacation'
-  /** 颜色 */
-  color?: 'BLUE' | 'GRAY' | 'INDIGO' | 'WATHET' | 'GREEN' | 'TURQUOISE' | 'YELLOW' | 'LIME' | 'RED' | 'ORANGE' | 'PURPLE' | 'VIOLET' | 'CARMINE'
-  /** 优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。 */
-  priority?: number
-  /** 同步设置 */
-  sync_setting?: SystemStatusSyncSetting
-}
+export namespace PersonalSettings {
+  export interface Methods {
+    systemStatus: SystemStatus.Methods
+  }
 
-export interface CreatePersonalSettingsSystemStatusResponse {
-  /** 系统状态 */
-  system_status?: SystemStatus
-}
+  export namespace SystemStatus {
+    export interface Methods {
+      /**
+       * 创建系统状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/create
+       */
+      create(body: CreateRequest): Promise<CreateResponse>
+      /**
+       * 删除系统状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/delete
+       */
+      delete(system_status_id: string): Promise<void>
+      /**
+       * 修改系统状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/patch
+       */
+      patch(system_status_id: string, body: PatchRequest): Promise<PatchResponse>
+      /**
+       * 获取系统状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/list
+       */
+      list(query?: Pagination): Paginated<Lark.SystemStatus>
+      /**
+       * 批量开启系统状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_open
+       */
+      batchOpen(system_status_id: string, body: BatchOpenRequest, query?: BatchOpenQuery): Promise<BatchOpenResponse>
+      /**
+       * 批量关闭系统状态
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/personal_settings-v1/system_status/batch_close
+       */
+      batchClose(system_status_id: string, body: BatchCloseRequest, query?: BatchCloseQuery): Promise<BatchCloseResponse>
+    }
 
-export interface PatchPersonalSettingsSystemStatusRequest {
-  /** 系统状态 */
-  system_status: SystemStatus
-  /** 需要更新的字段 */
-  update_fields: ('TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING')[]
-}
+    export interface CreateRequest {
+      /** 系统状态名称，名称字符数要在1到20范围内。 */
+      title: string
+      /** 系统状态国际化名称，名称字符数要在1到20范围内。 */
+      i18n_title?: Lark.SystemStatusI18nName
+      /** 图标 */
+      icon_key: 'GeneralDoNotDisturb' | 'GeneralInMeetingBusy' | 'Coffee' | 'GeneralBusinessTrip' | 'GeneralWorkFromHome' | 'StatusEnjoyLife' | 'GeneralTravellingCar' | 'StatusBus' | 'StatusInFlight' | 'Typing' | 'EatingFood' | 'SICK' | 'GeneralSun' | 'GeneralMoonRest' | 'StatusReading' | 'Status_PrivateMessage' | 'StatusFlashOfInspiration' | 'GeneralVacation'
+      /** 颜色 */
+      color?: 'BLUE' | 'GRAY' | 'INDIGO' | 'WATHET' | 'GREEN' | 'TURQUOISE' | 'YELLOW' | 'LIME' | 'RED' | 'ORANGE' | 'PURPLE' | 'VIOLET' | 'CARMINE'
+      /** 优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。 */
+      priority?: number
+      /** 同步设置 */
+      sync_setting?: Lark.SystemStatusSyncSetting
+    }
 
-export interface PatchPersonalSettingsSystemStatusResponse {
-  /** 系统状态 */
-  system_status?: SystemStatus
-}
+    export interface CreateResponse {
+      /** 系统状态 */
+      system_status?: Lark.SystemStatus
+    }
 
-export interface BatchOpenPersonalSettingsSystemStatusRequest {
-  /** 开启列表 */
-  user_list: SystemStatusUserOpenParam[]
-}
+    export interface PatchRequest {
+      /** 系统状态 */
+      system_status: Lark.SystemStatus
+      /** 需要更新的字段 */
+      update_fields: ('TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING')[]
+    }
 
-export interface BatchOpenPersonalSettingsSystemStatusQuery {
-  /** 用户id类型 open_id/user_id/union_id */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface PatchResponse {
+      /** 系统状态 */
+      system_status?: Lark.SystemStatus
+    }
 
-export interface BatchOpenPersonalSettingsSystemStatusResponse {
-  /** 开启结果 */
-  result_list: SystemStatusUserOpenResultEntity[]
-}
+    export interface BatchOpenRequest {
+      /** 开启列表 */
+      user_list: Lark.SystemStatusUserOpenParam[]
+    }
 
-export interface BatchClosePersonalSettingsSystemStatusRequest {
-  /** 成员列表 */
-  user_list: string[]
-}
+    export interface BatchOpenQuery {
+      /** 用户id类型 open_id/user_id/union_id */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface BatchClosePersonalSettingsSystemStatusQuery {
-  /** 用户id类型 open_id/user_id/union_id */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface BatchOpenResponse {
+      /** 开启结果 */
+      result_list: Lark.SystemStatusUserOpenResultEntity[]
+    }
 
-export interface BatchClosePersonalSettingsSystemStatusResponse {
-  /** 关闭结果 */
-  result_list: SystemStatusUserCloseResultEntity[]
+    export interface BatchCloseRequest {
+      /** 成员列表 */
+      user_list: string[]
+    }
+
+    export interface BatchCloseQuery {
+      /** 用户id类型 open_id/user_id/union_id */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export interface BatchCloseResponse {
+      /** 关闭结果 */
+      result_list: Lark.SystemStatusUserCloseResultEntity[]
+    }
+  }
 }
 
 Internal.define({
   '/personal_settings/v1/system_statuses': {
-    POST: 'createPersonalSettingsSystemStatus',
-    GET: { name: 'listPersonalSettingsSystemStatus', pagination: { argIndex: 0 } },
+    POST: 'personalSettings.systemStatus.create',
+    GET: { name: 'personalSettings.systemStatus.list', pagination: { argIndex: 0 } },
   },
   '/personal_settings/v1/system_statuses/{system_status_id}': {
-    DELETE: 'deletePersonalSettingsSystemStatus',
-    PATCH: 'patchPersonalSettingsSystemStatus',
+    DELETE: 'personalSettings.systemStatus.delete',
+    PATCH: 'personalSettings.systemStatus.patch',
   },
   '/personal_settings/v1/system_statuses/{system_status_id}/batch_open': {
-    POST: 'batchOpenPersonalSettingsSystemStatus',
+    POST: 'personalSettings.systemStatus.batchOpen',
   },
   '/personal_settings/v1/system_statuses/{system_status_id}/batch_close': {
-    POST: 'batchClosePersonalSettingsSystemStatus',
+    POST: 'personalSettings.systemStatus.batchClose',
   },
 })

package/src/types/report.ts

@@ -1,84 +1,108 @@
-import { Rule, Task } from '.'
-import { Internal } from '../internal'
+import * as Lark from '.'
+import { Internal, Paginated } from '../internal'
 
 declare module '../internal' {
   interface Internal {
-    /**
-     * 查询规则
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query
-     */
-    queryReportRule(query?: QueryReportRuleQuery): Promise<QueryReportRuleResponse>
-    /**
-     * 移除规则看板
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove
-     */
-    removeReportRuleView(rule_id: string, body: RemoveReportRuleViewRequest, query?: RemoveReportRuleViewQuery): Promise<void>
-    /**
-     * 查询任务
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query
-     */
-    queryReportTask(body: QueryReportTaskRequest, query?: QueryReportTaskQuery): Paginated<Task>
+    report: Report.Methods
   }
 }
 
-export const enum QueryReportRuleQueryIncludeDeleted {
-  /** 不包括已删除 */
-  Exclude = 0,
-  /** 包括已删除 */
-  Include = 1,
-}
+export namespace Report {
+  export interface Methods {
+    rule: Rule.Methods
+    task: Task.Methods
+  }
 
-export interface QueryReportRuleQuery {
-  /** 规则名称 */
-  rule_name: string
-  /** 是否包括已删除，默认未删除 */
-  include_deleted?: QueryReportRuleQueryIncludeDeleted
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+  export namespace Rule {
+    export interface Methods {
+      view: View.Methods
+      /**
+       * 查询规则
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule/query
+       */
+      query(query?: QueryQuery): Promise<QueryResponse>
+    }
 
-export interface QueryReportRuleResponse {
-  /** 规则列表 */
-  rules?: Rule[]
-}
+    export const enum QueryQueryIncludeDeleted {
+      /** 不包括已删除 */
+      Exclude = 0,
+      /** 包括已删除 */
+      Include = 1,
+    }
 
-export interface RemoveReportRuleViewRequest {
-  /** 列表为空删除规则下全用户视图，列表不为空删除指定用户视图，大小限制200。 */
-  user_ids?: string[]
-}
+    export interface QueryQuery {
+      /** 规则名称 */
+      rule_name: string
+      /** 是否包括已删除，默认未删除 */
+      include_deleted?: QueryQueryIncludeDeleted
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
 
-export interface RemoveReportRuleViewQuery {
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
-}
+    export interface QueryResponse {
+      /** 规则列表 */
+      rules?: Lark.Rule[]
+    }
 
-export interface QueryReportTaskRequest {
-  /** 提交开始时间时间戳 */
-  commit_start_time: number
-  /** 提交结束时间时间戳 */
-  commit_end_time: number
-  /** 汇报规则ID */
-  rule_id?: string
-  /** 用户ID */
-  user_id?: string
-  /** 分页标识符 */
-  page_token: string
-  /** 单次分页返回的条数 */
-  page_size: number
-}
+    export namespace View {
+      export interface Methods {
+        /**
+         * 移除规则看板
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/rule-view/remove
+         */
+        remove(rule_id: string, body: RemoveRequest, query?: RemoveQuery): Promise<void>
+      }
 
-export interface QueryReportTaskQuery {
-  /** 此次调用中使用的用户ID的类型 */
-  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+      export interface RemoveRequest {
+        /** 列表为空删除规则下全用户视图，列表不为空删除指定用户视图，大小限制200。 */
+        user_ids?: string[]
+      }
+
+      export interface RemoveQuery {
+        user_id_type?: 'user_id' | 'union_id' | 'open_id'
+      }
+    }
+  }
+
+  export namespace Task {
+    export interface Methods {
+      /**
+       * 查询任务
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/report/report-v1/task/query
+       */
+      query(body: QueryRequest, query?: QueryQuery): Paginated<Lark.Task>
+    }
+
+    export interface QueryRequest {
+      /** 提交开始时间时间戳 */
+      commit_start_time: number
+      /** 提交结束时间时间戳 */
+      commit_end_time: number
+      /** 汇报规则ID */
+      rule_id?: string
+      /** 用户ID */
+      user_id?: string
+      /** 分页标识符 */
+      page_token: string
+      /** 单次分页返回的条数 */
+      page_size: number
+    }
+
+    export interface QueryQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+  }
 }
 
 Internal.define({
   '/report/v1/rules/query': {
-    GET: 'queryReportRule',
+    GET: 'report.rule.query',
   },
   '/report/v1/rules/{rule_id}/views/remove': {
-    POST: 'removeReportRuleView',
+    POST: 'report.rule.view.remove',
   },
   '/report/v1/tasks/query': {
-    POST: 'queryReportTask',
+    POST: 'report.task.query',
   },
 })