@tapd/tapd-node-sdk 1.31.0 → 1.32.0-beta.10

package/README.md

@@ -4,29 +4,16 @@
 > 推荐版本: NodeJs 12.13.0+
 
 ## Install
-设置npm工具使用软件源的registry
-```
-npm config set registry https://mirrors.tencent.com/npm/
-```
 安装SDK包
 ```
-npm install @tencent/tapd-node-sdk
+npm install @tapd/tapd-node-sdk
 ```
 
 ## Usage
 
-#### 申请应用
-1. 申请和使用应用
-https://o.tapd.woa.com/document/api-doc/API%E6%96%87%E6%A1%A3/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E5%BA%94%E7%94%A8API%E4%BD%BF%E7%94%A8%E6%8C%87%E5%BC%95.html
-
-2. 复制应用ID和密钥
-https://o.tapd.woa.com/admin/{你的应用标识}/dashboard
-![Alt](https://o.tapd.woa.com/document/img/tapd_20417300_1638862843_15.png)
-
-
 #### DEMO
 ```javascript
-const SDK = require('@tencent/tapd-node-sdk');
+const SDK = require('@tapd/tapd-node-sdk');
 
 const api = new SDK({
     client: 'gggg123', // 你的应用CODE
@@ -70,30 +57,4 @@ api.uploadImage({
 }).catch(e => console.log(e));
 ```
 
-#### [查看所有SDK方法和参数](https://o.tapd.woa.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/)
-
-#### IDC 网络的使用
-1. 怎看自己是不是IDC网络, 查看这个[链接](https://iwiki.woa.com/tencent/static/iwiki-editor-pro/dist/preview.html?space=&page=1227785302&id=131410&name=6997554869969258912(1).MP4&size=1160018&language=zh)
-
-2. 如果是IDC网络怎么设置
-```javascript
-const SDK = require('@tencent/tapd-node-sdk');
-
-const api = new SDK({
-    client: 'gggg123', // 你的应用CODE
-    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
-    env: 'idc'
-});
-
-```
-
-
-## Artifact
- https://mirrors.tencent.com/#/private/npm/detail?repo_id=537&project_name=%40tencent%2Ftapd-node-sdk&search_label=package_name&search_value=tapd-node-sdk&page_num=1
-
-## 其他问题
-
-提issue可能看不到，找tapd客服解决反馈。
-
-## Contributions
-欢迎参与SDK共建！开发&共建流程，请参照 [contributing.md](https://git.woa.com/tapd-plugin-core/tplugin-sdk/blob/dev/CONTRIBUTING.md)。
+#### [查看所有SDK方法和参数](https://o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tapd/tapd-node-sdk",
-  "version": "1.31.0",
+  "version": "1.32.0-beta.10",
   "description": "node sdk for open tapd ",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -1566,6 +1566,24 @@ module.exports = class API extends SDK {
         );
     }
     
+    /**
+     * @description 获取单个图片下载链接 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/attachment/get_image.html 
+     * @scope attachment#r
+    
+     * @params - {integer} workspace_id 项目ID   
+     * @params - {string} image_path 图片路径, 支持完整url地址, 图片所属项目必须和传入的项目id一致   
+     */
+    getImage(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/files/get_image', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
     /**
      * @description 复制缺陷 
      * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/bug/copy_bug.html 
@@ -7435,6 +7453,390 @@ module.exports = class API extends SDK {
         );
     }
     
+    /**
+     * @description 项目集关联项目 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/program/program_relate_workspace.html 
+     * @scope program#w
+    
+     */
+    programRelateWorkspace(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/program/program_relate_workspace', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 项目集批量关联/取消关联业务对象 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/program/program_bind_entities.html 
+     * @scope program#w
+    
+     */
+    programBindEntities(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/program/program_bind_entities', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 添加工作项 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/add_mini_item.html 
+     * @scope mini_item#w
+    
+     */
+    addMiniItem(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 更新工作项 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/update_mini_item.html 
+     * @scope mini_item#w
+    
+     */
+    updateMiniItem(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_items.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItems(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项数量 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_items_count.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemsCount(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/count', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 创建分组 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/add_mini_item_category.html 
+     * @scope mini_item#w
+    
+     */
+    addMiniItemCategory(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_item_categories', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 更新分组 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/update_mini_item_category.html 
+     * @scope mini_item#w
+    
+     */
+    updateMiniItemCategory(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_item_categories', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取分组 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_categories.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemCategories(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_item_categories', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取分组数量 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_categories_count.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemCategoriesCount(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_item_categories/count', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项动态 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_changes.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemChanges(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_item_changes', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项动态数量 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_changes_count.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemChangesCount(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_item_changes/count', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项自定义字段配置 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_custom_fields_settings.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemCustomFieldsSettings(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/custom_fields_settings', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项所有字段的标签 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_fields_label.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemFieldsLabel(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/get_fields_label', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 创建工作项与其他业务对象的关联关系 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/create_mini_item_relation.html 
+     * @scope mini_item#w
+    
+     */
+    createMiniItemRelation(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/create_mini_item_relation', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项与需求的所有关联关系 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_link_stories.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemLinkStories(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/get_link_stories', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取工作项与缺陷的所有关联关系 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_mini_item_related_bugs.html 
+     * @scope mini_item#r
+    
+     */
+    getMiniItemRelatedBugs(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/get_related_bugs', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 解除工作项与缺陷关联关系 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/remove_mini_item_bug_relation.html 
+     * @scope mini_item#w
+    
+     */
+    removeMiniItemBugRelation(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/remove_mini_item_bug_relation', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取回收站的工作项 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_item/get_removed_mini_items.html 
+     * @scope mini_item#r
+    
+     */
+    getRemovedMiniItems(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/mini_items/get_removed_mini_items', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取空间信息 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_project/get_mini_project_info.html 
+     * @scope mini_project#r
+    
+     */
+    getMiniProjectInfo(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/workspaces/get_workspace_info', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 添加空间成员 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_project/add_mini_project_member.html 
+     * @scope mini_project#w
+    
+     */
+    addMiniProjectMember(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/workspaces/add_workspace_member', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取空间成员列表 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_project/get_mini_project_users.html 
+     * @scope mini_project#r
+    
+     */
+    getMiniProjectUsers(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/workspaces/users', 
+                'GET',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 新建空间 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_project/create_mini_project_oa.html 
+     * @scope mini_project#w
+    
+     */
+    createMiniProjectOa(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/workspaces/create_mini_project_oa', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
+    /**
+     * @description 获取用户所有参与的空间 
+     * @link o.tapd.tencent.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/mini_project/get_mini_project_list_with_permission.html 
+     * @scope mini_project#r
+    
+     */
+    getMiniProjectListWithPermission(...args) {
+        return this.oAuthRequest.apply(
+            this, [
+                '/workspaces/get_mini_project_list_with_permission', 
+                'POST',
+                ...args 
+            ]
+        );
+    }
+    
 
 }
 module.exports.FILE = FILE;

package/src/sdk.js

@@ -12,11 +12,15 @@ class SDK {
     address = '',
     accessToken = '',
     authType = '',
+    corpid = '',
+    corpsecret = '',
   } = {}) {
     this.client = client;
     this.secret = secret;
     this.address = address;
     this.axios = Axios(this.address);
+    this.corpid = corpid;
+    this.corpsecret = corpsecret;
 
     if (authType !== '') {
       this.authType = authType;
@@ -129,6 +133,12 @@ class SDK {
     const authHeader = this.isOauth() ? `Bearer ${accessToken}` : `Basic ${Base64.encode(`${this.client}:${this.secret}`)}`;
     const upperMethod = method.toUpperCase();
 
+    // 添加企微数据
+    if (this.corpid && this.corpsecret) {
+      params.corpid = this.corpid;
+      params.corpsecret = this.corpsecret;
+    }
+
     const config = {
       ...args,
       method,