@satorijs/adapter-dingtalk 1.0.0

package/lib/api/oauth2.d.ts

@@ -0,0 +1,114 @@
+export interface CreateJsapiTicketResponse {
+    jsapiTicket?: string;
+    expireIn?: number;
+}
+export interface GetSsoAccessTokenParams {
+    /** 企业的corpId。 */
+    corpid: string;
+    /** sso密钥，可以在[开发者后台](https://open-dev.dingtalk.com/fe/old#/corpAuthInfo)**基本信息**—**开发信息**（****旧版****）页面查看。 */
+    ssoSecret: string;
+}
+export interface GetSsoAccessTokenResponse {
+    accessToken?: string;
+    expireIn?: number;
+}
+export interface GetPersonalAuthRuleResponse {
+    result?: {
+        resource: string;
+        authItems: number;
+    }[];
+}
+export interface GetAccessTokenParams {
+    /** 已创建的企业内部应用的AppKey。 */
+    appKey: string;
+    /** 已创建的企业内部应用的AppSecret。 */
+    appSecret?: string;
+}
+export interface GetAccessTokenResponse {
+    accessToken?: string;
+    expireIn?: number;
+}
+export interface GetCorpAccessTokenParams {
+    /** 已创建的第三方企业应用的SuiteKey。 */
+    suiteKey: string;
+    /** 已创建的第三方企业应用的SuiteSecret。 */
+    suiteSecret: string;
+    /** 授权企业的CorpId。 */
+    authCorpId: string;
+    /** 钉钉推送的suiteTicket。 */
+    suiteTicket: string;
+}
+export interface GetCorpAccessTokenResponse {
+    accessToken?: string;
+    expireIn?: number;
+}
+export interface GetUserTokenParams {
+    /** 应用id。可使用扫码登录应用或者第三方个人小程序的appId。 */
+    clientId: string;
+    /** 应用密钥。 */
+    clientSecret?: string;
+    /** OAuth 2.0 临时授权码。 */
+    code?: string;
+    /** OAuth2.0刷新令牌，从返回结果里面获取。 */
+    refreshToken?: string;
+    /** - 如果使用授权码换token，传authorization\_code。 */
+    grantType?: string;
+}
+export interface GetUserTokenResponse {
+    accessToken?: string;
+    refreshToken?: string;
+    expireIn?: number;
+    corpId?: string;
+}
+export interface GetSsoUserInfoQuery {
+    /** 临时授权码，管理员在钉钉管理后台，跳转到应用管理页面时，该授权码会附带在URL中。 */
+    code: string;
+}
+export interface GetSsoUserInfoResponse {
+    corpId: string;
+    corpName: string;
+    userId: string;
+    email: string;
+    userName: string;
+    avatar: string;
+    isAdmin: unknown;
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 生成jsapi ticket
+         * @see https://developers.dingtalk.com/document/isvapp/create-a-jsapi-ticket
+         */
+        createJsapiTicket(): Promise<CreateJsapiTicketResponse>;
+        /**
+         * 生成微应用管理后台accessToken
+         * @see https://developers.dingtalk.com/document/isvapp/obtain-the-access_token-of-the-micro-application-background-without-log-on
+         */
+        getSsoAccessToken(params: GetSsoAccessTokenParams): Promise<GetSsoAccessTokenResponse>;
+        /**
+         * 查询个人授权记录
+         * @see https://developers.dingtalk.com/document/isvapp/query-individual-authorization-records
+         */
+        getPersonalAuthRule(): Promise<GetPersonalAuthRuleResponse>;
+        /**
+         * 获取企业accessToken(企业内部应用)
+         * @see https://developers.dingtalk.com/document/orgapp/obtain-the-access_token-of-an-internal-app
+         */
+        getAccessToken(params: GetAccessTokenParams): Promise<GetAccessTokenResponse>;
+        /**
+         * 获取企业accessToken(应用商店应用)
+         * @see https://developers.dingtalk.com/document/isvapp/obtain-the-access_token-of-the-authorized-enterprise
+         */
+        getCorpAccessToken(params: GetCorpAccessTokenParams): Promise<GetCorpAccessTokenResponse>;
+        /**
+         * 获取用户token
+         * @see https://developers.dingtalk.com/document/isvapp/obtain-user-token
+         */
+        getUserToken(params: GetUserTokenParams): Promise<GetUserTokenResponse>;
+        /**
+         * 查询微应用后台免登的用户信息
+         * @see https://developers.dingtalk.com/document/isvapp/obtains-the-identity-of-an-application-administrator
+         */
+        getSsoUserInfo(query: GetSsoUserInfoQuery): Promise<GetSsoUserInfoResponse>;
+    }
+}

package/lib/api/pedia.d.ts

