@satorijs/adapter-dingtalk 1.0.0

package/lib/api/industry.d.ts

@@ -0,0 +1,117 @@
+export interface CampusGetCampusQuery {
+    /** 园区项目的部门ID。 */
+    campusDeptId: number;
+}
+export interface CampusGetCampusResponse {
+    campusName?: string;
+    campusCorpId?: string;
+    campusDeptId?: number;
+    belongProjectGroupId?: string;
+    telephone?: string;
+    description?: string;
+    area?: unknown;
+    country?: string;
+    provId?: number;
+    cityId?: number;
+    countyId?: number;
+    address?: string;
+    location?: string;
+    capacity?: string;
+    orderStartTime?: number;
+    orderEndTime?: number;
+    orderInfo?: string;
+    extend?: string;
+}
+export interface CampusGetCampusGroupQuery {
+    /** 项目组ID。 */
+    groupId: number;
+}
+export interface CampusGetCampusGroupResponse {
+    projectGroupName?: string;
+    extend?: string;
+}
+export interface CampusCreateCampusParams {
+    /** 园区项目的名称。 */
+    campusName: string;
+    /** 归属的项目组ID。 */
+    belongProjectGroupId?: number;
+    /** 联系电话。 */
+    telephone?: string;
+    /** 园区项目的描述。 */
+    description?: string;
+    /** 园区项目面积。 */
+    area?: unknown;
+    /** 园区所在国家。 */
+    country?: string;
+    /** 园区所在省行政编码。 */
+    provId?: number;
+    /** 园区所在市行政编码。 */
+    cityId?: number;
+    /** 园区所在区/县行政编码。 */
+    countyId?: number;
+    /** 园区所在详细地址信息。 */
+    address?: string;
+    /** 园区容量。 */
+    capacity?: number;
+    /** 项目订购开始时间戳，单位毫秒。 */
+    orderStartTime?: number;
+    /** 项目订购结束时间戳，单位毫秒。 */
+    orderEndTime?: number;
+    /** 订单信息。 */
+    orderInfo?: string;
+    /** 扩展字段。 */
+    extend?: string;
+    /** 创建人的unionId。 */
+    creatorUnionId: string;
+    /** 经纬度，格式为：经度,维度。 */
+    location?: string;
+}
+export interface CampusCreateCampusResponse {
+    campusCorpId?: string;
+    campusDeptId?: string;
+}
+export interface CampusCreateCampusGroupParams {
+    /** 项目组名称。 */
+    name: string;
+    /** 扩展信息。 */
+    extend?: string;
+}
+export interface CampusCreateCampusGroupResponse {
+    groupId?: number;
+}
+export interface CampusDeleteCampusGroupQuery {
+    /** 项目组ID。 */
+    campusProjectGroupId: number;
+}
+export interface CampusDeleteCampusGroupResponse {
+    success?: unknown;
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 查询园区项目详情
+         * @see https://developers.dingtalk.com/document/isvapp/query-a-project-in-a-specified-campus
+         */
+        campusGetCampus(query: CampusGetCampusQuery): Promise<CampusGetCampusResponse>;
+        /**
+         * 查询项目组信息
+         * @see https://developers.dingtalk.com/document/isvapp/query-a-project-group-in-the-specified-park
+         */
+        campusGetCampusGroup(query: CampusGetCampusGroupQuery): Promise<CampusGetCampusGroupResponse>;
+        /**
+         * 创建园区项目
+         * @see https://developers.dingtalk.com/document/isvapp/create-a-campus-project
+         */
+        campusCreateCampus(params: CampusCreateCampusParams): Promise<CampusCreateCampusResponse>;
+        /**
+         * 创建项目组
+         * @see https://developers.dingtalk.com/document/isvapp/create-a-project-group
+         */
+        campusCreateCampusGroup(params: CampusCreateCampusGroupParams): Promise<CampusCreateCampusGroupResponse>;
+        /**
+         * 删除项目组
+         * @see https://developers.dingtalk.com/document/isvapp/delete-a-project-group
+         */
+        campusDeleteCampusGroup(query: CampusDeleteCampusGroupQuery): Promise<CampusDeleteCampusGroupResponse>;
+    }
+}

