@tocca-systems/twp-cli 0.14.1 → 0.15.1

package/command-model/training-session.json

@@ -0,0 +1,604 @@
+{
+  "domain": "training-session",
+  "operations": [
+    {
+      "name": "available-surveys",
+      "domain": "training-session",
+      "operationId": "trainingSession.availableSurveys",
+      "method": "GET",
+      "path": "/v2/training/sessions/{id}/available-surveys",
+      "summary": "紐付け可能なアンケート一覧を取得",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "type",
+          "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": "create",
+      "domain": "training-session",
+      "operationId": "trainingSession.store",
+      "method": "POST",
+      "path": "/v2/training/sessions",
+      "summary": "研修セッションを作成",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "training_master_id": {
+              "type": "string"
+            },
+            "session_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "session_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "session_end_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "session_time": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{2}:\\d{2}$"
+            },
+            "session_end_time": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{2}:\\d{2}$"
+            },
+            "session_location": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "scheduled",
+                "cancelled",
+                null
+              ]
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "report_format_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "meeting_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2048
+            },
+            "recording_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2048
+            },
+            "meeting_password": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "application_survey_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "followup_survey_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "required": [
+            "training_master_id",
+            "session_name",
+            "session_date"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "training-session",
+      "operationId": "trainingSession.destroy",
+      "method": "DELETE",
+      "path": "/v2/training/sessions/{id}",
+      "summary": "研修セッションを削除",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "application_survey_id",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "followup_survey_id",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "get",
+      "domain": "training-session",
+      "operationId": "trainingSession.show",
+      "method": "GET",
+      "path": "/v2/training/sessions/{id}",
+      "summary": "研修セッション詳細を取得",
+      "pathParams": [
+        {
+          "name": "id",
+          "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": "get-email-setting",
+      "domain": "training-session",
+      "operationId": "trainingSession.getEmailSetting",
+      "method": "GET",
+      "path": "/v2/training/sessions/{sessionId}/email-settings/{emailType}",
+      "summary": "メール設定を取得",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "emailType",
+          "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-session",
+      "operationId": "trainingSession.index",
+      "method": "GET",
+      "path": "/v2/training/sessions",
+      "summary": "研修セッション一覧を取得",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        },
+        {
+          "name": "training_master_id",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "status",
+          "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": "keyword",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "items",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "list-by-master",
+      "domain": "training-session",
+      "operationId": "trainingSession.listByMaster",
+      "method": "GET",
+      "path": "/v2/training/masters/{trainingMasterId}/sessions",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "trainingMasterId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "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": "save-email-setting",
+      "domain": "training-session",
+      "operationId": "trainingSession.saveEmailSetting",
+      "method": "PUT",
+      "path": "/v2/training/sessions/{sessionId}/email-settings/{emailType}",
+      "summary": "メール設定を保存",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "emailType",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "subject": {
+              "type": "string",
+              "maxLength": 500
+            },
+            "body": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 10000
+            },
+            "html_body": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50000
+            }
+          },
+          "required": [
+            "subject"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "send-meeting-url-announcement",
+      "domain": "training-session",
+      "operationId": "trainingSession.sendMeetingUrlAnnouncement",
+      "method": "POST",
+      "path": "/v2/training/sessions/{sessionId}/send-meeting-url-announcement",
+      "summary": "当日案内メール（会議URL案内）を外部受講者全員に一括送信",
+      "pathParams": [
+        {
+          "name": "sessionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "send-meeting-url-announcement-to-attendee",
+      "domain": "training-session",
+      "operationId": "trainingSession.sendMeetingUrlAnnouncementToAttendee",
+      "method": "POST",
+      "path": "/v2/training/sessions/{sessionId}/attendees/{attendeeId}/send-meeting-url-announcement",
+      "summary": "当日案内メール（会議URL案内）を個別受講者に送信",
+      "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": "update",
+      "domain": "training-session",
+      "operationId": "trainingSession.update",
+      "method": "PUT",
+      "path": "/v2/training/sessions/{id}",
+      "summary": "研修セッションを更新",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "training_master_id": {
+              "type": "string"
+            },
+            "session_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "session_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "session_end_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "session_time": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{2}:\\d{2}$"
+            },
+            "session_end_time": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{2}:\\d{2}$"
+            },
+            "session_location": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "scheduled",
+                "cancelled",
+                null
+              ]
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "report_format_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "meeting_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2048
+            },
+            "recording_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2048
+            },
+            "meeting_password": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "application_survey_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "followup_survey_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          }
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}