@tocca-systems/twp-cli 0.14.0 → 0.15.0

package/command-model/organization-announcement.json

@@ -0,0 +1,605 @@
+{
+  "domain": "organization-announcement",
+  "operations": [
+    {
+      "name": "create",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.store",
+      "method": "POST",
+      "path": "/v2/organization/announcements",
+      "summary": "組織お知らせを作成する",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "content": {
+              "type": "string",
+              "maxLength": 65535
+            },
+            "publish_start_at": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "publish_end_at": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "draft",
+                "published",
+                null
+              ]
+            },
+            "importance": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "important",
+                "general",
+                null
+              ]
+            },
+            "category_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "link_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2048
+            },
+            "link_button_title": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "sender_type": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "operation",
+                "department",
+                "individual",
+                null
+              ]
+            },
+            "sender_department_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "attachment_ids": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 255
+              },
+              "maxItems": 10
+            },
+            "require_confirmation": {
+              "type": [
+                "boolean",
+                "null"
+              ]
+            },
+            "target_mode": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "all",
+                "custom",
+                null
+              ]
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "target_type": {
+                    "type": "string",
+                    "enum": [
+                      "department",
+                      "department_position",
+                      "project",
+                      "user",
+                      "contract_type"
+                    ]
+                  },
+                  "target_id": {
+                    "type": "string",
+                    "maxLength": 255
+                  },
+                  "target_name": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "maxLength": 255
+                  },
+                  "min_position_rank": {
+                    "type": [
+                      "integer",
+                      "null"
+                    ],
+                    "minimum": 0
+                  },
+                  "min_position_name": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "maxLength": 255
+                  }
+                },
+                "required": [
+                  "target_type",
+                  "target_id"
+                ]
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "title",
+            "content",
+            "publish_start_at"
+          ],
+          "title": "StoreOrganizationAnnouncementRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.destroy",
+      "method": "DELETE",
+      "path": "/v2/organization/announcements/{id}",
+      "summary": "組織お知らせを削除する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "duplicate",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.duplicate",
+      "method": "POST",
+      "path": "/v2/organization/announcements/{id}/duplicate",
+      "summary": "組織お知らせを複製する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "get",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.show",
+      "method": "GET",
+      "path": "/v2/organization/announcements/{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": "list",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.index",
+      "method": "GET",
+      "path": "/v2/organization/announcements",
+      "summary": "組織お知らせ一覧を取得する",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "status",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "keyword",
+          "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": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "pin",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.pin",
+      "method": "POST",
+      "path": "/v2/organization/announcements/{id}/pin",
+      "summary": "組織お知らせをピン留めする（一覧の先頭に固定表示）",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "published",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.published",
+      "method": "GET",
+      "path": "/v2/organization/announcements/published",
+      "summary": "ユーザー向け: テナントの公開中お知らせ一覧を取得する",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "announcements",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "read-status",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.readStatus",
+      "method": "GET",
+      "path": "/v2/organization/announcements/{id}/read-status",
+      "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": "unpin",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.unpin",
+      "method": "DELETE",
+      "path": "/v2/organization/announcements/{id}/pin",
+      "summary": "組織お知らせのピン留めを解除する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "update",
+      "domain": "organization-announcement",
+      "operationId": "organizationAnnouncement.update",
+      "method": "PUT",
+      "path": "/v2/organization/announcements/{id}",
+      "summary": "組織お知らせを更新する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "content": {
+              "type": "string",
+              "maxLength": 65535
+            },
+            "publish_start_at": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "publish_end_at": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "draft",
+                "published",
+                "archived",
+                null
+              ]
+            },
+            "importance": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "important",
+                "general",
+                null
+              ]
+            },
+            "category_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "link_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2048
+            },
+            "link_button_title": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "sender_type": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "operation",
+                "department",
+                "individual",
+                null
+              ]
+            },
+            "sender_department_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "attachment_ids": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 255
+              },
+              "maxItems": 10
+            },
+            "require_confirmation": {
+              "type": [
+                "boolean",
+                "null"
+              ]
+            },
+            "target_mode": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "all",
+                "custom",
+                null
+              ]
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "target_type": {
+                    "type": "string",
+                    "enum": [
+                      "department",
+                      "department_position",
+                      "project",
+                      "user",
+                      "contract_type"
+                    ]
+                  },
+                  "target_id": {
+                    "type": "string",
+                    "maxLength": 255
+                  },
+                  "target_name": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "maxLength": 255
+                  },
+                  "min_position_rank": {
+                    "type": [
+                      "integer",
+                      "null"
+                    ],
+                    "minimum": 0
+                  },
+                  "min_position_name": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "maxLength": 255
+                  }
+                },
+                "required": [
+                  "target_type",
+                  "target_id"
+                ]
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "title",
+            "content",
+            "publish_start_at"
+          ],
+          "title": "UpdateOrganizationAnnouncementRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}

package/command-model/password-reset.json

@@ -0,0 +1,100 @@
+{
+  "domain": "password-reset",
+  "operations": [
+    {
+      "name": "request-reset",
+      "domain": "password-reset",
+      "operationId": "passwordReset.requestReset",
+      "method": "POST",
+      "path": "/v2/auth/password-reset/request",
+      "summary": "パスワードリセットをリクエスト",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "tenant_code": {
+              "type": "string",
+              "maxLength": 50
+            },
+            "email": {
+              "type": "string",
+              "format": "email",
+              "maxLength": 255
+            }
+          },
+          "required": [
+            "tenant_code",
+            "email"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "reset",
+      "domain": "password-reset",
+      "operationId": "passwordReset.reset",
+      "method": "POST",
+      "path": "/v2/auth/password-reset/reset",
+      "summary": "パスワードをリセット",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "token": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string",
+              "minLength": 8,
+              "maxLength": 255
+            },
+            "password_confirmation": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "token",
+            "password",
+            "password_confirmation"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "validate-token",
+      "domain": "password-reset",
+      "operationId": "passwordReset.validateToken",
+      "method": "POST",
+      "path": "/v2/auth/password-reset/validate",
+      "summary": "パスワードリセットトークンを検証",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "token": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "token"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}