@tocca-systems/twp-cli 0.14.1 → 0.15.0

package/command-model/estimate.json

@@ -0,0 +1,1025 @@
+{
+  "domain": "estimate",
+  "operations": [
+    {
+      "name": "create",
+      "domain": "estimate",
+      "operationId": "estimate.store",
+      "method": "POST",
+      "path": "/v2/sales/estimates",
+      "summary": "見積作成",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "estimate_format_id": {
+              "type": "integer"
+            },
+            "estimate_no_rule_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "title": {
+              "type": "string",
+              "maxLength": 500
+            },
+            "company_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "project_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "department_id": {
+              "type": "string",
+              "maxLength": 36
+            },
+            "estimate_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "kpi_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "business_place_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "has_work_report": {
+              "type": "boolean"
+            },
+            "seal_impression_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "reliability": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "60",
+                "55",
+                "50",
+                "40",
+                "30",
+                "20",
+                "10",
+                "02",
+                "01",
+                null
+              ]
+            },
+            "estimate_type": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "rough",
+                "formal",
+                null
+              ]
+            },
+            "project_category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "contracted",
+                "maintenance",
+                "ai_support",
+                "license",
+                "ses_other",
+                "ses_own",
+                null
+              ]
+            },
+            "evaluation_multiplier_category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "self_sourced_new",
+                "company_lead_new",
+                "directed_new",
+                "self_sourced_new_handoff",
+                "company_lead_new_handoff",
+                "directed_new_handoff",
+                "repeat",
+                "tossup_received",
+                null
+              ]
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "new",
+                "create_completed",
+                "in_progress",
+                "approved",
+                "rejected",
+                "submitted",
+                "deleted",
+                null
+              ]
+            },
+            "estimate_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "estimate_expiration_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "order_acceptance_issue_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "order_issue_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "order_no": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "order_no_blank": {
+              "type": "boolean"
+            },
+            "billing_acceptance_category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "bulk",
+                "per_detail",
+                "monthly",
+                null
+              ]
+            },
+            "billing_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "delivery_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "monthly_period_start": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{4}-\\d{2}$"
+            },
+            "monthly_period_end": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{4}-\\d{2}$"
+            },
+            "terms": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "order_acceptance_terms": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "memo": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "internal_memo": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 5000
+            },
+            "manage_form_data": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
+            "details": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "item_name": {
+                    "type": "string",
+                    "maxLength": 500
+                  },
+                  "quantity": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "unit": {
+                    "type": "string",
+                    "enum": [
+                      "set",
+                      "item",
+                      "unit",
+                      "hour",
+                      "day",
+                      "month",
+                      "person",
+                      "person_month",
+                      "person_day"
+                    ]
+                  },
+                  "unit_price": {
+                    "type": "integer"
+                  },
+                  "tax_rate": {
+                    "type": "string",
+                    "enum": [
+                      "10",
+                      "8",
+                      "0"
+                    ]
+                  },
+                  "acceptance_date": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "item_name",
+                  "quantity",
+                  "unit",
+                  "unit_price",
+                  "tax_rate"
+                ]
+              },
+              "minItems": 1
+            },
+            "recipients": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "customer_contact_id": {
+                    "type": "string",
+                    "maxLength": 64
+                  },
+                  "recipient_type": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "enum": [
+                      "to",
+                      "cc",
+                      null
+                    ]
+                  }
+                },
+                "required": [
+                  "customer_contact_id"
+                ]
+              },
+              "maxItems": 50
+            }
+          },
+          "required": [
+            "estimate_format_id",
+            "title",
+            "department_id",
+            "estimate_date",
+            "billing_date",
+            "details"
+          ],
+          "title": "EstimateStoreRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "estimate",
+      "operationId": "estimate.destroy",
+      "method": "DELETE",
+      "path": "/v2/sales/estimates/{id}",
+      "summary": "見積削除",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "delete-allocations",
+      "domain": "estimate",
+      "operationId": "estimate.deleteAllocations",
+      "method": "DELETE",
+      "path": "/v2/sales/estimates/{id}/allocations",
+      "summary": "見積の部署按分を削除",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "deposits",
+      "domain": "estimate",
+      "operationId": "estimate.deposits",
+      "method": "GET",
+      "path": "/v2/sales/estimates/{id}/deposits",
+      "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",
+      "domain": "estimate",
+      "operationId": "estimate.show",
+      "method": "GET",
+      "path": "/v2/sales/estimates/{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": "link-invoice",
+      "domain": "estimate",
+      "operationId": "estimate.linkInvoice",
+      "method": "POST",
+      "path": "/v2/sales/estimates/{id}/link-invoice",
+      "summary": "請求書を見積に紐づけ",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "invoice_no": {
+              "type": "string",
+              "maxLength": 255
+            }
+          },
+          "required": [
+            "invoice_no"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "list",
+      "domain": "estimate",
+      "operationId": "estimate.index",
+      "method": "GET",
+      "path": "/v2/sales/estimates",
+      "summary": "見積一覧取得",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "sort_column",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "sort_direction",
+          "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": "list-allocations",
+      "domain": "estimate",
+      "operationId": "estimate.listAllocations",
+      "method": "GET",
+      "path": "/v2/sales/estimates/{id}/allocations",
+      "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": "update",
+      "domain": "estimate",
+      "operationId": "estimate.update",
+      "method": "PUT",
+      "path": "/v2/sales/estimates/{id}",
+      "summary": "見積更新",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "estimate_format_id": {
+              "type": "integer"
+            },
+            "title": {
+              "type": "string",
+              "maxLength": 500
+            },
+            "company_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "project_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "department_id": {
+              "type": "string",
+              "maxLength": 36
+            },
+            "estimate_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "kpi_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "business_place_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "has_work_report": {
+              "type": "boolean"
+            },
+            "seal_impression_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "reliability": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "60",
+                "55",
+                "50",
+                "40",
+                "30",
+                "20",
+                "10",
+                "02",
+                "01",
+                null
+              ]
+            },
+            "estimate_type": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "rough",
+                "formal",
+                null
+              ]
+            },
+            "project_category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "contracted",
+                "maintenance",
+                "ai_support",
+                "license",
+                "ses_other",
+                "ses_own",
+                null
+              ]
+            },
+            "evaluation_multiplier_category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "self_sourced_new",
+                "company_lead_new",
+                "directed_new",
+                "self_sourced_new_handoff",
+                "company_lead_new_handoff",
+                "directed_new_handoff",
+                "repeat",
+                "tossup_received",
+                null
+              ]
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "new",
+                "create_completed",
+                "in_progress",
+                "approved",
+                "rejected",
+                "submitted",
+                "deleted",
+                null
+              ]
+            },
+            "estimate_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "estimate_expiration_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "order_acceptance_issue_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "order_issue_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "order_no": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "order_no_blank": {
+              "type": "boolean"
+            },
+            "billing_acceptance_category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "bulk",
+                "per_detail",
+                "monthly",
+                null
+              ]
+            },
+            "billing_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "delivery_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "monthly_period_start": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{4}-\\d{2}$"
+            },
+            "monthly_period_end": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "pattern": "^\\d{4}-\\d{2}$"
+            },
+            "terms": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "order_acceptance_terms": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "memo": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "internal_memo": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 5000
+            },
+            "approval_comment": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 1000
+            },
+            "manage_form_data": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
+            "details": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "item_name": {
+                    "type": "string",
+                    "maxLength": 500
+                  },
+                  "quantity": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "unit": {
+                    "type": "string",
+                    "enum": [
+                      "set",
+                      "item",
+                      "unit",
+                      "hour",
+                      "day",
+                      "month",
+                      "person",
+                      "person_month",
+                      "person_day"
+                    ]
+                  },
+                  "unit_price": {
+                    "type": "integer"
+                  },
+                  "tax_rate": {
+                    "type": "string",
+                    "enum": [
+                      "10",
+                      "8",
+                      "0"
+                    ]
+                  },
+                  "acceptance_date": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "format": "date-time"
+                  }
+                }
+              },
+              "minItems": 1
+            },
+            "recipients": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "customer_contact_id": {
+                    "type": "string",
+                    "maxLength": 64
+                  },
+                  "recipient_type": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "enum": [
+                      "to",
+                      "cc",
+                      null
+                    ]
+                  }
+                },
+                "required": [
+                  "customer_contact_id"
+                ]
+              },
+              "maxItems": 50
+            }
+          },
+          "title": "EstimateUpdateRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "update-internal-memo",
+      "domain": "estimate",
+      "operationId": "estimate.updateInternalMemo",
+      "method": "PATCH",
+      "path": "/v2/sales/estimates/{id}/internal-memo",
+      "summary": "見積の社内共有メモを更新する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "internal_memo": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 5000
+            }
+          },
+          "required": [
+            "internal_memo"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "upsert-allocations",
+      "domain": "estimate",
+      "operationId": "estimate.upsertAllocations",
+      "method": "POST",
+      "path": "/v2/sales/estimates/{id}/allocations",
+      "summary": "見積の部署按分を一括更新（全件置換）",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "allocations": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "department_id": {
+                    "type": "string",
+                    "maxLength": 36
+                  },
+                  "amount": {
+                    "type": "integer",
+                    "minimum": 0
+                  },
+                  "percentage": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 100
+                  }
+                },
+                "required": [
+                  "department_id",
+                  "amount",
+                  "percentage"
+                ]
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "allocations"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}