@tocca-systems/twp-cli 0.14.1 → 0.15.1

package/command-model/training-attendance.json

@@ -0,0 +1,509 @@
+{
+  "domain": "training-attendance",
+  "operations": [
+    {
+      "name": "bulk-assign",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.bulkAssign",
+      "method": "POST",
+      "path": "/v2/training/sessions/{sessionId}/attendances",
+      "summary": "受講者を一括割当",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "user_ids": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "user_ids"
+          ]
+        }
+      },
+      "resultPath": "items",
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.destroy",
+      "method": "DELETE",
+      "path": "/v2/training/attendances/{sessionId}/{userId}",
+      "summary": "受講者を削除",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "userId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "export-csv",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.exportCsv",
+      "method": "GET",
+      "path": "/v2/training/sessions/{sessionId}/attendances/export",
+      "summary": "セッションの受講者CSVエクスポート",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "list",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.index",
+      "method": "GET",
+      "path": "/v2/training/sessions/{sessionId}/attendances",
+      "summary": "セッションの受講者一覧を取得",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "attendance_status",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "items",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "list-all",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.listAll",
+      "method": "GET",
+      "path": "/v2/training/attendances",
+      "summary": "テナント全体の受講記録一覧を取得",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        },
+        {
+          "name": "attendance_status",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "keyword",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "training_master_id",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "created_by",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "has_report_format",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "date_from",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "date_to",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "items",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "send-survey",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.sendSurvey",
+      "method": "POST",
+      "path": "/v2/training/sessions/{sessionId}/attendees/{attendeeId}/send-survey",
+      "summary": "外部受講者にアンケートメールを送信",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "attendeeId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "store-external-attendee",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.storeExternalAttendee",
+      "method": "POST",
+      "path": "/v2/training/sessions/{sessionId}/external-attendees",
+      "summary": "外部受講者を登録",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "external_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "external_email": {
+              "type": "string",
+              "format": "email",
+              "maxLength": 255
+            },
+            "external_company": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            }
+          },
+          "required": [
+            "external_name",
+            "external_email"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "survey-invitation-logs",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.surveyInvitationLogs",
+      "method": "GET",
+      "path": "/v2/training/sessions/{sessionId}/survey-invitation-logs",
+      "summary": "セッションのアンケート送信履歴を取得",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "update-external-attendee",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.updateExternalAttendee",
+      "method": "PUT",
+      "path": "/v2/training/sessions/{sessionId}/external-attendees/{userId}",
+      "summary": "外部受講者を更新",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "userId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "external_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "external_email": {
+              "type": "string",
+              "format": "email",
+              "maxLength": 255
+            },
+            "external_company": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            }
+          }
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "update-report",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.updateReport",
+      "method": "PUT",
+      "path": "/v2/training/attendances/{sessionId}/{userId}/report",
+      "summary": "レポート提出情報を更新",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "userId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "report_id": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "report_id"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "update-status",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.updateStatus",
+      "method": "PUT",
+      "path": "/v2/training/attendances/{sessionId}/{userId}/status",
+      "summary": "受講ステータスを更新",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "userId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "attendance_status": {
+              "type": "string",
+              "enum": [
+                "scheduled",
+                "completed",
+                "cancelled",
+                "absent"
+              ]
+            }
+          },
+          "required": [
+            "attendance_status"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "user-training-history",
+      "domain": "training-attendance",
+      "operationId": "trainingAttendance.userTrainingHistory",
+      "method": "GET",
+      "path": "/v2/hr/users/{userId}/training-history",
+      "summary": "ユーザーの研修受講履歴を取得（HR連携用）",
+      "pathParams": [
+        {
+          "name": "userId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "date_from",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "date_to",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "items",
+      "risk": "read",
+      "aliases": []
+    }
+  ]
+}