package/lib/api/jzcrm.d.ts

@@ -0,0 +1,254 @@
+export interface EditContactParams {
+    /** 数据类型，固定值**197**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditContactResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditCustomerPoolParams {
+    /** 数据类型，固定值**238**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditCustomerPoolResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditExchangeParams {
+    /** 数据类型，固定值**228**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditExchangeResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditGoodsParams {
+    /** 数据类型，固定值**154**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditGoodsResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditOutstockParams {
+    /** 数据类型，固定值**191**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditOutstockResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditIntostockParams {
+    /** 数据类型，固定值**189**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditIntostockResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditProductionParams {
+    /** 数据类型，固定值**156**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditProductionResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditPurchaseParams {
+    /** 数据类型，固定值**153**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditPurchaseResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditOrderParams {
+    /** 数据类型，固定填写**150**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditOrderResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditInvoiceParams {
+    /** 数据类型，固定值**169**。 */
+    datatype: number;
+    /** 时间戳。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditInvoiceResponse {
+    time: string;
+    msgid: number;
+}
+export interface EditCustomerParams {
+    /** 数据类型，固定值**148**。 */
+    datatype: number;
+    /** 时间戳，单位：秒。 */
+    stamp: number;
+    /** 数据ID。 */
+    msgid?: number;
+    /** 编辑数据。 */
+    data?: unknown;
+}
+export interface EditCustomerResponse {
+    time: string;
+    msgid: number;
+}
+export interface GetDataViewQuery {
+    /** 数据类型。 */
+    datatype: string;
+    /** 数据ID。 */
+    msgid: number;
+}
+export interface GetDataViewResponse {
+    data: {
+        detail: number;
+    };
+    dataname: unknown;
+    time: string;
+}
+export interface GetDataListQuery {
+    /** 数据类型。 */
+    datatype: string;
+    /** 页码。 */
+    page: number;
+    /** 分页条数。 */
+    pagesize: number;
+}
+export interface GetDataListResponse {
+    data: {
+        detail: number;
+    }[];
+    dataname: unknown;
+    page: number;
+    pageSize: number;
+    totalCount: number;
+    time: string;
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 联系人
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-contacts
+         */
+        editContact(params: EditContactParams): Promise<EditContactResponse>;
+        /**
+         * 客户公共池
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-customer-public-pools
+         */
+        editCustomerPool(params: EditCustomerPoolParams): Promise<EditCustomerPoolResponse>;
+        /**
+         * 编辑销售换货单数据
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-a-sales-order
+         */
+        editExchange(params: EditExchangeParams): Promise<EditExchangeResponse>;
+        /**
+         * 编辑产品数据
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-product-information
+         */
+        editGoods(params: EditGoodsParams): Promise<EditGoodsResponse>;
+        /**
+         * 编辑出库单信息
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-an-issue-ticket
+         */
+        editOutstock(params: EditOutstockParams): Promise<EditOutstockResponse>;
+        /**
+         * 编辑入库单数据
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-a-shipment-record
+         */
+        editIntostock(params: EditIntostockParams): Promise<EditIntostockResponse>;
+        /**
+         * 生产单
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-a-production-order
+         */
+        editProduction(params: EditProductionParams): Promise<EditProductionResponse>;
+        /**
+         * 采购单
+         * @see https://developers.dingtalk.com/document/isvapp/edit-purchase-order
+         */
+        editPurchase(params: EditPurchaseParams): Promise<EditPurchaseResponse>;
+        /**
+         * 合同订单
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-contract-orders
+         */
+        editOrder(params: EditOrderParams): Promise<EditOrderResponse>;
+        /**
+         * 发货单
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-invoices
+         */
+        editInvoice(params: EditInvoiceParams): Promise<EditInvoiceResponse>;
+        /**
+         * 客户资料
+         * @see https://developers.dingtalk.com/document/isvapp/add-or-edit-customer-profile
+         */
+        editCustomer(params: EditCustomerParams): Promise<EditCustomerResponse>;
+        /**
+         * 获取数据详情
+         * @see https://developers.dingtalk.com/document/isvapp/queries-data-details
+         */
+        getDataView(query: GetDataViewQuery): Promise<GetDataViewResponse>;
+        /**
+         * 获取数据列表
+         * @see https://developers.dingtalk.com/document/isvapp/obtain-the-data-list
+         */
+        getDataList(query: GetDataListQuery): Promise<GetDataListResponse>;
+    }
+}

