@tocca-systems/twp-cli 0.17.0 → 0.17.1

package/command-model/company.json

@@ -299,30 +299,35 @@
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "customer_flg",
           "type": "string",
           "required": false,
+          "description": "true で顧客、false で顧客でない企業に絞り込む",
           "source": "spec"
         },
         {
           "name": "supplier_flg",
           "type": "string",
           "required": false,
+          "description": "true で仕入先、false で仕入先でない企業に絞り込む",
           "source": "spec"
         },
         {
           "name": "sort_column",
           "type": "string",
           "required": false,
+          "description": "並べ替える列（id / company_name / company_short_name / created_at / updated_at）",
           "source": "spec"
         },
         {
           "name": "sort_direction",
           "type": "string",
           "required": false,
+          "description": "asc / desc",
           "source": "spec"
         },
         {
@@ -338,6 +343,20 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "page_limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数（既定 20・最大 100。この一覧は limit ではなくこちらを読む）",
+          "source": "curation"
+        },
+        {
+          "name": "page_no",
+          "type": "integer",
+          "required": false,
+          "description": "ページ番号（1始まり）",
+          "source": "curation"
         }
       ],
       "body": null,

package/command-model/department.json

@@ -14,6 +14,7 @@
           "name": "parent_id",
           "type": "string",
           "required": false,
+          "description": "親部署のID（省略すると最上位の部署）",
           "source": "spec"
         },
         {
@@ -190,12 +191,14 @@
           "name": "status",
           "type": "string",
           "required": false,
+          "description": "部署の状態で絞り込む",
           "source": "spec"
         },
         {
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
@@ -247,6 +250,13 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "current_only",
+          "type": "boolean",
+          "required": false,
+          "description": "現在所属しているメンバーだけにする（既定 true。false で過去の所属者も含める）",
+          "source": "curation"
         }
       ],
       "body": null,

package/command-model/equipment.json

@@ -14,18 +14,21 @@
           "name": "category_ids",
           "type": "string",
           "required": false,
