@tocca-systems/twp-cli 0.14.0 → 0.15.0

package/command-model/prospect.json

@@ -0,0 +1,793 @@
+{
+  "domain": "prospect",
+  "operations": [
+    {
+      "name": "by-company",
+      "domain": "prospect",
+      "operationId": "prospect.byCompany",
+      "method": "GET",
+      "path": "/v2/prospects/by-company/{companyId}",
+      "summary": "昇格先の顧客IDから見込客を引く（顧客詳細から昇格元とアプローチ履歴を参照するため）",
+      "pathParams": [
+        {
+          "name": "companyId",
+          "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": "items",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "check-duplicates",
+      "domain": "prospect",
+      "operationId": "prospect.checkDuplicates",
+      "method": "GET",
+      "path": "/v2/prospects/check-duplicates",
+      "summary": "重複・既存顧客の事前チェック（登録フォームからの照会）",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "company_name",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "website",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "exclude_id",
+          "type": [
+            "string",
+            "null"
+          ],
+          "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": "create",
+      "domain": "prospect",
+      "operationId": "prospect.store",
+      "method": "POST",
+      "path": "/v2/prospects",
+      "summary": "見込客登録",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "company_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "company_name_kana": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "industry": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "employee_scale": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "website": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            },
+            "postal_code": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 20
+            },
+            "address": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            },
+            "tel": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "fax": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "contact_department": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "contact_name": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "contact_position": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "contact_email": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "email",
+              "maxLength": 255
+            },
+            "contact_tel": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "contact_form_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "new",
+                "approaching",
+                "responded",
+                "appointment",
+                "rejected",
+                "on_hold",
+                null
+              ]
+            },
+            "assignee_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "campaign_ids": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 255
+              }
+            },
+            "tags": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 50
+              }
+            },
+            "source": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "next_action_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date"
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 10000
+            }
+          },
+          "required": [
+            "company_name"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "prospect",
+      "operationId": "prospect.destroy",
+      "method": "DELETE",
+      "path": "/v2/prospects/{id}",
+      "summary": "見込客削除（論理削除・admin のみ）",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "export",
+      "domain": "prospect",
+      "operationId": "prospect.export",
+      "method": "GET",
+      "path": "/v2/prospects/export",
+      "summary": "見込客一覧の CSV エクスポート（絞り込み条件を反映・admin のみ）",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "keyword",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "status",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "industry",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "employee_scale",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "assignee_user_id",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "website_domain",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "campaign_ids[]",
+          "type": "array",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "tags[]",
+          "type": "array",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "unapproached_only",
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "next_action",
+          "type": [
+            "string",
+            "null"
+          ],
+          "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": "get",
+      "domain": "prospect",
+      "operationId": "prospect.show",
+      "method": "GET",
+      "path": "/v2/prospects/{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": "import",
+      "domain": "prospect",
+      "operationId": "prospect.import",
+      "method": "POST",
+      "path": "/v2/prospects/import",
+      "summary": "CSVファイルによる一括登録",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "file": {
+              "type": "string",
+              "format": "binary",
+              "contentMediaType": "application/octet-stream"
+            },
+            "dry_run": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "file"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "list",
+      "domain": "prospect",
+      "operationId": "prospect.index",
+      "method": "GET",
+      "path": "/v2/prospects",
+      "summary": "見込客一覧",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "keyword",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "status",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "industry",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "employee_scale",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "assignee_user_id",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "website_domain",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "campaign_ids[]",
+          "type": "array",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "tags[]",
+          "type": "array",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "unapproached_only",
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "next_action",
+          "type": [
+            "string",
+            "null"
+          ],
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "update",
+      "domain": "prospect",
+      "operationId": "prospect.update",
+      "method": "PUT",
+      "path": "/v2/prospects/{id}",
+      "summary": "見込客更新",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "company_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "company_name_kana": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "industry": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "employee_scale": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "website": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            },
+            "postal_code": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 20
+            },
+            "address": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            },
+            "tel": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "fax": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "contact_department": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "contact_name": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "contact_position": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "contact_email": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "email",
+              "maxLength": 255
+            },
+            "contact_tel": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 50
+            },
+            "contact_form_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "new",
+                "approaching",
+                "responded",
+                "appointment",
+                "rejected",
+                "on_hold",
+                null
+              ]
+            },
+            "assignee_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "campaign_ids": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 255
+              }
+            },
+            "tags": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 50
+              }
+            },
+            "source": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "next_action_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date"
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 10000
+            }
+          },
+          "required": [
+            "company_name"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}