package/lib/api/link.d.ts

@@ -0,0 +1,72 @@
+export interface GetUserFollowStatusQuery {
+    /** 待查询的服务窗关注者userId。 */
+    userId?: string;
+    /** 待查询的服务窗关注者unionId。 */
+    unionId?: string;
+    /** 服务窗帐号ID，可通过[服务窗帐号信息查询](https://open.dingtalk.com/document/orgapp/queries-the-list-of-services-under-an-enterprise)接口，获取返回参数`accountId`字段值。 */
+    accountId?: string;
+}
+export interface GetUserFollowStatusResponse {
+    result: {
+        status?: string;
+    };
+}
+export interface ListAccountResponse {
+    result?: {
+        accountId?: string;
+        accountName?: string;
+    }[];
+}
+export interface ListFollowerQuery {
+    /** 分页游标。 */
+    nextToken?: string;
+    /** 每页最大条目数，最大值100。 */
+    maxResults?: number;
+    /** 服务窗帐号ID，可调用[获取企业下服务窗列表](https://open.dingtalk.com/document/orgapp-server/queries-the-list-of-services-under-an-enterprise)接口获取accountId参数值。 */
+    accountId?: string;
+}
+export interface ListFollowerResponse {
+    requestId?: string;
+    result: {
+        nextToken?: string;
+        userList?: number;
+    };
+}
+export interface GetFollowerInfoQuery {
+    /** 关注服务窗用户的userId，可调用[批量获取关注服务窗用户信息](https://open.dingtalk.com/document/orgapp-server/obtains-the-follower-information-from-the-service-window)获得userId参数值。 */
+    userId?: string;
+    /** 关注服务窗用户的unionId，可通过[查询用户详情](https://open.dingtalk.com/document/orgapp-server/query-user-details)接口获取unionId参数值。 */
+    unionId?: string;
+    /** 服务窗帐号ID，可调用[获取企业下服务窗列表](https://open.dingtalk.com/document/orgapp-server/queries-the-list-of-services-under-an-enterprise)接口获取accountId参数值。 */
+    accountId?: string;
+}
+export interface GetFollowerInfoResponse {
+    requestId?: string;
+    result: {
+        user?: number;
+    };
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 获取用户关注状态
+         * @see https://developers.dingtalk.com/document/orgapp/obtain-the-attention-status-of-the-user-service-window
+         */
+        getUserFollowStatus(query: GetUserFollowStatusQuery): Promise<GetUserFollowStatusResponse>;
+        /**
+         * 获取企业下服务窗帐号列表
+         * @see https://developers.dingtalk.com/document/orgapp/queries-the-list-of-services-under-an-enterprise
+         */
+        listAccount(): Promise<ListAccountResponse>;
+        /**
+         * 批量获取关注服务窗用户信息
+         * @see https://developers.dingtalk.com/document/orgapp/obtains-the-follower-information-from-the-service-window
+         */
+        listFollower(query: ListFollowerQuery): Promise<ListFollowerResponse>;
+        /**
+         * 获取服务窗关注人信息
+         * @see https://developers.dingtalk.com/document/orgapp/queries-the-follower-information-of-the-service-window
+         */
+        getFollowerInfo(query: GetFollowerInfoQuery): Promise<GetFollowerInfoResponse>;
+    }
+}

package/lib/api/live.d.ts