+          "description": "備品カテゴリIDで絞り込む（カンマ区切り）",
           "source": "spec"
         },
         {
           "name": "start_date",
           "type": "string",
           "required": false,
+          "description": "貸出開始日（YYYY-MM-DD）。この期間に貸し出せる備品だけを返す",
           "source": "spec"
         },
         {
           "name": "due_date",
           "type": "string",
           "required": false,
+          "description": "返却予定日（YYYY-MM-DD）",
           "source": "spec"
         },
         {
@@ -175,6 +178,7 @@
           "name": "search",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
@@ -329,6 +333,7 @@
           "name": "status",
           "type": "string",
           "required": false,
+          "description": "貸出の状態で絞り込む",
           "source": "spec"
         },
         {

package/command-model/index.json

@@ -189,7 +189,7 @@
     },
     {
       "domain": "company",
-      "summary": "",
+      "summary": "取引先企業",
       "operationCount": 5
     },
     {
@@ -234,7 +234,7 @@
     },
     {
       "domain": "customer-contact",
-      "summary": "",
+      "summary": "顧客企業の担当者",
       "operationCount": 8
     },
     {
@@ -259,7 +259,7 @@
     },
     {
       "domain": "department",
-      "summary": "",
+      "summary": "部署",
       "operationCount": 8
     },
     {
@@ -314,7 +314,7 @@
     },
     {
       "domain": "equipment",
-      "summary": "",
+      "summary": "備品と貸出",
       "operationCount": 12
     },
     {
@@ -474,7 +474,7 @@
     },
     {
       "domain": "invoice",
-      "summary": "",
+      "summary": "請求",
       "operationCount": 13
     },
     {
@@ -599,7 +599,7 @@
     },
     {
       "domain": "meeting",
-      "summary": "",
+      "summary": "議事録",
       "operationCount": 13
     },
     {
@@ -649,7 +649,7 @@
     },
     {
       "domain": "my-task",
-      "summary": "",
+      "summary": "自分のタスク（プロジェクト横断）",
       "operationCount": 5
     },
     {
@@ -664,7 +664,7 @@
     },
     {
       "domain": "note",
-      "summary": "",
+      "summary": "ノート",
       "operationCount": 10
     },
     {
@@ -694,7 +694,7 @@
     },
     {
       "domain": "notification",
-      "summary": "",
+      "summary": "通知",
       "operationCount": 10
     },
     {
@@ -784,7 +784,7 @@
     },
     {
       "domain": "private-task",
-      "summary": "",
+      "summary": "個人タスク",
       "operationCount": 7
     },
     {
@@ -804,7 +804,7 @@
     },
     {
       "domain": "project",
-      "summary": "",
+      "summary": "プロジェクト",
       "operationCount": 10
     },
     {
@@ -839,7 +839,7 @@
     },
     {
       "domain": "project-member",
-      "summary": "",
+      "summary": "プロジェクトのメンバー",
       "operationCount": 9
     },
     {
@@ -884,7 +884,7 @@
     },
     {
       "domain": "project-task",
-      "summary": "",
+      "summary": "プロジェクトのタスク",
       "operationCount": 22
     },
     {
@@ -899,7 +899,7 @@
     },
     {
       "domain": "project-task-comment",
-      "summary": "",
+      "summary": "タスクのコメント",
       "operationCount": 7
     },
     {
@@ -959,7 +959,7 @@
     },
     {
       "domain": "prospect",
-      "summary": "",
+      "summary": "見込客",
       "operationCount": 9
     },
     {
@@ -1054,7 +1054,7 @@
     },
     {
       "domain": "report",
-      "summary": "",
+      "summary": "日報・レポート",
       "operationCount": 51
     },
     {
@@ -1214,7 +1214,7 @@
     },
     {
       "domain": "survey",
-      "summary": "",
+      "summary": "アンケート・組織サーベイ",
       "operationCount": 36
     },
     {
@@ -1334,7 +1334,7 @@
     },
     {
       "domain": "user",
-      "summary": "",
+      "summary": "ログイン中のユーザーとテナントのユーザー",
       "operationCount": 30
     },
     {
@@ -1424,7 +1424,7 @@
     },
     {
       "domain": "wiki",
-      "summary": "",
+      "summary": "プロジェクトの Wiki",
       "operationCount": 11
     },
     {
@@ -1479,7 +1479,7 @@
     },
     {
       "domain": "workflow-instance",
-      "summary": "",
+      "summary": "ワークフローの申請",
       "operationCount": 7
     },
     {

package/command-model/invoice.json

@@ -363,7 +363,7 @@
       "operationId": "invoice.destroy",
       "method": "DELETE",
       "path": "/v2/sales/invoices/{id}",
-      "summary": "",
+      "summary": "請求を削除",
       "pathParams": [
         {
           "name": "id",
@@ -391,12 +391,14 @@
           "name": "sort_column",
           "type": "string",
           "required": false,
+          "description": "並べ替える列（一覧と同じ）",
           "source": "spec"
         },
         {
           "name": "sort_direction",
           "type": "string",
           "required": false,
+          "description": "asc / desc",
           "source": "spec"
         },
         {
@@ -432,18 +434,21 @@
           "name": "debit_account",
           "type": "string",
           "required": false,
+          "description": "借方の勘定科目（既定 売上高）",
           "source": "spec"
         },
         {
           "name": "credit_account",
           "type": "string",
           "required": false,
+          "description": "貸方の勘定科目",
           "source": "spec"
         },
         {
           "name": "invoice_date_from",
           "type": "string",
           "required": false,
+          "description": "対象とする取引日の起点",
           "source": "spec"
         },
         {
@@ -515,18 +520,21 @@
           "name": "sort_column",
           "type": "string",
           "required": false,
+          "description": "並べ替える列",
           "source": "spec"
         },
         {
           "name": "sort_direction",
           "type": "string",
           "required": false,
+          "description": "asc / desc",
           "source": "spec"
         },
         {
           "name": "consolidated_view",
           "type": "boolean",
           "required": false,
+          "description": "true で統合請求書の下に統合元の請求書を children として付ける",
           "source": "spec"
         },
         {
@@ -542,10 +550,24 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "page_limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数（既定 20・最大 100。この一覧は limit ではなくこちらを読む）",
+          "source": "curation"
+        },
+        {
+          "name": "page_no",
+          "type": "integer",
+          "required": false,
+          "description": "ページ番号（1始まり）",
+          "source": "curation"
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "list",
       "risk": "read",
       "aliases": []
     },

package/command-model/meeting.json

@@ -7,7 +7,7 @@
       "operationId": "meeting.store",
       "method": "POST",
       "path": "/v2/meetings",
-      "summary": "",
+      "summary": "議事録を作成",
       "pathParams": [],
       "queryParams": [],
       "body": {
@@ -288,7 +288,7 @@
       "operationId": "meeting.createTaskFromActionItem",
       "method": "POST",
       "path": "/v2/meetings/{id}/action-items/{actionItemId}/create-task",
-      "summary": "",
+      "summary": "アクションアイテムからタスクを作成",
       "pathParams": [
         {
           "name": "id",
@@ -327,7 +327,7 @@
       "operationId": "meeting.destroy",
       "method": "DELETE",
       "path": "/v2/meetings/{id}",
-      "summary": "",
+      "summary": "議事録を削除",
       "pathParams": [
         {
           "name": "id",
@@ -466,7 +466,7 @@
       "operationId": "meeting.show",
       "method": "GET",
       "path": "/v2/meetings/{id}",
-      "summary": "",
+      "summary": "議事録詳細を取得",
       "pathParams": [
         {
           "name": "id",
@@ -492,7 +492,7 @@
         }
       ],
       "body": null,
-      "resultPath": "meeting",
+      "resultPath": null,
       "risk": "read",
       "aliases": []
     },
@@ -512,6 +512,7 @@
             "null"
           ],
           "required": false,
+          "description": "プロジェクトIDで絞り込む",
           "source": "spec"
         },
         {
@@ -521,12 +522,14 @@
             "null"
           ],
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "tags[]",
           "type": "array",
           "required": false,
+          "description": "タグで絞り込む（複数指定可）",
           "source": "spec"
         },
         {
@@ -536,6 +539,7 @@
             "null"
           ],
           "required": false,
+          "description": "並び順（meeting_date / created_at / updated_at / title）",
           "source": "spec"
         },
         {
@@ -545,30 +549,35 @@
             "null"
           ],
           "required": false,
+          "description": "asc / desc",
           "source": "spec"
         },
         {
           "name": "status",
           "type": "string",
           "required": false,
+          "description": "状態で絞り込む",
           "source": "spec"
         },
         {
           "name": "meeting_type",
           "type": "string",
           "required": false,
+          "description": "会議の種類で絞り込む",
           "source": "spec"
         },
         {
           "name": "start_date",
           "type": "string",
           "required": false,
+          "description": "開催日がこの日以降（YYYY-MM-DD）",
           "source": "spec"
         },
         {
           "name": "end_date",
           "type": "string",
           "required": false,
+          "description": "開催日がこの日以前（YYYY-MM-DD）",
           "source": "spec"
         },
         {
@@ -611,24 +620,28 @@
           "name": "status",
           "type": "string",
           "required": false,
+          "description": "状態で絞り込む",
           "source": "spec"
         },
         {
           "name": "meeting_type",
           "type": "string",
           "required": false,
+          "description": "会議の種類で絞り込む",
           "source": "spec"
         },
         {
           "name": "start_date",
           "type": "string",
           "required": false,
+          "description": "開催日がこの日以降（YYYY-MM-DD）",
           "source": "spec"
         },
         {
           "name": "end_date",
           "type": "string",
           "required": false,
+          "description": "開催日がこの日以前（YYYY-MM-DD）",
           "source": "spec"
         },
         {
@@ -647,7 +660,7 @@
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },
@@ -657,7 +670,7 @@
       "operationId": "meeting.pendingActionItems",
       "method": "GET",
       "path": "/v2/meetings/pending-action-items",
-      "summary": "",
+      "summary": "プロジェクトの議事録にある未完了のアクションアイテム一覧を取得",
       "pathParams": [],
       "queryParams": [
         {
@@ -673,6 +686,13 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "project_id",
+          "type": "string",
+          "required": false,
+          "description": "対象プロジェクトのID。省略するとサーバは常に0件を返す",
+          "source": "curation"
         }
       ],
       "body": null,
@@ -686,7 +706,7 @@
       "operationId": "meeting.publish",
       "method": "POST",
       "path": "/v2/meetings/{id}/publish",
-      "summary": "",
+      "summary": "議事録を公開",
       "pathParams": [
         {
           "name": "id",
@@ -736,7 +756,7 @@
       "operationId": "meeting.update",
       "method": "PUT",
       "path": "/v2/meetings/{id}",
-      "summary": "",
+      "summary": "議事録を更新",
       "pathParams": [
         {
           "name": "id",

package/command-model/my-task.json

@@ -108,6 +108,7 @@
           "name": "include_completed",
           "type": "boolean",
           "required": false,
+          "description": "true で完了済みのタスクも含める",
           "source": "spec"
         },
         {