@satorijs/adapter-lark 3.9.1 → 3.9.2

package/lib/types/approval.d.ts

@@ -179,6 +179,12 @@ export interface CreateApprovalQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface CreateApprovalResponse {
+    /** 审批定义 Code */
+    approval_code?: string;
+    /** 审批定义 id */
+    approval_id?: string;
+}
 export interface GetApprovalQuery {
     /** 语言可选值 */
     locale?: 'zh-CN' | 'en-US' | 'ja-JP';
@@ -187,6 +193,28 @@ export interface GetApprovalQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface GetApprovalResponse {
+    /** 审批名称 */
+    approval_name: string;
+    /** 审批定义状态 */
+    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'UNKNOWN';
+    /** 控件信息 */
+    form: string;
+    /** 节点信息 */
+    node_list: ApprovalNodeInfo[];
+    /** 可见人列表 */
+    viewers: ApprovalViewerInfo[];
+    /** 有数据管理权限的审批流程管理员ID */
+    approval_admin_ids?: string[];
+    /** 组件之间值关联关系 */
+    form_widget_relation?: string;
+}
+export declare const enum CreateApprovalInstanceRequestTitleDisplayMethod {
+    /** 如果都有title，展示approval 和instance的title，竖线分割。 */
+    DisplayAll = 0,
+    /** 如果都有title，只展示instance的title */
+    DisplayInstanceTitle = 1
+}
 export interface CreateApprovalInstanceRequest {
     /** 审批定义 code */
     approval_code: string;
@@ -221,10 +249,14 @@ export interface CreateApprovalInstanceRequest {
     /** 审批展示名称，如果填写了该字段，则审批列表中的审批名称使用该字段，如果不填该字段，则审批名称使用审批定义的名称 */
     title?: string;
     /** 详情页title展示模式 */
-    title_display_method?: 0 | 1;
+    title_display_method?: CreateApprovalInstanceRequestTitleDisplayMethod;
     /** 自动通过节点ID */
     node_auto_approval_list?: NodeAutoApproval[];
 }
+export interface CreateApprovalInstanceResponse {
+    /** 审批实例 Code */
+    instance_code: string;
+}
 export interface CancelApprovalInstanceRequest {
     /** 审批定义Code */
     approval_code: string;
@@ -273,6 +305,10 @@ export interface PreviewApprovalInstanceQuery {
     /** open_id(ou_开头)，union_id(on_开头)，user_id(字符串)。user_id_type不填默认为open_id */
     user_id_type?: 'open_id' | 'user_id' | 'union_id';
 }
+export interface PreviewApprovalInstanceResponse {
+    /** 预览节点信息 */
+    preview_nodes?: PreviewNode[];
+}
 export interface GetApprovalInstanceQuery {
     /** 语言 */
     locale?: 'zh-CN' | 'en-US' | 'ja-JP';
@@ -281,6 +317,44 @@ export interface GetApprovalInstanceQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'open_id' | 'union_id';
 }
+export interface GetApprovalInstanceResponse {
+    /** 审批名称 */
+    approval_name: string;
+    /** 审批创建时间 */
+    start_time?: string;
+    /** 审批完成时间，未完成为 0 */
+    end_time: string;
+    /** 发起审批用户 */
+    user_id: string;
+    /** 发起审批用户 open id */
+    open_id: string;
+    /** 审批单编号 */
+    serial_number: string;
+    /** 发起审批用户所在部门 */
+    department_id: string;
+    /** 审批实例状态 */
+    status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED';
+    /** 用户的唯一标识id */
+    uuid: string;
+    /** json字符串，控件值 */
+    form: string;
+    /** 审批任务列表 */
+    task_list: InstanceTask[];
+    /** 评论列表 */
+    comment_list: InstanceComment[];
+    /** 审批动态 */
+    timeline: InstanceTimeline[];
+    /** 修改的原实例 code,仅在查询修改实例时显示该字段 */
+    modified_instance_code?: string;
+    /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */
+    reverted_instance_code?: string;
+    /** 审批定义 Code */
+    approval_code: string;
+    /** 单据是否被撤销 */
+    reverted?: boolean;
+    /** 审批实例 Code */
+    instance_code: string;
+}
 export interface ListApprovalInstanceQuery extends Pagination {
     /** 审批定义唯一标识 */
     approval_code: string;
@@ -359,6 +433,22 @@ export interface SpecifiedRollbackApprovalInstanceQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export declare const enum AddSignApprovalInstanceRequestAddSignType {
+    /** 前加签 */
+    AddSignPre = 1,
+    /** 后加签 */
+    AddSignPost = 2,
+    /** 并加签 */
+    AddSignParallel = 3
+}
+export declare const enum AddSignApprovalInstanceRequestApprovalMethod {
+    /** 或签 */
+    OrSign = 1,
+    /** 会签 */
+    AddSign = 2,
+    /** 依次审批 */
+    SequentialSign = 3
+}
 export interface AddSignApprovalInstanceRequest {
     /** 操作用户id */
     user_id: string;
@@ -373,9 +463,9 @@ export interface AddSignApprovalInstanceRequest {
     /** 被加签人id */
     add_sign_user_ids: string[];
     /** 1/2/3分别代表前加签/后加签/并加签 */
-    add_sign_type: 1 | 2 | 3;
+    add_sign_type: AddSignApprovalInstanceRequestAddSignType;
     /** 仅在前加签、后加签时需要填写，1/2 分别代表或签/会签 */
-    approval_method?: 1 | 2 | 3;
+    approval_method?: AddSignApprovalInstanceRequestApprovalMethod;
 }
 export interface ResubmitApprovalTaskRequest {
     /** 审批定义 Code */
@@ -415,24 +505,42 @@ export interface CreateApprovalInstanceCommentQuery {
     /** 用户ID */
     user_id: string;
 }
+export interface CreateApprovalInstanceCommentResponse {
+    /** 保存成功的comment_id */
+    comment_id: string;
+}
 export interface DeleteApprovalInstanceCommentQuery {
     /** 用户ID类型，不填默认为open_id */
     user_id_type?: 'open_id' | 'user_id' | 'union_id';
     /** 根据user_id_type填写用户ID */
     user_id: string;
 }
+export interface DeleteApprovalInstanceCommentResponse {
+    /** 删除的评论ID */
+    comment_id?: string;
+}
 export interface RemoveApprovalInstanceCommentQuery {
     /** 用户ID类型，不填默认为open_id */
     user_id_type?: 'open_id' | 'user_id' | 'union_id';
     /** 根据user_id_type填写用户ID */
     user_id?: string;
 }
+export interface RemoveApprovalInstanceCommentResponse {
+    /** 审批实例code */
+    instance_id?: string;
+    /** 租户自定义审批实例ID */
+    external_id?: string;
+}
 export interface ListApprovalInstanceCommentQuery extends Pagination {
     /** 用户ID类型，不填默认为open_id */
     user_id_type?: 'open_id' | 'user_id' | 'union_id';
     /** 用户ID */
     user_id: string;
 }
+export interface ListApprovalInstanceCommentResponse {
+    /** 评论数据列表 */
+    comments: Comment[];
+}
 export interface CreateApprovalExternalApprovalRequest {
     /** 审批定义名称，创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段。 */
     approval_name: string;
@@ -459,10 +567,34 @@ export interface CreateApprovalExternalApprovalQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface CreateApprovalExternalApprovalResponse {
+    /** 审批定义 code，用户自定义，定义的唯一标识 */
+    approval_code: string;
+}
 export interface GetApprovalExternalApprovalQuery {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface GetApprovalExternalApprovalResponse {
+    /** 审批定义名称 */
+    approval_name: string;
+    /** 审批定义code */
+    approval_code: string;
+    /** 审批定义所属分组 */
+    group_code: string;
+    /** 分组名称 */
+    group_name?: string;
+    /** 审批定义的说明 */
+    description?: string;
+    /** 三方审批定义相关 */
+    external?: ApprovalCreateExternal;
+    /** 可见人列表 */
+    viewers?: ApprovalCreateViewers[];
+    /** 国际化文案 */
+    i18n_resources?: I18nResource[];
+    /** 流程管理员 */
+    managers?: string[];
+}
 export interface CreateApprovalExternalInstanceRequest {
     /** 审批定义 code， 创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段 */
     approval_code: string;
@@ -515,10 +647,18 @@ export interface CreateApprovalExternalInstanceRequest {
     /** 资源所在地区， 内部统计用字段， 不需要填 */
     resource_region?: string;
 }
+export interface CreateApprovalExternalInstanceResponse {
+    /** 同步的实例数据 */
+    data?: ExternalInstance;
+}
 export interface CheckApprovalExternalInstanceRequest {
     /** 校验的实例信息 */
     instances: ExteranlInstanceCheck[];
 }
+export interface CheckApprovalExternalInstanceResponse {
+    /** 更新时间不一致的实例信息 */
+    diff_instances?: ExteranlInstanceCheckResponse[];
+}
 export interface ListApprovalExternalTaskRequest {
     /** 审批定义 Code，用于指定只获取这些定义下的数据 */
     approval_codes?: string[];
@@ -555,6 +695,16 @@ export interface QueryApprovalInstanceQuery extends Pagination {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface QueryApprovalInstanceResponse {
+    /** 查询返回条数 */
+    count?: number;
+    /** 审批实例列表 */
+    instance_list?: InstanceSearchItem[];
+    /** 翻页 Token */
+    page_token?: string;
+    /** 是否有更多任务可供拉取 */
+    has_more?: boolean;
+}
 export interface SearchCcApprovalInstanceRequest {
     /** 根据x_user_type填写用户 id */
     user_id?: string;
@@ -581,6 +731,26 @@ export interface SearchCcApprovalInstanceQuery extends Pagination {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
+export interface SearchCcApprovalInstanceResponse {
+    /** 查询返回条数 */
+    count?: number;
+    /** 审批实例列表 */
+    cc_list?: CcSearchItem[];
+    /** 翻页 Token */
+    page_token?: string;
+    /** 是否有更多任务可供拉取 */
+    has_more?: boolean;
+}
+export declare const enum SearchApprovalTaskRequestOrder {
+    /** 按update_time倒排 */
+    UpdateTimeDESC = 0,
+    /** 按update_time正排 */
+    UpdateTimeASC = 1,
+    /** 按start_time倒排 */
+    StartTimeDESC = 2,
+    /** 按start_time正排 */
+    StartTimeASC = 3
+}
 export interface SearchApprovalTaskRequest {
     /** 根据x_user_type填写用户 id */
     user_id?: string;
@@ -605,158 +775,12 @@ export interface SearchApprovalTaskRequest {
     /** 可选择task_status中的多个状态，当填写此参数时，task_status失效 */
     task_status_list?: string[];
     /** 按时间排序 */
-    order?: 0 | 1 | 2 | 3;
+    order?: SearchApprovalTaskRequestOrder;
 }
 export interface SearchApprovalTaskQuery extends Pagination {
     /** 此次调用中使用的用户ID的类型 */
     user_id_type?: 'user_id' | 'union_id' | 'open_id';
 }
-export interface QueryApprovalTaskQuery extends Pagination {
-    /** 需要查询的 User ID */
-    user_id: string;
-    /** 需要查询的任务分组主题，如「待办」、「已办」等 */
-    topic: '1' | '2' | '3' | '17' | '18';
-    /** 此次调用中使用的用户ID的类型 */
-    user_id_type?: 'user_id' | 'union_id' | 'open_id';
-}
-export interface CreateApprovalResponse {
-    /** 审批定义 Code */
-    approval_code?: string;
-    /** 审批定义 id */
-    approval_id?: string;
-}
-export interface GetApprovalResponse {
-    /** 审批名称 */
-    approval_name: string;
-    /** 审批定义状态 */
-    status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'UNKNOWN';
-    /** 控件信息 */
-    form: string;
-    /** 节点信息 */
-    node_list: ApprovalNodeInfo[];
-    /** 可见人列表 */
-    viewers: ApprovalViewerInfo[];
-    /** 有数据管理权限的审批流程管理员ID */
-    approval_admin_ids?: string[];
-    /** 组件之间值关联关系 */
-    form_widget_relation?: string;
-}
-export interface CreateApprovalInstanceResponse {
-    /** 审批实例 Code */
-    instance_code: string;
-}
-export interface PreviewApprovalInstanceResponse {
-    /** 预览节点信息 */
-    preview_nodes?: PreviewNode[];
-}
-export interface GetApprovalInstanceResponse {
-    /** 审批名称 */
-    approval_name: string;
-    /** 审批创建时间 */
-    start_time?: string;
-    /** 审批完成时间，未完成为 0 */
-    end_time: string;
-    /** 发起审批用户 */
-    user_id: string;
-    /** 发起审批用户 open id */
-    open_id: string;
-    /** 审批单编号 */
-    serial_number: string;
-    /** 发起审批用户所在部门 */
-    department_id: string;
-    /** 审批实例状态 */
-    status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED';
-    /** 用户的唯一标识id */
-    uuid: string;
-    /** json字符串，控件值 */
-    form: string;
-    /** 审批任务列表 */
-    task_list: InstanceTask[];
-    /** 评论列表 */
-    comment_list: InstanceComment[];
-    /** 审批动态 */
-    timeline: InstanceTimeline[];
-    /** 修改的原实例 code,仅在查询修改实例时显示该字段 */
-    modified_instance_code?: string;
-    /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */
-    reverted_instance_code?: string;
-    /** 审批定义 Code */
-    approval_code: string;
-    /** 单据是否被撤销 */
-    reverted?: boolean;
-    /** 审批实例 Code */
-    instance_code: string;
-}
-export interface CreateApprovalInstanceCommentResponse {
-    /** 保存成功的comment_id */
-    comment_id: string;
-}
-export interface DeleteApprovalInstanceCommentResponse {
-    /** 删除的评论ID */
-    comment_id?: string;
-}
-export interface RemoveApprovalInstanceCommentResponse {
-    /** 审批实例code */
-    instance_id?: string;
-    /** 租户自定义审批实例ID */
-    external_id?: string;
-}
-export interface ListApprovalInstanceCommentResponse {
-    /** 评论数据列表 */
-    comments: Comment[];
-}
-export interface CreateApprovalExternalApprovalResponse {
-    /** 审批定义 code，用户自定义，定义的唯一标识 */
-    approval_code: string;
-}
-export interface GetApprovalExternalApprovalResponse {
-    /** 审批定义名称 */
-    approval_name: string;
-    /** 审批定义code */
-    approval_code: string;
-    /** 审批定义所属分组 */
-    group_code: string;
-    /** 分组名称 */
-    group_name?: string;
-    /** 审批定义的说明 */
-    description?: string;
-    /** 三方审批定义相关 */
-    external?: ApprovalCreateExternal;
-    /** 可见人列表 */
-    viewers?: ApprovalCreateViewers[];
-    /** 国际化文案 */
-    i18n_resources?: I18nResource[];
-    /** 流程管理员 */
-    managers?: string[];
-}
-export interface CreateApprovalExternalInstanceResponse {
-    /** 同步的实例数据 */
-    data?: ExternalInstance;
-}
-export interface CheckApprovalExternalInstanceResponse {
-    /** 更新时间不一致的实例信息 */
-    diff_instances?: ExteranlInstanceCheckResponse[];
-}
-export interface QueryApprovalInstanceResponse {
-    /** 查询返回条数 */
-    count?: number;
-    /** 审批实例列表 */
-    instance_list?: InstanceSearchItem[];
-    /** 翻页 Token */
-    page_token?: string;
-    /** 是否有更多任务可供拉取 */
-    has_more?: boolean;
-}
-export interface SearchCcApprovalInstanceResponse {
-    /** 查询返回条数 */
-    count?: number;
-    /** 审批实例列表 */
-    cc_list?: CcSearchItem[];
-    /** 翻页 Token */
-    page_token?: string;
-    /** 是否有更多任务可供拉取 */
-    has_more?: boolean;
-}
 export interface SearchApprovalTaskResponse {
     /** 查询返回条数 */
     count?: number;
@@ -767,6 +791,14 @@ export interface SearchApprovalTaskResponse {
     /** 是否有更多任务可供拉取 */
     has_more?: boolean;
 }
+export interface QueryApprovalTaskQuery extends Pagination {
+    /** 需要查询的 User ID */
+    user_id: string;
+    /** 需要查询的任务分组主题，如「待办」、「已办」等 */
+    topic: '1' | '2' | '3' | '17' | '18';
+    /** 此次调用中使用的用户ID的类型 */
+    user_id_type?: 'user_id' | 'union_id' | 'open_id';
+}
 export interface QueryApprovalTaskResponse {
     /** 任务列表 */
     tasks: Task[];