@@ -0,0 +1,185 @@
+export interface PediaWordsQueryQuery {
+    /** 查询主键编号。 */
+    uuid: number;
+    /** 当前操作用户的userId。 */
+    userId: string;
+}
+export interface PediaWordsQueryResponse {
+    data?: {
+        wordName?: string;
+        uuid?: number;
+        gmtCreate?: number;
+        gmtModify?: number;
+        wordAlias?: number;
+        highLightWordAlias?: number;
+        relatedDoc?: number;
+        relatedLink?: number;
+        creatorName?: string;
+        updaterName?: string;
+        approveName?: string;
+        wordParaphrase?: string;
+        simpleWordParaphrase?: string;
+        contacts?: number;
+        tagsList?: number;
+        appLink?: number;
+        imHighLight?: number;
+        simHighLight?: number;
+        picList?: number;
+        contactList?: number;
+        userId?: string;
+        parentUuid?: number;
+    };
+    success?: unknown;
+}
+export interface PediaWordsSearchParams {
+    /** 搜索关键词。 */
+    wordName?: string;
+    /** 操作人的userId。 */
+    userId: string;
+    /** 当前每页需要展示的数量，最大20。 */
+    pageSize: number;
+    /** 当前查询的页数，从1开始。 */
+    pageNumber: number;
+    /** 当前搜索列表的状态： */
+    status: string;
+}
+export interface PediaWordsSearchResponse {
+    data?: {
+        wordName?: string;
+        uuid?: number;
+        gmtCreate?: number;
+        gmtModify?: number;
+        wordAlias?: number;
+        highLightWordAlias?: number;
+        relatedLink?: number;
+        relatedDoc?: number;
+        creatorName?: string;
+        updaterName?: string;
+        approveName?: string;
+        wordParaphrase?: string;
+        simpleWordParaphrase?: string;
+        contacts?: number;
+        tagsList?: number;
+        appLink?: number;
+        imHighLight?: number;
+        simHighLight?: number;
+        picList?: number;
+        contactList?: number;
+        userId?: string;
+        parentUuid?: number;
+    }[];
+    success?: unknown;
+}
+export interface PediaWordsApproveParams {
+    /** 当前审核的词条的主键编号。 */
+    uuid: number;
+    /** 操作人的组织员工userId。 */
+    userId: string;
+    /** 审核的结果： */
+    approveStatus: string;
+    /** 拒绝的原因。 */
+    approveReason?: string;
+    /** 当前内部群是否高亮： */
+    imHighLight: unknown;
+    /** 服务群是否高亮： */
+    simHighLight: unknown;
+}
+export interface PediaWordsApproveResponse {
+    success?: unknown;
+}
+export interface PediaWordsDeleteQuery {
+    /** 当前需要删除的词条主键编号。 */
+    uuid: number;
+    /** 当前操作用户的userId。 */
+    userId: string;
+}
+export interface PediaWordsDeleteResponse {
+    uuid?: number;
+    success?: unknown;
+}
+export interface PediaWordsUpdateParams {
+    /** 需要更新的词条编号。 */
+    uuid: number;
+    /** 词条名称。 */
+    wordName: string;
+    /** 词条别名列表，最大值10。 */
+    wordAlias?: string[];
+    /** 可高亮的别名列表，最大值10。 */
+    highLightWordAlias?: string[];
+    /** 词条相关文档信息，最大值10。 */
+    relatedDoc?: object[];
+    /** 词条相关链接信息，最大值10。 */
+    relatedLink?: object[];
+    /** 词条释义。 */
+    wordParaphrase: string;
+    /** 相关应用对象。 */
+    appLink?: object[];
+    /** 操作人的userId。 */
+    userId?: string;
+    /** 词条的相关图片信息，最大值10。 */
+    picList?: object[];
+    /** 词条的相关联系人信息，最大值10。 */
+    contactList?: object[];
+}
+export interface PediaWordsUpdateResponse {
+    uuid?: number;
+    success?: unknown;
+}
+export interface PediaWordsAddParams {
+    /** 新增词条的名称。 */
+    wordName: string;
+    /** 词条的别名列表，多个名字的时候可以添加，每次调用最多传10个。 */
+    wordAlias?: string[];
+    /** 词条高亮别名列表，每次调用最多传10个。 */
+    highLightWordAlias?: string[];
+    /** 词条相关的文档列表，每次调用最多传10个。 */
+    relatedDoc?: object[];
+    /** 词条相关的链接信息，每次调用最多传10个。 */
+    relatedLink?: object[];
+    /** 词条释义，针对词条的描述内容。 */
+    wordParaphrase: string;
+    /** 词条相关的图片信息，每次调用最多传10个。 */
+    picList?: object[];
+    /** 组织对应的员工userId。 */
+    userId: string;
+    /** 词条相关的联系人信息，每次调用最多传10个。 */
+    contactList?: object[];
+}
+export interface PediaWordsAddResponse {
+    uuid?: number;
+    success?: unknown;
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 根据词条主键ID查询当前词条详情
+         * @see https://developers.dingtalk.com/document/app/entry-query
+         */
+        pediaWordsQuery(query: PediaWordsQueryQuery): Promise<PediaWordsQueryResponse>;
+        /**
+         * 分页获取企业词条信息
+         * @see https://developers.dingtalk.com/document/app/entry-search
+         */
+        pediaWordsSearch(params: PediaWordsSearchParams): Promise<PediaWordsSearchResponse>;
+        /**
+         * 企业百科针对待审核词条进行审核
+         * @see https://developers.dingtalk.com/document/app/entry-review
+         */
+        pediaWordsApprove(params: PediaWordsApproveParams): Promise<PediaWordsApproveResponse>;
+        /**
+         * 企业百科针对uuid删除当前词条
+         * @see https://developers.dingtalk.com/document/app/entry-delete
+         */
+        pediaWordsDelete(query: PediaWordsDeleteQuery): Promise<PediaWordsDeleteResponse>;
+        /**
+         * 企业百科对当前已经生效词条进行编辑
+         * @see https://developers.dingtalk.com/document/app/update-entry
+         */
+        pediaWordsUpdate(params: PediaWordsUpdateParams): Promise<PediaWordsUpdateResponse>;
+        /**
+         * 企业百科增加当前企业词条信息
+         * @see https://developers.dingtalk.com/document/app/new-entry
+         */
+        pediaWordsAdd(params: PediaWordsAddParams): Promise<PediaWordsAddResponse>;
+    }
+}