@@ -0,0 +1,131 @@
+export interface DeleteLiveQuery {
+    /** 直播ID。 */
+    liveId: string;
+    /** 用户unionId。 */
+    unionId: string;
+}
+export interface DeleteLiveResponse {
+    result?: {
+        success?: number;
+    };
+}
+export interface QueryLiveWatchUserListQuery {
+    /** 直播ID。 */
+    liveId: string;
+    /** 用户unionId。 */
+    unionId: string;
+    /** 分页起始位置，从0开始。 */
+    pageNumber?: number;
+    /** 分页大小。 */
+    pageSize: number;
+}
+export interface QueryLiveWatchUserListResponse {
+    result?: {
+        orgUsesList?: number;
+        outOrgUserList?: number;
+    };
+}
+export interface QueryLiveWatchDetailQuery {
+    /** 直播ID。 */
+    liveId: string;
+    /** 用户unionId。 */
+    unionId: string;
+}
+export interface QueryLiveWatchDetailResponse {
+    result?: {
+        pv?: number;
+        uv?: number;
+        liveUv?: number;
+        playbackUv?: number;
+        totalWatchTime?: number;
+        avgWatchTime?: number;
+        praiseCount?: number;
+        msgCount?: number;
+    };
+}
+export interface UpdateLiveParams {
+    /** 直播ID。 */
+    liveId: string;
+    /** 主播的unionId。 */
+    unionId: string;
+    /** 直播标题。 */
+    title?: string;
+    /** 直播简介。 */
+    introduction?: string;
+    /** 直播的封面地址。 */
+    coverUrl?: string;
+    /** 直播的预计开播时间戳，单位毫秒。 */
+    preStartTime?: number;
+    /** 直播的预计结束时间戳，单位毫秒。 */
+    preEndTime?: number;
+}
+export interface UpdateLiveResponse {
+    result?: {
+        success?: number;
+    };
+}
+export interface CreateLiveParams {
+    /** 发起直播的主播unionId。 */
+    unionId: string;
+    /** 直播标题。 */
+    title: string;
+    /** 直播简介。 */
+    introduction?: string;
+    /** 预计开播时间戳，单位毫秒。 */
+    preStartTime: number;
+    /** 直播的封面地址。 */
+    coverUrl?: string;
+    /** 预计结束时间戳，单位毫秒。 */
+    preEndTime: number;
+    publicType?: number;
+}
+export interface CreateLiveResponse {
+    result?: {
+        liveId?: string;
+    };
+}
+export interface QueryLiveInfoQuery {
+    /** 直播ID。 */
+    liveId: string;
+    /** 操作者的unionId。 */
+    unionId: string;
+}
+export interface QueryLiveInfoResponse {
+    result?: {
+        liveInfo?: number;
+    };
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 删除直播
+         * @see https://developers.dingtalk.com/document/isvapp/delete-live-streaming
+         */
+        deleteLive(query: DeleteLiveQuery): Promise<DeleteLiveResponse>;
+        /**
+         * 查询直播观看人员信息
+         * @see https://developers.dingtalk.com/document/isvapp/queries-the-viewing-information-of-viewers
+         */
+        queryLiveWatchUserList(query: QueryLiveWatchUserListQuery): Promise<QueryLiveWatchUserListResponse>;
+        /**
+         * 获取直播的观看数据
+         * @see https://developers.dingtalk.com/document/orgapp/queries-the-playback-data-of-a-live-stream
+         */
+        queryLiveWatchDetail(query: QueryLiveWatchDetailQuery): Promise<QueryLiveWatchDetailResponse>;
+        /**
+         * 修改直播属性信息
+         * @see https://developers.dingtalk.com/document/isvapp/modify-live-streaming
+         */
+        updateLive(params: UpdateLiveParams): Promise<UpdateLiveResponse>;
+        /**
+         * 创建直播
+         * @see https://developers.dingtalk.com/document/isvapp/create-live-streaming
+         */
+        createLive(params: CreateLiveParams): Promise<CreateLiveResponse>;
+        /**
+         * 查询直播详情
+         * @see https://developers.dingtalk.com/document/isvapp/queries-the-live-streaming-information
+         */
+        queryLiveInfo(query: QueryLiveInfoQuery): Promise<QueryLiveInfoResponse>;
+    }
+}