{ "openapi": "3.1.0", "info": { "title": "Laravel", "version": "130f053a9ee6", "description": "Gigma ERP and E-Commerce API contract generated from backend routes and request/response types.\n\n# \u0420\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044f \u0438 \u0432\u0445\u043e\u0434 \u043a\u043e\u043d\u0442\u0440\u0430\u0433\u0435\u043d\u0442\u0430 \u043f\u043e \u0437\u0432\u043e\u043d\u043a\u0443: \u0431\u0438\u0437\u043d\u0435\u0441-\u043b\u043e\u0433\u0438\u043a\u0430 \u0438 JSON\n\n\u041a\u043e\u043d\u0442\u0440\u0430\u043a\u0442 \u0434\u0435\u0439\u0441\u0442\u0432\u0443\u0435\u0442 \u0434\u043b\u044f \u0442\u0440\u0451\u0445 POST-\u0437\u0430\u043f\u0440\u043e\u0441\u043e\u0432:\n`/api/counterparty/callback_auth/init`, `status` \u0438 `exchange`.\n\u041a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u043f\u0435\u0440\u0435\u0434\u0430\u0451\u0442\u0441\u044f \u0432 \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u0435 `Token`. \u041e\u0442\u0432\u0435\u0442 \u0432\u0441\u0435\u0433\u0434\u0430 JSON, \u043d\u0435\u0437\u0430\u0432\u0438\u0441\u0438\u043c\u043e\n\u043e\u0442 \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u0430 `Accept`; \u043e\u0442\u0432\u0435\u0442\u044b \u0437\u0430\u043f\u0440\u0435\u0449\u0435\u043d\u043e \u043a\u0435\u0448\u0438\u0440\u043e\u0432\u0430\u0442\u044c. \u0412\u0445\u043e\u0434 \u043f\u043e email \u0438 \u0432\u0445\u043e\u0434\n\u0441\u043e\u0431\u0441\u0442\u0432\u0435\u043d\u043d\u0438\u043a\u0430 \u044d\u0442\u0438\u043c \u043a\u043e\u043d\u0442\u0440\u0430\u043a\u0442\u043e\u043c \u043d\u0435 \u0438\u0437\u043c\u0435\u043d\u044f\u044e\u0442\u0441\u044f.\n\n\u0418\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044f \u043e\u0431\u044a\u044f\u0441\u043d\u044f\u0435\u0442 \u043f\u0440\u043e\u0446\u0435\u0441\u0441 \u0434\u043b\u044f \u0440\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u0447\u0438\u043a\u0430 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u0438 AI-\u0430\u0433\u0435\u043d\u0442\u0430.\n\u0421\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u0443 \u043f\u043e\u043b\u0435\u0439 \u0438 HTTP-\u043e\u0442\u0432\u0435\u0442\u043e\u0432 \u043f\u0440\u043e\u0432\u0435\u0440\u044f\u0439\u0442\u0435 \u043f\u043e\n[\u043e\u043f\u0443\u0431\u043b\u0438\u043a\u043e\u0432\u0430\u043d\u043d\u043e\u043c\u0443 OpenAPI](https://api.gigma.ru/docs/api.json).\n\u041d\u0438\u0436\u0435 \u043e\u043f\u0438\u0441\u0430\u043d \u0438\u043c\u0435\u043d\u043d\u043e \u0432\u0445\u043e\u0434 \u043f\u043e \u0437\u0432\u043e\u043d\u043a\u0443 \u0447\u0435\u0440\u0435\u0437 callback-auth; \u0434\u0440\u0443\u0433\u0438\u0435 \u0441\u043f\u043e\u0441\u043e\u0431\u044b \u0432\u0445\u043e\u0434\u0430\n\u0438\u043c\u0435\u044e\u0442 \u0441\u043e\u0431\u0441\u0442\u0432\u0435\u043d\u043d\u044b\u0435 \u0437\u0430\u043f\u0440\u043e\u0441\u044b \u0438 \u043f\u0440\u0430\u0432\u0438\u043b\u0430.\n\n## \u0427\u0442\u043e \u0441\u0447\u0438\u0442\u0430\u0435\u0442\u0441\u044f \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u0435\u0439 \u0438 \u0432\u0445\u043e\u0434\u043e\u043c\n\n\u0414\u043b\u044f \u043d\u043e\u0432\u043e\u0433\u043e \u0438 \u0443\u0436\u0435 \u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0435\u0433\u043e \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442 \u043e\u0434\u0438\u043d\u0430\u043a\u043e\u0432\u044b\u0435 \u0448\u0430\u0433\u0438.\n\u041d\u043e\u043c\u0435\u0440 \u0442\u0435\u043b\u0435\u0444\u043e\u043d\u0430 \u2014 \u043e\u0441\u043d\u043e\u0432\u0430\u043d\u0438\u0435 \u0434\u043b\u044f \u043f\u043e\u0438\u0441\u043a\u0430 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u0432 \u043f\u0440\u043e\u0435\u043a\u0442\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f.\n\u041a\u043b\u044e\u0447 `Token` \u043e\u043f\u0440\u0435\u0434\u0435\u043b\u044f\u0435\u0442 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0438 \u0435\u0433\u043e \u043f\u0440\u043e\u0435\u043a\u0442: \u043f\u0435\u0440\u0435\u0434\u0430\u0432\u0430\u0442\u044c `project_id`\n\u0438\u043b\u0438 `counterparty_id` \u0432 \u044d\u0442\u0438\u0445 \u0442\u0440\u0451\u0445 \u0437\u0430\u043f\u0440\u043e\u0441\u0430\u0445 \u043d\u0435 \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f.\n\n| \u0428\u0430\u0433 | \u0427\u0442\u043e \u043f\u0440\u043e\u0438\u0441\u0445\u043e\u0434\u0438\u0442 \u043d\u0430 \u0441\u0435\u0440\u0432\u0435\u0440\u0435 | \u0427\u0442\u043e \u044d\u0442\u043e \u043e\u0437\u043d\u0430\u0447\u0430\u0435\u0442 \u0434\u043b\u044f \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f |\n|---|---|---|\n| `init` | \u0421\u043e\u0437\u0434\u0430\u0451\u0442\u0441\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u043d\u043e\u043c\u0435\u0440\u0430. \u0417\u0430\u043f\u0438\u0441\u044c \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043d\u0430 \u044d\u0442\u043e\u043c \u0448\u0430\u0433\u0435 \u043d\u0435 \u0441\u043e\u0437\u0434\u0430\u0451\u0442\u0441\u044f. | \u041f\u043e\u043a\u0430\u0437\u0430\u0442\u044c \u043d\u043e\u043c\u0435\u0440 \u0434\u043b\u044f \u0437\u0432\u043e\u043d\u043a\u0430; \u0432\u0445\u043e\u0434 \u0435\u0449\u0451 \u043d\u0435 \u0432\u044b\u043f\u043e\u043b\u043d\u0435\u043d. |\n| `status` \u2192 `pending` | \u041f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u0435 \u0437\u0432\u043e\u043d\u043a\u0430 \u0435\u0449\u0451 \u043d\u0435 \u0443\u0441\u0442\u0430\u043d\u043e\u0432\u043b\u0435\u043d\u043e. | \u041f\u0440\u043e\u0434\u043e\u043b\u0436\u0430\u0442\u044c \u043f\u0440\u043e\u0432\u0435\u0440\u044f\u0442\u044c \u0442\u0443 \u0436\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u0443. |\n| `status` \u2192 `verified` | \u0421\u0435\u0440\u0432\u0435\u0440 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0434\u0438\u043b \u0437\u0432\u043e\u043d\u043e\u043a. \u0422\u043e\u043a\u0435\u043d \u0435\u0449\u0451 \u043d\u0435 \u043f\u043e\u043b\u0443\u0447\u0435\u043d. | \u041f\u0435\u0440\u0435\u0439\u0442\u0438 \u043a `exchange`. |\n| \u0423\u0441\u043f\u0435\u0448\u043d\u044b\u0439 `exchange` | \u0421\u0435\u0440\u0432\u0435\u0440 \u043d\u0430\u0445\u043e\u0434\u0438\u0442 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043f\u043e \u043d\u043e\u043c\u0435\u0440\u0443 \u0432 \u043f\u0440\u043e\u0435\u043a\u0442\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u0438\u043b\u0438 \u0441\u043e\u0437\u0434\u0430\u0451\u0442 \u043d\u043e\u0432\u043e\u0433\u043e \u043a\u043b\u0438\u0435\u043d\u0442\u0430, \u0437\u0430\u0442\u0435\u043c \u0432\u044b\u0434\u0430\u0451\u0442 \u0442\u043e\u043a\u0435\u043d \u0434\u043e\u0441\u0442\u0443\u043f\u0430. | \u0421\u043e\u0445\u0440\u0430\u043d\u0438\u0442\u044c \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0439 \u0442\u043e\u043a\u0435\u043d; \u0432\u0445\u043e\u0434 \u0432\u044b\u043f\u043e\u043b\u043d\u0435\u043d. |\n\n\u0415\u0441\u043b\u0438 \u043d\u043e\u043c\u0435\u0440 \u0441\u043e\u043e\u0442\u0432\u0435\u0442\u0441\u0442\u0432\u0443\u0435\u0442 \u043d\u0435\u0441\u043a\u043e\u043b\u044c\u043a\u0438\u043c \u043a\u043b\u0438\u0435\u043d\u0442\u0430\u043c \u0432 \u043f\u0440\u043e\u0435\u043a\u0442\u0435, \u0441\u0435\u0440\u0432\u0435\u0440 \u043d\u0435 \u0432\u044b\u0431\u0438\u0440\u0430\u0435\u0442\n\u043e\u0434\u043d\u043e\u0433\u043e \u043d\u0430\u0443\u0433\u0430\u0434: `exchange` \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 `counterparty_phone_identity_conflict`.\n\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043d\u0430\u043f\u0440\u0430\u0432\u043b\u044f\u0435\u0442 \u0447\u0435\u043b\u043e\u0432\u0435\u043a\u0430 \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443, \u043d\u0435 \u0441\u043e\u0437\u0434\u0430\u0451\u0442 \u043e\u0442\u0434\u0435\u043b\u044c\u043d\u043e\u0433\u043e \u043a\u043b\u0438\u0435\u043d\u0442\u0430\n\u0447\u0435\u0440\u0435\u0437 \u0434\u0440\u0443\u0433\u043e\u0439 \u0437\u0430\u043f\u0440\u043e\u0441 \u0432 \u043f\u043e\u043f\u044b\u0442\u043a\u0435 \u043e\u0431\u043e\u0439\u0442\u0438 \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442.\n\n\u041a\u0440\u0438\u0442\u0435\u0440\u0438\u0439 \u0443\u0441\u043f\u0435\u0445\u0430 \u0434\u043b\u044f \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f: \u043f\u043e\u043b\u0443\u0447\u0435\u043d \u0443\u0441\u043f\u0435\u0448\u043d\u044b\u0439 \u043e\u0442\u0432\u0435\u0442 `exchange` \u0441\n`access_token`. \u0423\u0441\u043f\u0435\u0448\u043d\u044b\u0439 `init`, \u043e\u0442\u0432\u0435\u0442 \u043f\u0440\u043e\u0432\u0430\u0439\u0434\u0435\u0440\u0430 \u0437\u0432\u043e\u043d\u043a\u043e\u0432 \u0438\u043b\u0438 `verified`\n\u0441\u0430\u043c\u0438 \u043f\u043e \u0441\u0435\u0431\u0435 \u043d\u0435 \u044f\u0432\u043b\u044f\u044e\u0442\u0441\u044f \u0437\u0430\u0432\u0435\u0440\u0448\u0451\u043d\u043d\u044b\u043c \u0432\u0445\u043e\u0434\u043e\u043c.\n\n```mermaid\nflowchart TD\n A[\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c \u0432\u0432\u043e\u0434\u0438\u0442 \u0442\u0435\u043b\u0435\u0444\u043e\u043d] --> B[init: \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u043f\u043e\u043f\u044b\u0442\u043a\u0443]\n B --> C[\u041f\u043e\u043a\u0430\u0437\u0430\u0442\u044c callback_number \u0438 \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043f\u043e\u0437\u0432\u043e\u043d\u0438\u0442\u044c]\n C --> D[status: \u043f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c \u0442\u0435\u043a\u0443\u0449\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443]\n D -->|pending| D\n D -->|verified| E[exchange: \u043f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0442\u043e\u043a\u0435\u043d]\n D -->|expired| F[\u041f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443]\n E -->|access_token \u043f\u043e\u043b\u0443\u0447\u0435\u043d| G[\u0412\u0445\u043e\u0434 \u0437\u0430\u0432\u0435\u0440\u0448\u0451\u043d]\n```\n\n\u0414\u0438\u0430\u0433\u0440\u0430\u043c\u043c\u0430 \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0435\u0442 \u0443\u0441\u043f\u0435\u0448\u043d\u044b\u0439 \u043f\u0440\u043e\u0446\u0435\u0441\u0441 \u0438 \u0438\u0441\u0442\u0435\u0447\u0435\u043d\u0438\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u0438. \u0414\u043b\u044f \u043e\u0441\u0442\u0430\u043b\u044c\u043d\u044b\u0445\n\u043e\u0442\u043a\u0430\u0437\u043e\u0432 \u0434\u0435\u0439\u0441\u0442\u0432\u0443\u044e\u0442 \u043f\u0440\u0430\u0432\u0438\u043b\u0430 \u0440\u0430\u0437\u0434\u0435\u043b\u0430 \u00ab\u0414\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u043f\u043e\u0441\u043b\u0435 \u043e\u0442\u043a\u0430\u0437\u0430\u00bb.\n\n## \u041a\u0430\u043a \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0437\u0430\u0432\u0435\u0440\u0448\u0430\u0435\u0442 \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044e\n\n1. \u041e\u0434\u0438\u043d \u0440\u0430\u0437 \u0441\u043e\u0437\u0434\u0430\u0451\u0442 \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0447\u0435\u0440\u0435\u0437 `init` \u0438 \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u0435\u0442 \u0438\u0441\u0445\u043e\u0434\u043d\u044b\u0439 `client_nonce`\n \u0432\u043c\u0435\u0441\u0442\u0435 \u0441 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u043c `session_token`.\n2. \u041f\u0440\u043e\u0432\u0435\u0440\u044f\u0435\u0442 \u044d\u0442\u0443 \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0447\u0435\u0440\u0435\u0437 `status`. `pending` \u2014 \u043e\u0436\u0438\u0434\u0430\u043d\u0438\u0435 \u0437\u0432\u043e\u043d\u043a\u0430,\n `verified` \u2014 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043d\u043d\u044b\u0439 \u0437\u0432\u043e\u043d\u043e\u043a, `expired` \u2014 \u043d\u0443\u0436\u043d\u0430 \u043d\u043e\u0432\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430.\n3. \u041f\u0440\u0438 `verified` \u0432\u044b\u0437\u044b\u0432\u0430\u0435\u0442 `exchange`. \u0420\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044f/\u0432\u0445\u043e\u0434 \u0437\u0430\u0432\u0435\u0440\u0448\u0435\u043d\u044b \u0442\u043e\u043b\u044c\u043a\u043e\n \u043f\u043e\u0441\u043b\u0435 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f `access_token`; `status` \u043d\u0438\u043a\u043e\u0433\u0434\u0430 \u043d\u0435 \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 \u0442\u043e\u043a\u0435\u043d.\n\n\u041e\u0431\u044b\u0447\u043d\u044b\u0435 \u0443\u0441\u043f\u0435\u0448\u043d\u044b\u0435 \u0442\u0435\u043b\u0430 \u0441\u043e\u0445\u0440\u0430\u043d\u0435\u043d\u044b: `init` \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 `session_token`,\n`callback_number`, `expires_at`; `status` \u2014 `status`, `expires_at`,\n`server_time`, `remaining_seconds`; `exchange` \u2014 \u0442\u043e\u043b\u044c\u043a\u043e `access_token`.\n`status` \u0434\u043e\u043f\u043e\u043b\u043d\u0438\u0442\u0435\u043b\u044c\u043d\u043e \u043c\u043e\u0436\u0435\u0442 \u0441\u043e\u0434\u0435\u0440\u0436\u0430\u0442\u044c \u043d\u0435\u043e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u044c\u043d\u043e\u0435 `warning`.\n\n\u041d\u0435 \u0437\u0430\u043f\u0438\u0441\u044b\u0432\u0430\u0439\u0442\u0435 `Token`, `client_nonce`, `session_token` \u0438 `access_token`\n\u0432 \u0436\u0443\u0440\u043d\u0430\u043b\u044b \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f. \u0414\u043b\u044f \u043e\u0431\u0440\u0430\u0449\u0435\u043d\u0438\u044f \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443 \u0434\u043e\u0441\u0442\u0430\u0442\u043e\u0447\u043d\u043e \u043d\u043e\u043c\u0435\u0440\u0430 \u0437\u0430\u043f\u0440\u043e\u0441\u0430.\n\n## \u041f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430 \u0437\u0430\u043f\u0440\u043e\u0441\u0430: \u043a\u0430\u043a\u0438\u0435 \u0434\u0430\u043d\u043d\u044b\u0435 \u0434\u043b\u044f \u0447\u0435\u0433\u043e \u043d\u0443\u0436\u043d\u044b\n\n\u0412\u0441\u0435 \u0442\u0440\u0438 \u0437\u0430\u043f\u0440\u043e\u0441\u0430 \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u044f\u044e\u0442\u0441\u044f \u043d\u0430 `https://api.gigma.ru` \u043c\u0435\u0442\u043e\u0434\u043e\u043c POST.\n\u0417\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u0438:\n\n```http\nContent-Type: application/json\nAccept: application/json\nToken: \n```\n\n`` \u2014 \u043d\u0430\u0441\u0442\u0440\u043e\u0435\u043d\u043d\u044b\u0439 \u043a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f, \u0430 \u043d\u0435 \u0442\u043e\u043a\u0435\u043d \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f.\n`Accept` \u0440\u0435\u043a\u043e\u043c\u0435\u043d\u0434\u0443\u0435\u0442\u0441\u044f \u0443\u043a\u0430\u0437\u044b\u0432\u0430\u0442\u044c \u044f\u0432\u043d\u043e; \u044d\u0442\u0438 \u0442\u0440\u0438 \u043c\u0430\u0440\u0448\u0440\u0443\u0442\u0430 \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u044e\u0442 JSON\n\u0442\u0430\u043a\u0436\u0435 \u0431\u0435\u0437 \u043d\u0435\u0433\u043e. \u0412\u0441\u0435 \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u044f \u0432 \u043f\u0440\u0438\u043c\u0435\u0440\u0430\u0445 \u043d\u0438\u0436\u0435 \u0434\u0435\u043c\u043e\u043d\u0441\u0442\u0440\u0430\u0446\u0438\u043e\u043d\u043d\u044b\u0435: \u043e\u043d\u0438 \u043d\u0435\n\u044f\u0432\u043b\u044f\u044e\u0442\u0441\u044f \u0434\u0435\u0439\u0441\u0442\u0432\u0443\u044e\u0449\u0435\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u043e\u0439 \u0432\u0445\u043e\u0434\u0430. \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u044f \u0432 \u0443\u0433\u043b\u043e\u0432\u044b\u0445 \u0441\u043a\u043e\u0431\u043a\u0430\u0445 \u0437\u0430\u043c\u0435\u043d\u044f\u044e\u0442\u0441\u044f\n\u043e\u0442\u0432\u0435\u0442\u0430\u043c\u0438 \u0441\u0435\u0440\u0432\u0435\u0440\u0430 \u0438\u043b\u0438 \u043d\u0430\u0441\u0442\u0440\u043e\u0435\u043d\u043d\u044b\u043c\u0438 \u043a\u043b\u044e\u0447\u0430\u043c\u0438.\n\n| \u041f\u043e\u043b\u0435 | \u0413\u0434\u0435 \u043f\u0435\u0440\u0435\u0434\u0430\u0451\u0442\u0441\u044f | \u041d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u0438 \u043e\u0433\u0440\u0430\u043d\u0438\u0447\u0435\u043d\u0438\u044f |\n|---|---|---|\n| `phone` | `init` | \u0422\u0435\u043b\u0435\u0444\u043e\u043d, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0434\u0438\u0442 \u0437\u0432\u043e\u043d\u043a\u043e\u043c. \u041f\u043e\u0441\u043b\u0435 \u043d\u043e\u0440\u043c\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u0438 \u2014 11 \u0446\u0438\u0444\u0440, \u043d\u0430\u0447\u0438\u043d\u0430\u0435\u0442\u0441\u044f \u0441 `7`. |\n| `client_nonce` | \u0412\u0441\u0435 \u0442\u0440\u0438 \u0437\u0430\u043f\u0440\u043e\u0441\u0430 | \u0421\u0435\u043a\u0440\u0435\u0442 \u043e\u0434\u043d\u043e\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438, \u0441\u043e\u0437\u0434\u0430\u0451\u0442\u0441\u044f \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435\u043c \u0434\u043e `init`. 32\u2013128 \u0441\u0438\u043c\u0432\u043e\u043b\u043e\u0432: \u0431\u0443\u043a\u0432\u044b \u043b\u0430\u0442\u0438\u043d\u0438\u0446\u044b, \u0446\u0438\u0444\u0440\u044b, `_` \u0438 `-`. \u0414\u043b\u044f \u0440\u0435\u0430\u043b\u044c\u043d\u043e\u0433\u043e \u0432\u0445\u043e\u0434\u0430 \u0433\u0435\u043d\u0435\u0440\u0438\u0440\u0443\u0435\u0442\u0441\u044f \u043a\u0440\u0438\u043f\u0442\u043e\u0433\u0440\u0430\u0444\u0438\u0447\u0435\u0441\u043a\u0438 \u0441\u043b\u0443\u0447\u0430\u0439\u043d\u043e; \u043d\u0430\u043f\u0440\u0438\u043c\u0435\u0440, 32 \u0441\u043b\u0443\u0447\u0430\u0439\u043d\u044b\u0445 \u0431\u0430\u0439\u0442\u0430 \u0432 base64url \u0431\u0435\u0437 `=`. |\n| `session_token` | `status`, `exchange` | \u0421\u0435\u043a\u0440\u0435\u0442 \u043f\u043e\u043f\u044b\u0442\u043a\u0438, \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0439 \u0438\u0437 `init`, \u0441\u0442\u0440\u043e\u043a\u0430 \u0434\u043e 128 \u0441\u0438\u043c\u0432\u043e\u043b\u043e\u0432. \u041f\u0435\u0440\u0435\u0434\u0430\u0451\u0442\u0441\u044f \u0432\u043c\u0435\u0441\u0442\u0435 \u0441 \u0438\u0441\u0445\u043e\u0434\u043d\u044b\u043c `client_nonce` \u0438 \u0442\u0435\u043c \u0436\u0435 \u043a\u043b\u044e\u0447\u043e\u043c \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f. |\n| `device` | \u041d\u0435\u043e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u044c\u043d\u043e \u0432 `exchange` | \u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u0443\u0441\u0442\u0440\u043e\u0439\u0441\u0442\u0432\u0430, \u0441\u0442\u0440\u043e\u043a\u0430 \u0434\u043e 255 \u0441\u0438\u043c\u0432\u043e\u043b\u043e\u0432 \u0438\u043b\u0438 `null`. \u042d\u0442\u043e \u0434\u043e\u043f\u043e\u043b\u043d\u0438\u0442\u0435\u043b\u044c\u043d\u0430\u044f \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044f, \u043d\u0435 \u0434\u043e\u043a\u0430\u0437\u0430\u0442\u0435\u043b\u044c\u0441\u0442\u0432\u043e \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0437\u0432\u043e\u043d\u043a\u0430. |\n\n\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u0435\u0442 `client_nonce` \u0438 `session_token` \u043a\u0430\u043a \u043e\u0434\u043d\u0443 \u043f\u0430\u0440\u0443.\n\u041d\u0435 \u0433\u0435\u043d\u0435\u0440\u0438\u0440\u0443\u0435\u0442 \u043d\u043e\u0432\u044b\u0439 nonce \u0434\u043b\u044f \u043e\u0447\u0435\u0440\u0435\u0434\u043d\u043e\u0433\u043e `status` \u0438\u043b\u0438 `exchange` \u0438 \u043d\u0435\n\u043f\u0435\u0440\u0435\u043d\u043e\u0441\u0438\u0442 \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0432 \u0434\u0440\u0443\u0433\u043e\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435. \u041d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u043d\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430, \u0447\u0443\u0436\u043e\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435\n\u0438 \u043d\u0435\u0432\u0435\u0440\u043d\u044b\u0439 nonce \u0434\u0430\u044e\u0442 \u043e\u0434\u0438\u043d\u0430\u043a\u043e\u0432\u044b\u0439 \u0431\u0435\u0437\u043e\u043f\u0430\u0441\u043d\u044b\u0439 404.\n\n## \u0428\u0430\u0433 1. \u041d\u0430\u0447\u0430\u0442\u044c \u043f\u043e\u043f\u044b\u0442\u043a\u0443: init\n\n`POST /api/counterparty/callback_auth/init`\n\n```json\n{\n \"phone\": \"79001234567\",\n \"client_nonce\": \"EXAMPLE_NONCE_0123456789abcdefghij\"\n}\n```\n\n\u041f\u0440\u0438\u043c\u0435\u0440 \u0443\u0441\u043f\u0435\u0448\u043d\u043e\u0433\u043e \u043e\u0442\u0432\u0435\u0442\u0430 HTTP 200:\n\n```json\n{\n \"session_token\": \"\",\n \"callback_number\": \"79001000011\",\n \"expires_at\": \"2026-10-04T12:05:00+07:00\"\n}\n```\n\n\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u0435\u0442 `session_token` \u0441 nonce \u044d\u0442\u043e\u0433\u043e \u0437\u0430\u043f\u0440\u043e\u0441\u0430, \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0435\u0442\n\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044e `callback_number` \u0438 \u043f\u0440\u0435\u0434\u043b\u0430\u0433\u0430\u0435\u0442 \u043f\u043e\u0437\u0432\u043e\u043d\u0438\u0442\u044c \u043d\u0430 \u043d\u0435\u0433\u043e \u0441 \u0443\u043a\u0430\u0437\u0430\u043d\u043d\u043e\u0433\u043e\n\u0432 `phone` \u043d\u043e\u043c\u0435\u0440\u0430. \u0412 `status` \u0438 `exchange` \u043f\u0435\u0440\u0435\u0434\u0430\u0451\u0442\u0441\u044f `session_token`,\n\u0430 \u043d\u0435 `callback_number`. \u041d\u043e\u043c\u0435\u0440 \u0434\u043b\u044f \u0437\u0432\u043e\u043d\u043a\u0430 \u0432\u0441\u0435\u0433\u0434\u0430 \u0431\u0435\u0440\u0451\u0442\u0441\u044f \u0438\u0437 \u0440\u0435\u0430\u043b\u044c\u043d\u043e\u0433\u043e \u043e\u0442\u0432\u0435\u0442\u0430.\n\n\u0415\u0441\u043b\u0438 `init` \u0432\u0435\u0440\u043d\u0443\u043b \u043e\u0448\u0438\u0431\u043a\u0443, \u043f\u0440\u0438\u043c\u0435\u043d\u044f\u044e\u0442\u0441\u044f `error.next_action` \u0438 \u043f\u0440\u0430\u0432\u0438\u043b\u0430 \u043f\u043e\u0432\u0442\u043e\u0440\u043e\u0432.\n\u0415\u0441\u043b\u0438 \u043e\u0442\u0432\u0435\u0442 \u043f\u043e\u0442\u0435\u0440\u044f\u043d, \u043d\u0435 \u0441\u043b\u0435\u0434\u0443\u0435\u0442 \u0441\u0447\u0438\u0442\u0430\u0442\u044c \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u043d\u0435\u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0435\u0439 \u0438 \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\n\u043e\u0442\u043f\u0440\u0430\u0432\u043b\u044f\u0442\u044c \u043d\u043e\u0432\u044b\u0439 `init`.\n\n## \u0428\u0430\u0433 2. \u041f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c \u0437\u0432\u043e\u043d\u043e\u043a: status\n\n`POST /api/counterparty/callback_auth/status`\n\n```json\n{\n \"session_token\": \"\",\n \"client_nonce\": \"EXAMPLE_NONCE_0123456789abcdefghij\"\n}\n```\n\n\u041f\u0440\u0438\u043c\u0435\u0440 \u0443\u0441\u043f\u0435\u0448\u043d\u043e\u0433\u043e \u043e\u0442\u0432\u0435\u0442\u0430 HTTP 200:\n\n```json\n{\n \"status\": \"pending\",\n \"expires_at\": \"2026-10-04T12:05:00+07:00\",\n \"server_time\": \"2026-10-04T12:01:00+07:00\",\n \"remaining_seconds\": 240\n}\n```\n\n| `status` | \u0421\u043b\u0435\u0434\u0443\u044e\u0449\u0435\u0435 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435 |\n|---|---|\n| `pending` | \u041e\u0441\u0442\u0430\u0432\u0438\u0442\u044c \u0442\u0435\u043a\u0443\u0449\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0438 \u043f\u0440\u043e\u0434\u043e\u043b\u0436\u0430\u0442\u044c \u043e\u043f\u0440\u043e\u0441 \u0441 \u043f\u0430\u0443\u0437\u043e\u0439. \u0415\u0441\u043b\u0438 \u0435\u0441\u0442\u044c `warning`, \u0441\u043e\u0431\u043b\u044e\u0434\u0430\u0442\u044c \u0435\u0433\u043e \u0437\u0430\u0434\u0435\u0440\u0436\u043a\u0443. |\n| `verified` | \u041e\u0442\u043f\u0440\u0430\u0432\u0438\u0442\u044c `exchange` \u0441 \u0442\u043e\u0439 \u0436\u0435 \u043f\u0430\u0440\u043e\u0439 \u0441\u0435\u043a\u0440\u0435\u0442\u043e\u0432. |\n| `expired` | \u0417\u0430\u0432\u0435\u0440\u0448\u0438\u0442\u044c \u043e\u0436\u0438\u0434\u0430\u043d\u0438\u0435; \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044e \u043d\u0430\u0447\u0430\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443. |\n\n`expires_at` \u2014 \u0441\u0440\u043e\u043a \u0442\u0435\u043a\u0443\u0449\u0435\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438, `server_time` \u2014 \u0432\u0440\u0435\u043c\u044f \u0441\u0435\u0440\u0432\u0435\u0440\u0430,\n`remaining_seconds` \u2014 \u043e\u0441\u0442\u0430\u0432\u0448\u0435\u0435\u0441\u044f \u0432\u0440\u0435\u043c\u044f; \u043f\u043e\u043b\u044f \u0441\u0440\u043e\u043a\u0430 \u0438 \u043e\u0441\u0442\u0430\u0442\u043a\u0430 \u043c\u043e\u0433\u0443\u0442 \u0431\u044b\u0442\u044c `null`.\n\u0422\u0430\u0439\u043c\u0435\u0440 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u043e\u0440\u0438\u0435\u043d\u0442\u0438\u0440\u0443\u0435\u0442\u0441\u044f \u043d\u0430 \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u0438\u0439 \u043e\u0442\u0432\u0435\u0442 \u0441\u0435\u0440\u0432\u0435\u0440\u0430, \u0430 \u043d\u0435 \u043d\u0430\n\u0437\u0430\u0448\u0438\u0442\u043e\u0435 \u043f\u043e\u0441\u0442\u043e\u044f\u043d\u043d\u043e\u0435 \u0447\u0438\u0441\u043b\u043e \u043c\u0438\u043d\u0443\u0442. \u041f\u043e\u0441\u043b\u0435 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0441\u0440\u043e\u043a \u043c\u043e\u0436\u0435\u0442 \u0438\u0437\u043c\u0435\u043d\u0438\u0442\u044c\u0441\u044f.\n\n\u0421\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f \u043e\u043f\u0438\u0441\u044b\u0432\u0430\u044e\u0442 \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0437\u0432\u043e\u043d\u043a\u0430. \u041e\u0442\u0434\u0435\u043b\u044c\u043d\u043e\u0433\u043e \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u044f\n`logged_in` \u0432 `status` \u043d\u0435\u0442: \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043e\u0442\u043c\u0435\u0447\u0430\u0435\u0442 \u0432\u044b\u043f\u043e\u043b\u043d\u0435\u043d\u043d\u044b\u0439 \u0432\u0445\u043e\u0434 \u043f\u043e\u0441\u043b\u0435\n\u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0442\u043e\u043a\u0435\u043d\u0430 \u0438\u0437 `exchange`.\n\n## \u0428\u0430\u0433 3. \u0417\u0430\u0432\u0435\u0440\u0448\u0438\u0442\u044c \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044e \u0438\u043b\u0438 \u0432\u0445\u043e\u0434: exchange\n\n`POST /api/counterparty/callback_auth/exchange`\n\n```json\n{\n \"session_token\": \"\",\n \"client_nonce\": \"EXAMPLE_NONCE_0123456789abcdefghij\",\n \"device\": \"TV VPS / Android\"\n}\n```\n\n\u041f\u0440\u0438\u043c\u0435\u0440 \u0443\u0441\u043f\u0435\u0448\u043d\u043e\u0433\u043e \u043e\u0442\u0432\u0435\u0442\u0430 HTTP 200:\n\n```json\n{\n \"access_token\": \"\"\n}\n```\n\n\u041f\u0440\u0438 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u0438 `access_token` \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u0435\u0442 \u0435\u0433\u043e \u0432 \u0437\u0430\u0449\u0438\u0449\u0451\u043d\u043d\u043e\u043c \u0445\u0440\u0430\u043d\u0438\u043b\u0438\u0449\u0435\n\u0438 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442 \u0434\u043b\u044f \u043f\u043e\u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0438\u0445 \u0437\u0430\u043f\u0440\u043e\u0441\u043e\u0432, \u0442\u0440\u0435\u0431\u0443\u044e\u0449\u0438\u0445 \u0432\u0445\u043e\u0434\u0430 \u043a\u043e\u043d\u0442\u0440\u0430\u0433\u0435\u043d\u0442\u0430:\n\n```http\nAuthorization: Bearer \n```\n\n\u041f\u0440\u0438\u043c\u0435\u0440 \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0435\u0442 \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043e\u043a \u0430\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u0438, \u0430 \u043d\u0435 \u043f\u043e\u043b\u043d\u044b\u0439 \u043d\u0430\u0431\u043e\u0440 \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u043e\u0432 \u0432\u0441\u0435\u0445\n\u043c\u0430\u0440\u0448\u0440\u0443\u0442\u043e\u0432. \u0422\u0440\u0435\u0431\u043e\u0432\u0430\u043d\u0438\u044f \u043a\u043e\u043d\u043a\u0440\u0435\u0442\u043d\u043e\u0433\u043e \u043f\u043e\u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0435\u0433\u043e \u0437\u0430\u043f\u0440\u043e\u0441\u0430 \u043f\u0440\u043e\u0432\u0435\u0440\u044f\u044e\u0442\u0441\u044f \u0432 OpenAPI.\n\u041a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f `Token` \u0438 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0438\u0439 `access_token` \u0438\u043c\u0435\u044e\u0442 \u0440\u0430\u0437\u043d\u044b\u0435 \u0440\u043e\u043b\u0438.\n\n\u0415\u0441\u043b\u0438 `exchange` \u0432\u0435\u0440\u043d\u0443\u043b 409 `callback_auth_not_verified`, \u043d\u0443\u0436\u043d\u043e \u0432\u0435\u0440\u043d\u0443\u0442\u044c\u0441\u044f\n\u043a \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0435 \u0442\u043e\u0439 \u0436\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u0438. \u0412\u0440\u0435\u043c\u0435\u043d\u043d\u0430\u044f \u043d\u0435\u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c \u0437\u0432\u043e\u043d\u043e\u043a \u0434\u0430\u0451\u0442\n503 `callback_auth_verification_unavailable` \u0438 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435 `poll`.\n\u041e\u0431\u0430 \u0441\u043b\u0443\u0447\u0430\u044f \u043d\u0435 \u043e\u0437\u043d\u0430\u0447\u0430\u044e\u0442 \u0443\u0441\u043f\u0435\u0448\u043d\u044b\u0439 \u0432\u0445\u043e\u0434.\n\n## \u041e\u0442\u0432\u0435\u0442 \u0441 \u043e\u0448\u0438\u0431\u043a\u043e\u0439\n\n\u041f\u0440\u0435\u0436\u043d\u0438\u0435 `message` \u0438 \u043e\u0448\u0438\u0431\u043a\u0438 \u043f\u043e\u043b\u0435\u0439 `errors` \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u044e\u0442\u0441\u044f \u0434\u043b\u044f \u0441\u043e\u0432\u043c\u0435\u0441\u0442\u0438\u043c\u043e\u0441\u0442\u0438.\n\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043f\u0440\u0438\u043d\u0438\u043c\u0430\u0435\u0442 \u0440\u0435\u0448\u0435\u043d\u0438\u0435 \u043f\u043e `error.code` \u0438 `error.next_action`,\n\u0430 \u0442\u0435\u043a\u0441\u0442 `error.message` \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0435\u0442 \u0447\u0435\u043b\u043e\u0432\u0435\u043a\u0443:\n\n```json\n{\n \"message\": \"callback_auth_expired\",\n \"error\": {\n \"code\": \"callback_auth_expired\",\n \"message\": \"\u0412\u0440\u0435\u043c\u044f \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0438\u0441\u0442\u0435\u043a\u043b\u043e. \u041d\u0430\u0447\u043d\u0438\u0442\u0435 \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443.\",\n \"next_action\": \"restart\",\n \"retry_after_seconds\": null,\n \"request_id\": \"5a7f76e2-2851-4c02-8dc5-61882b616e3b\"\n }\n}\n```\n\n\u0422\u0435\u043a\u0441\u0442 \u0432\u044b\u0448\u0435 \u2014 \u043f\u0440\u0438\u043c\u0435\u0440 \u043e\u0431\u044a\u044f\u0441\u043d\u0435\u043d\u0438\u044f; \u0435\u0433\u043e \u0444\u043e\u0440\u043c\u0443\u043b\u0438\u0440\u043e\u0432\u043a\u0430 \u043d\u0435 \u044f\u0432\u043b\u044f\u0435\u0442\u0441\u044f \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u043d\u044b\u043c\n\u0438\u0434\u0435\u043d\u0442\u0438\u0444\u0438\u043a\u0430\u0442\u043e\u0440\u043e\u043c. `request_id` \u0441\u043e\u0437\u0434\u0430\u0451\u0442 \u0441\u0435\u0440\u0432\u0435\u0440 \u0438 \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 \u0442\u0430\u043a\u0436\u0435 \u0432 \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u0435\n`X-Request-ID`. \u0412\u0445\u043e\u0434\u044f\u0449\u0438\u0439 \u0438\u0434\u0435\u043d\u0442\u0438\u0444\u0438\u043a\u0430\u0442\u043e\u0440 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043d\u0435 \u0437\u0430\u043c\u0435\u043d\u044f\u0435\u0442 \u0441\u0435\u0440\u0432\u0435\u0440\u043d\u044b\u0439.\n\u0414\u043b\u044f \u0443\u0441\u043f\u0435\u0448\u043d\u044b\u0445 \u043e\u0442\u0432\u0435\u0442\u043e\u0432 \u0438\u0434\u0435\u043d\u0442\u0438\u0444\u0438\u043a\u0430\u0442\u043e\u0440 \u0434\u043e\u0441\u0442\u0443\u043f\u0435\u043d \u0432 \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u0435 \u0431\u0435\u0437 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f \u0442\u0435\u043b\u0430.\n\u0416\u0443\u0440\u043d\u0430\u043b\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u0435 \u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f \u043f\u043e \u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u0438 \u0438 \u043e\u0433\u0440\u0430\u043d\u0438\u0447\u0435\u043d\u043e: \u0434\u043e \u043f\u044f\u0442\u0438 \u0441\u043e\u0431\u044b\u0442\u0438\u0439\n\u043d\u0430 \u044d\u0442\u0430\u043f/\u043a\u043e\u0434 \u0437\u0430 \u043c\u0438\u043d\u0443\u0442\u0443 \u0438 \u0434\u043e 60 \u0441\u043e\u0431\u044b\u0442\u0438\u0439 \u0432 \u043c\u0438\u043d\u0443\u0442\u0443 \u0441\u0443\u043c\u043c\u0430\u0440\u043d\u043e. \u041f\u0440\u0438 \u043f\u043e\u0432\u0442\u043e\u0440\u043d\u044b\u0445 \u043e\u0442\u043a\u0430\u0437\u0430\u0445\n\u0438\u043b\u0438 \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u043e\u043c \u0436\u0443\u0440\u043d\u0430\u043b\u0435 \u0437\u0430\u043f\u0438\u0441\u044c \u043e\u0442\u0434\u0435\u043b\u044c\u043d\u043e\u0433\u043e \u043d\u043e\u043c\u0435\u0440\u0430 \u043e\u0431\u0440\u0430\u0449\u0435\u043d\u0438\u044f \u043c\u043e\u0436\u0435\u0442 \u043e\u0442\u0441\u0443\u0442\u0441\u0442\u0432\u043e\u0432\u0430\u0442\u044c;\n\u0441\u0430\u043c \u043e\u0442\u0432\u0435\u0442 \u0438 \u0430\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u044f \u043e\u0442 \u044d\u0442\u043e\u0433\u043e \u043d\u0435 \u043c\u0435\u043d\u044f\u044e\u0442\u0441\u044f.\n\n\u041f\u0440\u0438 HTTP 422 \u043f\u0440\u0435\u0436\u043d\u0438\u0439 \u043e\u0431\u044a\u0435\u043a\u0442 `errors` \u0441\u043e\u0434\u0435\u0440\u0436\u0438\u0442 \u043c\u0430\u0441\u0441\u0438\u0432 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0439 \u0434\u043b\u044f \u043a\u0430\u0436\u0434\u043e\u0433\u043e\n\u043e\u0448\u0438\u0431\u043e\u0447\u043d\u043e\u0433\u043e \u043f\u043e\u043b\u044f; \u043f\u0440\u0435\u0436\u043d\u0435\u0435 \u043f\u043e\u043b\u0435 `message` \u043c\u043e\u0436\u0435\u0442 \u043e\u0442\u0441\u0443\u0442\u0441\u0442\u0432\u043e\u0432\u0430\u0442\u044c. \u041d\u0435 \u0437\u0430\u043c\u0435\u043d\u044f\u0439\u0442\u0435\n\u043f\u043e\u0434\u0441\u0432\u0435\u0442\u043a\u0443 \u043f\u043e\u043b\u0435\u0439 \u043e\u0431\u0449\u0438\u043c \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0435\u043c \u0438\u0437 `error`.\n\n## \u0414\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u043f\u043e\u0441\u043b\u0435 \u043e\u0442\u043a\u0430\u0437\u0430\n\n| next_action | \u0414\u0435\u0439\u0441\u0442\u0432\u0438\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f |\n|---|---|\n| `fix_input` | \u041f\u043e\u043a\u0430\u0437\u0430\u0442\u044c \u043e\u0448\u0438\u0431\u043a\u0438 \u043f\u043e\u043b\u0435\u0439 \u0438 \u0434\u0430\u0442\u044c \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c \u0432\u0432\u043e\u0434. |\n| `contact_support` | \u041f\u0440\u0435\u043a\u0440\u0430\u0442\u0438\u0442\u044c \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\u0435 \u043f\u043e\u0432\u0442\u043e\u0440\u044b \u0438 \u043f\u043e\u043a\u0430\u0437\u0430\u0442\u044c \u043d\u043e\u043c\u0435\u0440 \u0437\u0430\u043f\u0440\u043e\u0441\u0430. |\n| `restart` | \u041f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044e \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0441 \u043d\u043e\u0432\u044b\u043c nonce. |\n| `poll` | \u041f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c \u043f\u0440\u0435\u0436\u043d\u044e\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0447\u0435\u0440\u0435\u0437 `status`; \u043d\u043e\u0432\u044b\u0439 `init` \u043d\u0435 \u0437\u0430\u043f\u0443\u0441\u043a\u0430\u0442\u044c. |\n| `wait` | \u0412\u044b\u0436\u0434\u0430\u0442\u044c \u0438\u0437\u0432\u0435\u0441\u0442\u043d\u044b\u0439 \u0441\u0440\u043e\u043a; \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u043d\u0435 \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c. |\n\n`retry_after_seconds` \u2014 \u0438\u0437\u0432\u0435\u0441\u0442\u043d\u044b\u0439 \u0441\u0440\u043e\u043a \u043e\u0436\u0438\u0434\u0430\u043d\u0438\u044f \u0438\u043b\u0438 `null`, \u0435\u0441\u043b\u0438 \u0441\u0440\u043e\u043a\n\u043d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u0435\u043d. \u0415\u0441\u043b\u0438 \u0441\u0435\u0440\u0432\u0435\u0440 \u043f\u0440\u0438\u0441\u043b\u0430\u043b `Retry-After`, \u0435\u0433\u043e \u0447\u0438\u0441\u043b\u043e \u0441\u0435\u043a\u0443\u043d\u0434 \u0441\u043e\u0432\u043f\u0430\u0434\u0430\u0435\u0442\n\u0441 \u043f\u043e\u043b\u0435\u043c \u0442\u0435\u043b\u0430. `null` \u043d\u0435 \u043e\u0437\u043d\u0430\u0447\u0430\u0435\u0442 \u043d\u0435\u043c\u0435\u0434\u043b\u0435\u043d\u043d\u044b\u0439 \u043f\u043e\u0432\u0442\u043e\u0440.\n\n| \u0421\u0438\u0442\u0443\u0430\u0446\u0438\u044f | \u041e\u0442\u0432\u0435\u0442 \u0438 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0435 |\n|---|---|\n| \u041d\u0435\u0432\u0435\u0440\u043d\u044b\u0439 \u043a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f | 401, \u043e\u0431\u0440\u0430\u0442\u0438\u0442\u044c\u0441\u044f \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443. |\n| \u041d\u0435\u0432\u0430\u043b\u0438\u0434\u043d\u044b\u0435 \u043f\u043e\u043b\u044f | 422, \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c \u0434\u0430\u043d\u043d\u044b\u0435 \u043f\u043e `errors`. |\n| \u041d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u043d\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430, \u0447\u0443\u0436\u043e\u0439 nonce, \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0438\u043b\u0438 \u043f\u0440\u043e\u0435\u043a\u0442 | \u041e\u0434\u0438\u043d\u0430\u043a\u043e\u0432\u044b\u0439 \u0431\u0435\u0437\u043e\u043f\u0430\u0441\u043d\u044b\u0439 404; \u043d\u0430\u0447\u0430\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443. |\n| \u0417\u0432\u043e\u043d\u043e\u043a \u0435\u0449\u0451 \u043d\u0435 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043d \u043f\u0440\u0438 `exchange` | 409, \u043f\u0440\u043e\u0434\u043e\u043b\u0436\u0438\u0442\u044c \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0443 \u043f\u0440\u0435\u0436\u043d\u0435\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438. |\n| \u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0443\u0436\u0435 \u043d\u0430\u0447\u0430\u0442\u0430 \u0438\u043b\u0438 \u0430\u043a\u0442\u0438\u0432\u043d\u0430 | 409, \u043e\u0436\u0438\u0434\u0430\u0442\u044c; \u043d\u0435 \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u043d\u043e\u0432\u044b\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u0438. |\n| \u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0438\u0441\u0442\u0435\u043a\u043b\u0430 \u0438\u043b\u0438 \u043e\u043a\u043d\u043e \u043f\u043e\u0432\u0442\u043e\u0440\u043d\u043e\u0433\u043e `exchange` \u0437\u0430\u043a\u0440\u044b\u0442\u043e | 410, \u043d\u043e\u0432\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430. |\n| \u041b\u0438\u043c\u0438\u0442 \u0438\u043b\u0438 \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u0430\u044f \u0437\u0430\u043d\u044f\u0442\u043e\u0441\u0442\u044c | 429, \u0436\u0434\u0430\u0442\u044c \u043f\u043e \u0438\u0437\u0432\u0435\u0441\u0442\u043d\u043e\u0439 \u0437\u0430\u0434\u0435\u0440\u0436\u043a\u0435. |\n| \u041a\u043e\u043d\u0444\u043b\u0438\u043a\u0442 \u0437\u0430\u043f\u0438\u0441\u0435\u0439 \u043a\u043e\u043d\u0442\u0440\u0430\u0433\u0435\u043d\u0442\u0430 | 409, \u043e\u0431\u0440\u0430\u0442\u0438\u0442\u044c\u0441\u044f \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443. \u041f\u043e\u0434\u0440\u043e\u0431\u043d\u043e\u0441\u0442\u0438 \u0437\u0430\u043f\u0438\u0441\u0435\u0439 \u043d\u0435 \u0440\u0430\u0441\u043a\u0440\u044b\u0432\u0430\u044e\u0442\u0441\u044f. |\n| \u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u0437\u0432\u043e\u043d\u043a\u0430 \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430 | \u041f\u0440\u043e\u0432\u0435\u0440\u044f\u0442\u044c \u043f\u0440\u0435\u0436\u043d\u044e\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443; `status` \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u0435\u0442 200/pending \u0441 \u043f\u0440\u0435\u0434\u0443\u043f\u0440\u0435\u0436\u0434\u0435\u043d\u0438\u0435\u043c. |\n| \u041d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u043d\u044b\u0439 \u0438\u0441\u0445\u043e\u0434 \u043d\u0430\u0447\u0430\u043b\u0430 \u043f\u043e\u043f\u044b\u0442\u043a\u0438 | 503, \u043e\u0431\u0440\u0430\u0442\u0438\u0442\u044c\u0441\u044f \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443; \u043d\u0435 \u043f\u043e\u0432\u0442\u043e\u0440\u044f\u0442\u044c `init` \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438. |\n| \u041d\u0435\u043e\u0436\u0438\u0434\u0430\u043d\u043d\u044b\u0439 \u0441\u0435\u0440\u0432\u0435\u0440\u043d\u044b\u0439 \u043e\u0442\u043a\u0430\u0437 | 500, \u0431\u0435\u0437\u043e\u043f\u0430\u0441\u043d\u043e\u0435 \u043e\u0431\u044a\u044f\u0441\u043d\u0435\u043d\u0438\u0435 \u0438 \u043d\u043e\u043c\u0435\u0440 \u0437\u0430\u043f\u0440\u043e\u0441\u0430 \u0434\u043b\u044f \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0438. |\n\n\u041f\u043e\u043b\u043d\u044b\u0439 \u043f\u0435\u0440\u0435\u0447\u0435\u043d\u044c \u0441\u0442\u0430\u0431\u0438\u043b\u044c\u043d\u044b\u0445 \u043a\u043e\u0434\u043e\u0432 \u0438 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0439 \u043f\u0443\u0431\u043b\u0438\u043a\u0443\u0435\u0442\u0441\u044f \u0432 OpenAPI, \u0441\u0445\u0435\u043c\u0430\n`CallbackAuthError`, \u0440\u0430\u0441\u0448\u0438\u0440\u0435\u043d\u0438\u0435 `x-gigma-error-catalog`; \u043e\u043d \u0431\u0435\u0440\u0451\u0442\u0441\u044f \u0438\u0437 \u0442\u043e\u0433\u043e \u0436\u0435\n\u043a\u0430\u0442\u0430\u043b\u043e\u0433\u0430, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u0444\u043e\u0440\u043c\u0438\u0440\u0443\u0435\u0442 \u043e\u0442\u0432\u0435\u0442\u044b \u0441\u0435\u0440\u0432\u0435\u0440\u0430.\n\n## \u0412\u0440\u0435\u043c\u0435\u043d\u043d\u0430\u044f \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0438\n\nHTTP 200 \u0441 `pending` \u0438 `warning` \u043d\u0435 \u043e\u0437\u043d\u0430\u0447\u0430\u0435\u0442 \u043d\u0435\u0443\u0434\u0430\u0447\u043d\u0443\u044e \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044e:\n\n```json\n{\n \"status\": \"pending\",\n \"expires_at\": \"2026-10-04T11:05:00+07:00\",\n \"server_time\": \"2026-10-04T11:01:00+07:00\",\n \"remaining_seconds\": 240,\n \"warning\": {\n \"code\": \"callback_auth_verification_unavailable\",\n \"message\": \"\u0421\u0435\u0439\u0447\u0430\u0441 \u043d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u043f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u0435 \u0437\u0432\u043e\u043d\u043a\u0430.\",\n \"next_action\": \"poll\",\n \"retry_after_seconds\": 3,\n \"request_id\": \"5a7f76e2-2851-4c02-8dc5-61882b616e3b\"\n }\n}\n```\n\n\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0436\u0434\u0451\u0442 \u0442\u0440\u0438 \u0441\u0435\u043a\u0443\u043d\u0434\u044b \u0438 \u043f\u043e\u0432\u0442\u043e\u0440\u044f\u0435\u0442 `status` \u0441 \u0442\u0435\u043c\u0438 \u0436\u0435 \u0441\u0435\u043a\u0440\u0435\u0442\u0430\u043c\u0438 \u043f\u043e\u043f\u044b\u0442\u043a\u0438.\n\u041e\u0431\u044b\u0447\u043d\u044b\u0439 `pending` \u0431\u0435\u0437 \u043f\u0440\u0435\u0434\u0443\u043f\u0440\u0435\u0436\u0434\u0435\u043d\u0438\u044f \u043e\u0441\u0442\u0430\u0451\u0442\u0441\u044f \u043d\u043e\u0440\u043c\u0430\u043b\u044c\u043d\u044b\u043c \u043e\u0436\u0438\u0434\u0430\u043d\u0438\u0435\u043c.\n\u0418\u0441\u0442\u0435\u0447\u0435\u043d\u0438\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u0438 \u0438\u043c\u0435\u0435\u0442 \u043f\u0440\u0438\u043e\u0440\u0438\u0442\u0435\u0442: \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043e\u0431\u0440\u0430\u0431\u0430\u0442\u044b\u0432\u0430\u0435\u0442 `expired`,\n\u0430 \u043d\u0435 \u043f\u0440\u043e\u0434\u043e\u043b\u0436\u0430\u0435\u0442 \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0443 \u0438\u0437-\u0437\u0430 \u043f\u0440\u0435\u0436\u043d\u0435\u0433\u043e \u043f\u0440\u0435\u0434\u0443\u043f\u0440\u0435\u0436\u0434\u0435\u043d\u0438\u044f.\n\n## \u041f\u043e\u0442\u0435\u0440\u044f \u043e\u0442\u0432\u0435\u0442\u0430 \u0438 \u043f\u043e\u0432\u0442\u043e\u0440\u044b\n\n\u0422\u0430\u0439\u043c\u0430\u0443\u0442 `init` \u043d\u0435 \u0434\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0435\u0442 \u043e\u0442\u0441\u0443\u0442\u0441\u0442\u0432\u0438\u0435 \u0441\u043e\u0437\u0434\u0430\u043d\u043d\u043e\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438. \u0423 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f\n\u043c\u043e\u0436\u0435\u0442 \u043d\u0435 \u0431\u044b\u0442\u044c `session_token`, \u043f\u043e\u044d\u0442\u043e\u043c\u0443 \u0441\u043b\u0435\u043f\u043e\u0439 \u043f\u043e\u0432\u0442\u043e\u0440 `init` \u0437\u0430\u043f\u0440\u0435\u0449\u0451\u043d:\n\u043d\u0443\u0436\u043d\u043e \u043f\u043e\u043a\u0430\u0437\u0430\u0442\u044c \u043d\u0435\u043e\u043f\u0440\u0435\u0434\u0435\u043b\u0451\u043d\u043d\u044b\u0439 \u0438\u0441\u0445\u043e\u0434 \u0438 \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043e\u0431\u0440\u0430\u0449\u0435\u043d\u0438\u0435 \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443.\n\u041d\u0430\u043b\u0438\u0447\u0438\u0435 `wait` \u0442\u0430\u043a\u0436\u0435 \u043d\u0435 \u044f\u0432\u043b\u044f\u0435\u0442\u0441\u044f \u0440\u0430\u0437\u0440\u0435\u0448\u0435\u043d\u0438\u0435\u043c \u043d\u0430 \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u043e\u0435 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u0435\n\u043d\u043e\u0432\u043e\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438.\n\n\u041f\u043e\u0432\u0442\u043e\u0440 `exchange` \u0441 \u0442\u043e\u0439 \u0436\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u043e\u0439 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u0438\u0432\u0430\u0435\u0442\u0441\u044f \u0442\u043e\u043b\u044c\u043a\u043e \u0432 \u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0435\u043c\n\u043e\u043a\u043d\u0435 \u0434\u043e\u0441\u0442\u0430\u0432\u043a\u0438 \u0442\u043e\u043a\u0435\u043d\u0430 \u2014 60 \u0441\u0435\u043a\u0443\u043d\u0434 \u0441 \u043f\u0435\u0440\u0432\u043e\u0439 \u0432\u044b\u0434\u0430\u0447\u0438. \u0422\u0430\u043a\u043e\u0439 \u043f\u043e\u0432\u0442\u043e\u0440 \u0437\u0430\u043c\u0435\u043d\u044f\u0435\u0442\n\u0440\u0430\u043d\u0435\u0435 \u0432\u044b\u0434\u0430\u043d\u043d\u044b\u0439 \u0442\u043e\u043a\u0435\u043d: \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442 \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u0438\u0439 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0439 \u0442\u043e\u043a\u0435\u043d.\n\u041f\u043e\u0441\u043b\u0435 `callback_auth_exchange_window_closed` \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f \u043d\u043e\u0432\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430.\n\u041e\u0431\u0449\u0438\u0435 \u0441\u0440\u043e\u043a\u0438 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0438 \u043f\u043e\u043b\u0438\u0442\u0438\u043a\u0430 \u0432\u044b\u0434\u0430\u0447\u0438 \u0442\u043e\u043a\u0435\u043d\u0430 \u043d\u0435 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u044b.\n\n## \u041f\u0440\u0430\u0432\u0438\u043b\u0430 \u0434\u043b\u044f \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u0438 AI-\u0430\u0433\u0435\u043d\u0442\u0430\n\n1. \u041f\u0435\u0440\u0435\u0434 \u043d\u043e\u0432\u044b\u043c `init` \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u043d\u043e\u0432\u044b\u0439 \u0441\u043b\u0443\u0447\u0430\u0439\u043d\u044b\u0439 nonce; \u0441\u043e\u0445\u0440\u0430\u043d\u0451\u043d\u043d\u044b\u0439 \u043f\u0440\u0438\u043c\u0435\u0440 \u0438\u0437\n \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u0438 \u0434\u043b\u044f \u0440\u0435\u0430\u043b\u044c\u043d\u043e\u0433\u043e \u0432\u0445\u043e\u0434\u0430 \u043d\u0435 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c.\n2. \u041f\u043e\u0441\u043b\u0435 \u0443\u0441\u043f\u0435\u0448\u043d\u043e\u0433\u043e `init` \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c \u0442\u043e\u043b\u044c\u043a\u043e \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u0443\u044e \u043f\u0430\u0440\u0443 \u0441\u0435\u043a\u0440\u0435\u0442\u043e\u0432\n \u0438 \u0442\u043e\u0442 \u0436\u0435 \u043a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u0434\u043e \u0437\u0430\u0432\u0435\u0440\u0448\u0435\u043d\u0438\u044f \u0438\u043b\u0438 \u0438\u0441\u0442\u0435\u0447\u0435\u043d\u0438\u044f \u044d\u0442\u043e\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438.\n3. HTTP 200 \u043e\u0442 `status` \u043d\u0435 \u043e\u0437\u043d\u0430\u0447\u0430\u0435\u0442 \u0432\u044b\u043f\u043e\u043b\u043d\u0435\u043d\u043d\u044b\u0439 \u0432\u0445\u043e\u0434: \u043f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c `status`\n \u0438 \u043f\u0440\u0438 `verified` \u0432\u044b\u0437\u0432\u0430\u0442\u044c `exchange`.\n4. \u0420\u0435\u0448\u0435\u043d\u0438\u0435 \u043f\u043e\u0441\u043b\u0435 \u043e\u0442\u043a\u0430\u0437\u0430 \u043f\u0440\u0438\u043d\u0438\u043c\u0430\u0442\u044c \u043f\u043e `error.code` \u0438 `next_action`;\n \u0442\u0435\u043a\u0441\u0442 \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0442\u044c \u0447\u0435\u043b\u043e\u0432\u0435\u043a\u0443. \u041f\u0440\u0438 422 \u0434\u043e\u043f\u043e\u043b\u043d\u0438\u0442\u0435\u043b\u044c\u043d\u043e \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0442\u044c \u043e\u0448\u0438\u0431\u043a\u0438 \u043f\u043e\u043b\u0435\u0439.\n5. `warning` \u043f\u0440\u0438 `pending` \u043e\u0437\u043d\u0430\u0447\u0430\u0435\u0442 \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u0443\u044e \u043d\u0435\u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u044c \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0438,\n \u0430 \u043d\u0435 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e\u0441\u0442\u044c \u043d\u043e\u0432\u043e\u0433\u043e \u0437\u0432\u043e\u043d\u043a\u0430. \u041f\u0440\u043e\u0434\u043e\u043b\u0436\u0438\u0442\u044c \u0442\u0435\u043a\u0443\u0449\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u043f\u043e\u0441\u043b\u0435 \u043f\u0430\u0443\u0437\u044b.\n6. \u041f\u043e\u0442\u0435\u0440\u044f\u043d\u043d\u044b\u0439 \u043e\u0442\u0432\u0435\u0442 `init` \u043d\u0435 \u043f\u043e\u0432\u0442\u043e\u0440\u044f\u0442\u044c \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438. \u041f\u043e\u0432\u0442\u043e\u0440 `exchange`\n \u043e\u0433\u0440\u0430\u043d\u0438\u0447\u0435\u043d \u043e\u043f\u0438\u0441\u0430\u043d\u043d\u044b\u043c \u0432\u044b\u0448\u0435 \u043e\u043a\u043d\u043e\u043c \u0438 \u0437\u0430\u043c\u0435\u043d\u044f\u0435\u0442 \u043f\u0440\u0435\u0434\u044b\u0434\u0443\u0449\u0438\u0439 \u0442\u043e\u043a\u0435\u043d.\n7. \u0417\u0430\u043a\u043e\u043d\u0447\u0438\u0442\u044c \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\u0439 \u043f\u0440\u043e\u0446\u0435\u0441\u0441 \u043f\u0440\u0438 `contact_support`; \u043f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0442\u044c\n `request_id`, \u0430 \u043d\u0435 \u0441\u0435\u043a\u0440\u0435\u0442\u044b \u0438\u043b\u0438 \u0432\u043d\u0443\u0442\u0440\u0435\u043d\u043d\u0438\u0435 \u0441\u0432\u0435\u0434\u0435\u043d\u0438\u044f \u0441\u0435\u0440\u0432\u0435\u0440\u0430.\n\n## \u0413\u0434\u0435 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u044b \u044d\u0442\u0438 \u043f\u0440\u0430\u0432\u0438\u043b\u0430\n\n- \u041c\u0430\u0440\u0448\u0440\u0443\u0442\u044b \u0438 \u043a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f: [routes/api.php](https://github.com/Progress-NSK/gigma-erp-api/blob/master/routes/api.php).\n- \u041f\u043e\u043b\u044f \u0438 \u043e\u0433\u0440\u0430\u043d\u0438\u0447\u0435\u043d\u0438\u044f: [InitCallbackAuthRequest](https://github.com/Progress-NSK/gigma-erp-api/blob/master/app/Http/Requests/Counterparties/CallbackAuth/InitCallbackAuthRequest.php),\n [StatusCallbackAuthRequest](https://github.com/Progress-NSK/gigma-erp-api/blob/master/app/Http/Requests/Counterparties/CallbackAuth/StatusCallbackAuthRequest.php),\n [ExchangeCallbackAuthRequest](https://github.com/Progress-NSK/gigma-erp-api/blob/master/app/Http/Requests/Counterparties/CallbackAuth/ExchangeCallbackAuthRequest.php).\n- \u0421\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f, \u0441\u0440\u043e\u043a\u0438 \u0438 \u0432\u044b\u0434\u0430\u0447\u0430 \u0442\u043e\u043a\u0435\u043d\u0430: [CallbackAuthService](https://github.com/Progress-NSK/gigma-erp-api/blob/master/app/Services/CallbackAuthService.php).\n- \u041f\u043e\u0438\u0441\u043a \u0438\u043b\u0438 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u0435 \u043a\u043b\u0438\u0435\u043d\u0442\u0430: [CounterpartyService](https://github.com/Progress-NSK/gigma-erp-api/blob/master/app/Services/CounterpartyService.php).\n- \u0424\u043e\u0440\u043c\u0430\u0442 \u043e\u0448\u0438\u0431\u043e\u043a: [CallbackAuthError](https://github.com/Progress-NSK/gigma-erp-api/blob/master/app/Support/CallbackAuthError.php).\n- \u0421\u0445\u0435\u043c\u044b OpenAPI: [CallbackAuthContractDocumenter](https://github.com/Progress-NSK/gigma-erp-api/blob/master/openapi/CallbackAuthContractDocumenter.php).\n\n\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442 \u043e\u043f\u0438\u0441\u044b\u0432\u0430\u0435\u0442 \u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0438\u0435 \u043f\u0440\u0430\u0432\u0438\u043b\u0430, \u043d\u0435 \u0432\u0432\u043e\u0434\u0438\u0442 \u043d\u043e\u0432\u044b\u0445 \u043c\u0430\u0440\u0448\u0440\u0443\u0442\u043e\u0432,\n\u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0439 \u0438\u043b\u0438 \u043e\u0441\u043d\u043e\u0432\u0430\u043d\u0438\u0439 \u0434\u043b\u044f \u0432\u044b\u0434\u0430\u0447\u0438 \u0442\u043e\u043a\u0435\u043d\u0430. \u041f\u0440\u0438 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0438 \u0440\u0435\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u0438\n\u043e\u0431\u043d\u043e\u0432\u043b\u044f\u0439\u0442\u0435 \u0432\u043c\u0435\u0441\u0442\u0435 \u043f\u0440\u0438\u043c\u0435\u0440\u044b, OpenAPI \u0438 \u044d\u0442\u0443 \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044e.\n" }, "servers": [ { "url": "https://api.gigma.ru", "description": "Production" } ], "paths": { "/api/info": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "instance": { "type": "string" }, "php": { "type": "string" }, "laravel": { "type": "string" }, "time": { "type": "string" } }, "required": [ "instance", "php", "laravel", "time" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/activity-logs": { "get": { "operationId": "activityLog.index", "tags": [ "ActivityLog" ], "parameters": [ { "name": "phone", "in": "query", "schema": { "type": "string", "maxLength": 64 } }, { "name": "events_cursor", "in": "query", "schema": { "type": "string", "maxLength": 8192 } }, { "name": "events_per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "level", "in": "query", "schema": { "type": "string", "enum": [ "debug", "info", "notice", "warning", "error", "critical", "alert", "emergency" ] } }, { "name": "source", "in": "query", "schema": { "type": "string", "enum": [ "activity_logs", "counterparty_audit_events", "histories", "counterparty_histories", "order_histories", "search_requests", "ticket_redemption_logs", "discount_usages", "client_notifications", "client_notification_deliveries", "webhook_deliveries", "auth_callback_sessions", "counterparty_sessions", "counterparty_verifications", "subscription_status_events", "subscription_payments", "subscription_autopay_consents", "subscription_payment_method_changes", "subscription_payment_compensations", "subscription_checkout_items", "payments", "calls", "personal_access_tokens", "owner_auth_attempts", "owner_auth_sessions", "owner_auth_events", "owner_mcp_oauth_authorizations", "owner_mcp_oauth_grants", "staff_mcp_oauth_proofs", "staff_mcp_oauth_sessions", "agent_access_requests", "jobs", "failed_jobs", "job_batches", "database", "laravel", "nginx_access", "nginx_error", "php_fpm" ] } }, { "name": "http_method", "in": "query", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ] } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "type", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "status", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "event_code", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "actor_type", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "entity_type", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "request_id", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "route", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "actor_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "entity_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "application_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "branch_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": [] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/agents": { "get": { "operationId": "agent.tableIndex", "tags": [ "Agent" ], "parameters": [ { "name": "role_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "branch_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "is_banned", "in": "query", "schema": { "type": "boolean" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agents": { "get": { "operationId": "agents.index", "tags": [ "Agent" ], "parameters": [ { "name": "role_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "branch_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "is_banned", "in": "query", "schema": { "type": "boolean" } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`AgentCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "agents.store", "tags": [ "Agent" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreRequest" } } } }, "responses": { "200": { "description": "`AgentResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "agent": { "$ref": "#/components/schemas/AgentResource" } }, "required": [ "agent" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agents/{agent}": { "get": { "operationId": "agents.show", "tags": [ "Agent" ], "parameters": [ { "name": "agent", "in": "path", "required": true, "description": "The agent ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`AgentResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "agent": { "$ref": "#/components/schemas/AgentResource" } }, "required": [ "agent" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "agents.update", "tags": [ "Agent" ], "parameters": [ { "name": "agent", "in": "path", "required": true, "description": "The agent ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequest" } } } }, "responses": { "200": { "description": "`AgentResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "agent": { "$ref": "#/components/schemas/AgentResource" } }, "required": [ "agent" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "agents.destroy", "tags": [ "Agent" ], "parameters": [ { "name": "agent", "in": "path", "required": true, "description": "The agent ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0410\u0433\u0435\u043d\u0442 \u0443\u0441\u043f\u0435\u0448\u043d\u043e \u043e\u0442\u043a\u043b\u044e\u0447\u0451\u043d" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agent-access-requests": { "post": { "operationId": "agentAccessRequest.store", "tags": [ "AgentAccessRequest" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreAgentAccessRequestRequest" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0415\u0441\u043b\u0438 \u0442\u0430\u043a\u043e\u0439 \u0430\u0434\u043c\u0438\u043d\u0438\u0441\u0442\u0440\u0430\u0442\u043e\u0440 \u0435\u0441\u0442\u044c, \u043c\u044b \u043e\u0442\u043f\u0440\u0430\u0432\u0438\u043b\u0438 \u0437\u0430\u043f\u0440\u043e\u0441." }, "request": { "type": "object", "properties": { "public_id": { "type": "string" }, "request_token": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "public_id", "request_token", "expires_at" ] } }, "required": [ "message", "request" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agent-access-requests/{publicId}/review": { "get": { "operationId": "agentAccessRequest.reviewPage", "tags": [ "AgentAccessRequest" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "agentAccessRequest.review", "tags": [ "AgentAccessRequest" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewAgentAccessRequestRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "request": { "type": "object", "properties": { "public_id": { "type": "string" }, "agent_name": { "type": "string" }, "agent_login": { "type": "string" }, "role": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "requested_permissions": { "type": "array", "items": [] }, "approved_permissions": { "type": [ "array", "null" ], "items": [] }, "purpose": { "type": [ "string", "null" ] }, "expires_at": { "type": "string" } }, "required": [ "public_id", "agent_name", "agent_login", "role", "requested_permissions", "approved_permissions", "purpose", "expires_at" ] } }, "required": [ "status", "request" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agent-access-requests/{publicId}/approve": { "post": { "operationId": "agentAccessRequest.approve", "tags": [ "AgentAccessRequest" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveAgentAccessRequestRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string", "const": "\u0414\u043e\u0441\u0442\u0443\u043f \u043e\u0434\u043e\u0431\u0440\u0435\u043d. \u0410\u0433\u0435\u043d\u0442 \u043c\u043e\u0436\u0435\u0442 \u0437\u0430\u0431\u0440\u0430\u0442\u044c \u0442\u043e\u043a\u0435\u043d." } }, "required": [ "status", "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agent-access-requests/{publicId}/decline": { "post": { "operationId": "agentAccessRequest.decline", "tags": [ "AgentAccessRequest" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineAgentAccessRequestRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string", "const": "\u0417\u0430\u043f\u0440\u043e\u0441 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043e\u0442\u043a\u043b\u043e\u043d\u0451\u043d." } }, "required": [ "status", "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agent-access-requests/{publicId}/status": { "post": { "operationId": "agentAccessRequest.status", "tags": [ "AgentAccessRequest" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusAgentAccessRequestRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "expires_at": { "type": "string" }, "server_time": { "type": "string" } }, "required": [ "status", "expires_at", "server_time" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agent-access-requests/{publicId}/consume": { "post": { "operationId": "agentAccessRequest.consume", "tags": [ "AgentAccessRequest" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumeAgentAccessRequestRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string" }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "login": { "type": "string" } }, "required": [ "id", "name", "login" ] }, "agent_token": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "value", "expires_at" ] } }, "required": [ "status", "agent", "agent_token" ] }, { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "consumed" }, "agent": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "agent_token": { "$ref": "#/components/schemas/NewAccessToken" } }, "required": [ "status", "agent", "agent_token" ] }, { "type": "object", "properties": { "status": { "type": "string", "const": "consumed" }, "already_consumed": { "type": "boolean" } }, "required": [ "status", "already_consumed" ] } ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agents/{agent}/tokens": { "get": { "operationId": "agentToken.index", "tags": [ "AgentToken" ], "parameters": [ { "name": "agent", "in": "path", "required": true, "description": "The agent ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`AgentTokenCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTokenCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "agentToken.store", "tags": [ "AgentToken" ], "parameters": [ { "name": "agent", "in": "path", "required": true, "description": "The agent ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreTokenRequest" } } } }, "responses": { "200": { "description": "`AgentTokenResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "agent_token": { "$ref": "#/components/schemas/AgentTokenResource" } }, "required": [ "agent_token" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/agents/{agent}/tokens/{token}": { "delete": { "operationId": "agentToken.destroy", "tags": [ "AgentToken" ], "parameters": [ { "name": "agent", "in": "path", "required": true, "description": "The agent ID", "schema": { "type": "integer" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0422\u043e\u043a\u0435\u043d \u0430\u0433\u0435\u043d\u0442\u0430 \u0443\u0441\u043f\u0435\u0448\u043d\u043e \u043e\u0442\u043e\u0437\u0432\u0430\u043d" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/applications": { "get": { "operationId": "application.tableIndex", "tags": [ "Application" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/applications/{application}/products": { "get": { "operationId": "applications.products", "tags": [ "Application" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{modelId}/history": { "get": { "operationId": "application.history", "tags": [ "Application" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications": { "get": { "operationId": "applications.index", "tags": [ "Application" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`ApplicationCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "applications.store", "tags": [ "Application" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Application.StoreRequest" } } } }, "responses": { "200": { "description": "`ApplicationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/ApplicationResource" } }, "required": [ "application" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}": { "get": { "operationId": "applications.show", "tags": [ "Application" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/ApplicationResource" } }, "required": [ "application" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "applications.update", "tags": [ "Application" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Application.UpdateRequest" } } } }, "responses": { "200": { "description": "`ApplicationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/ApplicationResource" } }, "required": [ "application" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "applications.destroy", "tags": [ "Application" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Application deleted" } }, "required": [ "message" ] } } } }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "\u041d\u0435\u043b\u044c\u0437\u044f \u0443\u0434\u0430\u043b\u0438\u0442\u044c \u042d\u041f\u0421 \u0441 \u043f\u043b\u0430\u0442\u0451\u0436\u043d\u044b\u043c\u0438 \u0438\u043d\u0442\u0435\u0433\u0440\u0430\u0446\u0438\u044f\u043c\u0438", "\u041d\u0435\u043b\u044c\u0437\u044f \u0443\u0434\u0430\u043b\u0438\u0442\u044c \u042d\u041f\u0421 \u0441 \u0438\u0441\u0442\u043e\u0440\u0438\u0435\u0439 \u043f\u043e\u0434\u043f\u0438\u0441\u043e\u043a", "\u041d\u0435\u043b\u044c\u0437\u044f \u0443\u0434\u0430\u043b\u0438\u0442\u044c \u042d\u041f\u0421 \u0441 \u0438\u0441\u0442\u043e\u0440\u0438\u0435\u0439 \u0437\u0430\u043a\u0430\u0437\u043e\u0432", "\u041d\u0435\u043b\u044c\u0437\u044f \u0443\u0434\u0430\u043b\u0438\u0442\u044c \u042d\u041f\u0421" ] } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/applications/{application}/brands": { "get": { "operationId": "applicationBrand.tableIndex", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/brands": { "get": { "operationId": "application-brands.index", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "application-brands.store", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationBrand.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] }, { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/brands/{brand}": { "get": { "operationId": "application-brands.show", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "application-brands.destroy", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Application brand deleted" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/brands/{brand}/up": { "post": { "operationId": "applicationBrand.incrementPriority", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Priority updated." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": [] }, "required": [ "message" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/brands/{brand}/down": { "post": { "operationId": "applicationBrand.decrementPriority", "tags": [ "ApplicationBrand" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Priority updated." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": [] }, "required": [ "message" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/applications/{application}/categories": { "get": { "operationId": "applicationCategory.tableIndex", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/categories": { "get": { "operationId": "application-categories.index", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CategoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "application-categories.store", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationCategory.StoreRequest" } } } }, "responses": { "200": { "description": "`CategoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/CategoryResource" } }, "required": [ "category" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/categories/{category}": { "get": { "operationId": "application-categories.show", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CategoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/CategoryResource" } }, "required": [ "category" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "application-categories.destroy", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Application category deleted" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/categories/{category}/up": { "post": { "operationId": "applicationCategory.incrementPriority", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Priority updated." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": [] }, "required": [ "message" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/categories/{category}/down": { "post": { "operationId": "applicationCategory.decrementPriority", "tags": [ "ApplicationCategory" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Priority updated." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": [] }, "required": [ "message" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/integrations": { "get": { "operationId": "applicationIntegration.index", "tags": [ "ApplicationIntegration" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "post": { "operationId": "applicationIntegration.store", "tags": [ "ApplicationIntegration" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegration.StoreRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/integrations/{integration}": { "get": { "operationId": "applicationIntegration.show", "tags": [ "ApplicationIntegration" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "operationId": "applicationIntegration.update", "tags": [ "ApplicationIntegration" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegration.UpdateRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/integrations/{integration}/parameters": { "get": { "operationId": "applicationIntegrationParameter.index", "tags": [ "ApplicationIntegrationParameter" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationParameterCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "post": { "operationId": "applicationIntegrationParameter.store", "tags": [ "ApplicationIntegrationParameter" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegrationParameter.StoreRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/counterparty/menus/{slug}": { "get": { "operationId": "applicationMenu.show", "tags": [ "ApplicationMenu" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "**Optional**", "schema": { "type": "string", "default": "navpanel" }, "x-optional": true } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.ApplicationMenuItem.ApplicationMenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "menuItems": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.ApplicationMenuItem.ApplicationMenuItemResource" } }, "required": [ "menuItems" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/applications/{application}/menu_items": { "get": { "operationId": "applicationMenuItem.tableIndex", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{modelId}/menu_items/{item}/history": { "get": { "operationId": "applicationMenuItem.history", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "item", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/menu_items": { "get": { "operationId": "menu_items.index", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationMenuItemCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationMenuItemCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "menu_items.store", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationMenuItem.StoreRequest" } } } }, "responses": { "200": { "description": "`ApplicationMenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ApplicationMenuItemResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/menu_items/{menuItem}": { "get": { "operationId": "menu_items.show", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "menuItem", "in": "path", "required": true, "description": "The menu item ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationMenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ApplicationMenuItemResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "menu_items.update", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "menuItem", "in": "path", "required": true, "description": "The menu item ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationMenuItem.UpdateRequest" } } } }, "responses": { "200": { "description": "`ApplicationMenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ApplicationMenuItemResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "menu_items.destroy", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "menuItem", "in": "path", "required": true, "description": "The menu item ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Menu item successfully deleted" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/menu_items/{menuItem}/up": { "post": { "operationId": "applicationMenuItem.incrementPriority", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "menuItem", "in": "path", "required": true, "description": "The menu item ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationMenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ApplicationMenuItemResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/menu_items/{menuItem}/down": { "post": { "operationId": "applicationMenuItem.decrementPriority", "tags": [ "ApplicationMenuItem" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "menuItem", "in": "path", "required": true, "description": "The menu item ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationMenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ApplicationMenuItemResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/notification-channels/sms": { "get": { "operationId": "applicationNotificationChannel.showSms", "tags": [ "ApplicationNotificationChannel" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationNotificationChannelResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "notification_channel": { "$ref": "#/components/schemas/ApplicationNotificationChannelResource" } }, "required": [ "notification_channel" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "put": { "operationId": "applicationNotificationChannel.updateSms", "tags": [ "ApplicationNotificationChannel" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSmsRequest" } } } }, "responses": { "200": { "description": "`ApplicationNotificationChannelResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "notification_channel": { "$ref": "#/components/schemas/ApplicationNotificationChannelResource" } }, "required": [ "notification_channel" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/notification-channels/email": { "get": { "operationId": "applicationNotificationChannel.showEmail", "tags": [ "ApplicationNotificationChannel" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationNotificationChannelResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "notification_channel": { "$ref": "#/components/schemas/ApplicationNotificationChannelResource" } }, "required": [ "notification_channel" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "put": { "operationId": "applicationNotificationChannel.updateEmail", "tags": [ "ApplicationNotificationChannel" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmailRequest" } } } }, "responses": { "200": { "description": "`ApplicationNotificationChannelResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "notification_channel": { "$ref": "#/components/schemas/ApplicationNotificationChannelResource" } }, "required": [ "notification_channel" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/subscription-nomenclatures/catalog": { "get": { "operationId": "applicationSubscriptionNomenclature.catalog", "tags": [ "ApplicationSubscriptionNomenclature" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationSubscriptionNomenclatureCatalogResource" } }, "meta": { "type": "object", "properties": { "application_id": { "type": "integer" }, "subscription_catalog_configured": { "type": "boolean" } }, "required": [ "application_id", "subscription_catalog_configured" ] } }, "required": [ "data", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/subscription-nomenclatures": { "get": { "operationId": "applicationSubscriptionNomenclature.index", "tags": [ "ApplicationSubscriptionNomenclature" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ApplicationSubscriptionNomenclatureResource" }, { "type": "object", "required": [ "nomenclature" ] } ] } } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "post": { "operationId": "applicationSubscriptionNomenclature.store", "tags": [ "ApplicationSubscriptionNomenclature" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationSubscriptionNomenclature.StoreRequest" } } } }, "responses": { "200": { "description": "`ApplicationSubscriptionNomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApplicationSubscriptionNomenclatureResource" }, { "type": "object", "required": [ "nomenclature" ] } ] } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/subscription-nomenclatures/{assignment}": { "patch": { "operationId": "applicationSubscriptionNomenclature.update", "tags": [ "ApplicationSubscriptionNomenclature" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "assignment", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationSubscriptionNomenclature.UpdateRequest" } } } }, "responses": { "200": { "description": "`ApplicationSubscriptionNomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApplicationSubscriptionNomenclatureResource" }, { "type": "object", "required": [ "nomenclature" ] } ] } }, "required": [ "data" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "operationId": "applicationSubscriptionNomenclature.destroy", "tags": [ "ApplicationSubscriptionNomenclature" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "assignment", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Subscription nomenclature assignment deleted" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/tables/applications/{application}/automations": { "get": { "operationId": "applicationWarehouse.tableIndex", "tags": [ "ApplicationWarehouse" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/warehouses/{warehouse}/up": { "post": { "operationId": "applicationWarehouse.incrementPriority", "tags": [ "ApplicationWarehouse" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Priority updated." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": [] }, "required": [ "message" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/warehouses/{warehouse}/down": { "post": { "operationId": "applicationWarehouse.decrementPriority", "tags": [ "ApplicationWarehouse" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Priority updated." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": [] }, "required": [ "message" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/webhooks": { "get": { "operationId": "applicationWebhook.index", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationWebhookCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationWebhookCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "post": { "operationId": "applicationWebhook.store", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationWebhook.StoreRequest" } } } }, "responses": { "201": { "description": "`ApplicationWebhookResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/ApplicationWebhookResource" } }, "required": [ "webhook" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/webhooks/{webhook}": { "get": { "operationId": "applicationWebhook.show", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ApplicationWebhookResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/ApplicationWebhookResource" } }, "required": [ "webhook" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "operationId": "applicationWebhook.update", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ApplicationWebhook.UpdateRequest" } } } }, "responses": { "200": { "description": "`ApplicationWebhookResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/ApplicationWebhookResource" } }, "required": [ "webhook" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "operationId": "applicationWebhook.destroy", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Webhook archived" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/webhooks/{webhook}/deliveries": { "get": { "operationId": "applicationWebhook.deliveries", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Paginated set of `WebhookDeliveryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "delivery": { "$ref": "#/components/schemas/WebhookDeliveryCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "delivery", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/webhooks/{webhook}/deliveries/{delivery}/resend": { "post": { "operationId": "applicationWebhook.resend", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "integer" } }, { "name": "delivery", "in": "path", "required": true, "description": "The delivery ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`WebhookDeliveryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "delivery": { "$ref": "#/components/schemas/WebhookDeliveryResource" } }, "required": [ "delivery" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/applications/{application}/webhooks/{webhook}/rotate-secret": { "post": { "operationId": "applicationWebhook.rotateSecret", "tags": [ "ApplicationWebhook" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "secret": { "type": "string" } }, "required": [ "secret" ] } } } }, "429": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "Secret can only be rotated once per 60 seconds" ] } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/counterparties/{counterparty}/bank_requisites": { "get": { "operationId": "bank_requisites.index", "tags": [ "BankRequisite" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BranchBankRequisiteCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchBankRequisiteCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "bank_requisites.store", "tags": [ "BankRequisite" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.BankRequisite.StoreRequest" } } } }, "responses": { "200": { "description": "`BranchBankRequisiteResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankRequisite": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "required": [ "bankRequisite" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}/bank_requisites/{bankRequisite}": { "get": { "operationId": "bank_requisites.show", "tags": [ "BankRequisite" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BranchBankRequisiteResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankRequisite": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "required": [ "bankRequisite" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "bank_requisites.update", "tags": [ "BankRequisite" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.BankRequisite.UpdateRequest" } } } }, "responses": { "200": { "description": "`BranchBankRequisiteResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankRequisite": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "required": [ "bankRequisite" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "bank_requisites.destroy", "tags": [ "BankRequisite" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Bank requisite successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/applications/{application}/blocks": { "get": { "operationId": "block.tableIndex", "tags": [ "Block" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{modelId}/blocks/{block}/history": { "get": { "operationId": "block.history", "tags": [ "Block" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "block", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/blocks": { "get": { "operationId": "blocks.index", "tags": [ "Block" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } } ], "responses": { "200": { "description": "`BlockCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "blocks.store", "tags": [ "Block" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Block.StoreRequest" } } } }, "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "block" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/blocks/{block}": { "get": { "operationId": "blocks.show", "tags": [ "Block" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "block", "in": "path", "required": true, "description": "The block ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "block" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "blocks.update", "tags": [ "Block" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "block", "in": "path", "required": true, "description": "The block ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Block.UpdateRequest" } } } }, "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "block" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "blocks.destroy", "tags": [ "Block" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "block", "in": "path", "required": true, "description": "The block ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Block successfully deleted" } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/blocks/{code}": { "get": { "operationId": "block.showByCode", "tags": [ "Block" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "block" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/blocks/id/{identifier}": { "get": { "operationId": "block.showById", "tags": [ "Block" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`BlockResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "$ref": "#/components/schemas/BlockResource" } }, "required": [ "block" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/block_types": { "get": { "operationId": "block_types.index", "tags": [ "BlockType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/block_types/{blockType}": { "get": { "operationId": "block_types.show", "tags": [ "BlockType" ], "parameters": [ { "name": "blockType", "in": "path", "required": true, "description": "The block type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches": { "get": { "operationId": "branches.index", "tags": [ "Branch" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "responsible_user_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "balance_gt", "in": "query", "schema": { "type": "integer" } }, { "name": "balance_lt", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BranchCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "branches.store", "tags": [ "Branch" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Branch.StoreRequest" } } } }, "responses": { "200": { "description": "`BranchResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "branch": { "$ref": "#/components/schemas/BranchResource" } }, "required": [ "branch" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}": { "get": { "operationId": "branches.show", "tags": [ "Branch" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BranchResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "branch": { "$ref": "#/components/schemas/BranchResource" } }, "required": [ "branch" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "branches.update", "tags": [ "Branch" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Branch.UpdateRequest" } } } }, "responses": { "200": { "description": "`BranchResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "branch": { "$ref": "#/components/schemas/BranchResource" } }, "required": [ "branch" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "branches.destroy", "tags": [ "Branch" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Branch successfully destroyed" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches_list": { "get": { "operationId": "branch.getAll", "tags": [ "Branch" ], "responses": { "200": { "description": "`BranchCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/branches": { "get": { "operationId": "branch.tableIndex", "tags": [ "Branch" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "responsible_user_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "balance_gt", "in": "query", "schema": { "type": "integer" } }, { "name": "balance_lt", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{modelId}/history": { "get": { "operationId": "branch.history", "tags": [ "Branch" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/responsible_users": { "get": { "operationId": "branch.responsibleUsersList", "tags": [ "Branch" ], "responses": { "200": { "description": "`ManagerCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagerCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites": { "get": { "operationId": "branch-bank-requisites.index", "tags": [ "BranchBankRequisite" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BranchBankRequisiteCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchBankRequisiteCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "branch-bank-requisites.store", "tags": [ "BranchBankRequisite" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.BranchBankRequisite.StoreRequest" } } } }, "responses": { "200": { "description": "`BranchBankRequisiteResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankRequisite": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "required": [ "bankRequisite" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites/{bankRequisite}": { "get": { "operationId": "branch-bank-requisites.show", "tags": [ "BranchBankRequisite" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BranchBankRequisiteResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankRequisite": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "required": [ "bankRequisite" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "branch-bank-requisites.update", "tags": [ "BranchBankRequisite" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.BranchBankRequisite.UpdateRequest" } } } }, "responses": { "200": { "description": "`BranchBankRequisiteResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankRequisite": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "required": [ "bankRequisite" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites/{bank_requisite}": { "delete": { "operationId": "branch-bank-requisites.destroy", "tags": [ "BranchBankRequisite" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bank_requisite", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Bank requisite successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites/{bankRequisite}/integrations": { "get": { "operationId": "branch-integrations.index", "tags": [ "BranchIntegration" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites/{bankRequisite}/integrations/{integration}": { "get": { "operationId": "branch-integrations.show", "tags": [ "BranchIntegration" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "branch-integrations.update", "tags": [ "BranchIntegration" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegration.UpdateRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites/{bankRequisite}/integrations/{integration}/parameters": { "get": { "operationId": "branch-integration-parameters.index", "tags": [ "BranchIntegrationParameter" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationParameterCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "branch-integration-parameters.store", "tags": [ "BranchIntegrationParameter" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegrationParameter.StoreRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/branches/{branch}/bank_requisites/{bankRequisite}/integrations/{integration}/parameters/{parameter}": { "get": { "operationId": "branch-integration-parameters.show", "tags": [ "BranchIntegrationParameter" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } }, { "name": "parameter", "in": "path", "required": true, "description": "The parameter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "branch-integration-parameters.destroy", "tags": [ "BranchIntegrationParameter" ], "parameters": [ { "name": "branch", "in": "path", "required": true, "description": "The branch ID", "schema": { "type": "integer" } }, { "name": "bankRequisite", "in": "path", "required": true, "description": "The bank requisite ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } }, { "name": "parameter", "in": "path", "required": true, "description": "The parameter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Parameter successfully deleted." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/brands": { "get": { "operationId": "brands.index", "tags": [ "Brand" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`BrandCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "brands.store", "summary": "Store a newly created resource in storage", "tags": [ "Brand" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Brand.StoreRequest" } } } }, "responses": { "200": { "description": "`BrandResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "$ref": "#/components/schemas/BrandResource" } }, "required": [ "brand" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/brands/{brand}": { "get": { "operationId": "brands.show", "summary": "Display the specified resource", "tags": [ "Brand" ], "parameters": [ { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`BrandResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "$ref": "#/components/schemas/BrandResource" } }, "required": [ "brand" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "brands.update", "summary": "Update the specified resource in storage", "tags": [ "Brand" ], "parameters": [ { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Brand.UpdateRequest" } } } }, "responses": { "200": { "description": "`BrandResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "$ref": "#/components/schemas/BrandResource" } }, "required": [ "brand" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "brands.destroy", "summary": "Remove the specified resource from storage", "tags": [ "Brand" ], "parameters": [ { "name": "brand", "in": "path", "required": true, "description": "The brand ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Brand successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/brands/history": { "get": { "operationId": "brand.history", "tags": [ "Brand" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/brands": { "get": { "operationId": "counterparties.brand.index", "tags": [ "Brand" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparties.DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryCollection" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/calls": { "post": { "operationId": "call.store", "tags": [ "Call" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Call.StoreRequest" } } } }, "responses": { "200": { "description": "`CallResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "call": { "$ref": "#/components/schemas/CallResource" } }, "required": [ "call" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "get": { "operationId": "calls.index", "tags": [ "Call" ], "parameters": [ { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "name": "call_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "is_incoming", "in": "query", "schema": { "type": "boolean" } }, { "name": "communication_type_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "counterparty_exists", "in": "query", "schema": { "type": "boolean" } }, { "name": "sales_channel_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "`CallCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/calls": { "get": { "operationId": "call.tableIndex", "tags": [ "Call" ], "parameters": [ { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "name": "call_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "is_incoming", "in": "query", "schema": { "type": "boolean" } }, { "name": "communication_type_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "counterparty_exists", "in": "query", "schema": { "type": "boolean" } }, { "name": "sales_channel_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/calls/{call}": { "get": { "operationId": "calls.show", "tags": [ "Call" ], "parameters": [ { "name": "call", "in": "path", "required": true, "description": "The call ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CallResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "call": { "$ref": "#/components/schemas/CallResource" } }, "required": [ "call" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "calls.update", "tags": [ "Call" ], "parameters": [ { "name": "call", "in": "path", "required": true, "description": "The call ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Call.UpdateRequest" } } } }, "responses": { "200": { "description": "`CallResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "call": { "$ref": "#/components/schemas/CallResource" } }, "required": [ "call" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/call_statuses": { "get": { "operationId": "call_statuses.index", "tags": [ "CallStatus" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/call_statuses/{callStatus}": { "get": { "operationId": "call_statuses.show", "tags": [ "CallStatus" ], "parameters": [ { "name": "callStatus", "in": "path", "required": true, "description": "The call status ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/call_statuses/history": { "get": { "operationId": "callStatus.history", "tags": [ "CallStatus" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/callback_auth/status": { "post": { "operationId": "callbackAuth.status", "tags": [ "CallbackAuth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusCallbackAuthRequest" }, "examples": { "registration_attempt": { "summary": "\u0414\u0435\u043c\u043e\u043d\u0441\u0442\u0440\u0430\u0446\u0438\u043e\u043d\u043d\u044b\u0439 \u0437\u0430\u043f\u0440\u043e\u0441: \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u044f \u0441\u0435\u043a\u0440\u0435\u0442\u043e\u0432 \u0437\u0430\u043c\u0435\u043d\u0438\u0442\u044c \u0434\u0430\u043d\u043d\u044b\u043c\u0438 \u0442\u0435\u043a\u0443\u0449\u0435\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438.", "value": { "session_token": "", "client_nonce": "EXAMPLE_NONCE_0123456789abcdefghij" } } } } } }, "responses": { "200": { "description": "Current attempt state. verified confirms the call; exchange is still required to obtain a Bearer token.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "status", "expires_at", "server_time", "remaining_seconds" ], "properties": { "status": { "type": "string", "enum": [ "pending", "verified", "expired" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "server_time": { "type": "string", "format": "date-time" }, "remaining_seconds": { "type": [ "integer", "null" ], "minimum": 0 }, "warning": { "$ref": "#/components/schemas/CallbackAuthWarning", "description": "Optional only when pending and verification is temporarily unavailable. Continue polling this session after retry_after_seconds; this is not a failed registration." } } }, "examples": { "pending": { "summary": "\u041e\u0436\u0438\u0434\u0430\u043d\u0438\u0435 \u0437\u0432\u043e\u043d\u043a\u0430: \u043f\u0440\u043e\u0432\u0435\u0440\u044f\u0442\u044c \u0442\u0443 \u0436\u0435 \u043f\u043e\u043f\u044b\u0442\u043a\u0443.", "value": { "status": "pending", "expires_at": "2026-10-04T12:05:00+07:00", "server_time": "2026-10-04T12:01:00+07:00", "remaining_seconds": 240 } }, "verified": { "summary": "\u0417\u0432\u043e\u043d\u043e\u043a \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043d; \u0432\u044b\u0437\u0432\u0430\u0442\u044c exchange \u0441 \u0442\u043e\u0439 \u0436\u0435 \u043f\u0430\u0440\u043e\u0439 \u0441\u0435\u043a\u0440\u0435\u0442\u043e\u0432.", "value": { "status": "verified", "expires_at": "2026-10-04T12:06:00+07:00", "server_time": "2026-10-04T12:04:00+07:00", "remaining_seconds": 120 } }, "expired": { "summary": "\u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0438\u0441\u0442\u0435\u043a\u043b\u0430: \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443.", "value": { "status": "expired", "expires_at": "2026-10-04T12:06:00+07:00", "server_time": "2026-10-04T12:06:00+07:00", "remaining_seconds": 0 } }, "verification_unavailable": { "summary": "\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430: \u0441\u043e\u0445\u0440\u0430\u043d\u0438\u0442\u044c \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0438 \u043f\u043e\u0432\u0442\u043e\u0440\u0438\u0442\u044c status \u0447\u0435\u0440\u0435\u0437 \u0442\u0440\u0438 \u0441\u0435\u043a\u0443\u043d\u0434\u044b.", "value": { "status": "pending", "expires_at": "2026-10-04T12:05:00+07:00", "server_time": "2026-10-04T12:01:00+07:00", "remaining_seconds": 240, "warning": { "code": "callback_auth_verification_unavailable", "message": "\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430.", "next_action": "poll", "retry_after_seconds": 3, "request_id": "5a7f76e2-2851-4c02-8dc5-61882b616e3b" } } } } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "401": { "description": "Application Token header is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "422": { "description": "Input validation failed; message is not required by the legacy validation contract.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Existing field validation errors, preserved for older clients." } }, "required": [ "errors", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "429": { "description": "Rate limit or temporary lock contention. Wait; do not start a new attempt automatically.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "500": { "description": "Unexpected server error; safe public response even when application debug is enabled. Contact support with request_id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "503": { "description": "Init outcome may be unknown: contact support, do not retry init automatically. Unavailable exchange verification: poll the current session.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "404": { "description": "Unknown attempt or incorrect nonce/application/project; all receive the same safe rejection.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "409": { "description": "Call not yet verified, attempt already started/active, or conflicting counterparty identity. Follow error.next_action.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "410": { "description": "Attempt expired or the existing token exchange retry window is closed. Start a new attempt.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } } }, "security": [ { "AppTokenAuth": [] } ], "description": "Check the current callback attempt using its original client_nonce and session_token. All responses are JSON regardless of Accept. pending is normal waiting; an optional warning means temporarily unavailable verification. verified is call confirmation, not completed registration. This endpoint never returns an access token.\n\n\u041f\u0440\u043e\u0432\u0435\u0440\u044f\u0435\u0442 \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u0441 \u0442\u043e\u0439 \u0436\u0435 \u043f\u0430\u0440\u043e\u0439 session_token/client_nonce \u0438 \u0442\u0435\u043c \u0436\u0435 \u043a\u043b\u044e\u0447\u043e\u043c \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f Token. pending \u043e\u0437\u043d\u0430\u0447\u0430\u0435\u0442 \u043e\u0436\u0438\u0434\u0430\u043d\u0438\u0435; warning \u0442\u0440\u0435\u0431\u0443\u0435\u0442 \u043f\u0430\u0443\u0437\u044b \u043f\u0435\u0440\u0435\u0434 \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0435\u0439 \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u043e\u0439. \u041f\u043e\u0441\u043b\u0435 verified \u043d\u0443\u0436\u043d\u043e \u0432\u044b\u0437\u0432\u0430\u0442\u044c exchange: \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043d\u043d\u044b\u0439 \u0437\u0432\u043e\u043d\u043e\u043a \u0441\u0430\u043c \u043f\u043e \u0441\u0435\u0431\u0435 \u043d\u0435 \u0437\u0430\u0432\u0435\u0440\u0448\u0430\u0435\u0442 \u0432\u0445\u043e\u0434. \u041f\u0440\u0438 expired \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0438\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443. \u041e\u0440\u0438\u0435\u043d\u0442\u0438\u0440\u0443\u0439\u0442\u0435\u0441\u044c \u043d\u0430 \u0441\u0440\u043e\u043a\u0438 \u0438\u0437 \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u0435\u0433\u043e \u043e\u0442\u0432\u0435\u0442\u0430 \u0441\u0435\u0440\u0432\u0435\u0440\u0430." } }, "/api/counterparty/callback_auth/exchange": { "post": { "operationId": "callbackAuth.exchange", "tags": [ "CallbackAuth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeCallbackAuthRequest" }, "examples": { "registration_attempt": { "summary": "\u0414\u0435\u043c\u043e\u043d\u0441\u0442\u0440\u0430\u0446\u0438\u043e\u043d\u043d\u044b\u0439 \u0437\u0430\u043f\u0440\u043e\u0441: \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u044f \u0441\u0435\u043a\u0440\u0435\u0442\u043e\u0432 \u0437\u0430\u043c\u0435\u043d\u0438\u0442\u044c \u0434\u0430\u043d\u043d\u044b\u043c\u0438 \u0442\u0435\u043a\u0443\u0449\u0435\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438.", "value": { "session_token": "", "client_nonce": "EXAMPLE_NONCE_0123456789abcdefghij", "device": "TV VPS / Android" } } } } } }, "responses": { "200": { "description": "Successful response; existing body fields are unchanged.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "access_token" ], "properties": { "access_token": { "type": "string", "description": "Bearer token; obtaining this token completes registration/sign-in for the application. Never log it." } } }, "examples": { "signed_in": { "summary": "\u041a\u043b\u0438\u0435\u043d\u0442 \u043d\u0430\u0439\u0434\u0435\u043d \u0438\u043b\u0438 \u0441\u043e\u0437\u0434\u0430\u043d, \u0442\u043e\u043a\u0435\u043d \u043f\u043e\u043b\u0443\u0447\u0435\u043d: \u0432\u0445\u043e\u0434 \u0437\u0430\u0432\u0435\u0440\u0448\u0451\u043d.", "value": { "access_token": "" } } } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "401": { "description": "Application Token header is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "422": { "description": "Input validation failed; message is not required by the legacy validation contract.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Existing field validation errors, preserved for older clients." } }, "required": [ "errors", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "429": { "description": "Rate limit or temporary lock contention. Wait; do not start a new attempt automatically.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "500": { "description": "Unexpected server error; safe public response even when application debug is enabled. Contact support with request_id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "503": { "description": "Init outcome may be unknown: contact support, do not retry init automatically. Unavailable exchange verification: poll the current session.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "404": { "description": "Unknown attempt or incorrect nonce/application/project; all receive the same safe rejection.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "409": { "description": "Call not yet verified, attempt already started/active, or conflicting counterparty identity. Follow error.next_action.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "410": { "description": "Attempt expired or the existing token exchange retry window is closed. Start a new attempt.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } } }, "security": [ { "AppTokenAuth": [] } ], "description": "Exchange a verified callback attempt for a Bearer token. All responses are JSON regardless of Accept. Repeated exchange is allowed only within the existing limited delivery retry window. After that window closes, restart registration instead of retrying exchange.\n\n\u041f\u043e\u0441\u043b\u0435 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0437\u0432\u043e\u043d\u043a\u0430 \u043d\u0430\u0445\u043e\u0434\u0438\u0442 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043f\u043e \u0442\u0435\u043b\u0435\u0444\u043e\u043d\u0443 \u0432 \u043f\u0440\u043e\u0435\u043a\u0442\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u0438\u043b\u0438 \u0441\u043e\u0437\u0434\u0430\u0451\u0442 \u043d\u043e\u0432\u043e\u0433\u043e \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u0438 \u0432\u044b\u0434\u0430\u0451\u0442 access_token. \u041f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u0435 access_token \u0437\u0430\u0432\u0435\u0440\u0448\u0430\u0435\u0442 \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044e/\u0432\u0445\u043e\u0434; \u0442\u043e\u043a\u0435\u043d \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442\u0441\u044f \u043a\u0430\u043a Authorization: Bearer. \u041f\u0435\u0440\u0435\u0434\u0430\u044e\u0442\u0441\u044f \u0438\u0441\u0445\u043e\u0434\u043d\u0430\u044f \u043f\u0430\u0440\u0430 session_token/client_nonce \u0438 \u0442\u043e\u0442 \u0436\u0435 \u043a\u043b\u044e\u0447 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f Token. \u041f\u043e\u0432\u0442\u043e\u0440 exchange \u0440\u0430\u0437\u0440\u0435\u0448\u0451\u043d \u0442\u043e\u043b\u044c\u043a\u043e 60 \u0441\u0435\u043a\u0443\u043d\u0434 \u0441 \u043f\u0435\u0440\u0432\u043e\u0439 \u0432\u044b\u0434\u0430\u0447\u0438 \u0438 \u0437\u0430\u043c\u0435\u043d\u044f\u0435\u0442 \u043f\u0440\u0435\u0434\u044b\u0434\u0443\u0449\u0438\u0439 \u0442\u043e\u043a\u0435\u043d. \u041f\u043e\u0441\u043b\u0435 callback_auth_exchange_window_closed \u043d\u0443\u0436\u043d\u0430 \u043d\u043e\u0432\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430; \u043a\u043e\u043d\u0444\u043b\u0438\u043a\u0442 \u0437\u0430\u043f\u0438\u0441\u0435\u0439 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043d\u0430\u043f\u0440\u0430\u0432\u043b\u044f\u0435\u0442\u0441\u044f \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443." } }, "/api/counterparty/callback_auth/init": { "post": { "operationId": "callbackAuth.init", "tags": [ "CallbackAuth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitCallbackAuthRequest" }, "examples": { "registration_attempt": { "summary": "\u0414\u0435\u043c\u043e\u043d\u0441\u0442\u0440\u0430\u0446\u0438\u043e\u043d\u043d\u044b\u0439 \u0437\u0430\u043f\u0440\u043e\u0441: \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u044f \u0441\u0435\u043a\u0440\u0435\u0442\u043e\u0432 \u0437\u0430\u043c\u0435\u043d\u0438\u0442\u044c \u0434\u0430\u043d\u043d\u044b\u043c\u0438 \u0442\u0435\u043a\u0443\u0449\u0435\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0438.", "value": { "phone": "79001234567", "client_nonce": "EXAMPLE_NONCE_0123456789abcdefghij" } } } } } }, "responses": { "200": { "description": "Successful response; existing body fields are unchanged.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "session_token", "callback_number", "expires_at" ], "properties": { "session_token": { "type": "string", "description": "Secret for the current attempt; retain with the original client_nonce and do not log." }, "callback_number": { "type": "string", "description": "Number the user must call to confirm the attempt." }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "examples": { "attempt_created": { "summary": "\u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0441\u043e\u0437\u0434\u0430\u043d\u0430; \u0432\u0445\u043e\u0434 \u043f\u043e \u044d\u0442\u043e\u0439 \u043f\u043e\u043f\u044b\u0442\u043a\u0435 \u0435\u0449\u0451 \u043d\u0435 \u0437\u0430\u0432\u0435\u0440\u0448\u0451\u043d.", "value": { "session_token": "", "callback_number": "79001000011", "expires_at": "2026-10-04T12:05:00+07:00" } } } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "401": { "description": "Application Token header is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "422": { "description": "Input validation failed; message is not required by the legacy validation contract.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Existing field validation errors, preserved for older clients." } }, "required": [ "errors", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "429": { "description": "Rate limit or temporary lock contention. Wait; do not start a new attempt automatically.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "500": { "description": "Unexpected server error; safe public response even when application debug is enabled. Contact support with request_id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "503": { "description": "Init outcome may be unknown: contact support, do not retry init automatically. Unavailable exchange verification: poll the current session.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } }, "409": { "description": "Call not yet verified, attempt already started/active, or conflicting counterparty identity. Follow error.next_action.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Existing legacy message is preserved. Use error.code for programmatic handling." }, "error": { "$ref": "#/components/schemas/CallbackAuthError" } }, "required": [ "message", "error" ] } } }, "headers": { "X-Request-ID": { "required": true, "description": "Server-generated UUID; matches error.request_id or warning.request_id when present.", "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "required": true, "description": "Contains the no-store directive: callback auth responses must not be cached.", "schema": { "type": "string", "examples": [ "no-store, private" ] } }, "Pragma": { "required": true, "description": "Compatibility with older HTTP caches.", "schema": { "type": "string", "const": "no-cache" } }, "Retry-After": { "required": false, "description": "Present only when a retry delay is known; seconds match error.retry_after_seconds or warning.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } } }, "security": [ { "AppTokenAuth": [] } ], "description": "Start counterparty registration/sign-in by callback. All responses are JSON regardless of Accept. Keep the client_nonce and returned session_token private. A timeout or unavailable response does not prove no attempt was created: never retry init automatically.\n\n\u0421\u043e\u0437\u0434\u0430\u0451\u0442 \u0442\u043e\u043b\u044c\u043a\u043e \u043f\u043e\u043f\u044b\u0442\u043a\u0443 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0442\u0435\u043b\u0435\u0444\u043e\u043d\u0430; \u0437\u0430\u043f\u0438\u0441\u044c \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u0438 \u0442\u043e\u043a\u0435\u043d \u043d\u0430 \u044d\u0442\u043e\u043c \u0448\u0430\u0433\u0435 \u043d\u0435 \u0441\u043e\u0437\u0434\u0430\u044e\u0442\u0441\u044f. \u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c \u0437\u0432\u043e\u043d\u0438\u0442 \u043d\u0430 callback_number \u0438\u0437 \u043e\u0442\u0432\u0435\u0442\u0430 \u0441 \u043d\u043e\u043c\u0435\u0440\u0430, \u043f\u0435\u0440\u0435\u0434\u0430\u043d\u043d\u043e\u0433\u043e \u0432 phone. \u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0441\u043e\u0445\u0440\u0430\u043d\u044f\u0435\u0442 session_token \u0438 \u0438\u0441\u0445\u043e\u0434\u043d\u044b\u0439 client_nonce \u0438 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442 \u044d\u0442\u0443 \u043f\u0430\u0440\u0443 \u0441 \u0442\u0435\u043c \u0436\u0435 \u043a\u043b\u044e\u0447\u043e\u043c \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f Token \u0432 status \u0438 exchange. \u041f\u0440\u0438 \u043f\u043e\u0442\u0435\u0440\u0435 \u043e\u0442\u0432\u0435\u0442\u0430 init \u043d\u0435\u043b\u044c\u0437\u044f \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u0437\u0430\u043f\u0443\u0441\u043a\u0430\u0442\u044c \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443." } }, "/api/counterparty/categories": { "get": { "operationId": "category.index", "tags": [ "Category" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "parent_id", "in": "query", "schema": { "type": [ "integer", "null" ] } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Category.CategoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Category.CategoryCollection" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/cities": { "get": { "operationId": "cities.index", "tags": [ "City" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/cities/{city}": { "get": { "operationId": "cities.show", "tags": [ "City" ], "parameters": [ { "name": "city", "in": "path", "required": true, "description": "The city ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/cities/history": { "get": { "operationId": "city.history", "tags": [ "City" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/communication_types": { "get": { "operationId": "communication_types.index", "tags": [ "CommunicationType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/communication_types/{communicationType}": { "get": { "operationId": "communication_types.show", "tags": [ "CommunicationType" ], "parameters": [ { "name": "communicationType", "in": "path", "required": true, "description": "The communication type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/communication_types/history": { "get": { "operationId": "communicationType.history", "tags": [ "CommunicationType" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/compositions/calculate": { "post": { "operationId": "composition.calculate", "tags": [ "Composition" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompositionCalculateRequest" } } } }, "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "composition_id": { "type": "string" }, "volume": { "type": "string" }, "thickness": { "type": "string" }, "components": { "type": "array", "items": { "type": "object", "properties": { "nomenclature_id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "storage_unit_id": { "type": [ "string", "null" ] }, "consumption_rate": { "type": "string" }, "scaling_kind": { "type": [ "string", "null" ] }, "base_thickness": { "type": "string" }, "raw_quantity": { "type": "number" }, "pieces_per_pack": { "type": [ "integer", "null" ] }, "quantity_pack": { "type": "integer" }, "quantity": { "type": "integer" } }, "required": [ "nomenclature_id", "name", "code", "storage_unit_id", "consumption_rate", "scaling_kind", "base_thickness", "raw_quantity", "pieces_per_pack", "quantity_pack", "quantity" ] } } }, "required": [ "composition_id", "volume", "thickness", "components" ] } }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "raw_quantity": { "type": "number" }, "pieces_per_pack": { "type": "string" }, "quantity_pack": { "type": "integer" }, "quantity": { "type": "integer" } }, "required": [ "id", "raw_quantity", "pieces_per_pack", "quantity_pack", "quantity" ] } } }, "required": [ "items", "products" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}/contacts": { "get": { "operationId": "contacts.index", "tags": [ "Contact" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "contacts.store", "tags": [ "Contact" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Contact.StoreRequest" } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "contact" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}/contacts/{contact}": { "get": { "operationId": "contacts.show", "tags": [ "Contact" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "contact" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "contacts.update", "tags": [ "Contact" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Contact.UpdateRequest" } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/ContactResource" } }, "required": [ "contact" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "contacts.destroy", "tags": [ "Contact" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}/type": { "patch": { "operationId": "counterparty.changeType", "tags": [ "Counterparty" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTypeRequest" } } } }, "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/counterparties": { "get": { "operationId": "counterparty.tableIndex", "tags": [ "Counterparty" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } }, { "name": "hierarchy", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "my", null ] } }, { "name": "is_company", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "counterparty_type_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "manager_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "credit_lt", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "credit_gt", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "credit", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "date_from", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties": { "get": { "operationId": "counterparties.index", "tags": [ "Counterparty" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } }, { "name": "hierarchy", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "my", null ] } }, { "name": "is_company", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "counterparty_type_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "manager_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "credit_lt", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "credit_gt", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "credit", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "date_from", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } } ], "responses": { "200": { "description": "`CounterpartyCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterpartyCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "counterparties.store", "tags": [ "Counterparty" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Counterparty.StoreRequest" } } } }, "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}": { "get": { "operationId": "counterparties.show", "tags": [ "Counterparty" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "counterparties.update", "tags": [ "Counterparty" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Counterparty.UpdateRequest" } } } }, "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "counterparties.destroy", "tags": [ "Counterparty" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Counterparty successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/managers": { "get": { "operationId": "counterparty.managersList", "tags": [ "Counterparty" ], "responses": { "200": { "description": "`ManagerCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagerCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty": { "get": { "operationId": "counterparty.authorized", "tags": [ "Counterparty" ], "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "counterparties.counterparty.update", "tags": [ "Counterparty" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Counterparties.Counterparty.UpdateRequest" } } } }, "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "counterparties.counterparty.destroy", "tags": [ "Counterparty" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Counterparty successfully deleted" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/phone/request_change": { "post": { "operationId": "counterparty.phone.requestChange", "summary": "\u0418\u043d\u0438\u0446\u0438\u0438\u0440\u0443\u0435\u0442 \u0441\u043c\u0435\u043d\u0443 \u043d\u043e\u043c\u0435\u0440\u0430 \u0442\u0435\u043b\u0435\u0444\u043e\u043d\u0430: \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u044f\u0435\u0442 OTP \u043d\u0430 \u043d\u043e\u0432\u044b\u0439 \u043d\u043e\u043c\u0435\u0440", "tags": [ "Counterparty" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestPhoneNumberChangeRequest" } } } }, "responses": { "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u043e\u0442\u043f\u0440\u0430\u0432\u0438\u0442\u044c \u043a\u043e\u0434 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f. \u041f\u043e\u0436\u0430\u043b\u0443\u0439\u0441\u0442\u0430, \u043f\u043e\u043f\u0440\u043e\u0431\u0443\u0439\u0442\u0435 \u043f\u043e\u0437\u0436\u0435." } }, "required": [ "message" ] } } } }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u041a\u043e\u0434 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u0435\u043d \u043d\u0430 \u0443\u043a\u0430\u0437\u0430\u043d\u043d\u044b\u0439 \u043d\u043e\u043c\u0435\u0440 \u0442\u0435\u043b\u0435\u0444\u043e\u043d\u0430." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/phone/verify_change": { "post": { "operationId": "counterparty.phone.verifyChange", "summary": "\u041f\u0440\u043e\u0432\u0435\u0440\u044f\u0435\u0442 OTP \u0438 \u0437\u0430\u0432\u0435\u0440\u0448\u0430\u0435\u0442 \u0441\u043c\u0435\u043d\u0443 \u043d\u043e\u043c\u0435\u0440\u0430 \u0442\u0435\u043b\u0435\u0444\u043e\u043d\u0430", "tags": [ "Counterparty" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyPhoneNumberChangeRequest" } } } }, "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u044d\u0442\u043e\u0433\u043e \u043d\u043e\u043c\u0435\u0440\u0430 \u0443\u0436\u0435 \u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/send_password": { "post": { "operationId": "counterparty.sendPassword", "tags": [ "Counterparty" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordRequest" } } } }, "responses": { "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Internal server error" } }, "required": [ "message" ] } } } }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Password successfully send" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/login": { "post": { "operationId": "counterparty.login", "tags": [ "Counterparty" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } } }, "responses": { "200": { "description": "`CounterpartyResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "$ref": "#/components/schemas/CounterpartyResource" } }, "required": [ "counterparty" ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0423\u043a\u0430\u0437\u0430\u043d \u043d\u0435\u043f\u0440\u0430\u0432\u0438\u043b\u044c\u043d\u044b\u0439 \u043f\u0430\u0440\u043e\u043b\u044c" } }, "required": [ "message" ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Send password before login. Password TTL is 5 minutes." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/counterparty-auth-clients": { "get": { "operationId": "counterpartyAuthClient.index", "tags": [ "CounterpartyAuthClient" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Paginated set of `CounterpartyAuthClientResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CounterpartyAuthClientResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "counterpartyAuthClient.store", "tags": [ "CounterpartyAuthClient" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.CounterpartyAuthClient.StoreRequest" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "client": { "$ref": "#/components/schemas/CounterpartyAuthClientResource" }, "client_secret": { "type": "string" } }, "required": [ "client", "client_secret" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/counterparty-auth-clients/{client}/rotate-secret": { "post": { "operationId": "counterpartyAuthClient.rotateSecret", "tags": [ "CounterpartyAuthClient" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "client": { "$ref": "#/components/schemas/CounterpartyAuthClientResource" }, "client_secret": { "type": "string" } }, "required": [ "client", "client_secret" ] } } } }, "422": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/applications/{application}/counterparty-auth-clients/{client}": { "delete": { "operationId": "counterpartyAuthClient.destroy", "tags": [ "CounterpartyAuthClient" ], "parameters": [ { "name": "application", "in": "path", "required": true, "description": "The application ID", "schema": { "type": "integer" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/auth/introspect": { "post": { "operationId": "counterparties.counterpartyAuthIntrospection", "tags": [ "CounterpartyAuthIntrospection" ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CounterpartyAuthIntrospectionRequest" } } } }, "responses": { "200": { "description": "Token introspection result with public identity and entitlement claims when active, or a minimal inactive response.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "active": { "type": "boolean", "description": "Token is valid for this auth client application." }, "principal_handle": { "type": [ "string", "null" ], "description": "Stable public counterparty identifier for external systems." }, "counterparty_type": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "string", "null" ], "description": "Public counterparty type slug, or null for legacy/custom types." } }, "required": [ "name", "slug" ], "description": "Public counterparty type name and slug. Slug may be null for legacy or custom types." }, "application": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "description": "Public application information for the token audience." }, "scopes": { "type": "array", "items": [], "description": "Public token abilities granted to this integration." }, "expires_at": { "type": [ "string", "null" ], "description": "Effective token expiry time, or null if no explicit expiry is known." }, "subscription": { "anyOf": [ { "type": "object", "properties": { "exists": { "type": "boolean", "description": "A subscription record exists in this application subscription scope." }, "active": { "type": "boolean", "description": "The subscription currently grants access or entitlement." }, "status": { "type": [ "string", "null" ], "description": "Public current subscription status." }, "type": { "type": [ "string", "null" ], "enum": [ "free", "paid", null ], "description": "Free or paid subscription type based on public billing meaning." }, "plan_slug": { "type": [ "string", "null" ], "description": "Representative public tariff slug, or null when no public slug should be exposed." }, "plan_slugs": { "type": "array", "items": { "type": "string" }, "description": "All active public tariff slugs currently granting entitlement." } }, "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ] }, { "type": "object", "properties": { "exists": { "type": "boolean", "description": "A subscription record exists in this application subscription scope." }, "active": { "type": "boolean", "description": "The subscription currently grants access or entitlement." }, "status": { "type": "null", "description": "Public current subscription status." }, "type": { "type": "null", "description": "Free or paid subscription type based on public billing meaning." }, "plan_slug": { "type": "null", "description": "Representative public tariff slug, or null when no public slug should be exposed." }, "plan_slugs": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false, "description": "All active public tariff slugs currently granting entitlement." } }, "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ] } ], "description": "Public subscription entitlement claim for this application scope." } }, "required": [ "active", "principal_handle", "counterparty_type", "application", "scopes", "expires_at", "subscription" ] }, { "type": "object", "properties": { "active": { "type": "boolean", "const": false, "description": "The token is invalid, expired, belongs to another app/project, or the client/application is not eligible; details are intentionally hidden." } }, "required": [ "active" ], "additionalProperties": false } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Forbidden." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "The auth client credentials are missing, invalid, disabled, or not eligible for this application.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthenticated." } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the counterparty auth introspection rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Too Many Attempts." } }, "required": [ "message" ] } } } }, "415": { "description": "The endpoint accepts only application/x-www-form-urlencoded request bodies.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unsupported Media Type." } }, "required": [ "message" ] } } } } }, "security": [ { "ClientCredentials": [] } ], "description": "External backend introspects a counterparty Bearer token for the current application and receives only public identity and entitlement claims." } }, "/api/counterparties/diagnostics": { "get": { "operationId": "counterpartyDiagnostics", "tags": [ "CounterpartyDiagnostics" ], "parameters": [ { "name": "phone", "in": "query", "schema": { "type": "string", "maxLength": 64 } }, { "name": "events_cursor", "in": "query", "schema": { "type": "string", "maxLength": 8192 } }, { "name": "events_per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "level", "in": "query", "schema": { "type": "string", "enum": [ "debug", "info", "notice", "warning", "error", "critical", "alert", "emergency" ] } }, { "name": "source", "in": "query", "schema": { "type": "string", "enum": [ "activity_logs", "counterparty_audit_events", "histories", "counterparty_histories", "order_histories", "search_requests", "ticket_redemption_logs", "discount_usages", "client_notifications", "client_notification_deliveries", "webhook_deliveries", "auth_callback_sessions", "counterparty_sessions", "counterparty_verifications", "subscription_status_events", "subscription_payments", "subscription_autopay_consents", "subscription_payment_method_changes", "subscription_payment_compensations", "subscription_checkout_items", "payments", "calls", "personal_access_tokens", "owner_auth_attempts", "owner_auth_sessions", "owner_auth_events", "owner_mcp_oauth_authorizations", "owner_mcp_oauth_grants", "staff_mcp_oauth_proofs", "staff_mcp_oauth_sessions", "agent_access_requests", "jobs", "failed_jobs", "job_batches", "database", "laravel", "nginx_access", "nginx_error", "php_fpm" ] } }, { "name": "http_method", "in": "query", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ] } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "type", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "status", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "event_code", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "actor_type", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "entity_type", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "request_id", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "route", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "actor_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "entity_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "application_id", "in": "query", "schema": { "type": "integer" } }, { "name": "branch_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "auth_window_hours", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 168 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "investigation": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "not_found", "ambiguous" ] }, "events": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "type": "null" }, "total": { "type": "integer" } }, "required": [ "has_more", "next_cursor", "total" ] }, "coverage": { "type": "object", "properties": { "warnings": { "type": "array", "prefixItems": [ { "type": "string", "const": "A unique counterparty in the current project is required." } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "warnings" ] } }, "required": [ "status", "events", "pagination", "coverage" ] } ] }, "periods": { "type": "object", "properties": { "business": { "type": "object", "properties": { "scope": { "type": "string", "const": "all_time" }, "from": { "type": "null" }, "to": { "type": "null" } }, "required": [ "scope", "from", "to" ] }, "auth": { "type": "object", "properties": { "scope": { "type": "string", "const": "window" }, "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] }, "hours": { "type": "integer" } }, "required": [ "scope", "from", "to", "hours" ] } }, "required": [ "business", "auth" ] }, "lookup": { "type": "object", "properties": { "counterparty_id": { "type": "string" }, "phone": { "type": "string" }, "normalized_phone": { "type": "string" }, "application_id": { "type": [ "integer", "null" ] }, "matched_counterparty_ids": { "type": "array", "items": { "type": "integer" } }, "match_count": { "type": "integer" } }, "required": [ "counterparty_id", "phone", "normalized_phone", "application_id", "matched_counterparty_ids", "match_count" ] }, "counterparty": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "counterparty_type": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "manager_id": { "type": [ "integer", "null" ] }, "is_company": { "type": "boolean" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "middle_name": { "type": "string" }, "registered_at": { "type": [ "string", "null" ] }, "phone_1": { "type": "string" }, "phone_2": { "type": "string" }, "email": { "type": "string" }, "phone_lookup_hash_prefix": { "type": [ "string", "null" ] }, "phone_identity_key_prefix": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_type", "manager_id", "is_company", "name", "first_name", "last_name", "middle_name", "registered_at", "phone_1", "phone_2", "email", "phone_lookup_hash_prefix", "phone_identity_key_prefix", "created_at", "updated_at" ] }, "counterparties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_type": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "manager_id": { "type": [ "integer", "null" ] }, "is_company": { "type": "boolean" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "middle_name": { "type": "string" }, "registered_at": { "type": [ "string", "null" ] }, "phone_1": { "type": "string" }, "phone_2": { "type": "string" }, "email": { "type": "string" }, "phone_lookup_hash_prefix": { "type": [ "string", "null" ] }, "phone_identity_key_prefix": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_type", "manager_id", "is_company", "name", "first_name", "last_name", "middle_name", "registered_at", "phone_1", "phone_2", "email", "phone_lookup_hash_prefix", "phone_identity_key_prefix", "created_at", "updated_at" ] } }, "phone_identity": { "anyOf": [ { "type": "object", "properties": { "normalized_phone_hash_prefix": { "type": [ "string", "null" ] }, "project_id": { "type": "integer" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "phone_lookup_hash_matches": { "type": "string" }, "phone_identity_key_matches": { "type": "string" } }, "required": [ "counterparty_id", "phone_lookup_hash_matches", "phone_identity_key_matches" ] } } }, "required": [ "normalized_phone_hash_prefix", "project_id", "matches" ] }, { "type": "object", "properties": { "normalized_phone_hash_prefix": { "type": "null" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "phone_lookup_hash_matches": { "type": "boolean" }, "phone_identity_key_matches": { "type": "boolean" } }, "required": [ "counterparty_id", "phone_lookup_hash_matches", "phone_identity_key_matches" ] } } }, "required": [ "normalized_phone_hash_prefix", "matches" ] } ] }, "service_registrations": { "type": "object", "properties": { "applications": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "application": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ] }, "records_count": { "type": "integer" }, "first_seen_at": { "type": [ "string", "null" ] }, "last_seen_at": { "type": [ "string", "null" ] } }, "required": [ "source", "application", "records_count", "first_seen_at", "last_seen_at" ] } }, "callback_auth_sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "status": { "type": "string" }, "phone": { "type": "string" }, "callback_number": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "verified_at": { "type": [ "string", "null" ] }, "access_token_delivered_at": { "type": [ "string", "null" ] }, "access_token_consumed_at": { "type": [ "string", "null" ] }, "last_activity_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "application", "status", "phone", "callback_number", "expires_at", "verified_at", "access_token_delivered_at", "access_token_consumed_at", "last_activity_at", "created_at", "updated_at" ] } } }, "required": [ "applications", "callback_auth_sessions" ] }, "auth": { "type": "object", "properties": { "window_hours": { "type": "integer" }, "callback_sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "status": { "type": "string" }, "phone": { "type": "string" }, "callback_number": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "verified_at": { "type": [ "string", "null" ] }, "access_token_delivered_at": { "type": [ "string", "null" ] }, "access_token_consumed_at": { "type": [ "string", "null" ] }, "last_activity_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "application", "status", "phone", "callback_number", "expires_at", "verified_at", "access_token_delivered_at", "access_token_consumed_at", "last_activity_at", "created_at", "updated_at" ] } }, "counterparty_sessions": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "count": { "type": "string" }, "last_seen_at": { "type": [ "string", "null" ] }, "active_count": { "type": "string" } }, "required": [ "count", "last_seen_at", "active_count" ] }, "items": { "type": "string" } }, "required": [ "summary", "items" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "count": { "type": "integer" }, "last_seen_at": { "type": "null" }, "active_count": { "type": "integer" } }, "required": [ "count", "last_seen_at", "active_count" ] }, "items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "summary", "items" ] } ] }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": "integer" }, "name": { "type": "string" }, "application_id": { "type": [ "integer", "null" ] }, "abilities": { "anyOf": [ { "type": "null" }, { "type": "object" }, { "type": "string" } ] }, "last_used_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "session_auth_method": { "type": "string" }, "session_device": { "type": "string" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "name", "application_id", "abilities", "last_used_at", "expires_at", "session_auth_method", "session_device", "created_at" ] } }, "auth_clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "string" }, "name": { "type": "string" }, "application_id": { "type": "integer" }, "audience": { "type": "string" }, "scopes": { "anyOf": [ { "type": "null" }, { "type": "object" }, { "type": "string" } ] }, "is_active": { "type": "boolean" }, "last_used_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "client_id", "name", "application_id", "audience", "scopes", "is_active", "last_used_at", "created_at", "updated_at" ] } }, "introspection_logs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "message": { "type": [ "string", "null" ] }, "context": { "type": "array", "items": [] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "message", "context", "created_at" ] } } }, "required": [ "window_hours", "callback_sessions", "counterparty_sessions", "tokens", "auth_clients", "introspection_logs" ] }, "subscriptions": { "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": "integer" }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "saved_payment_method_id": { "type": [ "integer", "null" ] }, "plan_slug": { "type": "string" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "status": { "type": "string" }, "current_period_start": { "type": [ "string", "null" ] }, "current_period_end": { "type": [ "string", "null" ] }, "canceled_at": { "type": [ "string", "null" ] }, "last_payment_at": { "type": [ "string", "null" ] }, "last_payment_error": { "type": "string" }, "retry_count": { "type": "integer" }, "next_charge_attempt_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "application", "saved_payment_method_id", "plan_slug", "amount", "currency", "status", "current_period_start", "current_period_end", "canceled_at", "last_payment_at", "last_payment_error", "retry_count", "next_charge_attempt_at", "created_at", "updated_at" ] }, { "type": "string" } ] } }, "status_events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "subscription_id": { "type": "integer" }, "application_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": "integer" }, "event_type": { "type": "string" }, "from_status": { "type": "string" }, "to_status": { "type": "string" }, "initiator_type": { "type": "string" }, "initiator_id": { "type": [ "integer", "null" ] }, "origin": { "type": "string" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "subscription_id", "application_id", "counterparty_id", "event_type", "from_status", "to_status", "initiator_type", "initiator_id", "origin", "created_at" ] } }, "autopay_consents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": "integer" }, "subscription_id": { "type": [ "integer", "null" ] }, "order_id": { "type": [ "integer", "null" ] }, "saved_payment_method_id": { "type": [ "integer", "null" ] }, "source": { "type": "string" }, "accepted_at": { "type": [ "string", "null" ] }, "version": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "billing_period_months": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "subscription_id", "order_id", "saved_payment_method_id", "source", "accepted_at", "version", "amount", "currency", "billing_period_months", "created_at" ] } }, "payment_method_changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "counterparty_id": { "type": "integer" }, "subscription_id": { "type": "integer" }, "previous_saved_payment_method_id": { "type": "integer" }, "new_saved_payment_method_id": { "type": [ "integer", "null" ] }, "subscription_autopay_consent_id": { "type": "integer" }, "status": { "type": "string" }, "active_slot": { "type": [ "integer", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "failure_code": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application", "counterparty_id", "subscription_id", "previous_saved_payment_method_id", "new_saved_payment_method_id", "subscription_autopay_consent_id", "status", "active_slot", "expires_at", "completed_at", "failure_code", "created_at", "updated_at" ] } }, "saved_payment_methods": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": "integer" }, "warehouse_integration_id": { "type": "integer" }, "application_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" } } ] }, "yookassa_payment_method_id_prefix": { "type": [ "string", "null" ] }, "payment_method_type": { "type": "string" }, "card_type": { "type": "string" }, "card_last_4": { "type": "string" }, "is_active": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "warehouse_integration_id", "application_ids", "yookassa_payment_method_id_prefix", "payment_method_type", "card_type", "card_last_4", "is_active", "created_at", "updated_at" ] } } }, "required": [ "items", "status_events", "autopay_consents", "payment_method_changes", "saved_payment_methods" ] }, "payments": { "type": "object", "properties": { "subscription_payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "subscription_id": { "type": "integer" }, "saved_payment_method_id": { "type": [ "integer", "null" ] }, "warehouse_integration_id": { "type": [ "integer", "null" ] }, "yookassa_payment_id_prefix": { "type": [ "string", "null" ] }, "amount": { "type": "string" }, "status": { "type": "string" }, "error_reason": { "type": [ "string", "null" ] }, "provider_status": { "type": "string" }, "submitted_at": { "type": [ "string", "null" ] }, "provider_checked_at": { "type": [ "string", "null" ] }, "provider_finalized_at": { "type": [ "string", "null" ] }, "next_reconcile_at": { "type": [ "string", "null" ] }, "reconciliation_attempts": { "type": "integer" }, "finality_reason": { "type": "string" }, "manual_review_required": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "subscription_id", "saved_payment_method_id", "warehouse_integration_id", "yookassa_payment_id_prefix", "amount", "status", "error_reason", "provider_status", "submitted_at", "provider_checked_at", "provider_finalized_at", "next_reconcile_at", "reconciliation_attempts", "finality_reason", "manual_review_required", "created_at", "updated_at" ] } }, "orders": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "status": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "price": { "type": [ "string", "null" ] }, "yookassa_payment_id_prefix": { "type": [ "string", "null" ] }, "yookassa_payment_method_type": { "type": "string" }, "paid_email_sent_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "application", "status", "price", "yookassa_payment_id_prefix", "yookassa_payment_method_type", "paid_email_sent_at", "created_at", "updated_at" ] }, { "type": "string" } ] } }, "payment_records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "order_id": { "type": "integer" }, "payment_id_prefix": { "type": [ "string", "null" ] }, "description": { "type": "string" }, "amount": { "type": "string" }, "card_type": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "order_id", "payment_id_prefix", "description", "amount", "card_type", "created_at", "updated_at" ] } }, "verifications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "counterparty_id": { "type": "integer" }, "warehouse_integration_id": { "type": [ "integer", "null" ] }, "method": { "type": "string" }, "status": { "type": "string" }, "provider": { "type": "string" }, "provider_payment_id_prefix": { "type": [ "string", "null" ] }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "verified_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application", "counterparty_id", "warehouse_integration_id", "method", "status", "provider", "provider_payment_id_prefix", "amount", "currency", "expires_at", "verified_at", "created_at", "updated_at" ] } }, "webhook_deliveries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "application_webhook_id": { "type": "integer" }, "event": { "type": "string" }, "event_id_prefix": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "attempts": { "type": "integer" }, "next_attempt_at": { "type": [ "string", "null" ] }, "last_status_code": { "type": [ "integer", "null" ] }, "last_error": { "type": [ "string", "null" ] }, "delivered_at": { "type": [ "string", "null" ] }, "failed_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application_webhook_id", "event", "event_id_prefix", "status", "attempts", "next_attempt_at", "last_status_code", "last_error", "delivered_at", "failed_at", "created_at", "updated_at" ] } } }, "required": [ "subscription_payments", "orders", "payment_records", "verifications", "webhook_deliveries" ] }, "communications": { "type": "object", "properties": { "client_notifications": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "application": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "counterparty_id": { "type": "integer" }, "event": { "type": "string" }, "event_id_prefix": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "action_url_present": { "type": "string" }, "data_keys": { "type": "array", "items": [] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application", "counterparty_id", "event", "event_id_prefix", "title", "body", "action_url_present", "data_keys", "created_at", "updated_at" ] }, { "type": "string" } ] } }, "deliveries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "client_notification_id": { "type": "integer" }, "channel": { "type": "string" }, "provider": { "type": "string" }, "status": { "type": "string" }, "attempts": { "type": "integer" }, "next_attempt_at": { "type": [ "string", "null" ] }, "last_status_code": { "type": [ "integer", "null" ] }, "last_error": { "type": [ "string", "null" ] }, "provider_message_id_prefix": { "type": [ "string", "null" ] }, "accepted_at": { "type": [ "string", "null" ] }, "delivered_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "client_notification_id", "channel", "provider", "status", "attempts", "next_attempt_at", "last_status_code", "last_error", "provider_message_id_prefix", "accepted_at", "delivered_at", "created_at", "updated_at" ] } } }, "required": [ "client_notifications", "deliveries" ] }, "histories": { "type": "object", "properties": { "counterparty_histories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "action": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "data_keys": { "type": "array", "items": [] }, "user": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ] }, "login": { "type": "string" } }, "required": [ "id", "name", "login" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "counterparty_id", "action", "title", "description", "data_keys", "user", "created_at" ] } }, "generic_histories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "model": { "type": "string" }, "model_id": { "type": [ "integer", "null" ] }, "action": { "type": "string" }, "url_path": { "type": [ "string", "null" ] }, "url_query_keys": { "type": "array", "items": [] }, "data_keys": { "type": "array", "items": [] }, "user": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ] }, "login": { "type": "string" } }, "required": [ "id", "name", "login" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "model", "model_id", "action", "url_path", "url_query_keys", "data_keys", "user", "created_at" ] } }, "activity_logs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "status": { "type": "string" }, "message": { "type": [ "string", "null" ] }, "context": { "type": "array", "items": [] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "type", "status", "message", "context", "created_at" ] } } }, "required": [ "counterparty_histories", "generic_histories", "activity_logs" ] }, "timeline": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "at": { "type": [ "string", "null" ] }, "source": { "type": "string", "const": "counterparty" }, "type": { "type": "string", "const": "created" }, "id": { "type": "integer" }, "label": { "type": "string" } }, "required": [ "at", "source", "type", "id", "label" ] }, { "type": "object", "properties": { "at": { "type": "string" }, "source": { "type": "string", "const": "subscription" }, "type": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "at", "source", "type", "id", "label" ] }, { "type": "object", "properties": { "at": { "type": "string" }, "source": { "type": "string", "const": "order" }, "type": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "at", "source", "type", "id", "label" ] }, { "type": "object", "properties": { "at": { "type": "string" }, "source": { "type": "string", "const": "client_notification" }, "type": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "at", "source", "type", "id", "label" ] } ] } }, "meta": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string", "enum": [ "counterparty_not_found_in_project", "phone_lookup_matched_multiple_counterparties" ] } }, "privacy": { "type": "object", "properties": { "secrets_redacted": { "type": "boolean" }, "hashes": { "type": "string", "const": "prefix_only" }, "recipient_external_ids_redacted": { "type": "boolean" }, "encrypted_payloads_redacted": { "type": "boolean" } }, "required": [ "secrets_redacted", "hashes", "recipient_external_ids_redacted", "encrypted_payloads_redacted" ] } }, "required": [ "warnings", "privacy" ] } }, "required": [ "investigation", "periods", "lookup", "counterparty", "counterparties", "phone_identity", "service_registrations", "auth", "subscriptions", "payments", "communications", "histories", "timeline", "meta" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}/history": { "get": { "operationId": "counterpartyHistory.index", "tags": [ "CounterpartyHistory" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparties/{counterparty}/sessions": { "get": { "operationId": "counterpartySession.index", "tags": [ "CounterpartySession" ], "parameters": [ { "name": "counterparty", "in": "path", "required": true, "description": "The counterparty ID", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "application_id", "in": "query", "schema": { "type": "integer" } }, { "name": "auth_method", "in": "query", "schema": { "type": "string", "enum": [ "phone_code", "email_code", "miniapp_max", "miniapp_telegram", "callback_call", "legacy" ] } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "active", "ended" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "last_login_at": { "type": [ "string", "null" ] }, "last_seen_at": { "type": [ "string", "null" ] }, "is_online": { "type": "string" }, "total_duration_seconds": { "type": "integer" } }, "required": [ "last_login_at", "last_seen_at", "is_online", "total_duration_seconds" ] }, "sessions": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "total", "per_page", "current_page", "last_page" ] } }, "required": [ "summary", "sessions", "pagination" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/session/heartbeat": { "post": { "operationId": "counterparties.counterpartySessionHeartbeat", "tags": [ "CounterpartySessionHeartbeat" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "type": "object", "properties": { "id": [], "status": { "type": "string", "enum": [ "active", "ended" ] }, "started_at": { "type": "string" }, "last_seen_at": { "type": "string" }, "duration_seconds": { "type": "integer" } }, "required": [ "id", "status", "started_at", "last_seen_at", "duration_seconds" ] }, "server_time": { "type": "string" }, "next_heartbeat_in_seconds": { "type": [ "object", "null" ] } }, "required": [ "session", "server_time", "next_heartbeat_in_seconds" ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "counterparty_session_unavailable" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty_types": { "get": { "operationId": "counterparty_types.index", "tags": [ "CounterpartyType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty_types/{counterpartyType}": { "get": { "operationId": "counterparty_types.show", "tags": [ "CounterpartyType" ], "parameters": [ { "name": "counterpartyType", "in": "path", "required": true, "description": "The counterparty type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty_types/history": { "get": { "operationId": "counterpartyType.history", "tags": [ "CounterpartyType" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/verifications/sbp-payment": { "post": { "operationId": "counterpartyVerification.startSbp", "tags": [ "CounterpartyVerification" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/countries": { "get": { "operationId": "countries.index", "tags": [ "Country" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "countries.store", "summary": "Store a newly created resource in storage", "tags": [ "Country" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Dictionary.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/countries/{country}": { "get": { "operationId": "countries.show", "summary": "Display the specified resource", "tags": [ "Country" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "The country ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "countries.update", "summary": "Update the specified resource in storage", "tags": [ "Country" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "The country ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Dictionary.UpdateRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "countries.destroy", "summary": "Remove the specified resource from storage", "tags": [ "Country" ], "parameters": [ { "name": "country", "in": "path", "required": true, "description": "The country ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Country successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/countries": { "get": { "operationId": "country.index_448", "tags": [ "Country" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/search_address": { "post": { "operationId": "dadata.searchAddress_190", "tags": [ "Dadata" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "`DadataAddressCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadataAddressCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/search_company": { "post": { "operationId": "dadata.searchCompany", "tags": [ "Dadata" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "`DadataCompanyCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadataCompanyCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/search_bank": { "post": { "operationId": "dadata.searchBank", "tags": [ "Dadata" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "`DadataBankCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadataBankCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/search_nomenclature": { "post": { "operationId": "dadata.searchNomenclature", "tags": [ "Dadata" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "return $this->dadataService->searchNomenclature($data['query']);\n\n\n\n`DadataNomenclatureCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadataNomenclatureCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/search_address": { "post": { "operationId": "dadata.searchAddress_468", "tags": [ "Dadata" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "`DadataAddressCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadataAddressCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/delivery_types/{type}/subtypes": { "get": { "operationId": "deliverySubtype.index", "tags": [ "DeliverySubtype" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "The type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/delivery_types/{type}/subtypes/{subtype}": { "get": { "operationId": "deliverySubtype.show", "tags": [ "DeliverySubtype" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "The type ID", "schema": { "type": "integer" } }, { "name": "subtype", "in": "path", "required": true, "description": "The subtype ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "deliveryType": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" } }, "required": [ "deliveryType" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/delivery_types/{type}/subtypes/{subtype}/params": { "get": { "operationId": "deliverySubtypeParam.index", "tags": [ "DeliverySubtypeParam" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "The type ID", "schema": { "type": "integer" } }, { "name": "subtype", "in": "path", "required": true, "description": "The subtype ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DeliverySubtypeParamCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverySubtypeParamCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/delivery_types": { "get": { "operationId": "delivery_types.index", "tags": [ "DeliveryType" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`DeliveryTypeCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryTypeCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/delivery_types": { "get": { "operationId": "counterparties.deliveryType.index", "tags": [ "DeliveryType" ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeCollection" } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/delivery_types/{type}": { "get": { "operationId": "deliveryType.show", "tags": [ "DeliveryType" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "The type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "deliveryType": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" } }, "required": [ "deliveryType" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/departments": { "get": { "operationId": "departments.index", "tags": [ "Department" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "departments.store", "tags": [ "Department" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Dictionary.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/departments/{department}": { "get": { "operationId": "departments.show", "tags": [ "Department" ], "parameters": [ { "name": "department", "in": "path", "required": true, "description": "The department ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "departments.update", "tags": [ "Department" ], "parameters": [ { "name": "department", "in": "path", "required": true, "description": "The department ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Dictionary.UpdateRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "departments.destroy", "tags": [ "Department" ], "parameters": [ { "name": "department", "in": "path", "required": true, "description": "The department ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Department successfully destroyed" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/departments/history": { "get": { "operationId": "department.history", "tags": [ "Department" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/dictionaries": { "get": { "operationId": "dictionary.index", "summary": "\u0412\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 \u043a\u043e\u043b\u043b\u0435\u043a\u0446\u0438\u044e \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u043e\u0432", "tags": [ "Dictionary" ], "parameters": [ { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "dictionaries": { "type": "object", "properties": { "categories": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Category.CategoryCollection" }, "brands": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryCollection" }, "countries": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryCollection" }, "tags": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryCollection" }, "popular_requests": { "type": "array", "items": { "$ref": "#/components/schemas/SearchHistoryResource" } } }, "required": [ "categories", "brands", "countries", "tags", "popular_requests" ] } }, "required": [ "dictionaries" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/discounts/stats": { "get": { "operationId": "discount.stats", "tags": [ "Discount" ], "parameters": [ { "name": "period", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "/^\\d{4}-(0[1-9]" } }, { "name": "application_id", "in": "query", "schema": { "type": [ "integer", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string" }, "active_count": { "type": "integer", "minimum": 0 }, "active_delta": { "type": "integer", "minimum": 0 }, "usage_count_for_period": { "type": "integer", "minimum": 0 }, "usage_delta_percent": { "type": [ "number", "null" ] }, "saved_amount_for_period": { "type": "number" }, "saved_delta_percent": { "type": [ "number", "null" ] } }, "required": [ "period", "active_count", "active_delta", "usage_count_for_period", "usage_delta_percent", "saved_amount_for_period", "saved_delta_percent" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/discounts/{discount}/pause": { "post": { "operationId": "discount.pause", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/DiscountResource" } }, "required": [ "discount" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/discounts/{discount}/activate": { "post": { "operationId": "discount.activate", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/DiscountResource" } }, "required": [ "discount" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/discounts/{discount}/archive": { "post": { "operationId": "discount.archive", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/DiscountResource" } }, "required": [ "discount" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/discounts": { "get": { "operationId": "discounts.index", "tags": [ "Discount" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "status", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "active", "scheduled", "expired", "paused", "draft", "archived", null ] } }, { "name": "audience", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "new_clients", "partners", "custom", null ] } }, { "name": "period", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "/^\\d{4}-(0[1-9]" } }, { "name": "application_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "branch_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "Paginated set of `DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/DiscountCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "discount", "links", "meta" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "discounts.store", "tags": [ "Discount" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Discount.StoreRequest" } } } }, "responses": { "200": { "description": "`DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/DiscountResource" } }, "required": [ "discount" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/discounts/{discount}": { "get": { "operationId": "discounts.show", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "allOf": [ { "$ref": "#/components/schemas/DiscountResource" }, { "type": "object", "required": [ "latest_usages" ] } ] } }, "required": [ "discount" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "discounts.update", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Discount.UpdateRequest" } } } }, "responses": { "200": { "description": "`DiscountResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/DiscountResource" } }, "required": [ "discount" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "discounts.destroy", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/discounts/{discount}/usages": { "get": { "operationId": "discount.usagesTableIndex", "tags": [ "Discount" ], "parameters": [ { "name": "discount", "in": "path", "required": true, "description": "The discount ID", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer" } }, { "name": "order_id", "in": "query", "schema": { "type": "integer" } }, { "name": "application_id", "in": "query", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 128 } }, { "name": "sort_by", "in": "query", "schema": { "type": "string", "enum": [ "used_at", "final_amount", "discount_amount", "original_amount" ] } }, { "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/events": { "get": { "operationId": "events.index", "tags": [ "Event" ], "parameters": [ { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer" } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "order_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "`EventCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "events.store", "tags": [ "Event" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Event.StoreRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Event.EventResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/App.Http.Resources.Event.EventResource" } }, "required": [ "event" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/events/{event}": { "get": { "operationId": "events.show", "tags": [ "Event" ], "parameters": [ { "name": "event", "in": "path", "required": true, "description": "The event ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Event.EventResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/App.Http.Resources.Event.EventResource" } }, "required": [ "event" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "events.update", "tags": [ "Event" ], "parameters": [ { "name": "event", "in": "path", "required": true, "description": "The event ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Event.UpdateRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Event.EventResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/App.Http.Resources.Event.EventResource" } }, "required": [ "event" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "events.destroy", "tags": [ "Event" ], "parameters": [ { "name": "event", "in": "path", "required": true, "description": "The event ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Event successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/events": { "get": { "operationId": "event.tableIndex", "tags": [ "Event" ], "parameters": [ { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer" } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "order_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/event_statuses": { "get": { "operationId": "event_statuses.index", "tags": [ "EventStatus" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "event_statuses.store", "summary": "Store a newly created resource in storage", "tags": [ "EventStatus" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.EventStatus.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/event_statuses/{event_status}": { "get": { "operationId": "event_statuses.show", "tags": [ "EventStatus" ], "parameters": [ { "name": "event_status", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "event_statuses.update", "tags": [ "EventStatus" ], "parameters": [ { "name": "event_status", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.EventStatus.UpdateRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "event_statuses.destroy", "tags": [ "EventStatus" ], "parameters": [ { "name": "event_status", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Event Status successfully deleted" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/products/favourites": { "get": { "operationId": "favourites.index", "tags": [ "FavouriteProduct" ], "responses": { "200": { "description": "`ShortProductCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortProductCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "favourites.store", "tags": [ "FavouriteProduct" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Counterparties.Product.Favourite.StoreRequest" } } } }, "responses": { "200": { "description": "`ProductResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/ProductResource" } }, "required": [ "product" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/products/favourites/{nomenclatureId}": { "get": { "operationId": "favourites.show", "tags": [ "FavouriteProduct" ], "parameters": [ { "name": "nomenclatureId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`ProductResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/ProductResource" } }, "required": [ "product" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "favourites.destroy", "tags": [ "FavouriteProduct" ], "parameters": [ { "name": "nomenclatureId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Product successfully deleted from favourites" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/files": { "get": { "operationId": "file.index", "tags": [ "File" ], "responses": { "200": { "description": "`FileCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "file.store", "tags": [ "File" ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.File.StoreRequest" } } } }, "responses": { "200": { "description": "`FileResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/FileResource" } }, "required": [ "file" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/files/{file}": { "get": { "operationId": "file.show", "tags": [ "File" ], "parameters": [ { "name": "file", "in": "path", "required": true, "description": "The file ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`FileResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/FileResource" } }, "required": [ "file" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "file.update", "tags": [ "File" ], "parameters": [ { "name": "file", "in": "path", "required": true, "description": "The file ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.File.UpdateRequest" } } } }, "responses": { "200": { "description": "`FileResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/FileResource" } }, "required": [ "file" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "file.destroy", "tags": [ "File" ], "parameters": [ { "name": "file", "in": "path", "required": true, "description": "The file ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "File successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/files": { "post": { "operationId": "counterparties.file.store", "tags": [ "File" ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AvatarStoreRequest" } } } }, "responses": { "200": { "description": "`FileResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/FileResource" } }, "required": [ "file" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/file_types": { "get": { "operationId": "file_types.index", "tags": [ "FileType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/file_types/{fileType}": { "get": { "operationId": "file_types.show", "tags": [ "FileType" ], "parameters": [ { "name": "fileType", "in": "path", "required": true, "description": "The file type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/file_types/history": { "get": { "operationId": "fileType.history", "tags": [ "FileType" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/integrations": { "get": { "operationId": "integrations.index", "tags": [ "Integration" ], "parameters": [ { "name": "integration_type_id", "in": "query", "schema": { "type": [ "integer", "null" ] } } ], "responses": { "200": { "description": "`IntegrationCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/integrations/{integration}": { "get": { "operationId": "integrations.show", "tags": [ "Integration" ], "parameters": [ { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`IntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/IntegrationResource" } }, "required": [ "integration" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/integrations/history": { "get": { "operationId": "integration.history", "tags": [ "Integration" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/integration_types": { "get": { "operationId": "integration_types.index", "tags": [ "IntegrationType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/integration_types/{integrationType}": { "get": { "operationId": "integration_types.show", "tags": [ "IntegrationType" ], "parameters": [ { "name": "integrationType", "in": "path", "required": true, "description": "The integration type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/inventories/upload": { "post": { "operationId": "inventory.importDataFromFile", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportInventoryRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "error" }, "message": { "type": "string", "const": "\u0414\u043e\u043f\u0443\u0441\u0442\u0438\u043c\u044b\u0435 \u0444\u043e\u0440\u043c\u0430\u0442\u044b: XMR, XML, CSV \u0438\u043b\u0438 Excel (XLS/XLSX)." } }, "required": [ "status", "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/inventories": { "get": { "operationId": "inventory.tableIndex", "tags": [ "Inventory" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 1024 } }, { "name": "owned_by_us", "in": "query", "schema": { "type": "boolean" } }, { "name": "warehouse_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "type_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "city_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "brand_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "vat_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "counterparty_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TableCollection" }, { "type": "object" } ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/inventories/{modelId}/history": { "get": { "operationId": "inventory.history", "tags": [ "Inventory" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders/calculator": { "post": { "operationId": "inventory.calculatePrice", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculatePriceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "price": { "type": "integer" } }, "required": [ "price" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/inventories": { "get": { "operationId": "inventories.index", "tags": [ "Inventory" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 1024 } }, { "name": "owned_by_us", "in": "query", "schema": { "type": "boolean" } }, { "name": "warehouse_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "type_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "city_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "brand_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "vat_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "counterparty_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`InventoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "inventories.store", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.WarehouseNomenclature.StoreRequest" } } } }, "responses": { "200": { "description": "`InventoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/InventoryResource" } }, "required": [ "inventory" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/inventories/{inventory}": { "get": { "operationId": "inventories.show", "tags": [ "Inventory" ], "parameters": [ { "name": "inventory", "in": "path", "required": true, "description": "The inventory ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`InventoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/InventoryResource" } }, "required": [ "inventory" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "inventories.update", "tags": [ "Inventory" ], "parameters": [ { "name": "inventory", "in": "path", "required": true, "description": "The inventory ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.WarehouseNomenclature.UpdateRequest" } } } }, "responses": { "200": { "description": "`InventoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/InventoryResource" } }, "required": [ "inventory" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "inventories.destroy", "tags": [ "Inventory" ], "parameters": [ { "name": "inventory", "in": "path", "required": true, "description": "The inventory ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Inventory deleted successfully." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/menus": { "get": { "operationId": "menus.index", "tags": [ "Menu" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "menus.store", "tags": [ "Menu" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Dictionary.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/menus/{menu}": { "get": { "operationId": "menus.show", "tags": [ "Menu" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "menus.update", "tags": [ "Menu" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Dictionary.UpdateRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "menus.destroy", "tags": [ "Menu" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Menu has been deleted." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/miniapps/{provider}/contact_auth": { "post": { "operationId": "miniappAuth.contact", "tags": [ "MiniappAuth" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "default": "max" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAuthRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterparty": { "type": "array", "items": [] } }, "required": [ "counterparty" ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "const": "miniapp_contact_auth_invalid" } }, "required": [ "error" ] }, { "type": "object", "properties": { "error": { "type": "string", "const": "application_token_required" } }, "required": [ "error" ] } ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "const": "miniapp_contact_auth_not_configured" } }, "required": [ "error" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "const": "miniapp_provider_not_supported" } }, "required": [ "error" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/nomenclatures": { "get": { "operationId": "nomenclature.tableIndex", "tags": [ "Nomenclature" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "type_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "kind_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "is_import", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures/{modelId}/history": { "get": { "operationId": "nomenclature.history", "tags": [ "Nomenclature" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures/export": { "post": { "operationId": "nomenclature.export", "tags": [ "Nomenclature" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures/import": { "post": { "operationId": "nomenclature.import", "tags": [ "Nomenclature" ], "responses": { "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "message": { "type": "string", "const": "Import successful" }, "created": { "anyOf": [ { "type": "string" }, { "type": "integer", "enum": [ 0 ] } ] }, "updated": { "anyOf": [ { "type": "string" }, { "type": "integer", "enum": [ 0 ] } ] }, "skipped": { "anyOf": [ { "type": "string" }, { "type": "integer", "enum": [ 0 ] } ] }, "errors": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "status", "message", "created", "updated", "skipped", "errors" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures": { "get": { "operationId": "nomenclatures.index", "tags": [ "Nomenclature" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "type_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "kind_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } } }, { "name": "is_import", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`NomenclatureCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomenclatureCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "nomenclatures.store", "tags": [ "Nomenclature" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Nomenclature.StoreRequest" } } } }, "responses": { "200": { "description": "`NomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "nomenclature": { "$ref": "#/components/schemas/NomenclatureResource" } }, "required": [ "nomenclature" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures/{nomenclature}": { "get": { "operationId": "nomenclatures.show", "tags": [ "Nomenclature" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`NomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "nomenclature": { "$ref": "#/components/schemas/NomenclatureResource" } }, "required": [ "nomenclature" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "nomenclatures.update", "tags": [ "Nomenclature" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Nomenclature.UpdateRequest" } } } }, "responses": { "200": { "description": "`NomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "nomenclature": { "$ref": "#/components/schemas/NomenclatureResource" } }, "required": [ "nomenclature" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "nomenclatures.destroy", "tags": [ "Nomenclature" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/categories": { "get": { "operationId": "nomenclatureCategory.tableIndex", "tags": [ "NomenclatureCategory" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } }, { "name": "creator_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/categories/{modelId}/history": { "get": { "operationId": "nomenclatureCategory.history", "tags": [ "NomenclatureCategory" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/categories/creators": { "get": { "operationId": "nomenclatureCategory.creatorsList", "tags": [ "NomenclatureCategory" ], "responses": { "200": { "description": "`UserNameCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNameCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/categories": { "get": { "operationId": "categories.index", "summary": "Display a listing of the resource", "tags": [ "NomenclatureCategory" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } }, { "name": "creator_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`CategoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "categories.store", "summary": "Store a newly created resource in storage", "tags": [ "NomenclatureCategory" ], "responses": { "200": { "description": "`CategoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/CategoryResource" } }, "required": [ "category" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/categories/{category}": { "get": { "operationId": "categories.show", "summary": "Display the specified resource", "tags": [ "NomenclatureCategory" ], "parameters": [ { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CategoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/CategoryResource" } }, "required": [ "category" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "categories.update", "summary": "Update the specified resource in storage", "tags": [ "NomenclatureCategory" ], "parameters": [ { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CategoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/CategoryResource" } }, "required": [ "category" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "categories.destroy", "summary": "Remove the specified resource from storage", "tags": [ "NomenclatureCategory" ], "parameters": [ { "name": "category", "in": "path", "required": true, "description": "The category ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Nomenclature category successfully destroyed" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures/{nomenclature}/compositions": { "get": { "operationId": "compositions.index", "tags": [ "NomenclatureComposition" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`NomenclatureCompositionCollection`", "content": { "application/json": { "schema": { "type": "object", "properties": { "compositions": { "$ref": "#/components/schemas/NomenclatureCompositionCollection" } }, "required": [ "compositions" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "compositions.store", "tags": [ "NomenclatureComposition" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`NomenclatureCompositionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "composition": { "allOf": [ { "$ref": "#/components/schemas/NomenclatureCompositionResource" }, { "type": "object", "required": [ "component" ] } ] } }, "required": [ "composition" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclatures/{nomenclature}/compositions/{composition}": { "put": { "operationId": "compositions.update", "tags": [ "NomenclatureComposition" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } }, { "name": "composition", "in": "path", "required": true, "description": "The composition ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`NomenclatureCompositionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "composition": { "allOf": [ { "$ref": "#/components/schemas/NomenclatureCompositionResource" }, { "type": "object", "required": [ "component" ] } ] } }, "required": [ "composition" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "compositions.destroy", "tags": [ "NomenclatureComposition" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } }, { "name": "composition", "in": "path", "required": true, "description": "The composition ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Nomenclature composition successfully destroyed" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclature_kinds": { "get": { "operationId": "nomenclature_kinds.index", "tags": [ "NomenclatureKind" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclature_kinds/{nomenclatureKind}": { "get": { "operationId": "nomenclature_kinds.show", "tags": [ "NomenclatureKind" ], "parameters": [ { "name": "nomenclatureKind", "in": "path", "required": true, "description": "The nomenclature kind ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tags": { "get": { "operationId": "tags.index", "tags": [ "NomenclatureTag" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/tags": { "get": { "operationId": "nomenclatureTag.index_441", "tags": [ "NomenclatureTag" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclature_types": { "get": { "operationId": "nomenclature_types.index", "tags": [ "NomenclatureType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/nomenclature_types/{nomenclatureType}": { "get": { "operationId": "nomenclature_types.show", "tags": [ "NomenclatureType" ], "parameters": [ { "name": "nomenclatureType", "in": "path", "required": true, "description": "The nomenclature type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/notifications": { "get": { "operationId": "notification.index", "tags": [ "Notification" ], "responses": { "200": { "description": "Paginated set of `NotificationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "notification": { "$ref": "#/components/schemas/NotificationCollection" }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "notification", "links", "meta" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/objects": { "get": { "operationId": "objects.index", "tags": [ "Object" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/objects/{object}": { "get": { "operationId": "objects.show", "tags": [ "Object" ], "parameters": [ { "name": "object", "in": "path", "required": true, "description": "The object ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/orders": { "get": { "operationId": "order.tableIndex", "tags": [ "Order" ], "parameters": [ { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer" } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "order_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/orders/{order}/files": { "get": { "operationId": "order.tableFileIndex", "tags": [ "Order" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders": { "get": { "operationId": "orders.index", "tags": [ "Order" ], "parameters": [ { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "name": "counterparty_id", "in": "query", "schema": { "type": "integer" } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "order_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "`OrderCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "orders.store", "tags": [ "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Order.StoreRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Order.OrderResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/App.Http.Resources.Order.OrderResource" } }, "required": [ "order" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders/{order}": { "get": { "operationId": "orders.show", "tags": [ "Order" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Order.OrderResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/App.Http.Resources.Order.OrderResource" } }, "required": [ "order" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "orders.update", "tags": [ "Order" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Order.UpdateRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Order.OrderResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/App.Http.Resources.Order.OrderResource" } }, "required": [ "order" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders/{order}/request-refund": { "post": { "operationId": "order.requestRefund", "tags": [ "Order" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestRefundRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0417\u0430\u043f\u0440\u043e\u0441 \u043d\u0430 \u0432\u043e\u0437\u0432\u0440\u0430\u0442 \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u0435\u043d \u043a\u043b\u0438\u0435\u043d\u0442\u0443 \u0438 \u0432\u0430\u043c \u043d\u0430 \u043f\u043e\u0447\u0442\u0443." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders/{order}/files": { "post": { "operationId": "order.storeFile", "tags": [ "Order" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.File.StoreRequest" } } } }, "responses": { "200": { "description": "`FileResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/FileResource" } }, "required": [ "file" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/orders/precalculate": { "post": { "operationId": "order.preCalculate", "tags": [ "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrecalculateRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "price": { "type": "number" }, "discount": { "type": "number" }, "total": { "type": "number" }, "quantity_pack": { "type": "integer" }, "original_price": { "type": "number" }, "product_discount": { "type": "number" }, "promo_discount": { "type": "number" }, "product_discount_amount": { "type": "number" }, "promo_discount_amount": { "type": "number" }, "total_discount_amount": { "type": "number" }, "final_price": { "type": "number" }, "applied_discount": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "number" } }, "required": [ "id", "code", "name", "type", "value" ] }, "discount_error": { "type": "object", "properties": { "reason": { "type": "string", "const": "\u041f\u0440\u043e\u043c\u043e\u043a\u043e\u0434 \u043d\u0435 \u043f\u0440\u0438\u043c\u0435\u043d\u0438\u043c." }, "code": { "type": "integer", "const": 2099 } }, "required": [ "reason", "code" ] }, "products": { "type": "array", "items": [] } }, "required": [ "price", "discount", "total", "quantity_pack", "original_price", "product_discount", "promo_discount", "product_discount_amount", "promo_discount_amount", "total_discount_amount", "final_price", "applied_discount", "discount_error", "products" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/orders": { "get": { "operationId": "counterparty-orders.index", "tags": [ "Order" ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Order.OrderCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Order.OrderCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "counterparty-orders.store", "tags": [ "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Counterparties.Order.StoreRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Order.OrderResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Order.OrderResource" } }, "required": [ "order" ] } } } }, "502": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "enum": [ "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u043f\u043b\u0430\u0442\u0451\u0436. \u0417\u0430\u043a\u0430\u0437 \u043e\u0442\u043c\u0435\u043d\u0451\u043d, \u043f\u0440\u043e\u043c\u043e\u043a\u043e\u0434 \u043d\u0435 \u0431\u044b\u043b \u0441\u043f\u0438\u0441\u0430\u043d.", "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u043f\u043b\u0430\u0442\u0451\u0436. \u0417\u0430\u043a\u0430\u0437 \u043e\u0442\u043c\u0435\u043d\u0451\u043d." ] } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "\u0421\u0442\u0430\u0442\u0443\u0441 \u043f\u043b\u0430\u0442\u0435\u0436\u0430 \u0443\u0442\u043e\u0447\u043d\u044f\u0435\u0442\u0441\u044f. \u0417\u0430\u043a\u0430\u0437 \u0441\u043e\u0445\u0440\u0430\u043d\u0451\u043d; \u043f\u043e\u0432\u0442\u043e\u0440\u043d\u0443\u044e \u043e\u043f\u043b\u0430\u0442\u0443 \u043d\u0435 \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0439\u0442\u0435." }, "code": { "type": "string", "const": "payment_confirmation_pending" }, "resume_token": { "type": "null" } }, "required": [ "message", "code", "resume_token" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/orders/{order}": { "get": { "operationId": "counterparty-orders.show", "tags": [ "Order" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Order.OrderResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Order.OrderResource" } }, "required": [ "order" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/contact_form": { "post": { "operationId": "order.contactForm", "tags": [ "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactFormRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Order.OrderResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Order.OrderResource" } }, "required": [ "order" ] } } } }, "502": { "description": "A pre-attempt failure returns only message. An uncertain durable payment returns code payment_confirmation_pending and resume_token: the guest order is saved, so retain the 14-day handle and poll payment_status instead of submitting contact_form again.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "message", "code", "resume_token" ], "additionalProperties": false, "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "payment_confirmation_pending" }, "resume_token": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, { "type": "object", "required": [ "message" ], "additionalProperties": false, "properties": { "message": { "type": "string" } } } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/contact_form/payment_status": { "post": { "operationId": "order.guestPaymentStatus", "tags": [ "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "resume_token" ], "properties": { "resume_token": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } } }, "responses": { "200": { "description": "The saved order payment status; payment_link is returned only while waiting.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "payment_link" ], "additionalProperties": false, "properties": { "status": { "type": "string", "enum": [ "waiting", "paid", "canceled", "manual_review" ] }, "payment_link": { "type": [ "string", "null" ] } } } } }, "headers": { "Cache-Control": { "schema": { "type": "string" }, "description": "no-store, private" } } }, "404": { "description": "The resume handle is not usable in this application.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Not Found" } }, "required": [ "message" ] } } }, "headers": { "Cache-Control": { "schema": { "type": "string" }, "description": "no-store, private" } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "headers": { "Cache-Control": { "schema": { "type": "string" }, "description": "no-store, private" } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." }, "description": "Read-only guest payment recovery. Requires the original application Token header and the opaque resume_token received in a contact_form 502 response. The 14-day handle is scoped to its application/project. Polling never creates or retries a payment. Unknown, malformed, expired and foreign handles return the same 404; a lost HTTP response without a received handle is not recovered by this endpoint." } }, "/api/orders/{order}/history": { "get": { "operationId": "orderHistory.index", "tags": [ "OrderHistory" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`OrderHistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderHistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/events/{event}/history": { "get": { "operationId": "orderHistory.eventIndex", "tags": [ "OrderHistory" ], "parameters": [ { "name": "event", "in": "path", "required": true, "description": "The event ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`OrderHistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderHistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/orders/{order}/nomenclatures": { "get": { "operationId": "orderNomenclature.tableIndex", "tags": [ "OrderNomenclature" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders/{order}/nomenclatures": { "post": { "operationId": "orderNomenclature.store", "tags": [ "OrderNomenclature" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.OrderNomenclature.StoreRequest" } } } }, "responses": { "200": { "description": "`OrderNomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderNomenclature": { "$ref": "#/components/schemas/OrderNomenclatureResource" } }, "required": [ "orderNomenclature" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/orders/{order}/nomenclatures/{nomenclature}": { "put": { "operationId": "orderNomenclature.update", "tags": [ "OrderNomenclature" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } }, { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.OrderNomenclature.UpdateRequest" } } } }, "responses": { "200": { "description": "`OrderNomenclatureResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderNomenclature": { "$ref": "#/components/schemas/OrderNomenclatureResource" } }, "required": [ "orderNomenclature" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "orderNomenclature.destroy", "tags": [ "OrderNomenclature" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } }, { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Order nomenclature deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/order_statuses": { "get": { "operationId": "order_statuses.index", "tags": [ "OrderStatus" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/order_statuses/{orderStatus}": { "get": { "operationId": "order_statuses.show", "tags": [ "OrderStatus" ], "parameters": [ { "name": "orderStatus", "in": "path", "required": true, "description": "The order status ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/order_statuses/history": { "get": { "operationId": "orderStatus.history", "tags": [ "OrderStatus" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/event_types": { "get": { "operationId": "event_types.index", "tags": [ "OrderType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "event_types.store", "summary": "Store a newly created resource in storage", "tags": [ "OrderType" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.OrderType.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/event_types/{event_type}": { "get": { "operationId": "event_types.show", "tags": [ "OrderType" ], "parameters": [ { "name": "event_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "event_types.update", "tags": [ "OrderType" ], "parameters": [ { "name": "event_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.OrderType.UpdateRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "event_types.destroy", "tags": [ "OrderType" ], "parameters": [ { "name": "event_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "OrderType successfully deleted" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/eventstypes": { "get": { "operationId": "orderType.tableIndex", "tags": [ "OrderType" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/owner/callback-auth/bootstrap": { "post": { "operationId": "ownerCallback.bootstrap", "tags": [ "OwnerCallback" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "const": "Bearer" }, "attempt_id": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "access_token", "token_type", "attempt_id", "expires_at" ] } } } } }, "security": [] } }, "/api/owner/callback-auth/exchange": { "post": { "operationId": "ownerCallback.exchange", "tags": [ "OwnerCallback" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": [] } } } } }, "security": [] } }, "/api/owner/callback-auth/webhook": { "post": { "operationId": "ownerCallback.webhook", "tags": [ "OwnerCallback" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "received": { "type": "boolean" } }, "required": [ "received" ] } } } } }, "security": [] } }, "/api/pages": { "get": { "operationId": "pages.index", "tags": [ "Page" ], "parameters": [ { "name": "page_type_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "application_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order_by", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "date_asc", "date_desc", "popularity_asc", "popularity_desc", null ] } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`PageCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "pages.store", "tags": [ "Page" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Page.StoreRequest" } } } }, "responses": { "200": { "description": "`PageResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/PageResource" } }, "required": [ "page" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/pages/{page}": { "get": { "operationId": "pages.show", "tags": [ "Page" ], "parameters": [ { "name": "page", "in": "path", "required": true, "description": "The page ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`PageResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/PageResource" } }, "required": [ "page" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "pages.update", "tags": [ "Page" ], "parameters": [ { "name": "page", "in": "path", "required": true, "description": "The page ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Page.UpdateRequest" } } } }, "responses": { "200": { "description": "`PageResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/PageResource" } }, "required": [ "page" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "pages.destroy", "tags": [ "Page" ], "parameters": [ { "name": "page", "in": "path", "required": true, "description": "The page ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Page successfully destroyed" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/pages": { "get": { "operationId": "page.tableIndex", "tags": [ "Page" ], "parameters": [ { "name": "page_type_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "application_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order_by", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "date_asc", "date_desc", "popularity_asc", "popularity_desc", null ] } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/pages/{modelId}/history": { "get": { "operationId": "page.history", "tags": [ "Page" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/pages": { "get": { "operationId": "counterparties.page.index", "tags": [ "Page" ], "parameters": [ { "name": "page_type_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "application_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "order_by", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "date_asc", "date_desc", "popularity_asc", "popularity_desc", null ] } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Page.PageCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Page.PageCollection" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/pages/{slug}": { "get": { "operationId": "counterparties.page.show", "tags": [ "Page" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Page.PageResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Page.PageResource" } }, "required": [ "page" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/page_tags": { "get": { "operationId": "page_tags.index", "tags": [ "PageTag" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/page_tags/{pageTag}": { "get": { "operationId": "page_tags.show", "tags": [ "PageTag" ], "parameters": [ { "name": "pageTag", "in": "path", "required": true, "description": "The page tag ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/page_types": { "get": { "operationId": "page_types.index", "tags": [ "PageType" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/page_types/{pageType}": { "get": { "operationId": "page_types.show", "tags": [ "PageType" ], "parameters": [ { "name": "pageType", "in": "path", "required": true, "description": "The page type ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/page_types": { "get": { "operationId": "counterparties.pageType.index", "tags": [ "PageType" ], "responses": { "200": { "description": "`App.Http.Resources.Counterparties.DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryCollection" } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/payment_types": { "get": { "operationId": "paymentType.index", "tags": [ "PaymentType" ], "responses": { "200": { "description": "`PaymentTypeCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTypeCollection" } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/permissions": { "get": { "operationId": "permissions.index", "tags": [ "Permission" ], "responses": { "200": { "description": "`PermissionCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "permissions.store", "tags": [ "Permission" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Permission.StoreRequest" } } } }, "responses": { "200": { "description": "`PermissionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "$ref": "#/components/schemas/PermissionResource" } }, "required": [ "permission" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/permissions/{permission}": { "get": { "operationId": "permissions.show", "tags": [ "Permission" ], "parameters": [ { "name": "permission", "in": "path", "required": true, "description": "The permission ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`PermissionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "$ref": "#/components/schemas/PermissionResource" } }, "required": [ "permission" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "permissions.update", "tags": [ "Permission" ], "parameters": [ { "name": "permission", "in": "path", "required": true, "description": "The permission ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Permission.UpdateRequest" } } } }, "responses": { "200": { "description": "`PermissionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "permission": { "$ref": "#/components/schemas/PermissionResource" } }, "required": [ "permission" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "permissions.destroy", "tags": [ "Permission" ], "parameters": [ { "name": "permission", "in": "path", "required": true, "description": "The permission ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Permission successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/permissions/history": { "get": { "operationId": "permission.history", "tags": [ "Permission" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/prices": { "get": { "operationId": "product.prices", "tags": [ "Product" ], "parameters": [ { "name": "category_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "brand_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "country_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 } }, { "name": "order_by", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "name_asc", "name_desc", "popularity_asc", "popularity_desc", "price_asc", "price_desc", null ] } }, { "name": "price_from", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0 } }, { "name": "price_to", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 1 } }, { "name": "tag_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "min_price": { "type": "integer" }, "max_price": { "type": "integer" } }, "required": [ "min_price", "max_price" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/products": { "get": { "operationId": "product.index", "tags": [ "Product" ], "parameters": [ { "name": "category_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "brand_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "country_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 } }, { "name": "order_by", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "name_asc", "name_desc", "popularity_asc", "popularity_desc", "price_asc", "price_desc", null ] } }, { "name": "price_from", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 0 } }, { "name": "price_to", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 1 } }, { "name": "tag_id[]", "in": "query", "schema": { "type": [ "array", "null" ], "items": { "type": "string" } } } ], "responses": { "200": { "description": "`ShortProductCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortProductCollection" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/products/{nomenclature}": { "get": { "operationId": "product.show", "tags": [ "Product" ], "parameters": [ { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ProductResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/ProductResource" } }, "required": [ "product" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/projects": { "post": { "operationId": "project.store", "tags": [ "Project" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Project.StoreRequest" } } } }, "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/promotions": { "get": { "operationId": "promotions.index", "tags": [ "Promotion" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/promotions/{promotion}": { "get": { "operationId": "promotions.show", "tags": [ "Promotion" ], "parameters": [ { "name": "promotion", "in": "path", "required": true, "description": "The promotion ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/repair-estimates/config": { "get": { "operationId": "repairEstimate.config", "tags": [ "RepairEstimate" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "calculator": { "type": "object", "properties": { "version": { "type": "string", "const": "2026-06-28" }, "apartment_types": { "type": "array", "items": [] }, "apartment_presets": { "type": "object", "properties": { "studio": { "type": "object", "properties": { "label": { "type": "string", "const": "\u0421\u0442\u0443\u0434\u0438\u044f" }, "rooms": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "name": { "type": "string", "const": "\u041a\u043e\u043c\u043d\u0430\u0442\u0430" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "totalLivingArea": { "type": "number" }, "bathroomArea": { "type": "number" }, "bathroomArea2": { "type": "number" } }, "required": [ "label", "rooms", "totalLivingArea", "bathroomArea", "bathroomArea2" ] }, "1room": { "type": "object", "properties": { "label": { "type": "string", "const": "1-\u043a\u043e\u043c\u043d\u0430\u0442\u043d\u0430\u044f" }, "rooms": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "name": { "type": "string", "const": "\u041a\u043e\u043c\u043d\u0430\u0442\u0430" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041a\u0443\u0445\u043d\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "kitchen" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041f\u0440\u0438\u0445\u043e\u0436\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "hallway" } }, "required": [ "name", "defaultArea", "type" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, "totalLivingArea": { "type": "number" }, "bathroomArea": { "type": "number" }, "bathroomArea2": { "type": "number" } }, "required": [ "label", "rooms", "totalLivingArea", "bathroomArea", "bathroomArea2" ] }, "2room": { "type": "object", "properties": { "label": { "type": "string", "const": "2-\u043a\u043e\u043c\u043d\u0430\u0442\u043d\u0430\u044f" }, "rooms": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "name": { "type": "string", "const": "\u0413\u043e\u0441\u0442\u0438\u043d\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u0421\u043f\u0430\u043b\u044c\u043d\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041a\u0443\u0445\u043d\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "kitchen" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041f\u0440\u0438\u0445\u043e\u0436\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "hallway" } }, "required": [ "name", "defaultArea", "type" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "totalLivingArea": { "type": "number" }, "bathroomArea": { "type": "number" }, "bathroomArea2": { "type": "number" } }, "required": [ "label", "rooms", "totalLivingArea", "bathroomArea", "bathroomArea2" ] }, "3room": { "type": "object", "properties": { "label": { "type": "string", "const": "3-\u043a\u043e\u043c\u043d\u0430\u0442\u043d\u0430\u044f" }, "rooms": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "name": { "type": "string", "const": "\u0413\u043e\u0441\u0442\u0438\u043d\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u0421\u043f\u0430\u043b\u044c\u043d\u044f 1" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u0421\u043f\u0430\u043b\u044c\u043d\u044f 2" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041a\u0443\u0445\u043d\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "kitchen" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041f\u0440\u0438\u0445\u043e\u0436\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "hallway" } }, "required": [ "name", "defaultArea", "type" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false }, "totalLivingArea": { "type": "number" }, "bathroomArea": { "type": "number" }, "bathroomArea2": { "type": "number" } }, "required": [ "label", "rooms", "totalLivingArea", "bathroomArea", "bathroomArea2" ] }, "4room": { "type": "object", "properties": { "label": { "type": "string", "const": "4-\u043a\u043e\u043c\u043d\u0430\u0442\u043d\u0430\u044f" }, "rooms": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "name": { "type": "string", "const": "\u0413\u043e\u0441\u0442\u0438\u043d\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u0421\u043f\u0430\u043b\u044c\u043d\u044f 1" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u0421\u043f\u0430\u043b\u044c\u043d\u044f 2" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u0414\u0435\u0442\u0441\u043a\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "living" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041a\u0443\u0445\u043d\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "kitchen" } }, "required": [ "name", "defaultArea", "type" ] }, { "type": "object", "properties": { "name": { "type": "string", "const": "\u041f\u0440\u0438\u0445\u043e\u0436\u0430\u044f" }, "defaultArea": { "type": "number" }, "type": { "type": "string", "const": "hallway" } }, "required": [ "name", "defaultArea", "type" ] } ], "minItems": 6, "maxItems": 6, "additionalItems": false }, "totalLivingArea": { "type": "number" }, "bathroomArea": { "type": "number" }, "bathroomArea2": { "type": "number" } }, "required": [ "label", "rooms", "totalLivingArea", "bathroomArea", "bathroomArea2" ] } }, "required": [ "studio", "1room", "2room", "3room", "4room" ] }, "inputs": { "type": "object", "properties": { "total_area": { "type": "object", "properties": { "required": { "type": "boolean" }, "type": { "type": "string", "const": "decimal" }, "min": { "type": "integer", "const": 1 } }, "required": [ "required", "type", "min" ] }, "ceiling_height": { "type": "object", "properties": { "required": { "type": "boolean" }, "type": { "type": "string", "const": "decimal" }, "min": { "type": "integer", "const": 2 } }, "required": [ "required", "type", "min" ] }, "bathroom.type": { "type": "object", "properties": { "required": { "type": "boolean" }, "enum": { "type": "array", "prefixItems": [ { "type": "string", "const": "combined" }, { "type": "string", "const": "separate" } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "required", "enum" ] }, "bathroom.primary_area": { "type": "object", "properties": { "required": { "type": "boolean" }, "type": { "type": "string", "const": "decimal" }, "min": { "type": "number", "const": 0.1 } }, "required": [ "required", "type", "min" ] }, "bathroom.secondary_area": { "type": "object", "properties": { "required_when": { "type": "string", "const": "bathroom.type=separate" }, "type": { "type": "string", "const": "decimal" }, "min": { "type": "number", "const": 0.1 } }, "required": [ "required_when", "type", "min" ] } }, "required": [ "total_area", "ceiling_height", "bathroom.type", "bathroom.primary_area", "bathroom.secondary_area" ] }, "quantity_sources": { "type": "array", "items": [] } }, "required": [ "version", "apartment_types", "apartment_presets", "inputs", "quantity_sources" ] }, "works": { "type": "array", "items": { "type": "string" } }, "generated_at": { "type": "string" } }, "required": [ "application", "calculator", "works", "generated_at" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/repair-estimates/precalculate": { "post": { "operationId": "repairEstimate.precalculate", "tags": [ "RepairEstimate" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Counterparties.RepairEstimate.PrecalculateRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "complete", "partial" ] }, "context": { "type": "object", "properties": { "apartment_type": { "type": "string" }, "total_area": { "type": "number" }, "ceiling_height": { "type": "number" }, "bathroom": { "type": "string" }, "selected_options": { "type": [ "string", "null" ] } }, "required": [ "apartment_type", "total_area", "ceiling_height", "bathroom", "selected_options" ] }, "derived_quantities": { "type": "object", "properties": { "living_area": { "type": "number" }, "bathroom_total_area": { "type": "number" }, "total_wall_area": { "type": "number" }, "living_floor": { "type": "number" }, "ceiling_area": { "type": "number" }, "bathroom_wall_area": { "type": "number" }, "bathroom_floor_area": { "type": "number" }, "skirting_perimeter": { "type": "number" } }, "required": [ "living_area", "bathroom_total_area", "total_wall_area", "living_floor", "ceiling_area", "bathroom_wall_area", "bathroom_floor_area", "skirting_perimeter" ] }, "works": { "type": "array", "items": { "type": "object", "properties": { "composition_id": { "type": "integer" }, "name": { "type": "string" }, "category": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "quantity_source": { "type": "string" }, "quantity": { "type": "number" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "\u043c2" ] } ] }, "thickness": { "type": [ "number", "null" ] }, "price_per_unit": { "type": "string" }, "total": { "type": "string" } }, "required": [ "composition_id", "name", "category", "quantity_source", "quantity", "unit", "thickness", "price_per_unit", "total" ] } }, "materials": { "type": "array", "items": { "type": "object", "properties": { "nomenclature_id": { "type": "integer" }, "name": { "type": "string" }, "category": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "raw_quantity": { "type": "number" }, "pieces_per_pack": { "type": [ "object", "null" ] }, "quantity_pack": { "type": "integer" }, "quantity": { "type": "integer" }, "unit": { "type": "string" }, "price_per_unit": { "type": "string" }, "total": { "type": "string" } }, "required": [ "nomenclature_id", "name", "category", "raw_quantity", "pieces_per_pack", "quantity_pack", "quantity", "unit", "price_per_unit", "total" ] } }, "totals": { "type": "object", "properties": { "works_total": { "type": "string" }, "materials_total": { "type": "string" }, "total": { "type": "string" } }, "required": [ "works_total", "materials_total", "total" ] }, "warnings": { "type": "array", "items": [] } }, "required": [ "status", "context", "derived_quantities", "works", "materials", "totals", "warnings" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/repair-estimate-orders": { "post": { "operationId": "repairEstimate.storeOrder", "tags": [ "RepairEstimate" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreOrderRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/repair-estimate-orders/{order}": { "get": { "operationId": "repairEstimate.showOrder", "tags": [ "RepairEstimate" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`RepairEstimateOrderResource`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepairEstimateOrderResource" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "patch": { "operationId": "repairEstimate.updateOrder", "tags": [ "RepairEstimate" ], "parameters": [ { "name": "order", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderRequest" } } } }, "responses": { "200": { "description": "`RepairEstimateOrderResource`", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RepairEstimateOrderResource" }, { "type": "string" } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/reservations": { "get": { "operationId": "reservation.tableIndex", "tags": [ "Reservation" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "order_id", "in": "query", "schema": { "type": [ "integer", "null" ] } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/roles": { "get": { "operationId": "roles.index", "tags": [ "Role" ], "responses": { "200": { "description": "`RoleCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "roles.store", "tags": [ "Role" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Role.StoreRequest" } } } }, "responses": { "200": { "description": "`RoleResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/RoleResource" } }, "required": [ "role" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/roles/{role}": { "get": { "operationId": "roles.show", "tags": [ "Role" ], "parameters": [ { "name": "role", "in": "path", "required": true, "description": "The role ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`RoleResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/RoleResource" } }, "required": [ "role" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "roles.update", "tags": [ "Role" ], "parameters": [ { "name": "role", "in": "path", "required": true, "description": "The role ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Role.UpdateRequest" } } } }, "responses": { "200": { "description": "`RoleResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/RoleResource" } }, "required": [ "role" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "roles.destroy", "tags": [ "Role" ], "parameters": [ { "name": "role", "in": "path", "required": true, "description": "The role ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Role successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/roles/history": { "get": { "operationId": "role.history", "tags": [ "Role" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/sales_channels": { "get": { "operationId": "sales_channels.index", "tags": [ "SalesChannel" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 } } ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/sales_channels/{salesChannel}": { "get": { "operationId": "sales_channels.show", "tags": [ "SalesChannel" ], "parameters": [ { "name": "salesChannel", "in": "path", "required": true, "description": "The sales channel ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/sales_channels/history": { "get": { "operationId": "salesChannel.history", "tags": [ "SalesChannel" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/sales_strategies": { "get": { "operationId": "sales_strategies.index", "tags": [ "SalesStrategy" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/sales_strategies/{salesStrategy}": { "get": { "operationId": "sales_strategies.show", "tags": [ "SalesStrategy" ], "parameters": [ { "name": "salesStrategy", "in": "path", "required": true, "description": "The sales strategy ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/payment-methods": { "get": { "operationId": "savedPaymentMethod.index", "tags": [ "SavedPaymentMethod" ], "responses": { "200": { "description": "Array of `SavedPaymentMethodResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SavedPaymentMethodResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/payment-methods/{id}": { "delete": { "operationId": "savedPaymentMethod.destroy", "tags": [ "SavedPaymentMethod" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0421\u043f\u043e\u0441\u043e\u0431 \u043e\u043f\u043b\u0430\u0442\u044b \u043e\u0442\u0432\u044f\u0437\u0430\u043d" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/screens": { "get": { "operationId": "screens.index", "tags": [ "Screen" ], "responses": { "200": { "description": "`ScreenCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/screens/{screen}": { "get": { "operationId": "screens.show", "tags": [ "Screen" ], "parameters": [ { "name": "screen", "in": "path", "required": true, "description": "The screen ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ScreenResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "screen": { "$ref": "#/components/schemas/ScreenResource" } }, "required": [ "screen" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/search/history": { "get": { "operationId": "searchRequest.index_414", "tags": [ "SearchRequest" ], "responses": { "200": { "description": "`SearchHistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchHistoryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/search/popular": { "get": { "operationId": "searchRequest.index_440", "tags": [ "SearchRequest" ], "responses": { "200": { "description": "`SearchHistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchHistoryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/change": { "post": { "operationId": "counterparties.serverSubscriptionChange", "summary": "External backend changes a counterparty subscription plan by public principal_handle", "tags": [ "ServerSubscriptionChange" ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServerChangeSubscriptionRequest" } } } }, "responses": { "200": { "description": "\u0421\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0430\u044f \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0430 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0430/\u043d\u0430\u0439\u0434\u0435\u043d\u0430 \u0438\u043b\u0438 \u043e\u0436\u0438\u0434\u0430\u044e\u0449\u0438\u0439 checkout \u043f\u0435\u0440\u0435\u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d.", "content": { "application/json": { "schema": { "oneOf": [ { "anyOf": [ { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Subscription.SubscriptionResource" }, "subscription": { "anyOf": [ { "type": "object", "properties": { "exists": { "type": "boolean" }, "active": { "type": "string" }, "status": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ], "enum": [ "free", "paid", null ] }, "plan_slug": { "type": [ "string", "null" ] }, "plan_slugs": { "type": "string" } }, "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ] }, { "type": "object", "properties": { "exists": { "type": "boolean" }, "active": { "type": "boolean" }, "status": { "type": "null" }, "type": { "type": "null" }, "plan_slug": { "type": "null" }, "plan_slugs": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ] } ] } }, "required": [ "data", "subscription" ] }, { "type": "string" } ] }, { "type": "object", "properties": { "order_id": { "type": "integer" }, "nomenclature_id": { "type": "integer" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "billing_period_months": { "type": "integer" }, "payment_method_type": { "type": "string" }, "payment_link": { "type": "string", "format": "uri" } }, "required": [ "order_id", "nomenclature_id", "amount", "currency", "billing_period_months", "payment_method_type", "payment_link" ] } ] } } } }, "202": { "description": "\u0418\u0441\u0445\u043e\u0434 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u044f \u043f\u043b\u0430\u0442\u0435\u0436\u0430 \u043f\u043e\u043a\u0430 \u043d\u0435\u0438\u0437\u0432\u0435\u0441\u0442\u0435\u043d; \u043f\u043e\u0432\u0442\u043e\u0440\u043d\u044b\u0439 checkout \u0431\u043b\u043e\u043a\u0438\u0440\u0443\u0435\u0442\u0441\u044f \u0434\u043e \u0441\u0432\u0435\u0440\u043a\u0438.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "order_id": { "type": "integer" } }, "required": [ "message", "order_id" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "415": { "description": "The endpoint accepts only application/x-www-form-urlencoded request bodies.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unsupported Media Type." } }, "required": [ "message" ] } } } }, "201": { "description": "\u0421\u043e\u0437\u0434\u0430\u043d\u0430 \u0431\u0435\u0441\u043f\u043b\u0430\u0442\u043d\u0430\u044f \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0430 \u0438\u043b\u0438 \u043f\u043b\u0430\u0442\u043d\u044b\u0439 checkout.", "content": { "application/json": { "schema": { "oneOf": [ { "anyOf": [ { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Subscription.SubscriptionResource" }, "subscription": { "anyOf": [ { "type": "object", "properties": { "exists": { "type": "boolean" }, "active": { "type": "string" }, "status": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ], "enum": [ "free", "paid", null ] }, "plan_slug": { "type": [ "string", "null" ] }, "plan_slugs": { "type": "string" } }, "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ] }, { "type": "object", "properties": { "exists": { "type": "boolean" }, "active": { "type": "boolean" }, "status": { "type": "null" }, "type": { "type": "null" }, "plan_slug": { "type": "null" }, "plan_slugs": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ] } ] } }, "required": [ "data", "subscription" ] }, { "type": "string" } ] }, { "type": "object", "properties": { "order_id": { "type": "integer" }, "nomenclature_id": { "type": "integer" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "billing_period_months": { "type": "integer" }, "payment_method_type": { "type": "string" }, "payment_link": { "type": "string", "format": "uri" } }, "required": [ "order_id", "nomenclature_id", "amount", "currency", "billing_period_months", "payment_method_type", "payment_link" ] } ] } } } } }, "security": [ { "ClientCredentials": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." }, "description": "\u0412\u044b\u0431\u043e\u0440 \u0431\u0435\u0441\u043f\u043b\u0430\u0442\u043d\u043e\u0433\u043e \u0442\u0430\u0440\u0438\u0444\u0430 \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 \u0431\u0435\u0437 \u043f\u043b\u0430\u0442\u0435\u0436\u0430; \u0432\u044b\u0431\u043e\u0440 \u043f\u043b\u0430\u0442\u043d\u043e\u0433\u043e \u0442\u0430\u0440\u0438\u0444\u0430 \u0441 \u043d\u043e\u043c\u0435\u043d\u043a\u043b\u0430\u0442\u0443\u0440\u043e\u0439 \u0441\u043e\u0437\u0434\u0430\u0451\u0442 checkout \u0441 \u0441\u0441\u044b\u043b\u043a\u043e\u0439 YooKassa. \u041f\u043e\u0432\u0442\u043e\u0440 \u043e\u0436\u0438\u0434\u0430\u044e\u0449\u0435\u0433\u043e checkout \u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430\u0435\u0442 \u0442\u043e\u0442 \u0436\u0435 \u0437\u0430\u043a\u0430\u0437 \u0438 \u0441\u0441\u044b\u043b\u043a\u0443. \u0414\u0435\u0439\u0441\u0442\u0432\u0443\u044e\u0449\u0430\u044f \u043f\u043b\u0430\u0442\u043d\u0430\u044f \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0430 \u043c\u0435\u043d\u044f\u0435\u0442 \u0442\u0430\u0440\u0438\u0444 \u0431\u0435\u0437 checkout. \u0414\u043b\u044f \u043f\u043b\u0430\u0442\u043d\u043e\u0433\u043e \u0442\u0430\u0440\u0438\u0444\u0430 \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f autopay_consent." } }, "/api/counterparty/subscriptions:resolveCurrent": { "post": { "operationId": "counterparties.serverSubscriptionResolveCurrent", "summary": "Resolve the current subscription claim for a server-authenticated principal", "tags": [ "ServerSubscriptionResolveCurrent" ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServerResolveCurrentSubscriptionRequest" } } } }, "responses": { "200": { "description": "Current subscription and nullable paid entitlement. Recovery requires an active entitlement with usable public plan and dates.", "content": { "application/json": { "schema": { "type": "object", "required": [ "subscription", "entitlement" ], "properties": { "subscription": { "type": "object", "required": [ "exists", "active", "status", "type", "plan_slug", "plan_slugs" ], "properties": { "exists": { "type": "boolean" }, "active": { "type": "boolean" }, "status": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "plan_slug": { "type": [ "string", "null" ] }, "plan_slugs": { "type": "array", "items": { "type": "string" } } } }, "entitlement": { "type": [ "object", "null" ], "additionalProperties": false, "required": [ "principal_handle", "phone_1", "plan_slug", "status", "period_start", "period_end", "access_until", "active" ], "properties": { "principal_handle": { "type": "string", "format": "uuid" }, "phone_1": { "type": [ "string", "null" ], "description": "Current phone bound to this principal, never a historical webhook phone." }, "plan_slug": { "type": [ "string", "null" ], "description": "Public slug or null for unmapped legacy plans." }, "status": { "type": "string", "enum": [ "active", "past_due", "charging", "canceled" ] }, "period_start": { "type": [ "string", "null" ], "format": "date-time" }, "period_end": { "type": [ "string", "null" ], "format": "date-time" }, "access_until": { "type": [ "string", "null" ], "format": "date-time", "description": "Period end plus configured grace for active/past_due/charging; canceled uses period end without grace." }, "active": { "type": "boolean" } } } } } } } }, "404": { "description": "No matching principal or subscription in this application scope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } }, "415": { "description": "The endpoint accepts only application/x-www-form-urlencoded request bodies.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unsupported Media Type." } }, "required": [ "message" ] } } } }, "409": { "description": "More than one live paid subscription makes recovery ambiguous.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Multiple paid subscriptions." } }, "required": [ "message" ] } } } } }, "security": [ { "ClientCredentials": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." }, "description": "Requires subscription:write client scope and matching audience. Returns the unchanged subscription claim and a separate authoritative paid entitlement. Exactly one live paid subscription is selected; multiple live paid subscriptions return 409. Without live paid subscriptions, a sole inactive paid row may be returned; otherwise entitlement is null. Legacy slugs require an existing active application/project catalogue assignment; unmapped internal slugs remain null. No subscription normalization is performed." } }, "/api/settings": { "get": { "operationId": "settings.index", "tags": [ "Setting" ], "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "`SettingCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "settings.store", "tags": [ "Setting" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Setting.StoreRequest" } } } }, "responses": { "200": { "description": "`SettingResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "setting": { "$ref": "#/components/schemas/SettingResource" } }, "required": [ "setting" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/settings/{setting}": { "get": { "operationId": "settings.show", "tags": [ "Setting" ], "parameters": [ { "name": "setting", "in": "path", "required": true, "description": "The setting ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`SettingResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "setting": { "$ref": "#/components/schemas/SettingResource" } }, "required": [ "setting" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "settings.update", "tags": [ "Setting" ], "parameters": [ { "name": "setting", "in": "path", "required": true, "description": "The setting ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Setting.UpdateRequest" } } } }, "responses": { "200": { "description": "`SettingResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "setting": { "$ref": "#/components/schemas/SettingResource" } }, "required": [ "setting" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "settings.destroy", "tags": [ "Setting" ], "parameters": [ { "name": "setting", "in": "path", "required": true, "description": "The setting ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Setting successfully deleted" } }, "required": [ "message" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/settings": { "get": { "operationId": "counterparties.setting.show", "tags": [ "Setting" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "wholesale": { "type": "boolean" } }, "required": [ "wholesale" ] } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops": { "get": { "operationId": "shops.index", "tags": [ "Shop" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "city_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "branch_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "is_shop", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`ShopCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "shops.store", "tags": [ "Shop" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Shop.StoreRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.ShopResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "shop": { "$ref": "#/components/schemas/App.Http.Resources.ShopResource" } }, "required": [ "shop" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{shop}": { "get": { "operationId": "shops.show", "tags": [ "Shop" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.ShopResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "shop": { "$ref": "#/components/schemas/App.Http.Resources.ShopResource" } }, "required": [ "shop" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "shops.update", "tags": [ "Shop" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Shop.UpdateRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.ShopResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "shop": { "$ref": "#/components/schemas/App.Http.Resources.ShopResource" } }, "required": [ "shop" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "shops.destroy", "tags": [ "Shop" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Shop successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/shops": { "get": { "operationId": "shop.tableIndex", "tags": [ "Shop" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 3 } }, { "name": "city_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "branch_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "is_shop", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{modelId}/history": { "get": { "operationId": "shop.history", "tags": [ "Shop" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/shops": { "get": { "operationId": "counterparties.shop.index", "tags": [ "Shop" ], "responses": { "200": { "description": "`ShopCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopCollection" } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/shops/{shop}": { "get": { "operationId": "counterparties.shop.show", "tags": [ "Shop" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Page.PageResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Page.PageResource" } }, "required": [ "page" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{shop}/exceptions": { "get": { "operationId": "exceptions.index", "summary": "Display a listing of the resource", "tags": [ "ShopException" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ShopExceptionCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopExceptionCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "exceptions.store", "summary": "Store a newly created resource in storage", "tags": [ "ShopException" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreShopExceptionRequest" } } } }, "responses": { "200": { "description": "`ShopExceptionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "exception": { "$ref": "#/components/schemas/ShopExceptionResource" } }, "required": [ "exception" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{shop}/exceptions/{exception}": { "get": { "operationId": "exceptions.show", "summary": "Display the specified resource", "tags": [ "ShopException" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } }, { "name": "exception", "in": "path", "required": true, "description": "The exception ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ShopExceptionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "exception": { "$ref": "#/components/schemas/ShopExceptionResource" } }, "required": [ "exception" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "exceptions.update", "summary": "Update the specified resource in storage", "tags": [ "ShopException" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } }, { "name": "exception", "in": "path", "required": true, "description": "The exception ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShopExceptionRequest" } } } }, "responses": { "200": { "description": "`ShopExceptionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "exception": { "$ref": "#/components/schemas/ShopExceptionResource" } }, "required": [ "exception" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "exceptions.destroy", "summary": "Remove the specified resource from storage", "tags": [ "ShopException" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } }, { "name": "exception", "in": "path", "required": true, "description": "The exception ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Shop exception deleted successfully." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{shop}/holidays": { "get": { "operationId": "shopHoliday.index", "summary": "Display a listing of the resource", "tags": [ "ShopHoliday" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ShopHolidayResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "holidays": { "$ref": "#/components/schemas/ShopHolidayResource" } }, "required": [ "holidays" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "shopHoliday.update", "summary": "Update the specified resource in storage", "tags": [ "ShopHoliday" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShopHolidayRequest" } } } }, "responses": { "200": { "description": "`ShopHolidayResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "holidays": { "$ref": "#/components/schemas/ShopHolidayResource" } }, "required": [ "holidays" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{shop}/hours": { "get": { "operationId": "hours.index", "summary": "Display a listing of the resource", "tags": [ "ShopHour" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ShopHourCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopHourCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "hours.store", "summary": "Store a newly created resource in storage", "tags": [ "ShopHour" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreShopHourRequest" } } } }, "responses": { "200": { "description": "`ShopHourResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "hour": { "$ref": "#/components/schemas/ShopHourResource" } }, "required": [ "hour" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/shops/{shop}/hours/{hour}": { "get": { "operationId": "hours.show", "summary": "Display the specified resource", "tags": [ "ShopHour" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } }, { "name": "hour", "in": "path", "required": true, "description": "The hour ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ShopHourResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "hour": { "$ref": "#/components/schemas/ShopHourResource" } }, "required": [ "hour" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "hours.update", "summary": "Update the specified resource in storage", "tags": [ "ShopHour" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } }, { "name": "hour", "in": "path", "required": true, "description": "The hour ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShopHourRequest" } } } }, "responses": { "200": { "description": "`ShopHourResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "hour": { "$ref": "#/components/schemas/ShopHourResource" } }, "required": [ "hour" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "hours.destroy", "summary": "Remove the specified resource from storage", "tags": [ "ShopHour" ], "parameters": [ { "name": "shop", "in": "path", "required": true, "description": "The shop ID", "schema": { "type": "integer" } }, { "name": "hour", "in": "path", "required": true, "description": "The hour ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Shop hour deleted successfully." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/slides": { "get": { "operationId": "slide.index", "tags": [ "Slide" ], "responses": { "200": { "description": "`SlideCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlideCollection" } } } }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/storage_units": { "get": { "operationId": "storage_units.index", "tags": [ "StorageUnit" ], "responses": { "200": { "description": "`StorageUnitCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageUnitCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/storage_units/{storageUnit}": { "get": { "operationId": "storage_units.show", "tags": [ "StorageUnit" ], "parameters": [ { "name": "storageUnit", "in": "path", "required": true, "description": "The storage unit ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`StorageUnitResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "unit": { "$ref": "#/components/schemas/StorageUnitResource" } }, "required": [ "unit" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/subscriptions": { "get": { "operationId": "subscription.tableIndex", "tags": [ "Subscription" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 100 } }, { "name": "status[]", "in": "query", "schema": { "type": "array", "enum": [ "active", "charging", "past_due", "canceled" ], "items": { "type": "string", "enum": [ "active", "charging", "past_due", "canceled" ] } } }, { "name": "application_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sort_by", "in": "query", "schema": { "type": "string", "enum": [ "created_at", "current_period_end", "last_payment_at", "amount" ] } }, { "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "`SubscriptionTableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionTableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/subscriptions/{subscription}": { "get": { "operationId": "subscription.show", "tags": [ "Subscription" ], "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`SubscriptionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/SubscriptionResource" } }, "required": [ "subscription" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions": { "get": { "operationId": "subscription.index", "tags": [ "Subscription" ], "responses": { "200": { "description": "`SubscriptionCollection`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCollection" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "subscription.store", "tags": [ "Subscription" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSubscriptionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "202": { "description": "`App.Http.Resources.Counterparty.Subscription.SubscriptionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Subscription.SubscriptionResource" }, { "type": "object", "required": [ "autopay_consent", "saved_payment_method", "latest_payment", "can_retry_payment", "retry_payment_reason" ] } ] } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/free": { "post": { "operationId": "subscription.free", "tags": [ "Subscription" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateFreeSubscriptionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/checkout": { "post": { "operationId": "subscription.checkout", "tags": [ "Subscription" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutSubscriptionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u0421\u043e\u0437\u0434\u0430\u043d\u0438\u0435 \u043f\u043b\u0430\u0442\u0435\u0436\u0430 \u0435\u0449\u0451 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0430\u0435\u0442\u0441\u044f. \u041f\u043e\u0432\u0442\u043e\u0440\u0438\u0442\u0435 \u0437\u0430\u043f\u0440\u043e\u0441 \u0447\u0435\u0440\u0435\u0437 \u043d\u0435\u0441\u043a\u043e\u043b\u044c\u043a\u043e \u0441\u0435\u043a\u0443\u043d\u0434." }, "order_id": { "type": "string" } }, "required": [ "message", "order_id" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "order_id": { "type": "integer" }, "amount": { "type": "string" }, "currency": { "type": "string", "const": "RUB" }, "payment_method_type": { "type": "string" }, "payment_link": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "nomenclature_id": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "billing_period_months": { "type": "string" } }, "required": [ "nomenclature_id", "amount", "currency", "billing_period_months" ] } } }, "required": [ "order_id", "amount", "currency", "payment_method_type", "payment_link", "items" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}": { "patch": { "operationId": "subscription.update", "tags": [ "Subscription" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.Counterparty.Subscription.SubscriptionResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Subscription.SubscriptionResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}/cancel": { "post": { "operationId": "subscription.cancel", "tags": [ "Subscription" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u041f\u043e\u0434\u043f\u0438\u0441\u043a\u0430 \u043e\u0442\u043c\u0435\u043d\u0435\u043d\u0430" } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "\u0418\u0434\u0451\u0442 \u0441\u043f\u0438\u0441\u0430\u043d\u0438\u0435, \u043f\u043e\u043f\u0440\u043e\u0431\u0443\u0439\u0442\u0435 \u0447\u0435\u0440\u0435\u0437 \u043c\u0438\u043d\u0443\u0442\u0443" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "\u041f\u043e\u0434\u043f\u0438\u0441\u043a\u0430 \u0443\u0436\u0435 \u043e\u0442\u043c\u0435\u043d\u0435\u043d\u0430" } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}/resume": { "post": { "operationId": "subscription.resume", "tags": [ "Subscription" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeSubscriptionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "\u041f\u043e\u0434\u043f\u0438\u0441\u043a\u0430 \u0432\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0430" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "409": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "\u0414\u043e\u0436\u0434\u0438\u0442\u0435\u0441\u044c \u0437\u0430\u0432\u0435\u0440\u0448\u0435\u043d\u0438\u044f \u0441\u043c\u0435\u043d\u044b \u043a\u0430\u0440\u0442\u044b \u043f\u0435\u0440\u0435\u0434 \u0432\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u0435\u043c" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "\u0412\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u0435 \u0437\u0430\u0431\u043b\u043e\u043a\u0438\u0440\u043e\u0432\u0430\u043d\u043e \u0434\u043e \u0437\u0430\u0432\u0435\u0440\u0448\u0435\u043d\u0438\u044f \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0438 \u043f\u0440\u0435\u0434\u044b\u0434\u0443\u0449\u0435\u0433\u043e \u043f\u043b\u0430\u0442\u0435\u0436\u0430" } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}/payments": { "get": { "operationId": "subscription.payments", "tags": [ "Subscription" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Paginated set of `SubscriptionPaymentResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPaymentResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}/payments/{payment}/retry": { "post": { "operationId": "subscription.retryPayment", "tags": [ "Subscription" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "payment", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscription-catalog/grouped": { "get": { "operationId": "subscriptionCatalog.grouped", "tags": [ "SubscriptionCatalog" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscription-catalog": { "get": { "operationId": "subscriptionCatalog.index", "tags": [ "SubscriptionCatalog" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCatalogResource" } } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "data" ] } ] } } } }, "401": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}/payment-method-change": { "post": { "operationId": "subscriptionPaymentMethodChange.store", "tags": [ "SubscriptionPaymentMethodChange" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeSubscriptionPaymentMethodRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "subscription_id": { "type": "integer" }, "status": { "type": "string" }, "confirmation_url": { "type": [ "string", "null" ] }, "saved_payment_method_id": { "type": [ "integer", "null" ] }, "expires_at": { "type": [ "string", "null" ] } }, "required": [ "id", "subscription_id", "status", "confirmation_url", "saved_payment_method_id", "expires_at" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscriptions/{id}/payment-method-changes/{change}/sync": { "post": { "operationId": "subscriptionPaymentMethodChange.sync", "tags": [ "SubscriptionPaymentMethodChange" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "change", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncSubscriptionPaymentMethodChangeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "subscription_id": { "type": "integer" }, "status": { "type": "string" }, "confirmation_url": { "type": [ "string", "null" ] }, "saved_payment_method_id": { "type": [ "integer", "null" ] }, "expires_at": { "type": [ "string", "null" ] } }, "required": [ "id", "subscription_id", "status", "confirmation_url", "saved_payment_method_id", "expires_at" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [], "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/subscription-plans": { "get": { "operationId": "subscriptionPlan.index", "tags": [ "SubscriptionPlan" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "data" ] } } } }, "401": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/subscriptions/{subscription}/status-events": { "get": { "operationId": "subscriptionStatusEvent.index", "tags": [ "SubscriptionStatusEvent" ], "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page_size", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 0 } }, { "name": "page_token", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 4096 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_events": { "type": "array", "items": { "type": "string" } }, "next_page_token": { "type": "string" } }, "required": [ "status_events", "next_page_token" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/subscriptions/{subscription}/status-events/{status_event}": { "get": { "operationId": "subscriptionStatusEvent.show", "tags": [ "SubscriptionStatusEvent" ], "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "status_event", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": [] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/tables/tasks": { "get": { "operationId": "task.tableIndex", "tags": [ "Task" ], "parameters": [ { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "creator_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "executor_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "order_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "task_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tasks": { "get": { "operationId": "tasks.index", "tags": [ "Task" ], "parameters": [ { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "creator_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "executor_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "order_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "task_status_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`TaskCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "tasks.store", "tags": [ "Task" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Task.StoreRequest" } } } }, "responses": { "200": { "description": "`TaskResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/TaskResource" } }, "required": [ "task" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tasks/{task}": { "get": { "operationId": "tasks.show", "tags": [ "Task" ], "parameters": [ { "name": "task", "in": "path", "required": true, "description": "The task ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`TaskResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/TaskResource" } }, "required": [ "task" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "tasks.update", "tags": [ "Task" ], "parameters": [ { "name": "task", "in": "path", "required": true, "description": "The task ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Task.UpdateRequest" } } } }, "responses": { "200": { "description": "`TaskResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/TaskResource" } }, "required": [ "task" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/task_statuses": { "get": { "operationId": "task_statuses.index", "tags": [ "TaskStatus" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/task_statuses/{taskStatus}": { "get": { "operationId": "task_statuses.show", "tags": [ "TaskStatus" ], "parameters": [ { "name": "taskStatus", "in": "path", "required": true, "description": "The task status ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/task_statuses/history": { "get": { "operationId": "taskStatus.history", "tags": [ "TaskStatus" ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/admin/tickets/lookup": { "get": { "operationId": "ticket.lookup", "description": "GET /api/admin/tickets/lookup?token=...", "summary": "\u041f\u0440\u0435\u0432\u044c\u044e \u0431\u0438\u043b\u0435\u0442\u0430 \u0431\u0435\u0437 \u0433\u0430\u0448\u0435\u043d\u0438\u044f \u2014 \u0434\u043b\u044f \u043a\u0430\u0440\u0442\u043e\u0447\u043a\u0438 \u0441\u043a\u0430\u043d\u0435\u0440\u0430", "tags": [ "Ticket" ], "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "minLength": 32, "maxLength": 32 } } ], "responses": { "200": { "description": "`TicketResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "$ref": "#/components/schemas/TicketResource" } }, "required": [ "ticket" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/admin/tickets/by-order/{order_id}": { "get": { "operationId": "ticket.lookupByOrder", "description": "GET /api/admin/tickets/by-order/{order_id}\n\nIDOR-scope \u043e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u0435\u043d: same project, \u0434\u043b\u044f \u043d\u0435-ADMIN/OWNER \u0435\u0449\u0451 same\nbranch (branchless skip). \u0417\u0435\u0440\u043a\u0430\u043b\u043e `OrderController::show` \u043f\u043e\u0441\u043b\u0435\nCodex fix-up'\u043e\u0432 \u0432 #151/#152.\n\n404 \u0434\u043b\u044f:\n - \u043d\u0435\u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0435\u0433\u043e order_id (TicketNotFoundException, code 4001);\n - \u0447\u0443\u0436\u043e\u0433\u043e project \u2014 \u0431\u0435\u0437 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0441\u0443\u0449\u0435\u0441\u0442\u0432\u043e\u0432\u0430\u043d\u0438\u044f (IDOR-\u0441\u0442\u0438\u043b\u044c);\n - \u0447\u0443\u0436\u043e\u0433\u043e branch \u0434\u043b\u044f \u043d\u0435-\u043f\u0440\u0438\u0432\u0438\u043b\u0435\u0433\u0438\u0440\u043e\u0432\u0430\u043d\u043d\u044b\u0445 \u0440\u043e\u043b\u0435\u0439;\n - \u0437\u0430\u043a\u0430\u0437\u0430 \u0431\u0435\u0437 `redeem_token` (legacy \u0434\u043e \u043c\u0438\u0433\u0440\u0430\u0446\u0438\u0438-\u0441\u0438\u0434\u0435\u0440\u0430 TK1 \u0438\u043b\u0438\n \u043d\u0435\u043e\u043f\u043b\u0430\u0447\u0435\u043d\u043d\u044b\u0439).\n\n422 (\u043f\u043e design doc) \u2014 \u0434\u043b\u044f \u043d\u0435\u0447\u0438\u0441\u043b\u043e\u0432\u043e\u0433\u043e order_id. \u0420\u0435\u0430\u043b\u0438\u0437\u043e\u0432\u0430\u043d\u043e \u0447\u0435\u0440\u0435\u0437\n`LookupTicketByOrderRequest` (\u043f\u0440\u0430\u0432\u0438\u043b\u043e `integer` \u043d\u0430 `order_id` \u0438\u0437\nroute \u2192 Laravel \u0432\u0435\u0440\u043d\u0451\u0442 422). \u041c\u0430\u0440\u0448\u0440\u0443\u0442 \u043d\u0430\u043c\u0435\u0440\u0435\u043d\u043d\u043e \u0431\u0435\u0437 `whereNumber`,\n\u0447\u0442\u043e\u0431\u044b \u0432\u0430\u043b\u0438\u0434\u0430\u0446\u0438\u044f \u0448\u043b\u0430 \u0447\u0435\u0440\u0435\u0437 FormRequest, \u0430 \u043d\u0435 \u0447\u0435\u0440\u0435\u0437 route mismatch\n(\u0442\u043e\u0433\u0434\u0430 \u0431\u044b\u043b \u0431\u044b 404, \u0430 \u0444\u0440\u043e\u043d\u0442 dasha_ai \u0432 open-question #1 design\ndoc'\u0430 \u043f\u0440\u043e\u0441\u0438\u043b \u0438\u043c\u0435\u043d\u043d\u043e 422).", "summary": "\u041f\u0440\u0435\u0432\u044c\u044e \u0431\u0438\u043b\u0435\u0442\u0430 \u043f\u043e `order_id` \u2014 \u0434\u043b\u044f admin-\u043a\u0430\u0440\u0442\u043e\u0447\u043a\u0438 \u0437\u0430\u043a\u0430\u0437\u0430 \u0432 dasha_ai\n(`/admin/tickets/:id`). \u0422\u043e\u0442 \u0436\u0435 payload \u0447\u0442\u043e \u0443 `lookup`, \u043d\u043e \u0432\u0445\u043e\u0434\u043d\u043e\u0439\n\u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440 order_id, \u043d\u0435 token", "tags": [ "Ticket" ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order_id", "in": "query", "required": true, "description": "`min:1` \u2014 `/by-order/0` \u0441\u0440\u0430\u0437\u0443 \u0434\u0430\u0451\u0442 422 (\u0430 \u043d\u0435 404 \u043e\u0442\n`Order::find(0)`). \u0421\u0435\u043c\u0430\u043d\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u0442\u043e\u0447\u043d\u0435\u0435. monster P3 \u043d\u0430 TK3 r3.", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "`TicketResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "$ref": "#/components/schemas/TicketResource" } }, "required": [ "ticket" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/admin/tickets/redeem": { "post": { "operationId": "ticket.redeem", "description": "POST /api/admin/tickets/redeem body { token }", "summary": "\u0413\u0430\u0448\u0435\u043d\u0438\u0435 \u043e\u0434\u043d\u043e\u0433\u043e \u043f\u0440\u043e\u0445\u043e\u0434\u0430", "tags": [ "Ticket" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedeemTicketRequest" } } } }, "responses": { "200": { "description": "`TicketResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "$ref": "#/components/schemas/TicketResource" } }, "required": [ "ticket" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/admin/tickets/unredeem": { "post": { "operationId": "ticket.unredeem", "description": "POST /api/admin/tickets/unredeem body { order_id, note }", "summary": "\u041e\u0442\u043a\u0430\u0442 \u043f\u043e\u0441\u043b\u0435\u0434\u043d\u0435\u0433\u043e \u043f\u0440\u043e\u0445\u043e\u0434\u0430. \u0422\u0440\u0435\u0431\u0443\u0435\u0442 note (\u0432\u0430\u043b\u0438\u0434\u0438\u0440\u0443\u0435\u0442\u0441\u044f \u0432 FormRequest)", "tags": [ "Ticket" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnredeemTicketRequest" } } } }, "responses": { "200": { "description": "`TicketResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "$ref": "#/components/schemas/TicketResource" } }, "required": [ "ticket" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/send_password": { "post": { "operationId": "user.sendPassword", "tags": [ "User" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.PasswordRequest" } } } }, "responses": { "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Internal server error" } }, "required": [ "message" ] } } } }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Password successfully send" } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Agent accounts cannot use password login" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/login": { "post": { "operationId": "user.login", "tags": [ "User" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.User.LoginRequest" } } } }, "responses": { "200": { "description": "`UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserResource" } }, "required": [ "user" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "The request exceeded the configured rate limit.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/users": { "get": { "operationId": "user.tableIndex", "tags": [ "User" ], "parameters": [ { "name": "role_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "branch_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "employee", "manager" ] } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } }, { "name": "hours_in_system_gt", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "hours_in_system_lt", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "hours_absent_system_gt", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/user": { "get": { "operationId": "user.authorized", "tags": [ "User" ], "responses": { "200": { "description": "`UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserResource" } }, "required": [ "user" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/user/logout": { "post": { "operationId": "user.logout_195", "tags": [ "User" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "User successfully logout" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "User successfully logout" ] } ] } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users": { "get": { "operationId": "users.index", "tags": [ "User" ], "parameters": [ { "name": "role_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "branch_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "department_id[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "hierarchy", "in": "query", "schema": { "type": "string", "enum": [ "employee", "manager" ] } }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 255 } }, { "name": "hours_in_system_gt", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "hours_in_system_lt", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "hours_absent_system_gt", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "`UserCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "users.store", "tags": [ "User" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.User.StoreRequest" } } } }, "responses": { "200": { "description": "`UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserResource" } }, "required": [ "user" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users/{user}": { "get": { "operationId": "users.show", "tags": [ "User" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserResource" } }, "required": [ "user" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "users.update", "tags": [ "User" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.User.UpdateRequest" } } } }, "responses": { "200": { "description": "`UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserResource" } }, "required": [ "user" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "users.destroy", "tags": [ "User" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "User successfully deleted" } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users/{modelId}/history": { "get": { "operationId": "user.history", "tags": [ "User" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/logout": { "post": { "operationId": "user.logout_401", "tags": [ "User" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "User successfully logout" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "User successfully logout" ] } ] } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users/{user}/integrations": { "get": { "operationId": "user-integrations.index", "tags": [ "UserIntegration" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/users/{user}/integrations/{integration}": { "get": { "operationId": "user-integrations.show", "tags": [ "UserIntegration" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ] }, "put": { "operationId": "user-integrations.update", "tags": [ "UserIntegration" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegration.UpdateRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ] } }, "/api/users/{user}/integrations/{integration}/parameters": { "get": { "operationId": "user-integration-parameters.index", "tags": [ "UserIntegrationParameter" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationParameterCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "user-integration-parameters.store", "tags": [ "UserIntegrationParameter" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegrationParameter.StoreRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users/{user}/integrations/{integration}/parameters/{parameter}": { "get": { "operationId": "user-integration-parameters.show", "tags": [ "UserIntegrationParameter" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } }, { "name": "parameter", "in": "path", "required": true, "description": "The parameter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "user-integration-parameters.destroy", "tags": [ "UserIntegrationParameter" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } }, { "name": "parameter", "in": "path", "required": true, "description": "The parameter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Parameter successfully deleted." } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/menus/default/items": { "get": { "operationId": "userMenuItem.defaultMenuItems", "tags": [ "UserMenuItem" ], "responses": { "200": { "description": "`MenuItemCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/menus/{menu}/items": { "get": { "operationId": "items.index", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`MenuItemCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "items.store", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.UserMenuItem.StoreRequest" } } } }, "responses": { "200": { "description": "`MenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "menuItem": { "$ref": "#/components/schemas/MenuItemResource" } }, "required": [ "menuItem" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/menus/{menu}/items/{item}": { "get": { "operationId": "items.show", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } }, { "name": "item", "in": "path", "required": true, "description": "The item ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`MenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "menuItem": { "$ref": "#/components/schemas/MenuItemResource" } }, "required": [ "menuItem" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "items.update", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } }, { "name": "item", "in": "path", "required": true, "description": "The item ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.UserMenuItem.StoreRequest" } } } }, "responses": { "200": { "description": "`MenuItemResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "menuItem": { "$ref": "#/components/schemas/MenuItemResource" } }, "required": [ "menuItem" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "items.destroy", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "menu", "in": "path", "required": true, "description": "The menu ID", "schema": { "type": "integer" } }, { "name": "item", "in": "path", "required": true, "description": "The item ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Menu item has been deleted." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users/{user}/attach_menu": { "post": { "operationId": "userMenuItem.attachMenuToUser", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Menu has been attached." } }, "required": [ "message" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/attach_menu_to_project": { "post": { "operationId": "userMenuItem.attachMenuToProject", "tags": [ "UserMenuItem" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Menu has been attached." } }, "required": [ "message" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/users/{user}/create_menu_from_user_items": { "post": { "operationId": "userMenuItem.createMenuFromUserItems", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "user", "in": "path", "required": true, "description": "The user ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Menu.StoreRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Menu has been created." } }, "required": [ "message" ] } } } }, "403": { "description": "An error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "examples": [ "" ] } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/counterparty/menus/{name}/items": { "get": { "operationId": "userMenuItem.indexByName", "tags": [ "UserMenuItem" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`MenuItemCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItemCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "description": "Request authentication is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "security": [ { "AppTokenAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/vats": { "get": { "operationId": "vats.index", "tags": [ "Vat" ], "responses": { "200": { "description": "`DictionaryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DictionaryCollection" } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/vats/{vat}": { "get": { "operationId": "vats.show", "tags": [ "Vat" ], "parameters": [ { "name": "vat", "in": "path", "required": true, "description": "The vat ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`DictionaryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "item" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/warehouses": { "get": { "operationId": "warehouse.tableIndex", "tags": [ "Warehouse" ], "parameters": [ { "name": "type_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "city_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "owned_by_us", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{modelId}/history": { "get": { "operationId": "warehouse.history", "tags": [ "Warehouse" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses": { "get": { "operationId": "warehouses.index", "summary": "Display a listing of the resource", "tags": [ "Warehouse" ], "parameters": [ { "name": "type_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "city_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "owned_by_us", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "`WarehouseCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "warehouses.store", "summary": "Store a newly created resource in storage", "tags": [ "Warehouse" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Warehouse.StoreRequest" } } } }, "responses": { "200": { "description": "`WarehouseResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/WarehouseResource" } }, "required": [ "warehouse" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}": { "get": { "operationId": "warehouses.show", "summary": "Display the specified resource", "tags": [ "Warehouse" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`WarehouseResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/WarehouseResource" } }, "required": [ "warehouse" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "warehouses.update", "summary": "Update the specified resource in storage", "tags": [ "Warehouse" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.Warehouse.UpdateRequest" } } } }, "responses": { "200": { "description": "`WarehouseResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/WarehouseResource" } }, "required": [ "warehouse" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "warehouses.destroy", "summary": "Remove the specified resource from storage", "tags": [ "Warehouse" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Warehouse deleted." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}/integrations": { "get": { "operationId": "warehouse-integrations.index", "tags": [ "WarehouseIntegration" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}/integrations/{integration}": { "get": { "operationId": "warehouse-integrations.show", "tags": [ "WarehouseIntegration" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "warehouse-integrations.update", "tags": [ "WarehouseIntegration" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegration.UpdateRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "required": [ "integration" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}/integrations/{integration}/parameters": { "get": { "operationId": "warehouse-integration-parameters.index", "tags": [ "WarehouseIntegrationParameter" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelIntegrationParameterCollection" } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "post": { "operationId": "warehouse-integration-parameters.store", "tags": [ "WarehouseIntegrationParameter" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.ModelIntegrationParameter.StoreRequest" } } } }, "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}/integrations/{integration}/parameters/{parameter}": { "get": { "operationId": "warehouse-integration-parameters.show", "tags": [ "WarehouseIntegrationParameter" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } }, { "name": "parameter", "in": "path", "required": true, "description": "The parameter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ModelIntegrationParameterResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "required": [ "parameter" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "warehouse-integration-parameters.destroy", "tags": [ "WarehouseIntegrationParameter" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "integration", "in": "path", "required": true, "description": "The integration ID", "schema": { "type": "integer" } }, { "name": "parameter", "in": "path", "required": true, "description": "The parameter ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Parameter successfully deleted." } }, "required": [ "message" ] } } } }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/tables/warehouses/{warehouse}/nomenclatures": { "get": { "operationId": "warehouseNomenclature.tableIndex", "tags": [ "WarehouseNomenclature" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3, "maxLength": 1024 } }, { "name": "owned_by_us", "in": "query", "schema": { "type": "boolean" } }, { "name": "warehouse_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "type_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "city_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "brand_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "vat_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "application_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "counterparty_id[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "`TableCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{modelId}/nomenclatures/{nomenclature}/history": { "get": { "operationId": "warehouseNomenclature.history", "tags": [ "WarehouseNomenclature" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "nomenclature", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`HistoryCollection`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryCollection" } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}/nomenclatures": { "post": { "operationId": "warehouse-nomenclatures.store", "tags": [ "WarehouseNomenclature" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.WarehouseNomenclature.StoreRequest" } } } }, "responses": { "200": { "description": "`InventoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/InventoryResource" } }, "required": [ "inventory" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } }, "/api/warehouses/{warehouse}/nomenclatures/{nomenclature}": { "get": { "operationId": "warehouse-nomenclatures.show", "tags": [ "WarehouseNomenclature" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`InventoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/InventoryResource" } }, "required": [ "inventory" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "put": { "operationId": "warehouse-nomenclatures.update", "tags": [ "WarehouseNomenclature" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/App.Http.Requests.WarehouseNomenclature.UpdateRequest" } } } }, "responses": { "200": { "description": "`InventoryResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/InventoryResource" } }, "required": [ "inventory" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "422": { "$ref": "#/components/responses/ValidationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } }, "delete": { "operationId": "warehouse-nomenclatures.destroy", "tags": [ "WarehouseNomenclature" ], "parameters": [ { "name": "warehouse", "in": "path", "required": true, "description": "The warehouse ID", "schema": { "type": "integer" } }, { "name": "nomenclature", "in": "path", "required": true, "description": "The nomenclature ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Warehouse nomenclature deleted successfully." } }, "required": [ "message" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } }, "security": [ { "BearerAuth": [] } ], "x-gigma-zero-to-null": { "before": [ 0, "0" ], "after": null, "stage": "before-validation", "description": "Numeric 0 and string \"0\" in request input are converted to null before validation." } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" }, "AppTokenAuth": { "type": "apiKey", "in": "header", "name": "Token" }, "ClientCredentials": { "type": "http", "scheme": "basic" } }, "schemas": { "ActivateFreeSubscriptionRequest": { "type": "object", "properties": { "plan_slug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]*$", "maxLength": 64 } }, "required": [ "plan_slug" ], "title": "ActivateFreeSubscriptionRequest" }, "AgentCollection": { "type": "object", "properties": { "agents": { "type": "array", "items": { "$ref": "#/components/schemas/AgentResource" } }, "agentsCount": { "type": "integer" } }, "required": [ "agents", "agentsCount" ], "title": "AgentCollection" }, "AgentResource": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "login": { "type": "string" }, "role": { "$ref": "#/components/schemas/RoleResource" }, "branch": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "department": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "agent_description": { "type": "string" }, "is_agent": { "type": "boolean" }, "is_banned": { "type": "boolean" }, "creator": { "$ref": "#/components/schemas/UserNameResource" }, "last_activity_at": { "type": "string" }, "permissions": { "$ref": "#/components/schemas/PermissionCollection" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "code", "name", "login", "role", "branch", "department", "agent_description", "is_agent", "is_banned", "creator", "last_activity_at", "permissions", "created_at", "updated_at" ], "title": "AgentResource" }, "AgentTokenCollection": { "type": "object", "properties": { "agent_tokens": { "type": "array", "items": { "$ref": "#/components/schemas/AgentTokenResource" } }, "agentTokensCount": { "type": "integer" } }, "required": [ "agent_tokens", "agentTokensCount" ], "title": "AgentTokenCollection" }, "AgentTokenResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "last_used_at": { "type": "string" }, "expires_at": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "created_at", "last_used_at", "expires_at", "value" ], "title": "AgentTokenResource" }, "App.Http.Requests.Application.StoreRequest": { "type": "object", "properties": { "is_website": { "type": "boolean" }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "branch_id": { "type": "integer" }, "photo_id": { "type": [ "integer", "null" ] }, "warehouse_id": { "type": "array", "items": { "type": "integer" } }, "sales_strategy_id": { "type": "integer" }, "wholesale": { "type": "boolean" }, "success_payment_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2048 } }, "required": [ "is_website", "name", "branch_id", "sales_strategy_id" ], "title": "App.Http.Requests.Application.StoreRequest" }, "App.Http.Requests.Application.UpdateRequest": { "type": "object", "properties": { "subscription_payment_integration_id": { "type": [ "integer", "null" ] }, "is_website": { "type": "boolean" }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "branch_id": { "type": "integer" }, "photo_id": { "type": "integer" }, "warehouse_id": { "type": "array", "items": { "type": "integer" } }, "sales_strategy_id": { "type": "integer" }, "is_token_active": { "type": "boolean" }, "wholesale": { "type": "boolean" }, "success_payment_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2048 } }, "title": "App.Http.Requests.Application.UpdateRequest" }, "App.Http.Requests.ApplicationBrand.StoreRequest": { "type": "object", "properties": { "brand_id": { "type": "string" } }, "required": [ "brand_id" ], "title": "App.Http.Requests.ApplicationBrand.StoreRequest" }, "App.Http.Requests.ApplicationCategory.StoreRequest": { "type": "object", "properties": { "category_id": { "type": "string" } }, "required": [ "category_id" ], "title": "App.Http.Requests.ApplicationCategory.StoreRequest" }, "App.Http.Requests.ApplicationMenuItem.StoreRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "avatar_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "parent_id": { "type": [ "integer", "null" ] }, "order": { "type": [ "number", "null" ], "minimum": 1 }, "preview_id": { "type": [ "integer", "null" ] }, "slug": { "type": [ "string", "null" ] } }, "required": [ "name" ], "title": "App.Http.Requests.ApplicationMenuItem.StoreRequest" }, "App.Http.Requests.ApplicationMenuItem.UpdateRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "avatar_id": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "parent_id": { "type": [ "integer", "null" ] }, "order": { "type": "number", "minimum": 1 }, "preview_id": { "type": "integer" }, "slug": { "type": "string" } }, "title": "App.Http.Requests.ApplicationMenuItem.UpdateRequest" }, "App.Http.Requests.ApplicationSubscriptionNomenclature.StoreRequest": { "type": "object", "properties": { "nomenclature_id": { "type": "integer" }, "slug": { "type": [ "string", "null" ], "pattern": "^[a-z0-9][a-z0-9-]*$", "maxLength": 64 }, "sort_order": { "type": "integer", "minimum": 0 }, "is_active": { "type": "boolean" } }, "required": [ "nomenclature_id" ], "title": "App.Http.Requests.ApplicationSubscriptionNomenclature.StoreRequest" }, "App.Http.Requests.ApplicationSubscriptionNomenclature.UpdateRequest": { "type": "object", "properties": { "slug": { "type": [ "string", "null" ], "pattern": "^[a-z0-9][a-z0-9-]*$", "maxLength": 64 }, "sort_order": { "type": "integer", "minimum": 0 }, "is_active": { "type": "boolean" } }, "title": "App.Http.Requests.ApplicationSubscriptionNomenclature.UpdateRequest" }, "App.Http.Requests.ApplicationWebhook.StoreRequest": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "order.paid" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "headers": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 1000 }, "maxItems": 10 }, "secret": { "type": "string", "minLength": 16, "maxLength": 512 }, "is_active": { "type": "boolean" } }, "required": [ "event", "url", "secret" ], "title": "App.Http.Requests.ApplicationWebhook.StoreRequest" }, "App.Http.Requests.ApplicationWebhook.UpdateRequest": { "type": "object", "properties": { "secret": { "type": "string", "description": "event is intentionally excluded \u2014 immutable after creation\nsecret is intentionally excluded \u2014 use rotate-secret endpoint; explicit null must fail" }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "headers": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 1000 }, "maxItems": 10 }, "is_active": { "type": "boolean" } }, "title": "App.Http.Requests.ApplicationWebhook.UpdateRequest" }, "App.Http.Requests.BankRequisite.StoreRequest": { "type": "object", "properties": { "payment_account": { "type": "number" }, "name": { "type": "string", "minLength": 3, "maxLength": 1024 }, "bik": { "type": "number" }, "kpp": { "type": "number" }, "address": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "required": [ "payment_account", "name", "bik", "kpp" ], "title": "App.Http.Requests.BankRequisite.StoreRequest" }, "App.Http.Requests.BankRequisite.UpdateRequest": { "type": "object", "properties": { "payment_account": { "type": "number" }, "name": { "type": "string", "minLength": 3, "maxLength": 1024 }, "bik": { "type": "number" }, "kpp": { "type": "number" }, "address": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "title": "App.Http.Requests.BankRequisite.UpdateRequest" }, "App.Http.Requests.Block.StoreRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "avatar_id": { "type": [ "integer", "null" ] }, "identifier": { "type": [ "string", "null" ], "minLength": 1 }, "name": { "type": "string" }, "block_type_id": { "type": "integer" }, "parent_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "file_id": { "type": [ "integer", "null" ] }, "link": { "type": [ "string", "null" ] } }, "required": [ "name", "block_type_id" ], "title": "App.Http.Requests.Block.StoreRequest" }, "App.Http.Requests.Block.UpdateRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string" }, "identifier": { "type": [ "string", "null" ], "minLength": 1 }, "avatar_id": { "type": [ "integer", "null" ] }, "block_type_id": { "type": "integer" }, "parent_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "file_id": { "type": [ "integer", "null" ] }, "link": { "type": [ "string", "null" ] } }, "title": "App.Http.Requests.Block.UpdateRequest" }, "App.Http.Requests.Branch.StoreRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "title": { "type": "string" }, "inn": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "kpp": { "type": [ "string", "null" ] }, "phone_1": { "type": "string" }, "phone_2": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email" }, "head": { "type": [ "string", "null" ] }, "address": { "type": "string" }, "legal_address": { "type": "string" }, "responsible_user_id": { "type": [ "integer", "null" ] } }, "required": [ "title", "inn", "name", "phone_1", "email", "address", "legal_address" ], "title": "App.Http.Requests.Branch.StoreRequest" }, "App.Http.Requests.Branch.UpdateRequest": { "type": "object", "properties": { "project_id": { "type": "string" }, "avatar_id": { "type": [ "integer", "null" ] }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "title": { "type": "string" }, "inn": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "kpp": { "type": [ "string", "null" ] }, "phone_1": { "type": "string" }, "phone_2": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email" }, "head": { "type": "string" }, "address": { "type": "string" }, "legal_address": { "type": "string" }, "responsible_user_id": { "type": [ "integer", "null" ] } }, "required": [ "inn" ], "title": "App.Http.Requests.Branch.UpdateRequest" }, "App.Http.Requests.BranchBankRequisite.StoreRequest": { "type": "object", "properties": { "payment_account": { "type": "number" }, "name": { "type": "string", "minLength": 3, "maxLength": 1024 }, "bik": { "type": "number" }, "kpp": { "type": "number" }, "address": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "required": [ "payment_account", "name", "bik", "kpp" ], "title": "App.Http.Requests.BranchBankRequisite.StoreRequest" }, "App.Http.Requests.BranchBankRequisite.UpdateRequest": { "type": "object", "properties": { "payment_account": { "type": "number" }, "name": { "type": "string", "minLength": 3, "maxLength": 1024 }, "bik": { "type": "number" }, "kpp": { "type": "number" }, "address": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "title": "App.Http.Requests.BranchBankRequisite.UpdateRequest" }, "App.Http.Requests.Brand.StoreRequest": { "type": "object", "properties": { "name": { "type": "string" }, "avatar_id": { "type": [ "integer", "null" ] }, "branch_id": { "type": [ "integer", "null" ] } }, "required": [ "name" ], "title": "App.Http.Requests.Brand.StoreRequest" }, "App.Http.Requests.Brand.UpdateRequest": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "avatar_id": { "type": [ "integer", "null" ] }, "branch_id": { "type": [ "integer", "null" ] } }, "title": "App.Http.Requests.Brand.UpdateRequest" }, "App.Http.Requests.Call.StoreRequest": { "type": "object", "properties": { "phone": { "type": "string" }, "specialist_phone": { "type": "string" }, "is_incoming": { "type": "boolean" }, "call_status_id": { "type": "number" } }, "required": [ "phone", "specialist_phone", "is_incoming", "call_status_id" ], "title": "App.Http.Requests.Call.StoreRequest" }, "App.Http.Requests.Call.UpdateRequest": { "type": "object", "properties": { "specialist_id": { "type": "integer" }, "manager_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": [ "integer", "null" ] }, "order_id": { "type": [ "integer", "null" ] }, "object": { "type": [ "string", "null" ] }, "telegram": { "type": [ "string", "null" ] } }, "title": "App.Http.Requests.Call.UpdateRequest" }, "App.Http.Requests.Contact.StoreRequest": { "type": "object", "properties": { "first_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "birthday": { "type": [ "string", "null" ], "format": "date-time" }, "phone_1": { "type": [ "number", "null" ] }, "phone_2": { "type": [ "number", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "address": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 2048 } }, "required": [ "first_name" ], "title": "App.Http.Requests.Contact.StoreRequest" }, "App.Http.Requests.Contact.UpdateRequest": { "type": "object", "properties": { "first_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "birthday": { "type": [ "string", "null" ], "format": "date-time" }, "phone_1": { "type": [ "number", "null" ] }, "phone_2": { "type": [ "number", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "address": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 2048 } }, "title": "App.Http.Requests.Contact.UpdateRequest" }, "App.Http.Requests.Counterparties.Counterparty.UpdateRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "first_name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 255 }, "address": { "type": [ "string", "null" ] }, "phone_2": { "type": [ "string", "null" ], "maxLength": 20 } }, "title": "App.Http.Requests.Counterparties.Counterparty.UpdateRequest" }, "App.Http.Requests.Counterparties.Order.StoreRequest": { "type": "object", "properties": { "delivery_type_id": { "type": "integer" }, "delivery_subtype_id": { "type": [ "integer", "null" ] }, "delivery_subtype_param_id": { "type": [ "integer", "null" ] }, "shop_id": { "type": [ "integer", "null" ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "quantity": { "type": "integer", "minimum": 1 } }, "required": [ "id", "quantity" ] }, "minItems": 1 }, "payment_type_id": { "type": [ "integer", "null" ] }, "payment_method_type": { "type": "string", "enum": [ "bank_card", "sbp" ] }, "address": { "type": [ "string", "null" ], "minLength": 1 }, "promo_code": { "type": [ "string", "null" ], "pattern": "^[A-Za-z0-9\\-]+$", "maxLength": 64 } }, "required": [ "delivery_type_id", "products" ], "title": "App.Http.Requests.Counterparties.Order.StoreRequest" }, "App.Http.Requests.Counterparties.Product.Favourite.StoreRequest": { "type": "object", "properties": { "product_id": { "type": "integer" } }, "required": [ "product_id" ], "title": "App.Http.Requests.Counterparties.Product.Favourite.StoreRequest" }, "App.Http.Requests.Counterparties.RepairEstimate.PrecalculateRequest": { "type": "object", "properties": { "apartment_type": { "type": "string", "enum": [ "studio", "1room", "2room", "3room", "4room" ] }, "total_area": { "type": "number", "maximum": 10000 }, "ceiling_height": { "type": "number", "maximum": 20 }, "bathroom": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "combined", "separate" ] }, "primary_area": { "type": "number", "maximum": 1000 }, "secondary_area": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "type", "primary_area" ] }, "selected_works": { "type": "array", "items": { "type": "object", "properties": { "composition_id": { "type": "integer" }, "quantity_source": { "type": "string", "enum": [ "total_wall_area", "living_floor", "ceiling_area", "bathroom_wall_area", "bathroom_floor_area", "skirting_perimeter" ] }, "thickness": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "composition_id", "quantity_source" ] }, "minItems": 1, "maxItems": 100 }, "selected_options": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "apartment_type", "total_area", "ceiling_height", "bathroom", "selected_works" ], "title": "App.Http.Requests.Counterparties.RepairEstimate.PrecalculateRequest" }, "App.Http.Requests.Counterparty.StoreRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "is_company": { "type": "boolean" }, "avatar_id": { "type": "integer" }, "counterparty_type_id": { "type": "integer" }, "counterparty_type_slug": { "type": "string", "maxLength": 64 }, "registered_at": { "type": "string", "format": "date-time" }, "name": { "type": "string", "minLength": 3, "maxLength": 2048 }, "inn": { "type": "number" }, "kpp": { "type": "number" }, "head": { "type": "string", "minLength": 3, "maxLength": 1024 }, "legal_address": { "type": "string", "minLength": 3, "maxLength": 2048 }, "phone_1": { "type": "number" }, "phone_2": { "type": [ "number", "null" ] }, "email": { "type": "string", "format": "email" }, "first_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "last_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "middle_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "birthday": { "type": "string", "format": "date-time" }, "address": { "type": "string", "minLength": 3, "maxLength": 2048 } }, "required": [ "is_company" ], "title": "App.Http.Requests.Counterparty.StoreRequest" }, "App.Http.Requests.Counterparty.UpdateRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "counterparty_type_id": { "type": "integer" }, "avatar_id": { "type": "integer" }, "manager_id": { "type": "integer" }, "registered_at": { "type": "string", "format": "date-time" }, "name": { "type": "string", "minLength": 3, "maxLength": 2048 }, "inn": { "type": "number" }, "kpp": { "type": "number" }, "head": { "type": "string", "minLength": 3, "maxLength": 1024 }, "legal_address": { "type": "string", "minLength": 3, "maxLength": 2048 }, "phone_1": { "type": "number" }, "phone_2": { "type": [ "number", "null" ] }, "email": { "type": "string", "format": "email" }, "first_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "last_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "middle_name": { "type": "string", "minLength": 2, "maxLength": 255 }, "birthday": { "type": "string", "format": "date-time" }, "address": { "type": "string", "minLength": 3, "maxLength": 2048 } }, "title": "App.Http.Requests.Counterparty.UpdateRequest" }, "App.Http.Requests.CounterpartyAuthClient.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 128 }, "audience": { "type": "string", "maxLength": 64 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "chat:access", "subscription:write" ] }, "minItems": 1, "maxItems": 2, "uniqueItems": true }, "project_id": { "type": "string" }, "application_id": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "is_active": { "type": "string" } }, "required": [ "name", "scopes" ], "title": "App.Http.Requests.CounterpartyAuthClient.StoreRequest" }, "App.Http.Requests.Dictionary.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ], "title": "App.Http.Requests.Dictionary.StoreRequest" }, "App.Http.Requests.Dictionary.UpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ], "title": "App.Http.Requests.Dictionary.UpdateRequest" }, "App.Http.Requests.Discount.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "pattern": "^[A-Z0-9\\-]+$", "maxLength": 64 }, "status": { "type": [ "string", "null" ], "enum": [ "draft", "active", "paused", "archived", null ] }, "discount_type": { "type": "string", "enum": [ "percent", "fixed" ] }, "discount_value": { "type": "number", "minimum": 0.01 }, "min_order_amount": { "type": [ "number", "null" ], "minimum": 0 }, "max_discount_amount": { "type": [ "number", "null" ], "minimum": 0 }, "total_usage_limit": { "type": [ "integer", "null" ], "minimum": 1 }, "per_client_usage_limit": { "type": [ "integer", "null" ], "minimum": 1 }, "starts_at": { "type": [ "string", "null" ], "format": "date-time" }, "ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2048 }, "audience": { "type": [ "string", "null" ], "enum": [ "all", "new_clients", "partners", "custom", null ] }, "description": { "type": [ "string", "null" ] }, "application_id": { "type": [ "integer", "null" ] }, "branch_id": { "type": [ "integer", "null" ] } }, "required": [ "name", "code", "discount_type", "discount_value" ], "title": "App.Http.Requests.Discount.StoreRequest" }, "App.Http.Requests.Discount.UpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "pattern": "^[A-Z0-9\\-]+$", "maxLength": 64 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived" ] }, "discount_type": { "type": "string", "enum": [ "percent", "fixed" ] }, "discount_value": { "type": "string" }, "min_order_amount": { "type": [ "number", "null" ], "minimum": 0 }, "max_discount_amount": { "type": [ "number", "null" ], "minimum": 0 }, "total_usage_limit": { "type": [ "integer", "null" ], "minimum": 1 }, "per_client_usage_limit": { "type": [ "integer", "null" ], "minimum": 1 }, "starts_at": { "type": [ "string", "null" ], "format": "date-time" }, "ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2048 }, "audience": { "type": "string", "enum": [ "all", "new_clients", "partners", "custom" ] }, "description": { "type": [ "string", "null" ] }, "application_id": { "type": [ "integer", "null" ] }, "branch_id": { "type": [ "integer", "null" ] } }, "title": "App.Http.Requests.Discount.UpdateRequest" }, "App.Http.Requests.Event.StoreRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": "integer" }, "delivery_type_id": { "type": [ "integer", "null" ] }, "shop_id": { "type": [ "integer", "null" ] }, "address": { "type": [ "string", "null" ], "minLength": 3 }, "branch_id": { "type": [ "string", "null" ] }, "object_id": { "type": [ "integer", "null" ] }, "application_id": { "type": [ "integer", "null" ] }, "sales_channel_id": { "type": [ "integer", "null" ] }, "manager_id": { "type": "integer" }, "promotion_id": { "type": [ "integer", "null" ] }, "contract_number": { "type": [ "string", "null" ], "minLength": 1 }, "contract_id": { "type": [ "integer", "null" ] }, "contract_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "contract_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_number": { "type": [ "string", "null" ], "minLength": 1 }, "invoice_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "event_type_id": { "type": "integer" }, "name": { "type": [ "string", "null" ], "minLength": 1 }, "comment": { "type": [ "string", "null" ], "minLength": 1 }, "reserve_until": { "type": [ "integer", "null" ], "minimum": 1 }, "reserved_after_at": { "type": [ "string", "null" ], "format": "date-time" }, "assembly_started_at": { "type": [ "string", "null" ], "format": "date-time" }, "assembly_finished_at": { "type": [ "string", "null" ], "format": "date-time" }, "event_started_at": { "type": [ "string", "null" ], "format": "date-time" }, "event_finished_at": { "type": [ "string", "null" ], "format": "date-time" }, "disassembly_started_at": { "type": [ "string", "null" ], "format": "date-time" }, "disassembly_finished_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "counterparty_id", "manager_id", "event_type_id" ], "title": "App.Http.Requests.Event.StoreRequest" }, "App.Http.Requests.Event.UpdateRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": "integer" }, "delivery_type_id": { "type": [ "integer", "null" ] }, "address": { "type": [ "string", "null" ], "minLength": 3 }, "branch_id": { "type": "string" }, "object_id": { "type": [ "integer", "null" ] }, "shop_id": { "type": [ "integer", "null" ] }, "application_id": { "type": [ "integer", "null" ] }, "sales_channel_id": { "type": [ "integer", "null" ] }, "manager_id": { "type": "integer" }, "promotion_id": { "type": [ "integer", "null" ] }, "contract_number": { "type": [ "string", "null" ], "minLength": 1 }, "contract_id": { "type": [ "integer", "null" ] }, "contract_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "contract_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_number": { "type": [ "string", "null" ], "minLength": 1 }, "invoice_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "event_type_id": { "type": "integer" }, "event_status_id": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ], "minLength": 1 }, "comment": { "type": [ "string", "null" ], "minLength": 1 }, "reserve_until": { "type": [ "integer", "null" ], "minimum": 1 }, "reserved_after_at": { "type": [ "string", "null" ], "format": "date-time" }, "assembly_started_at": { "type": [ "string", "null" ], "format": "date-time" }, "assembly_finished_at": { "type": [ "string", "null" ], "format": "date-time" }, "event_started_at": { "type": [ "string", "null" ], "format": "date-time" }, "event_finished_at": { "type": [ "string", "null" ], "format": "date-time" }, "disassembly_started_at": { "type": [ "string", "null" ], "format": "date-time" }, "disassembly_finished_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "event_type_id" ], "title": "App.Http.Requests.Event.UpdateRequest" }, "App.Http.Requests.EventStatus.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ], "title": "App.Http.Requests.EventStatus.StoreRequest" }, "App.Http.Requests.EventStatus.UpdateRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "title": "App.Http.Requests.EventStatus.UpdateRequest" }, "App.Http.Requests.File.StoreRequest": { "type": "object", "properties": { "file_type_id": { "type": "integer" }, "file": { "type": "string", "format": "binary", "contentMediaType": "application/octet-stream", "description": "Maximum file size: 2048 kilobytes." }, "link": { "type": [ "string", "null" ] } }, "required": [ "file_type_id", "file" ], "title": "App.Http.Requests.File.StoreRequest" }, "App.Http.Requests.File.UpdateRequest": { "type": "object", "properties": { "file_type_id": { "type": "integer" }, "file": { "type": "string", "format": "binary", "contentMediaType": "application/octet-stream", "description": "Maximum file size: 2048 kilobytes." }, "link": { "type": [ "string", "null" ] } }, "required": [ "file_type_id", "file" ], "title": "App.Http.Requests.File.UpdateRequest" }, "App.Http.Requests.Menu.StoreRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "title": "App.Http.Requests.Menu.StoreRequest" }, "App.Http.Requests.ModelIntegration.StoreRequest": { "type": "object", "properties": { "integration_id": { "type": "integer" }, "is_active": { "type": "boolean" } }, "required": [ "integration_id" ], "title": "App.Http.Requests.ModelIntegration.StoreRequest" }, "App.Http.Requests.ModelIntegration.UpdateRequest": { "type": "object", "properties": { "is_active": { "type": "boolean" } }, "required": [ "is_active" ], "title": "App.Http.Requests.ModelIntegration.UpdateRequest" }, "App.Http.Requests.ModelIntegrationParameter.StoreRequest": { "type": "object", "properties": { "integration_parameter_id": { "type": "integer" }, "value_1": { "type": "string" }, "value_2": { "type": "string" } }, "required": [ "integration_parameter_id" ], "title": "App.Http.Requests.ModelIntegrationParameter.StoreRequest" }, "App.Http.Requests.Nomenclature.StoreRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ], "minimum": 1 }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "category_id": { "type": [ "integer", "null" ] }, "specification": { "type": [ "string", "null" ] }, "type_id": { "type": [ "integer", "null" ] }, "kind_id": { "type": "integer" }, "branch_id": { "type": "integer" }, "tags": { "type": [ "array", "null" ], "items": { "type": "integer" } }, "preview_id": { "type": [ "integer", "null" ], "minimum": 1 }, "photos": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "photo_id": { "type": "integer", "minimum": 1 }, "order": { "type": "integer", "minimum": 0 } } } }, "storage_unit_id": { "type": [ "integer", "null" ] }, "brand_id": { "type": [ "integer", "null" ] }, "country_id": { "type": "integer" }, "is_import": { "type": "boolean" }, "cost_price": { "type": [ "number", "null" ], "pattern": "^\\d+(\\.\\d{1,2})?$", "minimum": 0 }, "pieces_per_pack": { "type": "integer", "minimum": 1 }, "price": { "type": "number", "pattern": "^\\d+(\\.\\d{1,2})?$", "minimum": 0 }, "vat_id": { "type": [ "integer", "null" ] }, "quantity": { "type": [ "integer", "null" ], "minimum": 0 }, "discount": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100 }, "markup": { "type": "integer", "minimum": 0 }, "is_subscription": { "type": "boolean" }, "billing_period_months": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 120 }, "parent_nomenclature_id": { "type": [ "integer", "null" ] }, "variant_label": { "type": [ "string", "null" ], "maxLength": 255 }, "variant_sort_order": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 4294967295 } }, "required": [ "name", "kind_id", "branch_id", "country_id" ], "title": "App.Http.Requests.Nomenclature.StoreRequest" }, "App.Http.Requests.Nomenclature.UpdateRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ], "minimum": 1 }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "category_id": { "type": [ "integer", "null" ] }, "specification": { "type": [ "string", "null" ] }, "type_id": { "type": [ "integer", "null" ] }, "kind_id": { "type": "integer" }, "branch_id": { "type": "integer" }, "tags": { "type": [ "array", "null" ], "items": { "type": "integer" } }, "preview_id": { "type": [ "integer", "null" ], "minimum": 1 }, "photos": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "photo_id": { "type": "integer", "minimum": 1 }, "order": { "type": "integer", "minimum": 0 } } } }, "storage_unit_id": { "type": [ "integer", "null" ] }, "brand_id": { "type": [ "integer", "null" ] }, "country_id": { "type": "integer" }, "is_import": { "type": "boolean" }, "is_subscription": { "type": "boolean" }, "billing_period_months": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 120 }, "parent_nomenclature_id": { "type": [ "integer", "null" ] }, "variant_label": { "type": [ "string", "null" ], "maxLength": 255 }, "variant_sort_order": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 4294967295 }, "cost_price": { "type": [ "number", "null" ], "pattern": "^\\d+(\\.\\d{1,2})?$", "minimum": 0 }, "pieces_per_pack": { "type": "integer", "minimum": 1 }, "price": { "type": "number", "pattern": "^\\d+(\\.\\d{1,2})?$", "minimum": 0 }, "vat_id": { "type": [ "integer", "null" ] }, "quantity": { "type": [ "integer", "null" ], "minimum": 0 }, "discount": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100 }, "markup": { "type": "integer", "minimum": 0 } }, "required": [ "name", "kind_id" ], "title": "App.Http.Requests.Nomenclature.UpdateRequest" }, "App.Http.Requests.Order.StoreRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": "integer" }, "delivery_type_id": { "type": [ "integer", "null" ] }, "shop_id": { "type": [ "integer", "null" ] }, "address": { "type": [ "string", "null" ], "minLength": 3 }, "branch_id": { "type": [ "string", "null" ] }, "object_id": { "type": [ "integer", "null" ] }, "application_id": { "type": [ "integer", "null" ] }, "sales_channel_id": { "type": [ "integer", "null" ] }, "manager_id": { "type": "integer" }, "promotion_id": { "type": [ "integer", "null" ] }, "contract_number": { "type": [ "string", "null" ], "minLength": 1 }, "contract_id": { "type": [ "integer", "null" ] }, "contract_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "contract_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_number": { "type": [ "string", "null" ], "minLength": 1 }, "invoice_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_end_date": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "counterparty_id", "manager_id" ], "title": "App.Http.Requests.Order.StoreRequest" }, "App.Http.Requests.Order.UpdateRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": "integer" }, "delivery_type_id": { "type": [ "integer", "null" ] }, "address": { "type": [ "string", "null" ], "minLength": 3 }, "branch_id": { "type": "string" }, "object_id": { "type": [ "integer", "null" ] }, "shop_id": { "type": [ "integer", "null" ] }, "application_id": { "type": [ "integer", "null" ] }, "sales_channel_id": { "type": [ "integer", "null" ] }, "manager_id": { "type": "integer" }, "promotion_id": { "type": [ "integer", "null" ] }, "contract_number": { "type": [ "string", "null" ], "minLength": 1 }, "contract_id": { "type": [ "integer", "null" ] }, "contract_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "contract_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_number": { "type": [ "string", "null" ], "minLength": 1 }, "invoice_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_end_date": { "type": [ "string", "null" ], "format": "date-time" } }, "title": "App.Http.Requests.Order.UpdateRequest" }, "App.Http.Requests.OrderNomenclature.StoreRequest": { "type": "object", "properties": { "nomenclature_id": { "type": [ "integer", "null" ] }, "quantity": { "type": "string", "minLength": 1 }, "storage_unit_id": { "type": [ "integer", "null" ] }, "price": { "type": [ "number", "null" ], "minimum": 1 }, "vat_id": { "type": [ "integer", "null" ] } }, "required": [ "quantity" ], "title": "App.Http.Requests.OrderNomenclature.StoreRequest" }, "App.Http.Requests.OrderNomenclature.UpdateRequest": { "type": "object", "properties": { "nomenclature_id": { "type": "integer" }, "quantity": { "type": "string", "minLength": 1 }, "storage_unit_id": { "type": "integer" }, "price": { "type": "number", "minimum": 1 }, "vat_id": { "type": [ "integer", "null" ] } }, "title": "App.Http.Requests.OrderNomenclature.UpdateRequest" }, "App.Http.Requests.OrderType.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ], "title": "App.Http.Requests.OrderType.StoreRequest" }, "App.Http.Requests.OrderType.UpdateRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "title": "App.Http.Requests.OrderType.UpdateRequest" }, "App.Http.Requests.Page.StoreRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "application_id": { "type": "integer" }, "avatar_id": { "type": [ "integer", "null" ] }, "is_page": { "type": "boolean" }, "page_type_id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "meta_title": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "preview_id": { "type": [ "integer", "null" ] }, "description": { "type": [ "string", "null" ] }, "meta_description": { "type": [ "string", "null" ] }, "content": { "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "type": "integer" } } }, "required": [ "application_id", "is_page", "page_type_id", "slug", "title", "content" ], "title": "App.Http.Requests.Page.StoreRequest" }, "App.Http.Requests.Page.UpdateRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "application_id": { "type": "integer" }, "avatar_id": { "type": [ "integer", "null" ] }, "is_page": { "type": "boolean" }, "page_type_id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "meta_title": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "preview_id": { "type": [ "integer", "null" ] }, "description": { "type": [ "string", "null" ] }, "meta_description": { "type": [ "string", "null" ] }, "content": { "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "type": "integer" } } }, "required": [ "application_id", "is_page", "page_type_id", "slug", "title", "content" ], "title": "App.Http.Requests.Page.UpdateRequest" }, "App.Http.Requests.PasswordRequest": { "type": "object", "properties": { "login": { "type": "string", "format": "email" } }, "required": [ "login" ], "title": "App.Http.Requests.PasswordRequest" }, "App.Http.Requests.Permission.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name", "description" ], "title": "App.Http.Requests.Permission.StoreRequest" }, "App.Http.Requests.Permission.UpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name", "description" ], "title": "App.Http.Requests.Permission.UpdateRequest" }, "App.Http.Requests.Project.StoreRequest": { "type": "object", "properties": { "name": { "type": "string" }, "login": { "type": "string", "format": "email" }, "menu_id": { "type": "integer" } }, "required": [ "name", "login", "menu_id" ], "title": "App.Http.Requests.Project.StoreRequest" }, "App.Http.Requests.Role.StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name", "description" ], "title": "App.Http.Requests.Role.StoreRequest" }, "App.Http.Requests.Role.UpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name", "description" ], "title": "App.Http.Requests.Role.UpdateRequest" }, "App.Http.Requests.Setting.StoreRequest": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "title": "App.Http.Requests.Setting.StoreRequest" }, "App.Http.Requests.Setting.UpdateRequest": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "title": "App.Http.Requests.Setting.UpdateRequest" }, "App.Http.Requests.Shop.StoreRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "is_shop": { "type": [ "boolean", "null" ] }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string", "maxLength": 255 }, "branches": { "type": [ "array", "null" ], "items": { "type": "integer" } }, "warehouses": { "type": [ "array", "null" ], "items": { "type": "integer" } }, "address": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "name", "address", "phone" ], "title": "App.Http.Requests.Shop.StoreRequest" }, "App.Http.Requests.Shop.UpdateRequest": { "type": "object", "properties": { "avatar_id": { "type": [ "integer", "null" ] }, "is_shop": { "type": [ "boolean", "null" ] }, "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "name": { "type": "string", "maxLength": 255 }, "branches": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } }, "warehouses": { "type": [ "array", "null" ], "items": { "type": [ "integer", "null" ] } }, "address": { "type": "string" }, "phone": { "type": "string" } }, "title": "App.Http.Requests.Shop.UpdateRequest" }, "App.Http.Requests.Task.StoreRequest": { "type": "object", "properties": { "name": { "type": "string" }, "started_at": { "type": "string", "format": "date-time" }, "finished_at": { "type": "string", "format": "date-time" }, "executor_id": { "type": "integer" }, "object": { "type": "string" }, "order_id": { "type": "integer" }, "create_everyday": { "type": "boolean" }, "notifications": { "type": "array", "items": { "type": "integer" } } }, "required": [ "name", "started_at", "finished_at", "executor_id", "order_id" ], "title": "App.Http.Requests.Task.StoreRequest" }, "App.Http.Requests.Task.UpdateRequest": { "type": "object", "properties": { "task_status_id": { "type": "integer" }, "name": { "type": "string" }, "started_at": { "type": "string", "format": "date-time" }, "finished_at": { "type": "string", "format": "date-time" }, "executor_id": { "type": "integer" }, "object": { "type": "string" }, "order_id": { "type": "integer" }, "create_everyday": { "type": "boolean" }, "notifications": { "type": "array", "items": { "type": "integer" } } }, "title": "App.Http.Requests.Task.UpdateRequest" }, "App.Http.Requests.User.LoginRequest": { "type": "object", "properties": { "login": { "type": "string", "format": "email" }, "password": { "type": "string" }, "device": { "type": "string", "minLength": 3, "maxLength": 50 } }, "required": [ "login", "password" ], "title": "App.Http.Requests.User.LoginRequest" }, "App.Http.Requests.User.StoreRequest": { "type": "object", "properties": { "first_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "last_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "birthday": { "type": [ "string", "null" ], "format": "date-time" }, "branch_id": { "type": [ "integer", "null" ] }, "department_id": { "type": [ "integer", "null" ] }, "role_id": { "type": "integer" }, "login": { "type": "string" }, "phone": { "type": "number" }, "avatar_id": { "type": [ "integer", "null" ] }, "employment_contract_id": { "type": [ "integer", "null" ] }, "employment_date": { "type": [ "string", "null" ], "format": "date-time" }, "dismissal_date": { "type": [ "string", "null" ], "format": "date-time" }, "permissions": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "first_name", "last_name", "role_id", "login", "phone" ], "title": "App.Http.Requests.User.StoreRequest" }, "App.Http.Requests.User.UpdateRequest": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "birthday": { "type": [ "string", "null" ], "format": "date-time" }, "branch_id": { "type": [ "integer", "null" ] }, "department_id": { "type": [ "integer", "null" ] }, "role_id": { "type": [ "integer", "null" ] }, "login": { "type": "string" }, "phone": { "type": "string" }, "avatar_id": { "type": [ "integer", "null" ] }, "employment_contract_id": { "type": [ "integer", "null" ] }, "employment_date": { "type": [ "string", "null" ], "format": "date-time" }, "dismissal_date": { "type": [ "string", "null" ], "format": "date-time" }, "permissions": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_sick": { "type": [ "boolean", "null" ] }, "is_banned": { "type": [ "boolean", "null" ] } }, "title": "App.Http.Requests.User.UpdateRequest" }, "App.Http.Requests.UserMenuItem.StoreRequest": { "type": "object", "properties": { "user_id": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "parent_id": { "type": [ "integer", "null" ] }, "avatar_id": { "type": [ "integer", "null" ] }, "url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 255 } }, "required": [ "user_id", "name" ], "title": "App.Http.Requests.UserMenuItem.StoreRequest" }, "App.Http.Requests.Warehouse.StoreRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "avatar_id": { "type": [ "integer", "null" ] }, "name": { "type": "string", "maxLength": 255 }, "owned_by_us": { "type": [ "boolean", "null" ] }, "address": { "type": "string", "maxLength": 255 }, "storage_capacity": { "type": [ "number", "null" ], "minimum": 1 }, "storage_unit_id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "is_price_from_inventories": { "type": [ "boolean", "null" ] } }, "required": [ "name", "address", "storage_unit_id" ], "title": "App.Http.Requests.Warehouse.StoreRequest" }, "App.Http.Requests.Warehouse.UpdateRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "avatar_id": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "owned_by_us": { "type": [ "boolean", "null" ] }, "address": { "type": [ "string", "null" ], "maxLength": 255 }, "storage_capacity": { "type": [ "number", "null" ], "minimum": 1 }, "storage_unit_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": [ "integer", "null" ] }, "is_price_from_inventories": { "type": [ "boolean", "null" ] } }, "title": "App.Http.Requests.Warehouse.UpdateRequest" }, "App.Http.Requests.WarehouseNomenclature.StoreRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "nomenclature_id": { "type": "integer" }, "warehouse_id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "price": { "type": [ "number", "null" ], "pattern": "^\\d+(\\.\\d{1,2})?$", "minimum": 0 }, "vat_id": { "type": [ "integer", "null" ] }, "quantity": { "type": [ "integer", "null" ], "minimum": 0 }, "discount": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100 }, "markup": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "nomenclature_id", "warehouse_id" ], "title": "App.Http.Requests.WarehouseNomenclature.StoreRequest" }, "App.Http.Requests.WarehouseNomenclature.UpdateRequest": { "type": "object", "properties": { "code": { "type": [ "number", "null" ], "minimum": 1, "maximum": 1.8446744073709552e+19 }, "warehouse_id": { "type": "integer" }, "nomenclature_id": { "type": "integer" }, "counterparty_id": { "type": [ "integer", "null" ] }, "vat_id": { "type": [ "integer", "null" ] }, "quantity": { "type": [ "integer", "null" ], "minimum": 0 }, "price": { "type": [ "number", "null" ], "pattern": "^\\d+(\\.\\d{1,2})?$", "minimum": 0 }, "discount": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100 }, "markup": { "type": [ "integer", "null" ], "minimum": 0 } }, "required": [ "warehouse_id", "nomenclature_id" ], "title": "App.Http.Requests.WarehouseNomenclature.UpdateRequest" }, "App.Http.Resources.Counterparties.DictionaryCollection": { "anyOf": [ { "type": "object", "properties": { "": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryResource" } }, "Count": { "type": "integer" } }, "required": [ null, "Count" ] }, { "type": "array", "items": [] } ], "title": "App.Http.Resources.Counterparties.DictionaryCollection" }, "App.Http.Resources.Counterparties.DictionaryResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "photo": { "type": [ "string", "null" ] }, "created_at": { "type": "string" } }, "required": [ "id", "name", "photo", "created_at" ], "title": "App.Http.Resources.Counterparties.DictionaryResource" }, "App.Http.Resources.Counterparties.FileCollection": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.FileResource" }, "title": "App.Http.Resources.Counterparties.FileCollection" }, "App.Http.Resources.Counterparties.FileResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "link": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "path", "link" ], "title": "App.Http.Resources.Counterparties.FileResource" }, "App.Http.Resources.Counterparties.WarehouseProduct.OrderNomenclatureResource": { "type": "object", "properties": { "id": { "type": "integer" }, "old_price": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "name": { "type": "string" }, "photos": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.FileCollection" }, "quantity": { "type": "integer" }, "parameters": { "type": "object", "properties": { "wholesale": { "type": "boolean" }, "pieces_per_pack": { "type": [ "object", "null" ] }, "quantity_pack": { "type": "integer" } }, "required": [ "wholesale", "pieces_per_pack", "quantity_pack" ] } }, "required": [ "id", "old_price", "price", "name", "photos", "quantity", "parameters" ], "title": "App.Http.Resources.Counterparties.WarehouseProduct.OrderNomenclatureResource" }, "App.Http.Resources.Counterparty.ApplicationMenuItem.ApplicationMenuItemResource": { "type": "object", "properties": { "code": { "type": [ "integer", "null" ] }, "avatar": { "type": "string" }, "preview": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.ApplicationMenuItem.ApplicationMenuItemResource" } } }, "required": [ "code", "avatar", "preview", "name", "url", "children" ], "title": "App.Http.Resources.Counterparty.ApplicationMenuItem.ApplicationMenuItemResource" }, "App.Http.Resources.Counterparty.Category.CategoryCollection": { "anyOf": [ { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Category.CategoryResource" } }, "categoriesCount": { "type": "integer", "minimum": 0 } }, "required": [ "categories", "categoriesCount" ] }, { "type": "array", "items": [] } ], "title": "App.Http.Resources.Counterparty.Category.CategoryCollection" }, "App.Http.Resources.Counterparty.Category.CategoryResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "photo": { "type": "string" }, "parent": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Category.CategoryResource" } }, "required": [ "id", "name", "photo", "parent" ], "title": "App.Http.Resources.Counterparty.Category.CategoryResource" }, "App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeCollection": { "type": "object", "properties": { "": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" } }, "Count": { "type": "integer" } }, "required": [ null, "Count" ], "title": "App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeCollection" }, "App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "string" }, "is_active": { "type": "integer" } }, "required": [ "id", "name", "price", "is_active" ], "title": "App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" }, "App.Http.Resources.Counterparty.Order.OrderCollection": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Order.OrderResource" } }, "ordersCount": { "type": "integer" } }, "required": [ "orders", "ordersCount" ], "title": "App.Http.Resources.Counterparty.Order.OrderCollection" }, "App.Http.Resources.Counterparty.Order.OrderResource": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryResource" }, "price": { "type": [ "string", "null" ] }, "promo_code": { "type": [ "string", "null" ] }, "original_price": { "type": [ "number", "null" ] }, "product_discount_amount": { "type": [ "number", "null" ] }, "promo_discount_amount": { "type": [ "number", "null" ] }, "total_discount_amount": { "type": [ "number", "null" ] }, "final_price": { "type": [ "number", "null" ] }, "delivery_type": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" }, "delivery_subtype": { "anyOf": [ { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" }, { "type": "null" } ] }, "delivery_subtype_param": { "anyOf": [ { "$ref": "#/components/schemas/DeliverySubtypeParamResource" }, { "type": "null" } ] }, "payment_type": { "anyOf": [ { "$ref": "#/components/schemas/PaymentTypeResource" }, { "type": "null" } ] }, "yookassa_payment_method_type": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "shop": { "anyOf": [ { "$ref": "#/components/schemas/ShopResource" }, { "type": "null" } ] }, "products": { "$ref": "#/components/schemas/OrderNomenclatureCollection" }, "payment_link": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "redeem_token": { "type": [ "string", "null" ] }, "redeemed_count": { "type": [ "integer", "null" ] }, "total_tickets": { "type": [ "integer", "null" ] }, "last_redeemed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "price", "promo_code", "original_price", "product_discount_amount", "promo_discount_amount", "total_discount_amount", "final_price", "delivery_type", "delivery_subtype", "delivery_subtype_param", "payment_type", "yookassa_payment_method_type", "address", "shop", "products", "payment_link", "created_at", "redeem_token", "redeemed_count", "total_tickets", "last_redeemed_at" ], "title": "App.Http.Resources.Counterparty.Order.OrderResource" }, "App.Http.Resources.Counterparty.Page.PageCollection": { "type": "object", "properties": { "pages": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Page.PageResource" } }, "first_page_url": { "type": [ "string", "null" ] }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page_url": { "type": [ "string", "null" ] }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "next_page_url": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "prev_page_url": { "type": [ "string", "null" ] }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "data", "first_page_url", "from", "last_page_url", "last_page", "links", "next_page_url", "path", "per_page", "prev_page_url", "to", "total" ] } }, "required": [ "pages" ], "title": "App.Http.Resources.Counterparty.Page.PageCollection" }, "App.Http.Resources.Counterparty.Page.PageResource": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "preview": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "content": { "type": "string" }, "views_count": { "type": "integer" }, "author": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "tags": { "$ref": "#/components/schemas/DictionaryCollection" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "slug", "title", "description", "preview", "content", "views_count", "author", "tags", "created_at" ], "title": "App.Http.Resources.Counterparty.Page.PageResource" }, "App.Http.Resources.Counterparty.Subscription.SubscriptionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "application_id": { "type": [ "integer", "null" ] }, "plan_slug": { "type": "string" }, "nomenclature_id": { "type": [ "integer", "null" ] }, "initial_order_id": { "type": [ "integer", "null" ] }, "nomenclature": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "string" } }, "required": [ "id", "name", "price" ] }, "billing_period_months": { "type": [ "integer", "null" ] }, "amount": { "type": "string" }, "currency": { "type": "string" }, "status": { "type": "string" }, "current_period_start": { "type": [ "string", "null" ] }, "current_period_end": { "type": [ "string", "null" ] }, "next_charge_at": { "type": [ "string", "null" ], "description": "\u00ab\u041d\u0435 \u0440\u0430\u043d\u044c\u0448\u0435 \u0447\u0435\u043c\u00bb, \u0430 \u043d\u0435 \u0442\u043e\u0447\u043d\u043e\u0435 \u0432\u0440\u0435\u043c\u044f: \u0444\u0430\u043a\u0442\u0438\u0447\u0435\u0441\u043a\u0430\u044f \u043f\u043e\u043f\u044b\u0442\u043a\u0430 \u043f\u0440\u043e\u0438\u0437\u043e\u0439\u0434\u0451\u0442\n\u043d\u0430 \u0431\u043b\u0438\u0436\u0430\u0439\u0448\u0435\u043c \u043f\u0440\u043e\u0433\u043e\u043d\u0435 \u043f\u043b\u0430\u043d\u0438\u0440\u043e\u0432\u0449\u0438\u043a\u0430. \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u0432 \u043f\u0440\u043e\u0448\u043b\u043e\u043c \u2014 \u00ab\u0443\u0436\u0435 \u043f\u043e\u0440\u0430\u00bb." }, "canceled_at": { "type": [ "string", "null" ] }, "last_payment_at": { "type": [ "string", "null" ] }, "last_payment_error": { "type": [ "string", "null" ] }, "autopay_consent": { "type": [ "object", "null" ], "properties": { "accepted_at": { "type": "string" }, "version": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "billing_period_months": { "type": [ "integer", "null" ] } }, "required": [ "accepted_at", "version", "amount", "currency", "billing_period_months" ] }, "saved_payment_method": { "anyOf": [ { "$ref": "#/components/schemas/SavedPaymentMethodResource" }, { "type": "null" } ] }, "latest_payment": { "$ref": "#/components/schemas/SubscriptionPaymentResource" }, "can_retry_payment": { "type": "boolean" }, "retry_payment_reason": { "type": [ "string", "null" ], "enum": [ "payment_requires_reconciliation", "payment_finalized", "subscription_terms_changed", "payment_not_retryable", "payment_invalidated", "subscription_canceled", "payment_pending", "already_paid", "no_payment", null ] }, "latest_payment_method_change": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "expires_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "expires_at", "completed_at", "created_at" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application_id", "plan_slug", "nomenclature_id", "initial_order_id", "billing_period_months", "amount", "currency", "status", "current_period_start", "current_period_end", "next_charge_at", "canceled_at", "last_payment_at", "last_payment_error", "can_retry_payment", "retry_payment_reason", "created_at" ], "title": "App.Http.Resources.Counterparty.Subscription.SubscriptionResource" }, "App.Http.Resources.Event.EventResource": { "type": "object", "properties": { "id": { "type": "integer" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/DictionaryResource" }, "type": { "$ref": "#/components/schemas/DictionaryResource" }, "invoice_number": { "type": [ "string", "null" ] }, "invoice_start_date": { "type": [ "string", "null" ] }, "invoice_end_date": { "type": [ "string", "null" ] }, "application": { "$ref": "#/components/schemas/DictionaryResource" }, "counterparty": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ] }, { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "middle_name": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "first_name", "last_name", "middle_name", "name" ] } ] }, "delivery_type": { "$ref": "#/components/schemas/DeliveryTypeResource" }, "address": { "type": [ "string", "null" ] }, "shop": { "anyOf": [ { "$ref": "#/components/schemas/ShopResource" }, { "type": "null" } ] }, "branch": { "$ref": "#/components/schemas/DictionaryResource" }, "object": { "$ref": "#/components/schemas/DictionaryResource" }, "source": { "$ref": "#/components/schemas/DictionaryResource" }, "sales_channel": { "$ref": "#/components/schemas/DictionaryResource" }, "manager": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "promotion": { "$ref": "#/components/schemas/DictionaryResource" }, "contract": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "contract_number": { "type": [ "string", "null" ] }, "contract_start_date": { "type": [ "string", "null" ] }, "contract_end_date": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "comment": { "type": [ "string", "null" ] }, "reserve_until": { "type": [ "integer", "null" ] }, "reserved_after_at": { "type": [ "string", "null" ] }, "assembly_started_at": { "type": [ "string", "null" ] }, "assembly_finished_at": { "type": [ "string", "null" ] }, "event_started_at": { "type": [ "string", "null" ] }, "event_finished_at": { "type": [ "string", "null" ] }, "disassembly_started_at": { "type": [ "string", "null" ] }, "disassembly_finished_at": { "type": [ "string", "null" ] } }, "required": [ "id", "avatar", "status", "type", "invoice_number", "invoice_start_date", "invoice_end_date", "application", "counterparty", "delivery_type", "address", "shop", "branch", "object", "source", "sales_channel", "manager", "promotion", "contract", "contract_number", "contract_start_date", "contract_end_date", "name", "comment", "reserve_until", "reserved_after_at", "assembly_started_at", "assembly_finished_at", "event_started_at", "event_finished_at", "disassembly_started_at", "disassembly_finished_at" ], "title": "App.Http.Resources.Event.EventResource" }, "App.Http.Resources.Order.OrderResource": { "type": "object", "properties": { "id": { "type": "integer" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/DictionaryResource" }, "price": { "type": [ "string", "null" ] }, "promo_code": { "type": [ "string", "null" ] }, "original_price": { "type": [ "number", "null" ] }, "product_discount_amount": { "type": [ "number", "null" ] }, "promo_discount_amount": { "type": [ "number", "null" ] }, "total_discount_amount": { "type": [ "number", "null" ] }, "final_price": { "type": [ "number", "null" ] }, "invoice_number": { "type": [ "string", "null" ] }, "invoice_start_date": { "type": [ "string", "null" ] }, "invoice_end_date": { "type": [ "string", "null" ] }, "application": { "$ref": "#/components/schemas/DictionaryResource" }, "counterparty": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ] }, { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "middle_name": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "first_name", "last_name", "middle_name", "name" ] } ] }, "delivery_type": { "$ref": "#/components/schemas/DeliveryTypeResource" }, "address": { "type": [ "string", "null" ] }, "shop": { "anyOf": [ { "$ref": "#/components/schemas/ShopResource" }, { "type": "null" } ] }, "branch": { "$ref": "#/components/schemas/DictionaryResource" }, "object": { "$ref": "#/components/schemas/DictionaryResource" }, "source": { "$ref": "#/components/schemas/DictionaryResource" }, "sales_channel": { "$ref": "#/components/schemas/DictionaryResource" }, "manager": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "promotion": { "$ref": "#/components/schemas/DictionaryResource" }, "contract": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "contract_number": { "type": [ "string", "null" ] }, "contract_start_date": { "type": [ "string", "null" ] }, "contract_end_date": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "refund_request": { "type": "object", "properties": { "requested_at": { "type": [ "string", "null" ], "format": "date-time" }, "requested_by_user_id": { "type": [ "integer", "null" ] }, "comment": { "type": [ "string", "null" ] }, "email_sent_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "requested_at", "requested_by_user_id", "comment", "email_sent_at" ] }, "ticket": { "type": "object", "description": "Ticket redemption \u2014 \u0434\u043b\u044f \u0430\u0434\u043c\u0438\u043d-\u0441\u0442\u0440\u0430\u043d\u0438\u0446 \u00ab\u043a\u0430\u0440\u0442\u043e\u0447\u043a\u0430 \u0437\u0430\u043a\u0430\u0437\u0430/\u0441\u043e\u0431\u044b\u0442\u0438\u044f\u00bb\n(\u0444\u0440\u043e\u043d\u0442 dasha_ai: /events/:id \u0438\u0437 /admin/tickets/list). \u0411\u0430\u0437\u043e\u0432\u0430\u044f \u0437\u0430\u0449\u0438\u0442\u0430 \u2014 `OrderController::show` \u0444\u0438\u043b\u044c\u0442\u0440\u0443\u0435\u0442 \u043f\u043e project_id\n(\u0432\u0441\u0435\u0433\u0434\u0430) + branch_id (\u0434\u043b\u044f \u043d\u0435-ADMIN/OWNER). 404 \u0447\u0443\u0436\u043e\u043c\u0443 \u0431\u0435\u0437\n\u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0441\u0443\u0449\u0435\u0441\u0442\u0432\u043e\u0432\u0430\u043d\u0438\u044f order_id (Codex P1 \u043d\u0430 TK2).\n\nDefence-in-depth: \u0434\u0430\u0436\u0435 \u0435\u0441\u043b\u0438 \u043a\u0442\u043e-\u0442\u043e \u0438\u043c\u043f\u043e\u0440\u0442\u043d\u0451\u0442 \u044d\u0442\u043e\u0442 Resource\n\u0432 \u043e\u0431\u0445\u043e\u0434 show (\u043d\u0430\u043f\u0440\u0438\u043c\u0435\u0440, future endpoint \u0431\u0435\u0437 auth-\u0444\u0438\u043b\u044c\u0442\u0440\u0430) \u2014\nticket-\u043f\u043e\u043b\u044f \u0431\u0443\u0434\u0443\u0442 null \u0434\u043b\u044f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f, \u0443 \u043a\u043e\u0442\u043e\u0440\u043e\u0433\u043e \u043d\u0435\u0442\n\u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a \u044d\u0442\u043e\u043c\u0443 \u0437\u0430\u043a\u0430\u0437\u0443 \u043f\u043e project/branch. \u0421\u043c. ticketFields().\n\n`total_tickets` \u2014 accessor `Order::getTotalTicketsAttribute` \u2192\n`sum(order_nomenclatures.quantity)`. \u0414\u043b\u044f \u043e\u0434\u043d\u043e\u0433\u043e show \u2014 \u043e\u0434\u0438\u043d\n\u0434\u043e\u043f\u043e\u043b\u043d\u0438\u0442\u0435\u043b\u044c\u043d\u044b\u0439 SQL, \u043f\u0440\u0438\u0435\u043c\u043b\u0435\u043c\u043e. \u0414\u043b\u044f list-endpoints (`index`/`tableIndex`)\n\u2014 preload \u0447\u0435\u0440\u0435\u0437 `->withSum('nomenclatures as total_tickets', 'quantity')`\n\u0435\u0441\u043b\u0438 \u043f\u043e\u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f \u043f\u043e \u043d\u0430\u0433\u0440\u0443\u0437\u043a\u0435 (\u0434\u043b\u044f \u0442\u0435\u043a\u0443\u0449\u0435\u0433\u043e show \u043d\u0435 \u043d\u0443\u0436\u0435\u043d).\n\n`last_redeemed_by` \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442 relation `Order::lastRedeemedBy`\n(`belongsTo User`). \u041a\u043e\u043d\u0442\u0440\u043e\u043b\u043b\u0435\u0440 eager-load'\u0438\u0442 \u0435\u0451 \u0447\u0435\u0440\u0435\u0437\n`$order->load('lastRedeemedBy')` \u0447\u0442\u043e\u0431\u044b \u043d\u0435 \u043f\u043b\u043e\u0434\u0438\u0442\u044c N+1.", "properties": { "redeem_token": { "type": [ "string", "null" ] }, "redeemed_count": { "type": [ "integer", "null" ] }, "total_tickets": { "type": [ "integer", "null" ] }, "last_redeemed_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_redeemed_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "required": [ "redeem_token", "redeemed_count", "total_tickets", "last_redeemed_at", "last_redeemed_by" ] } }, "required": [ "id", "avatar", "status", "price", "promo_code", "original_price", "product_discount_amount", "promo_discount_amount", "total_discount_amount", "final_price", "invoice_number", "invoice_start_date", "invoice_end_date", "application", "counterparty", "delivery_type", "address", "shop", "branch", "object", "source", "sales_channel", "manager", "promotion", "contract", "contract_number", "contract_start_date", "contract_end_date", "name", "refund_request", "ticket" ], "title": "App.Http.Resources.Order.OrderResource" }, "App.Http.Resources.ShopResource": { "type": "object", "properties": { "id": { "type": "integer" }, "is_shop": { "type": "boolean" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "code": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "branches": { "$ref": "#/components/schemas/WarehouseCollection" }, "warehouses": { "$ref": "#/components/schemas/WarehouseCollection" }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": [ "string", "null" ] }, "longitude": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] } }, "required": [ "id", "is_shop", "avatar", "code", "name", "branches", "warehouses", "address", "latitude", "longitude", "phone" ], "title": "App.Http.Resources.ShopResource" }, "ApplicationCollection": { "type": "object", "properties": { "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationResource" } }, "applicationsCount": { "type": "integer" } }, "required": [ "applications", "applicationsCount" ], "title": "ApplicationCollection" }, "ApplicationMenuItemCollection": { "anyOf": [ { "type": "object", "properties": { "menuItems": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationMenuItemResource" } }, "menuItemsCount": { "type": "integer" } }, "required": [ "menuItems", "menuItemsCount" ] }, { "type": "array", "items": [] } ], "title": "ApplicationMenuItemCollection" }, "ApplicationMenuItemResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "integer", "null" ] }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "preview": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "name": { "type": "string" }, "slug": { "type": "string" }, "parent": { "anyOf": [ { "$ref": "#/components/schemas/ApplicationMenuItemResource" }, { "type": "null" } ] }, "children": { "$ref": "#/components/schemas/ApplicationMenuItemCollection" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "code", "avatar", "preview", "name", "slug", "created_at" ], "title": "ApplicationMenuItemResource" }, "ApplicationNotificationChannelResource": { "type": "object", "properties": { "id": { "type": "integer" }, "application_id": { "type": "integer" }, "channel": { "type": "string" }, "provider": { "type": [ "string", "null" ] }, "is_active": { "type": "boolean" }, "settings": { "anyOf": [ { "type": "object", "properties": { "provider": { "type": "string", "const": "smsc" }, "sender": { "type": "null" }, "max_sms_parts": { "type": "integer", "const": 2 }, "events": { "type": "object", "properties": { "subscription_charge_failed": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string", "const": "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u0441\u043f\u0438\u0441\u0430\u0442\u044c {amount} \u20bd \u0437\u0430 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 {plan}. \u041f\u0440\u043e\u0432\u0435\u0440\u044c\u0442\u0435 \u043a\u0430\u0440\u0442\u0443: {action_url}" }, "action_url": { "type": "null" } }, "required": [ "is_active", "template", "action_url" ] }, "subscription_renewal_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string", "const": "\u0422\u0432\u043e\u0439 \u0412\u041f\u0421: \u0432\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u0438\u0442\u0435 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443: {action_url}" }, "action_url": { "type": "string", "const": "https://tvoivps.ru/subscription" } }, "required": [ "is_active", "template", "action_url" ] }, "subscription_repurchase_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string", "const": "\u0422\u0432\u043e\u0439 \u0412\u041f\u0421: \u043e\u0444\u043e\u0440\u043c\u0438\u0442\u0435 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 \u0441\u043d\u043e\u0432\u0430: {action_url}" }, "action_url": { "type": "string", "const": "https://tvoivps.ru/subscription" } }, "required": [ "is_active", "template", "action_url" ] }, "subscription_payment_method_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string", "const": "\u0422\u0432\u043e\u0439 \u0412\u041f\u0421: \u043f\u0440\u0438\u0432\u044f\u0436\u0438\u0442\u0435 \u043a\u0430\u0440\u0442\u0443: {action_url}" }, "action_url": { "type": "string", "const": "https://tvoivps.ru/subscription" } }, "required": [ "is_active", "template", "action_url" ] } }, "required": [ "subscription_charge_failed", "subscription_renewal_required", "subscription_repurchase_required", "subscription_payment_method_required" ] } }, "required": [ "provider", "sender", "max_sms_parts", "events" ] }, { "type": "object", "properties": { "provider": { "type": "string", "const": "laravel_mail" }, "events": { "type": "object", "properties": { "subscription_renewal_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "subject": { "type": "string", "const": "\u0412\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u0438\u0442\u0435 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 \u00ab\u0422\u0432\u043e\u0439 \u0412\u041f\u0421\u00bb" }, "template": { "type": "string", "const": "\u0427\u0442\u043e\u0431\u044b \u043f\u0440\u043e\u0434\u043e\u043b\u0436\u0438\u0442\u044c \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u00ab\u0422\u0432\u043e\u0439 \u0412\u041f\u0421\u00bb, \u0432\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u0438\u0442\u0435 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443." }, "action_label": { "type": "string", "const": "\u0412\u043e\u0437\u043e\u0431\u043d\u043e\u0432\u0438\u0442\u044c \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443" }, "action_url": { "type": "string", "const": "https://tvoivps.ru/subscription" } }, "required": [ "is_active", "subject", "template", "action_label", "action_url" ] }, "subscription_repurchase_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "subject": { "type": "string", "const": "\u041e\u0444\u043e\u0440\u043c\u0438\u0442\u0435 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 \u00ab\u0422\u0432\u043e\u0439 \u0412\u041f\u0421\u00bb \u0441\u043d\u043e\u0432\u0430" }, "template": { "type": "string", "const": "\u0427\u0442\u043e\u0431\u044b \u0441\u043d\u043e\u0432\u0430 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u00ab\u0422\u0432\u043e\u0439 \u0412\u041f\u0421\u00bb, \u043e\u0444\u043e\u0440\u043c\u0438\u0442\u0435 \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443." }, "action_label": { "type": "string", "const": "\u041e\u0444\u043e\u0440\u043c\u0438\u0442\u044c \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 \u0441\u043d\u043e\u0432\u0430" }, "action_url": { "type": "string", "const": "https://tvoivps.ru/subscription" } }, "required": [ "is_active", "subject", "template", "action_label", "action_url" ] }, "subscription_payment_method_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "subject": { "type": "string", "const": "\u041f\u0440\u0438\u0432\u044f\u0436\u0438\u0442\u0435 \u043a\u0430\u0440\u0442\u0443 \u0434\u043b\u044f \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0438 \u00ab\u0422\u0432\u043e\u0439 \u0412\u041f\u0421\u00bb" }, "template": { "type": "string", "const": "\u041f\u0440\u0438\u0432\u044f\u0436\u0438\u0442\u0435 \u043a\u0430\u0440\u0442\u0443, \u0447\u0442\u043e\u0431\u044b \u043f\u0440\u043e\u0434\u043b\u0438\u0442\u044c \u043f\u043e\u0434\u043f\u0438\u0441\u043a\u0443 \u00ab\u0422\u0432\u043e\u0439 \u0412\u041f\u0421\u00bb." }, "action_label": { "type": "string", "const": "\u041f\u0440\u0438\u0432\u044f\u0437\u0430\u0442\u044c \u043a\u0430\u0440\u0442\u0443" }, "action_url": { "type": "string", "const": "https://tvoivps.ru/subscription" } }, "required": [ "is_active", "subject", "template", "action_label", "action_url" ] } }, "required": [ "subscription_renewal_required", "subscription_repurchase_required", "subscription_payment_method_required" ] } }, "required": [ "provider", "events" ] }, { "type": "array", "items": [] } ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "has_smsc_login": { "type": "boolean" }, "has_smsc_password": { "type": "boolean" }, "has_smsc_api_key": { "type": "boolean" } }, "required": [ "id", "application_id", "channel", "provider", "is_active", "settings", "created_at", "updated_at", "has_smsc_login", "has_smsc_password", "has_smsc_api_key" ], "title": "ApplicationNotificationChannelResource" }, "ApplicationResource": { "type": "object", "properties": { "id": { "type": "integer" }, "branch": { "anyOf": [ { "$ref": "#/components/schemas/BranchResource" }, { "type": "null" } ] }, "is_website": { "type": "boolean" }, "photo": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "code": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "is_token_active": { "type": "boolean" }, "wholesale": { "type": "boolean" }, "token": { "type": "string" }, "subscription_payment_integration_id": { "type": [ "integer", "null" ] }, "success_payment_url": { "type": [ "string", "null" ] }, "warehouses": { "$ref": "#/components/schemas/WarehouseCollection" }, "sales_strategy": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "id", "branch", "is_website", "photo", "code", "name", "is_token_active", "wholesale", "token", "subscription_payment_integration_id", "success_payment_url", "warehouses", "sales_strategy" ], "title": "ApplicationResource" }, "ApplicationSubscriptionNomenclatureCatalogResource": { "type": "object", "properties": { "nomenclature": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parent_nomenclature_id": { "type": "string" }, "variant_label": { "type": "string" }, "variant_sort_order": { "type": "string" }, "price": { "type": "string" }, "billing_period_months": { "type": "string" } }, "required": [ "id", "name", "parent_nomenclature_id", "variant_label", "variant_sort_order", "price", "billing_period_months" ] }, "assignment": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "is_active": { "type": "boolean" }, "sort_order": { "type": "integer" } }, "required": [ "id", "slug", "is_active", "sort_order" ] } }, "required": [ "nomenclature", "assignment" ], "title": "ApplicationSubscriptionNomenclatureCatalogResource" }, "ApplicationSubscriptionNomenclatureResource": { "type": "object", "properties": { "id": { "type": "integer" }, "application_id": { "type": "integer" }, "nomenclature_id": { "type": "integer" }, "slug": { "type": [ "string", "null" ] }, "sort_order": { "type": "integer" }, "is_active": { "type": "boolean" }, "nomenclature": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "string" }, "billing_period_months": { "type": [ "integer", "null" ] } }, "required": [ "id", "name", "price", "billing_period_months" ] } }, "required": [ "id", "application_id", "nomenclature_id", "slug", "sort_order", "is_active" ], "title": "ApplicationSubscriptionNomenclatureResource" }, "ApplicationWebhookCollection": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationWebhookResource" } } }, "required": [ "data" ], "title": "ApplicationWebhookCollection" }, "ApplicationWebhookResource": { "type": "object", "properties": { "id": { "type": "integer" }, "application_id": { "type": "integer" }, "event": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": [ "array", "null" ], "items": [] }, "has_secret": { "type": "boolean" }, "is_active": { "type": "boolean" }, "archived_at": { "type": [ "string", "null" ] }, "created_by_user_id": { "type": [ "integer", "null" ] }, "updated_by_user_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application_id", "event", "url", "headers", "has_secret", "is_active", "archived_at", "created_by_user_id", "updated_by_user_id", "created_at", "updated_at" ], "title": "ApplicationWebhookResource" }, "ApproveAgentAccessRequestRequest": { "type": "object", "properties": { "approval_token": { "type": "string", "maxLength": 255 }, "permissions": { "type": [ "array", "null" ], "items": { "type": "string" }, "maxItems": 100, "uniqueItems": true } }, "required": [ "approval_token" ], "title": "ApproveAgentAccessRequestRequest" }, "AvatarStoreRequest": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "contentMediaType": "application/octet-stream", "description": "Maximum file size: 2048 kilobytes." }, "link": { "type": [ "string", "null" ] } }, "required": [ "file" ], "title": "AvatarStoreRequest" }, "BlockCollection": { "anyOf": [ { "type": "object", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/BlockResource" } }, "blocksCount": { "type": "integer" } }, "required": [ "blocks", "blocksCount" ] }, { "type": "array", "items": [] } ], "title": "BlockCollection" }, "BlockResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "integer", "null" ] }, "identifier": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "block_type": { "anyOf": [ { "$ref": "#/components/schemas/DictionaryResource" }, { "type": "null" } ] }, "link": { "type": [ "string", "null" ] }, "file": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "text": { "type": [ "string", "null" ] }, "parent": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "code": { "type": [ "integer", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "code", "name" ] }, "children": { "$ref": "#/components/schemas/BlockCollection" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "code", "identifier", "name", "avatar", "block_type", "link", "file", "text", "created_at" ], "title": "BlockResource" }, "BranchBankRequisiteCollection": { "type": "object", "properties": { "bankRequisites": { "type": "array", "items": { "$ref": "#/components/schemas/BranchBankRequisiteResource" } }, "bankRequisitesCount": { "type": "integer" } }, "required": [ "bankRequisites", "bankRequisitesCount" ], "title": "BranchBankRequisiteCollection" }, "BranchBankRequisiteResource": { "type": "object", "properties": { "id": { "type": "integer" }, "payment_account": { "type": "string" }, "name": { "type": "string" }, "bik": { "type": "string" }, "kpp": { "type": "string" }, "address": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "payment_account", "name", "bik", "kpp", "address", "created_at", "updated_at" ], "title": "BranchBankRequisiteResource" }, "BranchCollection": { "type": "object", "properties": { "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchResource" } }, "branchesCount": { "type": "integer", "minimum": 0 } }, "required": [ "branches", "branchesCount" ], "title": "BranchCollection" }, "BranchResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "string", "null" ] }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "title": { "type": "string" }, "inn": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "responsible_user": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "kpp": { "type": [ "string", "null" ] }, "phone_1": { "type": [ "string", "null" ] }, "phone_2": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "head": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "legal_address": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "code", "avatar", "title", "inn", "name", "responsible_user", "kpp", "phone_1", "phone_2", "email", "head", "address", "legal_address", "created_at" ], "title": "BranchResource" }, "BrandCollection": { "type": "object", "properties": { "brands": { "type": "array", "items": { "$ref": "#/components/schemas/BrandResource" } }, "brandsCount": { "type": "array", "items": { "$ref": "#/components/schemas/BrandResource" } } }, "required": [ "brands", "brandsCount" ], "title": "BrandCollection" }, "BrandResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "branch": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "required": [ "id", "title" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "avatar", "branch", "created_at" ], "title": "BrandResource" }, "CalculatePriceRequest": { "type": "object", "properties": { "price": { "type": [ "number", "null" ] }, "markup": { "type": [ "number", "null" ] }, "discount": { "type": [ "number", "null" ] } }, "required": [ "price", "markup", "discount" ], "title": "CalculatePriceRequest" }, "CallCollection": { "type": "object", "properties": { "calls": { "type": "array", "items": { "$ref": "#/components/schemas/CallResource" } }, "callsCount": { "type": "integer" } }, "required": [ "calls", "callsCount" ], "title": "CallCollection" }, "CallResource": { "type": "object", "properties": { "id": { "type": "integer" }, "is_incoming": { "type": "integer" }, "created_at": { "type": "string" }, "specialist": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "manager": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "counterparty": { "anyOf": [ { "$ref": "#/components/schemas/CounterpartyResource" }, { "type": "null" } ] }, "phone": { "type": "string" }, "object": { "type": [ "string", "null" ] }, "order": { "type": "string" }, "telegram": { "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "id", "is_incoming", "created_at", "specialist", "manager", "counterparty", "phone", "object", "order", "telegram", "status" ], "title": "CallResource" }, "CategoryCollection": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryResource" } }, "categoriesCount": { "type": "integer" } }, "required": [ "categories", "categoriesCount" ], "title": "CategoryCollection" }, "CategoryResource": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "parent": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "photo": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "tags": { "$ref": "#/components/schemas/DictionaryCollection" } }, "required": [ "id", "code", "name", "description", "parent", "photo", "avatar", "tags" ], "title": "CategoryResource" }, "ChangeSubscriptionPaymentMethodRequest": { "type": "object", "properties": { "autopay_consent": { "enum": [ "yes", "on", "1", 1, "true", true ] }, "card": { "type": "string" }, "card_number": { "type": "string" }, "cvc": { "type": "string" }, "payment_method_data": { "type": "string" }, "return_url": { "type": "string" } }, "required": [ "autopay_consent" ], "title": "ChangeSubscriptionPaymentMethodRequest" }, "ChangeTypeRequest": { "type": "object", "properties": { "counterparty_type_slug": { "type": "string", "maxLength": 64 } }, "required": [ "counterparty_type_slug" ], "title": "ChangeTypeRequest" }, "CheckoutSubscriptionRequest": { "type": "object", "properties": { "nomenclature_id": { "type": [ "integer", "null" ] }, "nomenclature_ids": { "type": [ "array", "null" ], "items": { "type": "integer" }, "minItems": 1, "maxItems": 20, "uniqueItems": true }, "autopay_consent": { "enum": [ "yes", "on", "1", 1, "true", true ] }, "payment_method_type": { "type": [ "string", "null" ], "enum": [ "bank_card", "sbp", null ] } }, "required": [ "autopay_consent" ], "title": "CheckoutSubscriptionRequest" }, "CompositionCalculateRequest": { "type": "object", "description": "Public composition calculation (App Token); transport authorization stays in middleware.", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "composition_id": { "type": "integer" }, "volume": { "type": "number", "maximum": 100000 }, "thickness": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "composition_id", "volume" ] }, "minItems": 1, "maxItems": 100 } }, "required": [ "items" ], "title": "CompositionCalculateRequest" }, "ConsumeAgentAccessRequestRequest": { "type": "object", "properties": { "request_token": { "type": "string", "maxLength": 255 } }, "required": [ "request_token" ], "title": "ConsumeAgentAccessRequestRequest" }, "ContactAuthRequest": { "type": "object", "properties": { "phone": { "type": "string", "maxLength": 32 }, "normalized_phone": { "type": "string", "pattern": "^7\\d{10}$" }, "auth_date": { "type": "integer", "minimum": 1 }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$", "minLength": 64, "maxLength": 64 }, "init_data": { "type": "string", "maxLength": 8192 }, "device": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "phone", "normalized_phone", "auth_date", "hash", "init_data" ], "title": "ContactAuthRequest" }, "ContactCollection": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResource" } }, "contactsCount": { "type": "integer" } }, "required": [ "contacts", "contactsCount" ], "title": "ContactCollection" }, "ContactFormRequest": { "type": "object", "properties": { "first_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "last_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "phone": { "type": "number" }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "quantity": { "type": "integer", "minimum": 1 } }, "required": [ "id", "quantity" ] }, "minItems": 1 }, "address": { "type": [ "string", "null" ], "minLength": 1 }, "payment_type_id": { "type": [ "integer", "null" ] } }, "required": [ "first_name", "last_name", "phone", "products" ], "title": "ContactFormRequest" }, "ContactResource": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": [ "string", "null" ] }, "middle_name": { "type": [ "string", "null" ] }, "birthday": { "type": [ "string", "null" ] }, "phone_1": { "type": [ "string", "null" ] }, "phone_2": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] } }, "required": [ "id", "first_name", "last_name", "middle_name", "birthday", "phone_1", "phone_2", "email", "address" ], "title": "ContactResource" }, "CounterpartyAuthClientResource": { "type": "object", "properties": { "client_id": { "type": "string" }, "application_id": { "type": "integer" }, "name": { "type": "string" }, "audience": { "type": "string" }, "scopes": { "type": "array", "items": [] }, "is_active": { "type": "boolean" }, "last_used_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "client_id", "application_id", "name", "audience", "scopes", "is_active", "last_used_at", "created_at" ], "title": "CounterpartyAuthClientResource" }, "CounterpartyAuthIntrospectionRequest": { "type": "object", "properties": { "token": { "type": "string", "maxLength": 8192 }, "audience": { "type": "string", "maxLength": 64 } }, "required": [ "token", "audience" ], "title": "CounterpartyAuthIntrospectionRequest" }, "CounterpartyCollection": { "type": "object", "properties": { "counterparties": { "type": "array", "items": { "$ref": "#/components/schemas/CounterpartyResource" } }, "counterpartiesCount": { "type": "integer" } }, "required": [ "counterparties", "counterpartiesCount" ], "title": "CounterpartyCollection" }, "CounterpartyResource": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "$ref": "#/components/schemas/CounterpartyTypeResource" }, "manager": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] } }, "required": [ "id", "type", "manager", "avatar" ], "title": "CounterpartyResource" }, "CounterpartyTypeResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "created_at": { "type": "string" }, "slug": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "avatar", "created_at", "slug" ], "title": "CounterpartyTypeResource" }, "DadataAddressCollection": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/DadataAddressResource" } }, "addressesCount": { "type": "integer" } }, "required": [ "addresses", "addressesCount" ], "title": "DadataAddressCollection" }, "DadataAddressResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "value" ], "title": "DadataAddressResource" }, "DadataBankCollection": { "type": "object", "properties": { "banks": { "type": "array", "items": { "$ref": "#/components/schemas/DadataBankResource" } }, "banksCount": { "type": "integer" } }, "required": [ "banks", "banksCount" ], "title": "DadataBankCollection" }, "DadataBankResource": { "type": "object", "properties": { "name": { "type": "string" }, "bik": { "type": "string" }, "swift": { "type": "string" }, "kpp": { "type": "string" }, "correspondent_account": { "type": "string" }, "address": { "type": [ "string", "null" ] } }, "required": [ "name", "bik", "swift", "kpp", "correspondent_account", "address" ], "title": "DadataBankResource" }, "DadataCompanyCollection": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/components/schemas/DadataCompanyResource" } }, "companiesCount": { "type": "integer" } }, "required": [ "companies", "companiesCount" ], "title": "DadataCompanyCollection" }, "DadataCompanyResource": { "type": "object", "properties": { "name": { "type": "string" }, "inn": { "type": "string" }, "orgn": { "type": "string" }, "registration_date": { "type": "string" }, "legal_address": { "type": [ "string", "null" ] }, "kpp": { "type": [ "string", "null" ] }, "head": { "type": [ "string", "null" ] } }, "required": [ "name", "inn", "orgn", "registration_date", "legal_address", "kpp", "head" ], "title": "DadataCompanyResource" }, "DadataNomenclatureCollection": { "type": "object", "properties": { "nomenclatures": { "type": "array", "items": { "$ref": "#/components/schemas/DadataNomenclatureResource" } }, "nomenclaturesCount": { "type": "integer" } }, "required": [ "nomenclatures", "nomenclaturesCount" ], "title": "DadataNomenclatureCollection" }, "DadataNomenclatureResource": { "type": "object", "properties": { "name": { "type": "string" }, "number": { "type": "string" }, "name_ru": { "type": "string" }, "name_en": { "type": "string" }, "name_fr": { "type": "string" } }, "required": [ "name", "number", "name_ru", "name_en", "name_fr" ], "title": "DadataNomenclatureResource" }, "DeclineAgentAccessRequestRequest": { "type": "object", "properties": { "approval_token": { "type": "string", "maxLength": 255 } }, "required": [ "approval_token" ], "title": "DeclineAgentAccessRequestRequest" }, "DeliverySubtypeParamCollection": { "type": "object", "properties": { "deliverySubtypeParams": { "type": "array", "items": { "$ref": "#/components/schemas/DeliverySubtypeParamResource" } }, "deliverySubtypeParamsCount": { "type": "integer" } }, "required": [ "deliverySubtypeParams", "deliverySubtypeParamsCount" ], "title": "DeliverySubtypeParamCollection" }, "DeliverySubtypeParamResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "title": "DeliverySubtypeParamResource" }, "DeliveryTypeCollection": { "type": "object", "properties": { "deliveryTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryTypeResource" } }, "deliveryTypesCount": { "type": "integer" } }, "required": [ "deliveryTypes", "deliveryTypesCount" ], "title": "DeliveryTypeCollection" }, "DeliveryTypeResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "string" }, "is_active": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "price", "is_active", "created_at" ], "title": "DeliveryTypeResource" }, "DictionaryCollection": { "anyOf": [ { "type": "object", "properties": { "": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryResource" } }, "Count": { "type": "integer" } }, "required": [ null, "Count" ] }, { "type": "array", "items": [] } ], "title": "DictionaryCollection" }, "DictionaryResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "avatar", "created_at" ], "title": "DictionaryResource" }, "DiscountCollection": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountResource" } }, "discountsCount": { "anyOf": [ { "type": "string" }, { "type": "integer", "minimum": 0 } ] }, "pagination": { "type": [ "object", "null" ], "properties": { "current_page": { "type": "string" }, "per_page": { "type": "string" }, "last_page": { "type": "string" }, "total": { "type": "string" } }, "required": [ "current_page", "per_page", "last_page", "total" ] } }, "required": [ "discounts", "discountsCount", "pagination" ], "title": "DiscountCollection" }, "DiscountResource": { "type": "object", "properties": { "id": { "type": "integer" }, "project_id": { "type": "integer" }, "application_id": { "type": [ "integer", "null" ] }, "branch_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "effective_status": { "type": "string" }, "discount_type": { "type": "string" }, "discount_value": { "type": "number" }, "min_order_amount": { "type": "number" }, "max_discount_amount": { "type": [ "number", "null" ] }, "total_usage_limit": { "type": [ "integer", "null" ] }, "total_used_count": { "type": "integer" }, "per_client_usage_limit": { "type": [ "integer", "null" ] }, "usage_percent": { "type": "string" }, "audience": { "type": "string" }, "starts_at": { "type": [ "string", "null" ], "format": "date-time" }, "ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "url": { "type": [ "string", "null" ] }, "paused_at": { "type": [ "string", "null" ], "format": "date-time" }, "archived_at": { "type": [ "string", "null" ], "format": "date-time" }, "share_path": { "type": "string" }, "magic_link": { "type": "string" }, "created_by": { "type": [ "integer", "null" ] }, "updated_by": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "latest_usages": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountUsageResource" } } }, "required": [ "id", "project_id", "application_id", "branch_id", "name", "code", "description", "status", "effective_status", "discount_type", "discount_value", "min_order_amount", "max_discount_amount", "total_usage_limit", "total_used_count", "per_client_usage_limit", "usage_percent", "audience", "starts_at", "ends_at", "url", "paused_at", "archived_at", "share_path", "magic_link", "created_by", "updated_by", "created_at", "updated_at" ], "title": "DiscountResource" }, "DiscountUsageResource": { "type": "object", "properties": { "id": { "type": "integer" }, "discount_id": { "type": "integer" }, "order_id": { "type": [ "integer", "null" ] }, "counterparty_id": { "type": [ "integer", "null" ] }, "code": { "type": "string" }, "original_amount": { "type": "number" }, "product_discount_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "final_amount": { "type": "number" }, "status": { "type": "string" }, "used_at": { "type": "string", "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "discount_id", "order_id", "counterparty_id", "code", "original_amount", "product_discount_amount", "discount_amount", "final_amount", "status", "used_at", "created_at" ], "title": "DiscountUsageResource" }, "EventCollection": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/EventResource" } }, "eventsCount": { "type": "integer" } }, "required": [ "events", "eventsCount" ], "title": "EventCollection" }, "EventResource": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryResource" }, "price": { "type": [ "string", "null" ] }, "delivery_type": { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" }, "delivery_subtype": { "anyOf": [ { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.DeliveryType.DeliveryTypeResource" }, { "type": "null" } ] }, "delivery_subtype_param": { "anyOf": [ { "$ref": "#/components/schemas/DeliverySubtypeParamResource" }, { "type": "null" } ] }, "payment_type": { "anyOf": [ { "$ref": "#/components/schemas/PaymentTypeResource" }, { "type": "null" } ] }, "address": { "type": [ "string", "null" ] }, "shop": { "anyOf": [ { "$ref": "#/components/schemas/ShopResource" }, { "type": "null" } ] }, "payment_link": { "type": [ "string", "null" ], "description": "'products' => new OrderNomenclatureCollection($this->nomenclatures)," }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "price", "delivery_type", "delivery_subtype", "delivery_subtype_param", "payment_type", "address", "shop", "payment_link", "created_at" ], "title": "EventResource" }, "ExchangeCallbackAuthRequest": { "type": "object", "properties": { "session_token": { "type": "string", "maxLength": 128 }, "client_nonce": { "type": "string", "pattern": "^[A-Za-z0-9\\-_]+$", "minLength": 32, "maxLength": 128 }, "device": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "session_token", "client_nonce" ], "title": "ExchangeCallbackAuthRequest" }, "FileCollection": { "anyOf": [ { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileResource" } }, "filesCount": { "type": "integer" } }, "required": [ "files", "filesCount" ] }, { "type": "array", "items": [] } ], "title": "FileCollection" }, "FileResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DictionaryResource" }, "path": { "type": "string" }, "link": { "type": [ "string", "null" ] }, "order": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "type", "path", "link", "created_at", "updated_at" ], "title": "FileResource" }, "GuestPaymentStatusRequest": { "type": "object", "properties": { "resume_token": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "resume_token" ], "title": "GuestPaymentStatusRequest" }, "HistoryCollection": { "type": "object", "properties": { "histories": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryResource" } }, "historiesCount": { "type": "integer" } }, "required": [ "histories", "historiesCount" ], "title": "HistoryCollection" }, "HistoryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "icon": { "type": "string", "const": "check" }, "color": { "type": "string", "const": "primary" }, "title": { "type": "string" }, "description": { "type": "string" }, "datetime": { "type": "string" } }, "required": [ "id", "icon", "color", "title", "description", "datetime" ], "title": "HistoryResource" }, "ImportInventoryRequest": { "type": "object", "properties": { "warehouse_id": { "type": "integer" }, "file": { "type": "string", "format": "binary", "contentMediaType": "application/octet-stream" }, "items": { "type": "array", "items": { "type": "object", "properties": { "row_number": { "type": "number" }, "item_name": { "type": "string" }, "quantity": { "type": "number" }, "price": { "type": "number" }, "sum_without_vat": { "type": "number" }, "sum_with_vat": { "type": "number" }, "vat_rate": { "type": "string" }, "vat_amount": { "type": [ "number", "null" ] }, "sku": { "type": [ "string", "null" ] }, "barcode": { "type": [ "string", "null" ] } } }, "minItems": 1 }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "supplier_inn": { "type": "string" }, "supplier_name": { "type": "string" }, "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": [ "warehouse_id" ], "title": "ImportInventoryRequest" }, "InitCallbackAuthRequest": { "type": "object", "properties": { "phone": { "type": "string", "pattern": "^7\\d{10}$" }, "client_nonce": { "type": "string", "description": "\u041a\u043b\u0438\u0435\u043d\u0442\u0441\u043a\u0438\u0439 \u0441\u0435\u043a\u0440\u0435\u0442-\u0438\u0434\u0435\u043d\u0442\u0438\u0444\u0438\u043a\u0430\u0442\u043e\u0440 \u043f\u043e\u043f\u044b\u0442\u043a\u0438 \u0432\u0445\u043e\u0434\u0430. \u041d\u0435 \u043c\u0435\u043d\u0435\u0435 32 \u0441\u0438\u043c\u0432\u043e\u043b\u043e\u0432\n(>= ~192 \u0431\u0438\u0442 \u044d\u043d\u0442\u0440\u043e\u043f\u0438\u0438 \u0432 base64url). \u0421\u0435\u0440\u0432\u0435\u0440 \u0445\u0440\u0430\u043d\u0438\u0442 \u0442\u043e\u043b\u044c\u043a\u043e HMAC(nonce)\n\u0438 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442 \u0435\u0433\u043e \u043a\u0430\u043a \u0435\u0434\u0438\u043d\u0441\u0442\u0432\u0435\u043d\u043d\u043e\u0435 \u0434\u043e\u043a\u0430\u0437\u0430\u0442\u0435\u043b\u044c\u0441\u0442\u0432\u043e \u0442\u043e\u0433\u043e, \u0447\u0442\u043e status/exchange\n\u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442 \u0432\u043b\u0430\u0434\u0435\u043b\u0435\u0446 \u0431\u0440\u0430\u0443\u0437\u0435\u0440\u0430, \u0438\u043d\u0438\u0446\u0438\u0438\u0440\u043e\u0432\u0430\u0432\u0448\u0438\u0439 init.", "pattern": "^[A-Za-z0-9\\-_]+$", "minLength": 32, "maxLength": 128 } }, "required": [ "phone", "client_nonce" ], "title": "InitCallbackAuthRequest" }, "IntegrationCollection": { "type": "object", "properties": { "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationResource" } }, "integrationsCount": { "type": "integer" } }, "required": [ "integrations", "integrationsCount" ], "title": "IntegrationCollection" }, "IntegrationParameterCollection": { "anyOf": [ { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationParameterResource" } }, "parametersCount": { "type": "integer" } }, "required": [ "parameters", "parametersCount" ] }, { "type": "array", "items": [] } ], "title": "IntegrationParameterCollection" }, "IntegrationParameterResource": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "order": { "type": "integer" }, "key_1": { "type": "string" }, "key_2": { "type": [ "string", "null" ] }, "description_1": { "type": [ "string", "null" ] }, "description_2": { "type": [ "string", "null" ] } }, "required": [ "id", "title", "order", "key_1", "key_2", "description_1", "description_2" ], "title": "IntegrationParameterResource" }, "IntegrationResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "params": { "$ref": "#/components/schemas/IntegrationParameterCollection" } }, "required": [ "id", "name", "avatar", "params" ], "title": "IntegrationResource" }, "InventoryCollection": { "type": "object", "properties": { "inventories": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryResource" } }, "inventoriesCount": { "type": "integer" } }, "required": [ "inventories", "inventoriesCount" ], "title": "InventoryCollection" }, "InventoryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "avatar": { "$ref": "#/components/schemas/FileResource" }, "nomenclature": { "$ref": "#/components/schemas/NomenclatureResource" }, "warehouse": { "$ref": "#/components/schemas/WarehouseResource" }, "counterparty": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "inn": { "type": [ "string", "null" ] }, "type_id": { "type": "integer" } }, "required": [ "id", "name", "inn", "type_id" ] }, "quantity": { "type": "string" }, "price": { "type": "string" }, "discount": { "type": [ "integer", "null" ] }, "vat": { "$ref": "#/components/schemas/DictionaryResource" }, "markup": { "type": "string" }, "invoice": { "type": "object", "properties": { "number": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] }, "row_number": { "type": [ "integer", "null" ] } }, "required": [ "number", "date", "row_number" ] }, "line_total_without_vat": { "type": [ "string", "null" ] }, "line_total_with_vat": { "type": [ "string", "null" ] }, "vat_amount": { "type": [ "string", "null" ] }, "vat_rate": { "type": [ "string", "null" ] }, "currency_code": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "code", "avatar", "nomenclature", "warehouse", "counterparty", "quantity", "price", "discount", "vat", "markup", "invoice", "line_total_without_vat", "line_total_with_vat", "vat_amount", "vat_rate", "currency_code", "created_at", "updated_at" ], "title": "InventoryResource" }, "LoginRequest": { "type": "object", "properties": { "phone": { "type": "number" }, "password": { "type": "string" }, "device": { "type": "string", "minLength": 3, "maxLength": 50 } }, "required": [ "phone", "password" ], "title": "LoginRequest" }, "LogoutRequest": { "type": "object", "properties": { "from_all_devices": { "type": "boolean" } }, "required": [ "from_all_devices" ], "title": "LogoutRequest" }, "ManagerCollection": { "type": "object", "properties": { "": { "type": "array", "items": { "$ref": "#/components/schemas/ManagerResource" } }, "Count": { "type": "integer" } }, "required": [ null, "Count" ], "title": "ManagerCollection" }, "ManagerResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "title": "ManagerResource" }, "MenuItemCollection": { "anyOf": [ { "type": "object", "properties": { "menuItems": { "type": "array", "items": { "$ref": "#/components/schemas/MenuItemResource" } }, "menuItemsCount": { "type": "integer" } }, "required": [ "menuItems", "menuItemsCount" ] }, { "type": "array", "items": [] } ], "title": "MenuItemCollection" }, "MenuItemResource": { "type": "object", "properties": { "id": { "type": "integer" }, "avatar": { "type": "string", "description": "'menu_id' => $this->menu_id,\n'parent_id' => $this->parent_id," }, "name": { "type": "string" }, "url": { "type": [ "string", "null" ] }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/MenuItemResource" } } }, "required": [ "id", "avatar", "name", "url", "children" ], "title": "MenuItemResource" }, "ModelIntegrationCollection": { "type": "object", "properties": { "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/ModelIntegrationResource" } }, "integrationsCount": { "type": "integer" } }, "required": [ "integrations", "integrationsCount" ], "title": "ModelIntegrationCollection" }, "ModelIntegrationParameterCollection": { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ModelIntegrationParameterResource" } }, "parametersCount": { "type": "integer" } }, "required": [ "parameters", "parametersCount" ], "title": "ModelIntegrationParameterCollection" }, "ModelIntegrationParameterResource": { "type": "object", "properties": { "id": { "type": "string" }, "key_1": { "type": "string" }, "description_1": { "type": "string" }, "key_2": { "type": "string" }, "description_2": { "type": "string" }, "value_1": { "type": [ "string", "null" ] }, "value_2": { "type": [ "string", "null" ] }, "has_value_1": { "type": "string" }, "has_value_2": { "type": "string" } }, "required": [ "id", "key_1", "description_1", "key_2", "description_2", "value_1", "value_2", "has_value_1", "has_value_2" ], "title": "ModelIntegrationParameterResource" }, "ModelIntegrationResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "integration_id": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "is_active": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "parameters": { "$ref": "#/components/schemas/IntegrationParameterCollection" }, "values": { "type": "array", "items": [] } }, "required": [ "id", "integration_id", "name", "avatar", "is_active", "parameters", "values" ] }, { "type": "array", "items": [] } ], "title": "ModelIntegrationResource" }, "NewAccessToken": { "type": "object", "additionalProperties": { "type": "string" }, "title": "NewAccessToken" }, "NomenclatureCollection": { "type": "object", "properties": { "nomenclatures": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NomenclatureResource" } }, "first_page_url": { "type": [ "string", "null" ] }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page_url": { "type": [ "string", "null" ] }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "next_page_url": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "prev_page_url": { "type": [ "string", "null" ] }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "data", "first_page_url", "from", "last_page_url", "last_page", "links", "next_page_url", "path", "per_page", "prev_page_url", "to", "total" ] } }, "required": [ "nomenclatures" ], "title": "NomenclatureCollection" }, "NomenclatureCompositionCollection": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/NomenclatureCompositionResource" }, { "type": "object", "required": [ "component" ] } ] }, "title": "NomenclatureCompositionCollection" }, "NomenclatureCompositionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "component_nomenclature_id": { "type": "integer" }, "component": { "type": "object", "description": "\u041c\u0438\u043d\u0438\u043c\u0430\u043b\u044c\u043d\u043e\u0435 \u043f\u0440\u0435\u0434\u0441\u0442\u0430\u0432\u043b\u0435\u043d\u0438\u0435 \u043a\u043e\u043c\u043f\u043e\u043d\u0435\u043d\u0442\u0430 (\u0431\u0435\u0437 \u043f\u043e\u043b\u043d\u043e\u0433\u043e NomenclatureResource):\nid/name/code/storage_unit_id/pieces_per_pack \u2014 \u044d\u0442\u043e\u0433\u043e \u0445\u0432\u0430\u0442\u0430\u0435\u0442 \u043a\u0430\u043b\u044c\u043a\u0443\u043b\u044f\u0442\u043e\u0440\u0443 \u0438 UI.", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": [ "string", "null" ] }, "storage_unit_id": { "type": [ "integer", "null" ] }, "pieces_per_pack": { "type": "integer" } }, "required": [ "id", "name", "code", "storage_unit_id", "pieces_per_pack" ] }, "consumption_rate": { "type": "string" }, "scaling_kind": { "type": "string" }, "base_thickness": { "type": [ "string", "null" ] }, "sort_order": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "component_nomenclature_id", "consumption_rate", "scaling_kind", "base_thickness", "sort_order", "created_at", "updated_at" ], "title": "NomenclatureCompositionResource" }, "NomenclatureResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "preview": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "description": { "type": [ "string", "null" ] }, "category": { "anyOf": [ { "$ref": "#/components/schemas/CategoryResource" }, { "type": "null" } ] }, "specification": { "type": [ "string", "null" ] }, "country": { "$ref": "#/components/schemas/DictionaryResource" }, "type": { "$ref": "#/components/schemas/DictionaryResource" }, "kind": { "$ref": "#/components/schemas/DictionaryResource" }, "branch": { "$ref": "#/components/schemas/BranchResource" }, "tags": { "$ref": "#/components/schemas/DictionaryCollection" }, "photos": { "$ref": "#/components/schemas/FileCollection" }, "unit": { "anyOf": [ { "$ref": "#/components/schemas/StorageUnitResource" }, { "type": "null" } ] }, "brand": { "$ref": "#/components/schemas/DictionaryResource" }, "price": { "type": "string" }, "cost_price": { "type": [ "string", "null" ] }, "discount": { "type": [ "integer", "null" ] }, "pieces_per_pack": { "type": "integer" }, "vat": { "$ref": "#/components/schemas/DictionaryResource" }, "markup": { "type": "string" }, "is_subscription": { "type": "boolean" }, "billing_period_months": { "type": [ "integer", "null" ] }, "parent_nomenclature_id": { "type": [ "integer", "null" ] }, "variant_label": { "type": [ "string", "null" ] }, "variant_sort_order": { "type": "integer" }, "compositions": { "type": "array", "description": "\u0422\u043e\u043b\u044c\u043a\u043e whenLoaded: \u043d\u0435 \u043f\u043b\u043e\u0434\u0438\u043c N+1 \u0438 \u043d\u0435 \u043c\u0435\u043d\u044f\u0435\u043c \u043a\u043e\u043d\u0442\u0440\u0430\u043a\u0442 \u043a\u0430\u0440\u0442\u043e\u0447\u043a\u0438 \u0434\u043b\u044f material/product.\nEager-load \u0434\u0435\u043b\u0430\u0435\u0442\u0441\u044f \u0442\u043e\u0447\u0435\u0447\u043d\u043e \u0442\u0430\u043c, \u0433\u0434\u0435 \u043d\u0443\u0436\u0435\u043d \u0441\u043e\u0441\u0442\u0430\u0432 (\u0441\u043c. NomenclatureCompositionController, calculate).", "items": { "$ref": "#/components/schemas/NomenclatureCompositionResource" } }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "code", "name", "avatar", "preview", "description", "category", "specification", "country", "type", "kind", "branch", "tags", "photos", "unit", "brand", "price", "cost_price", "discount", "pieces_per_pack", "vat", "markup", "is_subscription", "billing_period_months", "parent_nomenclature_id", "variant_label", "variant_sort_order", "created_at", "updated_at" ], "title": "NomenclatureResource" }, "NotificationCollection": { "type": "object", "properties": { "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResource" } }, "pagination": { "type": "object", "properties": { "total": { "type": "string" }, "per_page": { "type": "string" }, "current_page": { "type": "string" }, "last_page": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "total", "per_page", "current_page", "last_page", "from", "to" ] } }, "required": [ "notifications", "pagination" ], "title": "NotificationCollection" }, "NotificationResource": { "type": "object", "properties": { "id": { "type": "string" }, "icon": { "type": "null" }, "title": { "type": "string" }, "status": { "type": "string" }, "body": { "type": "string" }, "action_url": { "type": "string" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "icon", "title", "status", "body", "action_url", "created_at" ], "title": "NotificationResource" }, "OrderCollection": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Order.OrderResource" } }, "ordersCount": { "type": "integer" } }, "required": [ "orders", "ordersCount" ], "title": "OrderCollection" }, "OrderHistoryCollection": { "type": "object", "properties": { "histories": { "type": "array", "items": { "$ref": "#/components/schemas/OrderHistoryResource" } }, "historiesCount": { "type": "integer" } }, "required": [ "histories", "historiesCount" ], "title": "OrderHistoryCollection" }, "OrderHistoryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "icon": { "type": "string", "const": "payment" }, "color": { "type": "string", "const": "primary" }, "title": { "type": "string" }, "description": { "type": "string" }, "datetime": { "type": "string" } }, "required": [ "id", "icon", "color", "title", "description", "datetime" ], "title": "OrderHistoryResource" }, "OrderNomenclatureCollection": { "type": "array", "items": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.WarehouseProduct.OrderNomenclatureResource" }, "title": "OrderNomenclatureCollection" }, "OrderNomenclatureResource": { "type": "object", "properties": { "id": { "type": "integer" }, "warehouseNomenclature": { "type": "object", "properties": { "id": { "type": "string" }, "avatar": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "id", "avatar", "name" ] }, "quantity": { "type": "integer" }, "unit": { "$ref": "#/components/schemas/DictionaryResource" }, "price": { "type": "string" }, "vat": { "$ref": "#/components/schemas/DictionaryResource" }, "amount": { "type": "string" } }, "required": [ "id", "warehouseNomenclature", "quantity", "unit", "price", "vat", "amount" ], "title": "OrderNomenclatureResource" }, "OrderResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "price": { "type": [ "string", "null" ] }, "final_price": { "type": [ "string", "null" ] }, "status": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "application": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "branch": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "required": [ "id", "name", "created_at", "price", "final_price", "status", "application", "branch" ], "title": "OrderResource" }, "PageCollection": { "type": "object", "properties": { "pages": { "type": "array", "items": { "$ref": "#/components/schemas/PageResource" } }, "pagesCount": { "type": "integer" } }, "required": [ "pages", "pagesCount" ], "title": "PageCollection" }, "PageResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "string", "null" ] }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "is_page": { "type": "boolean" }, "views_count": { "type": "integer" }, "type": { "$ref": "#/components/schemas/DictionaryResource" }, "creator": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "slug": { "type": "string" }, "title": { "type": "string" }, "meta_title": { "type": [ "string", "null" ] }, "preview": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "description": { "type": [ "string", "null" ] }, "meta_description": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "application": { "$ref": "#/components/schemas/DictionaryResource" }, "tags": { "$ref": "#/components/schemas/DictionaryCollection" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "code", "avatar", "is_page", "views_count", "type", "creator", "slug", "title", "meta_title", "preview", "description", "meta_description", "content", "application", "tags", "created_at" ], "title": "PageResource" }, "PasswordRequest": { "type": "object", "properties": { "phone": { "type": "string", "maxLength": 255 } }, "required": [ "phone" ], "title": "PasswordRequest" }, "PaymentTypeCollection": { "type": "object", "properties": { "paymentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTypeResource" } }, "paymentTypesCount": { "type": "integer" } }, "required": [ "paymentTypes", "paymentTypesCount" ], "title": "PaymentTypeCollection" }, "PaymentTypeResource": { "type": "object", "properties": { "id": { "type": "integer" }, "photo": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "photo", "name", "description" ], "title": "PaymentTypeResource" }, "PermissionCollection": { "anyOf": [ { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionResource" } }, "permissionsCount": { "type": "integer" } }, "required": [ "permissions", "permissionsCount" ] }, { "type": "array", "items": [] } ], "title": "PermissionCollection" }, "PermissionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "screen": { "$ref": "#/components/schemas/DictionaryResource" }, "name": { "type": "string" }, "description": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "screen", "name", "description", "created_at" ], "title": "PermissionResource" }, "PrecalculateRequest": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "quantity": { "type": "integer", "minimum": 1 } }, "required": [ "id", "quantity" ] }, "minItems": 1 }, "promo_code": { "type": [ "string", "null" ], "pattern": "^[A-Za-z0-9\\-]+$", "maxLength": 64 } }, "required": [ "products" ], "title": "PrecalculateRequest" }, "ProductResource": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_nomenclature_id": { "type": [ "integer", "null" ] }, "variant_label": { "type": [ "string", "null" ] }, "variant_sort_order": { "type": "integer" }, "variants": { "type": "string" }, "views_count": { "type": "integer" }, "photo": { "type": "string" }, "photos": { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.FileCollection" }, "name": { "type": "string" }, "brand": { "anyOf": [ { "$ref": "#/components/schemas/App.Http.Resources.Counterparties.DictionaryResource" }, { "type": "object", "properties": { "id": { "type": "integer", "const": 1 }, "name": { "type": "string", "const": "-" } }, "required": [ "id", "name" ] } ] }, "description": { "type": [ "string", "null" ] }, "specification": { "type": [ "string", "null" ] }, "old_price": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "discount": { "type": "integer" }, "quantity": { "type": "integer" }, "unit": { "type": [ "string", "null" ] }, "is_favourite": { "type": "boolean" }, "share_link": { "type": "null" }, "tags": { "$ref": "#/components/schemas/DictionaryCollection" }, "parameters": { "type": "object", "properties": { "wholesale": { "type": "boolean" }, "pieces_per_pack": { "type": [ "object", "null" ] }, "quantity_pack": { "type": "integer" } }, "required": [ "wholesale", "pieces_per_pack", "quantity_pack" ] } }, "required": [ "id", "parent_nomenclature_id", "variant_label", "variant_sort_order", "variants", "views_count", "photo", "photos", "name", "brand", "description", "specification", "old_price", "price", "discount", "quantity", "unit", "is_favourite", "share_link", "tags", "parameters" ], "title": "ProductResource" }, "RedeemTicketRequest": { "type": "object", "properties": { "token": { "type": "string", "minLength": 32, "maxLength": 32 } }, "required": [ "token" ], "title": "RedeemTicketRequest" }, "RepairEstimateOrderResource": { "type": "object", "properties": { "order": { "type": "object", "properties": { "id": { "type": "integer" }, "status_id": { "type": "integer" }, "status": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "original_price": { "type": [ "string", "null" ] }, "final_price": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status_id", "status", "price", "original_price", "final_price", "created_at", "updated_at" ] }, "estimate": { "type": "object", "properties": { "order_id": { "type": "integer" }, "status": { "type": "string" }, "calculator_version": { "type": "string" }, "totals": { "type": "object", "properties": { "works_total": { "type": "string" }, "materials_total": { "type": "string" }, "total": { "type": "string" } }, "required": [ "works_total", "materials_total", "total" ] }, "input": { "type": "array", "items": [] }, "result": { "type": "array", "items": [] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "order_id", "status", "calculator_version", "totals", "input", "result", "created_at", "updated_at" ] } }, "required": [ "order", "estimate" ], "title": "RepairEstimateOrderResource" }, "RequestPhoneNumberChangeRequest": { "type": "object", "properties": { "new_phone_number": { "type": "string" } }, "required": [ "new_phone_number" ], "title": "RequestPhoneNumberChangeRequest" }, "RequestRefundRequest": { "type": "object", "properties": { "comment": { "type": [ "string", "null" ], "maxLength": 2000 } }, "title": "RequestRefundRequest" }, "ResumeSubscriptionRequest": { "type": "object", "properties": { "autopay_consent": { "enum": [ "yes", "on", "1", 1, "true", true ] } }, "required": [ "autopay_consent" ], "title": "ResumeSubscriptionRequest" }, "ReviewAgentAccessRequestRequest": { "type": "object", "properties": { "approval_token": { "type": "string", "maxLength": 255 } }, "required": [ "approval_token" ], "title": "ReviewAgentAccessRequestRequest" }, "RoleCollection": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleResource" } }, "rolesCount": { "type": "integer" } }, "required": [ "roles", "rolesCount" ], "title": "RoleCollection" }, "RoleResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "description": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "avatar", "description", "created_at" ], "title": "RoleResource" }, "SavedPaymentMethodResource": { "type": "object", "properties": { "id": { "type": "integer" }, "payment_method_type": { "type": [ "string", "null" ] }, "card_type": { "type": [ "string", "null" ] }, "card_last_4": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "is_active": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "payment_method_type", "card_type", "card_last_4", "title", "is_active", "created_at" ], "title": "SavedPaymentMethodResource" }, "ScreenCollection": { "type": "object", "properties": { "screens": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenResource" } }, "screensCount": { "type": "integer" } }, "required": [ "screens", "screensCount" ], "title": "ScreenCollection" }, "ScreenResource": { "type": "object", "properties": { "id": { "type": "integer" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "name": { "type": "string" }, "permissions": { "$ref": "#/components/schemas/PermissionCollection" } }, "required": [ "id", "avatar", "name", "permissions" ], "title": "ScreenResource" }, "SearchHistoryCollection": { "type": "object", "properties": { "searchRequests": { "type": "array", "items": { "$ref": "#/components/schemas/SearchHistoryResource" } }, "searchRequestsCount": { "type": "integer" } }, "required": [ "searchRequests", "searchRequestsCount" ], "title": "SearchHistoryCollection" }, "SearchHistoryResource": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "value", "created_at" ], "title": "SearchHistoryResource" }, "SearchRequest": { "type": "object", "properties": { "query": { "type": "string", "minLength": 3, "maxLength": 1024 }, "field": { "type": "string", "enum": [ "name", "inn", "ogrn" ] } }, "title": "SearchRequest" }, "ServerChangeSubscriptionRequest": { "type": "object", "properties": { "audience": { "type": "string", "maxLength": 64 }, "principal_handle": { "type": "string", "format": "uuid" }, "counterparty_id": { "type": "string" }, "plan_slug": { "type": "string", "maxLength": 255 }, "nomenclature_id": { "type": "integer", "minimum": 1 }, "autopay_consent": { "type": "string", "enum": [ "0", "1", "false", "true", "off", "on", "no", "yes" ] }, "payment_method_type": { "type": "string", "enum": [ "bank_card", "sbp" ] } }, "required": [ "audience", "principal_handle" ], "title": "ServerChangeSubscriptionRequest" }, "ServerResolveCurrentSubscriptionRequest": { "type": "object", "properties": { "audience": { "type": "string", "maxLength": 64 }, "principal_handle": { "type": "string", "format": "uuid" }, "counterparty_id": { "type": "string" }, "plan_slug": { "type": "string" }, "nomenclature_id": { "type": "string" }, "autopay_consent": { "type": "string" } }, "required": [ "audience", "principal_handle" ], "title": "ServerResolveCurrentSubscriptionRequest" }, "SettingCollection": { "type": "object", "properties": { "settings": { "type": "array", "items": { "$ref": "#/components/schemas/SettingResource" } }, "settingsCount": { "type": "integer" } }, "required": [ "settings", "settingsCount" ], "title": "SettingCollection" }, "SettingResource": { "type": "object", "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "key", "value" ], "title": "SettingResource" }, "ShopCollection": { "type": "object", "properties": { "shops": { "type": "array", "items": { "$ref": "#/components/schemas/ShopResource" } }, "shopsCount": { "type": "integer" } }, "required": [ "shops", "shopsCount" ], "title": "ShopCollection" }, "ShopExceptionCollection": { "type": "object", "properties": { "exceptions": { "type": "array", "items": { "$ref": "#/components/schemas/ShopExceptionResource" } }, "exceptionsCount": { "type": "integer" } }, "required": [ "exceptions", "exceptionsCount" ], "title": "ShopExceptionCollection" }, "ShopExceptionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "exception_start_date": { "type": "string" }, "exception_end_date": { "type": "string" } }, "required": [ "id", "exception_start_date", "exception_end_date" ], "title": "ShopExceptionResource" }, "ShopHolidayResource": { "type": "object", "properties": { "work_start_time": { "type": [ "string", "null" ] }, "work_end_time": { "type": [ "string", "null" ] }, "break_start_time": { "type": [ "string", "null" ] }, "break_end_time": { "type": [ "string", "null" ] } }, "required": [ "work_start_time", "work_end_time", "break_start_time", "break_end_time" ], "title": "ShopHolidayResource" }, "ShopHourCollection": { "type": "object", "properties": { "hours": { "type": "array", "items": { "$ref": "#/components/schemas/ShopHourResource" } }, "hoursCount": { "type": "integer" } }, "required": [ "hours", "hoursCount" ], "title": "ShopHourCollection" }, "ShopHourResource": { "type": "object", "properties": { "id": { "type": "integer" }, "day_of_week": { "type": "string" }, "is_working_day": { "type": "boolean" }, "work_start_time": { "type": "string" }, "work_end_time": { "type": "string" }, "break_start_time": { "type": [ "string", "null" ] }, "break_end_time": { "type": [ "string", "null" ] } }, "required": [ "id", "day_of_week", "is_working_day", "work_start_time", "work_end_time", "break_start_time", "break_end_time" ], "title": "ShopHourResource" }, "ShopResource": { "type": "object", "properties": { "id": { "type": "integer" }, "photo": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "name": { "type": "string" }, "address": { "type": [ "string", "null" ] }, "latitude": { "type": [ "string", "null" ] }, "longitude": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "schedule": { "type": [ "string", "null" ] } }, "required": [ "id", "photo", "name", "address", "latitude", "longitude", "phone", "schedule" ], "title": "ShopResource" }, "ShortProductCollection": { "anyOf": [ { "type": "object", "properties": { "products": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "data": { "type": "array", "items": { "type": "string" } }, "first_page_url": { "type": [ "string", "null" ] }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page_url": { "type": [ "string", "null" ] }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "next_page_url": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "prev_page_url": { "type": [ "string", "null" ] }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "data", "first_page_url", "from", "last_page_url", "last_page", "links", "next_page_url", "path", "per_page", "prev_page_url", "to", "total" ] } }, "required": [ "products" ] }, { "type": "array", "items": [] } ], "title": "ShortProductCollection" }, "SlideCollection": { "type": "object", "properties": { "slides": { "type": "array", "items": { "$ref": "#/components/schemas/SlideResource" } }, "slidesCount": { "type": "integer" } }, "required": [ "slides", "slidesCount" ], "title": "SlideCollection" }, "SlideResource": { "type": "object", "properties": { "id": { "type": "integer" }, "photo": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] } }, "required": [ "id", "photo", "name", "description", "link" ], "title": "SlideResource" }, "StatusAgentAccessRequestRequest": { "type": "object", "properties": { "request_token": { "type": "string", "maxLength": 255 } }, "required": [ "request_token" ], "title": "StatusAgentAccessRequestRequest" }, "StatusCallbackAuthRequest": { "type": "object", "properties": { "session_token": { "type": "string", "maxLength": 128 }, "client_nonce": { "type": "string", "pattern": "^[A-Za-z0-9\\-_]+$", "minLength": 32, "maxLength": 128 } }, "required": [ "session_token", "client_nonce" ], "title": "StatusCallbackAuthRequest" }, "StorageUnitCollection": { "type": "object", "properties": { "units": { "type": "array", "items": { "$ref": "#/components/schemas/StorageUnitResource" } }, "unitsCount": { "type": "integer" } }, "required": [ "units", "unitsCount" ], "title": "StorageUnitCollection" }, "StorageUnitResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "abbreviation": { "type": "string" } }, "required": [ "id", "name", "abbreviation" ], "title": "StorageUnitResource" }, "StoreAgentAccessRequestRequest": { "type": "object", "properties": { "owner_email": { "type": "string", "format": "email", "maxLength": 255 }, "agent_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "agent_login": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 255 }, "permissions": { "type": [ "array", "null" ], "items": { "type": "string" }, "maxItems": 100, "uniqueItems": true }, "purpose": { "type": [ "string", "null" ], "maxLength": 5000 } }, "required": [ "owner_email", "agent_name" ], "title": "StoreAgentAccessRequestRequest" }, "StoreOrderRequest": { "type": "object", "properties": { "apartment_type": { "type": "string", "enum": [ "studio", "1room", "2room", "3room", "4room" ] }, "total_area": { "type": "number", "maximum": 10000 }, "ceiling_height": { "type": "number", "maximum": 20 }, "bathroom": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "combined", "separate" ] }, "primary_area": { "type": "number", "maximum": 1000 }, "secondary_area": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "type", "primary_area" ] }, "selected_works": { "type": "array", "items": { "type": "object", "properties": { "composition_id": { "type": "integer" }, "quantity_source": { "type": "string", "enum": [ "total_wall_area", "living_floor", "ceiling_area", "bathroom_wall_area", "bathroom_floor_area", "skirting_perimeter" ] }, "thickness": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "composition_id", "quantity_source" ] }, "minItems": 1, "maxItems": 100 }, "selected_options": { "type": [ "array", "null" ], "items": { "type": "string" } }, "client_session_id": { "type": "string", "pattern": "^[A-Za-z0-9._:-]+$", "minLength": 8, "maxLength": 128 } }, "required": [ "apartment_type", "total_area", "ceiling_height", "bathroom", "selected_works", "client_session_id" ], "title": "StoreOrderRequest" }, "StoreRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "login": { "type": "string", "minLength": 3, "maxLength": 255 }, "role_id": { "type": "integer" }, "branch_id": { "type": [ "integer", "null" ] }, "department_id": { "type": [ "integer", "null" ] }, "permissions": { "type": [ "array", "null" ], "items": { "type": "string" } }, "agent_description": { "type": [ "string", "null" ], "maxLength": 5000 }, "is_banned": { "type": [ "boolean", "null" ] } }, "required": [ "name", "login", "role_id" ], "title": "StoreRequest" }, "StoreShopExceptionRequest": { "type": "object", "properties": { "exception_start_date": { "type": "string", "format": "date-time" }, "exception_end_date": { "type": "string", "format": "date-time" } }, "required": [ "exception_start_date", "exception_end_date" ], "title": "StoreShopExceptionRequest" }, "StoreShopHourRequest": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "\u041f\u041d", "\u0412\u0422", "\u0421\u0420", "\u0427\u0422", "\u041f\u0422", "\u0421\u0411", "\u0412\u0421" ] }, "is_working_day": { "type": "boolean" }, "work_start_time": { "type": [ "string", "null" ] }, "work_end_time": { "type": [ "string", "null" ] }, "break_start_time": { "type": [ "string", "null" ] }, "break_end_time": { "type": [ "string", "null" ] } }, "required": [ "day_of_week", "is_working_day" ], "title": "StoreShopHourRequest" }, "StoreSubscriptionRequest": { "type": "object", "properties": { "nomenclature_id": { "type": [ "integer", "null" ] }, "plan_slug": { "type": [ "string", "null" ] }, "saved_payment_method_id": { "type": "integer" }, "autopay_consent": { "enum": [ "yes", "on", "1", 1, "true", true ] } }, "required": [ "saved_payment_method_id", "autopay_consent" ], "title": "StoreSubscriptionRequest" }, "StoreTokenRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 100 }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "name" ], "title": "StoreTokenRequest" }, "SubscriptionCatalogResource": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "string" }, "currency": { "type": "string", "const": "RUB" }, "billing_period_months": { "type": "string" }, "avatar_url": { "type": [ "string", "null" ] } }, "required": [ "id", "slug", "name", "description", "price", "currency", "billing_period_months", "avatar_url" ], "title": "SubscriptionCatalogResource" }, "SubscriptionCollection": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/App.Http.Resources.Counterparty.Subscription.SubscriptionResource" }, { "type": "object", "required": [ "autopay_consent", "saved_payment_method", "latest_payment", "can_retry_payment", "retry_payment_reason", "latest_payment_method_change" ] } ] }, "title": "SubscriptionCollection" }, "SubscriptionPaymentResource": { "type": "object", "properties": { "id": { "type": "integer" }, "subscription_id": { "type": "integer" }, "order_id": { "type": [ "integer", "null" ] }, "nomenclature_id": { "type": [ "integer", "null" ] }, "amount": { "type": "string" }, "currency": { "type": "string" }, "status": { "type": "string" }, "period_start": { "type": [ "string", "null" ] }, "period_end": { "type": [ "string", "null" ] }, "billing_period_months": { "type": [ "integer", "null" ] }, "error_reason": { "type": [ "string", "null" ] }, "can_retry": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "subscription_id", "order_id", "nomenclature_id", "amount", "currency", "status", "period_start", "period_end", "billing_period_months", "error_reason", "can_retry", "created_at", "updated_at" ], "title": "SubscriptionPaymentResource" }, "SubscriptionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "plan_slug": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "billing_period_months": { "type": [ "integer", "null" ] }, "current_period_start": { "type": [ "string", "null" ], "format": "date-time" }, "current_period_end": { "type": [ "string", "null" ], "format": "date-time" }, "last_payment_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_payment_error": { "type": [ "string", "null" ] }, "next_charge_at": { "type": [ "string", "null" ], "format": "date-time" }, "canceled_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "counterparty": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "phone_1": { "type": [ "string", "null" ] }, "phone_2": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "phone_1", "phone_2" ] }, "application": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "nomenclature": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/OrderResource" } } }, "required": [ "id", "status", "plan_slug", "amount", "currency", "billing_period_months", "current_period_start", "current_period_end", "last_payment_at", "last_payment_error", "next_charge_at", "canceled_at", "created_at", "updated_at", "counterparty", "application", "nomenclature" ], "title": "SubscriptionResource" }, "SubscriptionTableCollection": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/TableColumn" } }, "subscriptions": { "type": "array", "items": [] }, "counters": { "type": "object", "additionalProperties": { "type": "integer" } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "from": { "type": [ "integer", "null" ] }, "to": { "type": [ "integer", "null" ] } }, "required": [ "total", "per_page", "current_page", "last_page", "from", "to" ] } }, "required": [ "columns", "subscriptions", "counters", "pagination" ], "title": "SubscriptionTableCollection" }, "SyncSubscriptionPaymentMethodChangeRequest": { "type": "object", "properties": { "autopay_consent": { "type": "string" }, "card": { "type": "string" }, "card_number": { "type": "string" }, "cvc": { "type": "string" }, "payment_method_data": { "type": "string" }, "return_url": { "type": "string" } }, "title": "SyncSubscriptionPaymentMethodChangeRequest" }, "TableCollection": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/TableColumn" } }, "": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "from": { "type": [ "integer", "null" ] }, "to": { "type": [ "integer", "null" ] } }, "required": [ "total", "per_page", "current_page", "last_page", "from", "to" ] } }, "required": [ "columns", null, "pagination" ], "title": "TableCollection" }, "TableColumn": { "type": "object", "properties": { "id": { "type": "integer" }, "table_id": { "type": "integer" }, "order": { "type": "integer" }, "key": { "type": "string" }, "has_icon": { "type": "integer" }, "text": { "type": "string" } }, "required": [ "id", "table_id", "order", "key", "has_icon", "text" ], "title": "TableColumn" }, "TaskCollection": { "type": "object", "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskResource" } }, "tasksCount": { "type": "integer" } }, "required": [ "tasks", "tasksCount" ], "title": "TaskCollection" }, "TaskResource": { "type": "object", "properties": { "id": { "type": "integer" }, "started_at": { "type": "string" }, "create_everyday": { "type": "integer" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "finished_at": { "type": "string" }, "duration": { "type": "string" }, "executor": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "creator": { "anyOf": [ { "$ref": "#/components/schemas/UserNameResource" }, { "type": "null" } ] }, "notifications": { "anyOf": [ { "$ref": "#/components/schemas/DictionaryCollection" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "object": { "type": [ "string", "null" ] }, "order": { "$ref": "#/components/schemas/App.Http.Resources.Order.OrderResource" }, "stage": { "$ref": "#/components/schemas/DictionaryResource" }, "progress": { "type": "integer", "enum": [ 0, 100, 50 ] }, "status": { "$ref": "#/components/schemas/DictionaryResource" } }, "required": [ "id", "started_at", "create_everyday", "name", "created_at", "finished_at", "duration", "executor", "creator", "notifications", "object", "order", "stage", "progress", "status" ], "title": "TaskResource" }, "TicketResource": { "type": "object", "properties": { "order_id": { "type": "string" }, "order_code": { "type": [ "string", "null" ] }, "is_paid": { "type": "string" }, "counterparty": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone_1": { "type": "string" }, "phone_2": { "type": "string" } }, "required": [ "id", "name", "email", "phone_1", "phone_2" ] }, "tariffs": { "type": "string" }, "used": { "type": "string" }, "total": { "type": "string" }, "remaining": { "type": "string" }, "last_redeemed_at": { "type": "string" }, "last_redeemed_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "recent_logs": { "type": "array", "items": { "type": "string" } }, "redeem_token": { "type": [ "string", "null" ], "description": "QR-\u0442\u043e\u043a\u0435\u043d \u0432 admin-payload. \u041f\u043e\u0434 `auth:user` (back-office\n\u0441\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a), \u043d\u0443\u0436\u0435\u043d \u0444\u0440\u043e\u043d\u0442\u0443 dasha_ai \u0434\u043b\u044f \u043f\u043e\u0432\u0442\u043e\u0440\u043d\u043e\u0439 \u043f\u0435\u0440\u0435\u0441\u044b\u043b\u043a\u0438 QR\n\u043a\u043b\u0438\u0435\u043d\u0442\u0443, \u0435\u0441\u043b\u0438 \u043e\u043d \u043f\u043e\u0442\u0435\u0440\u044f\u043b email \u043f\u043e\u0441\u043b\u0435 \u043e\u043f\u043b\u0430\u0442\u044b, \u0438 \u0434\u043b\u044f \u0433\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u0438\n\u043a\u0430\u0440\u0442\u0438\u043d\u043a\u0438 \u0432 \u043a\u0430\u0440\u0442\u043e\u0447\u043a\u0435 `/admin/tickets/:id` (Codex P2 \u043d\u0430 TK3). \u0412\u0441\u0435 4 \u043f\u043e\u0442\u0440\u0435\u0431\u0438\u0442\u0435\u043b\u044f \u0441\u0435\u0439\u0447\u0430\u0441 \u0437\u0430\u0449\u0438\u0449\u0435\u043d\u044b scope-check'\u043e\u043c \u0432 \u043a\u043e\u043d\u0442\u0440\u043e\u043b\u043b\u0435\u0440\u0435\n(`lookup`/`redeem` \u2014 \u0441\u0435\u043a\u0440\u0435\u0442\u043d\u043e\u0441\u0442\u044c\u044e \u0441\u0430\u043c\u043e\u0433\u043e \u0442\u043e\u043a\u0435\u043d\u0430; `lookupByOrder`\n\u0438 `unredeem` \u2014 \u044f\u0432\u043d\u044b\u043c `canSeeOrder`). \u042d\u0442\u043e\u0442 conditional \u2014\n*defensive belt-and-suspenders \u043d\u0430 \u0431\u0443\u0434\u0443\u0449\u0435\u0435**: \u0435\u0441\u043b\u0438 \u043a\u0442\u043e-\u0442\u043e\n\u0434\u043e\u0431\u0430\u0432\u0438\u0442 \u043d\u043e\u0432\u044b\u0439 endpoint \u0438 \u0437\u0430\u0431\u0443\u0434\u0435\u0442 scope-check, `redeem_token`\n\u043d\u0435 \u0443\u0442\u0435\u0447\u0451\u0442 \u0447\u0435\u0440\u0435\u0437 Resource \u0431\u0435\u0437 \u0430\u043a\u0442\u0443\u0430\u043b\u044c\u043d\u043e\u0433\u043e user-\u043a\u043e\u043d\u0442\u0435\u043a\u0441\u0442\u0430.\n\u0417\u0435\u0440\u043a\u0430\u043b\u043e `OrderResource::canSeeTicket` (monster P2 \u043d\u0430 TK3 r3)." } }, "required": [ "order_id", "order_code", "is_paid", "counterparty", "tariffs", "used", "total", "remaining", "last_redeemed_at", "last_redeemed_by", "recent_logs", "redeem_token" ], "title": "TicketResource" }, "UnredeemTicketRequest": { "type": "object", "properties": { "order_id": { "type": "integer", "description": "\u041d\u0415 \u0441\u0442\u0430\u0432\u0438\u043c `exists:orders,id` \u2014 \u044d\u0442\u043e \u0434\u0430\u0451\u0442 \u0440\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u0432\u0430\u0435\u043c\u0443\u044e \u0440\u0430\u0437\u043d\u0438\u0446\u0443\n422 (\u043d\u0435\u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0438\u0439 id) vs 404 (\u0447\u0443\u0436\u043e\u0439 \u0442\u0435\u043d\u0430\u043d\u0442). \u0410\u0442\u0430\u043a\u0443\u044e\u0449\u0438\u0439 \u0438\u0437\n\u043f\u0440\u043e\u0435\u043a\u0442\u0430 A \u043c\u043e\u0433 \u0431\u044b \u043f\u0435\u0440\u0435\u0431\u043e\u0440\u043e\u043c \u0443\u0437\u043d\u0430\u0432\u0430\u0442\u044c \u0441\u0443\u0449\u0435\u0441\u0442\u0432\u0443\u044e\u0449\u0438\u0435 order_id \u0432\n\u043b\u044e\u0431\u043e\u043c \u0442\u0435\u043d\u0430\u043d\u0442\u0435 \u2014 monster P2 \u043d\u0430 TK3. \u0421\u0443\u0449\u0435\u0441\u0442\u0432\u043e\u0432\u0430\u043d\u0438\u0435 \u0437\u0430\u043a\u0430\u0437\u0430 + IDOR-scope (project/branch) \u043f\u0440\u043e\u0432\u0435\u0440\u044f\u0435\u0442\n\u043a\u043e\u043d\u0442\u0440\u043e\u043b\u043b\u0435\u0440: `$order === null` \u0418\u041b\u0418 `! canSeeOrder(...)` \u2192\n\u043e\u0434\u0438\u043d\u0430\u043a\u043e\u0432\u044b\u0439 \u043e\u0442\u0432\u0435\u0442 404 + code 4001. \u0410\u0442\u0430\u043a\u0443\u044e\u0449\u0438\u0439 \u043d\u0435 \u0440\u0430\u0437\u043b\u0438\u0447\u0438\u0442\n\u00ab\u043d\u0435\u0442 \u0442\u0430\u043a\u043e\u0433\u043e id\u00bb \u043e\u0442 \u00ab\u0435\u0441\u0442\u044c, \u043d\u043e \u043d\u0435 \u0442\u0432\u043e\u0439\u00bb.\n\n(LookupTicketByOrderRequest \u0437\u0434\u0435\u0441\u044c \u0436\u0435 \u043d\u0430\u043c\u0435\u0440\u0435\u043d\u043d\u043e \u0431\u0435\u0437 `exists`\n\u043f\u043e \u0442\u043e\u043c\u0443 \u0436\u0435 \u0441\u043e\u043e\u0431\u0440\u0430\u0436\u0435\u043d\u0438\u044e.)" }, "note": { "type": "string", "description": "\u041f\u0440\u0438\u0447\u0438\u043d\u0430 \u043e\u0442\u043a\u0430\u0442\u0430 \u2014 \u043e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u044c\u043d\u0430. \u041a\u043e\u043d\u0442\u0440\u043e\u043b\u0451\u0440 \u0434\u043e\u043b\u0436\u0435\u043d \u0443\u043a\u0430\u0437\u0430\u0442\u044c,\n\u043f\u043e\u0447\u0435\u043c\u0443 \u043e\u0442\u043a\u0430\u0442\u044b\u0432\u0430\u0435\u0442 (\u0434\u043b\u044f \u0430\u0443\u0434\u0438\u0442\u0430). \u041c\u0438\u043d\u0438\u043c\u0443\u043c 3 \u0441\u0438\u043c\u0432\u043e\u043b\u0430, \u0447\u0442\u043e\u0431\u044b\n\u043d\u0435 \u043f\u0443\u0441\u043a\u0430\u0442\u044c \u00ab.\u00bb \u0438\u043b\u0438 \u00ab1\u00bb.", "minLength": 3, "maxLength": 255 } }, "required": [ "order_id", "note" ], "title": "UnredeemTicketRequest" }, "UpdateEmailRequest": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "laravel_mail" ] }, "settings": { "type": "object", "properties": { "events": { "type": "object", "properties": { "subscription_renewal_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "subject": { "type": "string", "maxLength": 255 }, "template": { "type": "string", "maxLength": 5000 }, "action_label": { "type": "string", "maxLength": 255 }, "action_url": { "type": "string", "format": "uri", "maxLength": 2048 } } }, "subscription_repurchase_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "subject": { "type": "string", "maxLength": 255 }, "template": { "type": "string", "maxLength": 5000 }, "action_label": { "type": "string", "maxLength": 255 }, "action_url": { "type": "string", "format": "uri", "maxLength": 2048 } } }, "subscription_payment_method_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "subject": { "type": "string", "maxLength": 255 }, "template": { "type": "string", "maxLength": 5000 }, "action_label": { "type": "string", "maxLength": 255 }, "action_url": { "type": "string", "format": "uri", "maxLength": 2048 } } } } } } } }, "title": "UpdateEmailRequest" }, "UpdateOrderRequest": { "type": "object", "properties": { "apartment_type": { "type": "string", "enum": [ "studio", "1room", "2room", "3room", "4room" ] }, "total_area": { "type": "number", "maximum": 10000 }, "ceiling_height": { "type": "number", "maximum": 20 }, "bathroom": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "combined", "separate" ] }, "primary_area": { "type": "number", "maximum": 1000 }, "secondary_area": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "type", "primary_area" ] }, "selected_works": { "type": "array", "items": { "type": "object", "properties": { "composition_id": { "type": "integer" }, "quantity_source": { "type": "string", "enum": [ "total_wall_area", "living_floor", "ceiling_area", "bathroom_wall_area", "bathroom_floor_area", "skirting_perimeter" ] }, "thickness": { "type": [ "number", "null" ], "maximum": 1000 } }, "required": [ "composition_id", "quantity_source" ] }, "minItems": 1, "maxItems": 100 }, "selected_options": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "apartment_type", "total_area", "ceiling_height", "bathroom", "selected_works" ], "title": "UpdateOrderRequest" }, "UpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "login": { "type": "string", "minLength": 3, "maxLength": 255 }, "role_id": { "type": "integer" }, "branch_id": { "type": [ "integer", "null" ] }, "department_id": { "type": [ "integer", "null" ] }, "permissions": { "type": [ "array", "null" ], "items": { "type": "string" } }, "agent_description": { "type": [ "string", "null" ], "maxLength": 5000 }, "is_banned": { "type": [ "boolean", "null" ] } }, "title": "UpdateRequest" }, "UpdateShopExceptionRequest": { "type": "object", "properties": { "exception_start_date": { "type": "string", "format": "date-time" }, "exception_end_date": { "type": "string", "format": "date-time" } }, "required": [ "exception_start_date", "exception_end_date" ], "title": "UpdateShopExceptionRequest" }, "UpdateShopHolidayRequest": { "type": "object", "properties": { "work_start_time": { "type": [ "string", "null" ] }, "work_end_time": { "type": [ "string", "null" ] }, "break_start_time": { "type": [ "string", "null" ] }, "break_end_time": { "type": [ "string", "null" ] } }, "title": "UpdateShopHolidayRequest" }, "UpdateShopHourRequest": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "\u041f\u041d", "\u0412\u0422", "\u0421\u0420", "\u0427\u0422", "\u041f\u0422", "\u0421\u0411", "\u0412\u0421" ] }, "is_working_day": { "type": "boolean" }, "work_start_time": { "type": [ "string", "null" ] }, "work_end_time": { "type": [ "string", "null" ] }, "break_start_time": { "type": [ "string", "null" ] }, "break_end_time": { "type": [ "string", "null" ] } }, "required": [ "day_of_week", "is_working_day" ], "title": "UpdateShopHourRequest" }, "UpdateSmsRequest": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "smsc" ] }, "smsc_login": { "type": [ "string", "null" ], "maxLength": 255 }, "smsc_password": { "type": [ "string", "null" ], "maxLength": 512 }, "smsc_api_key": { "type": [ "string", "null" ], "maxLength": 512 }, "settings": { "type": "object", "properties": { "sender": { "type": [ "string", "null" ], "pattern": "^(?:[A-Za-z0-9 ]{1,11}|\\d{1,15})$" }, "max_sms_parts": { "type": "integer", "minimum": 1, "maximum": 5 }, "events": { "type": "object", "properties": { "subscription_charge_failed": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string" }, "action_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2048 } } }, "subscription_renewal_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string" }, "action_url": { "type": "string", "format": "uri", "maxLength": 2048 } } }, "subscription_repurchase_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string" }, "action_url": { "type": "string", "format": "uri", "maxLength": 2048 } } }, "subscription_payment_method_required": { "type": "object", "properties": { "is_active": { "type": "boolean" }, "template": { "type": "string" }, "action_url": { "type": "string", "format": "uri", "maxLength": 2048 } } } } } } } }, "title": "UpdateSmsRequest" }, "UpdateSubscriptionRequest": { "type": "object", "properties": { "nomenclature_id": { "type": "integer" }, "plan_slug": { "type": "string" }, "saved_payment_method_id": { "type": "integer" }, "autopay_consent": { "enum": [ "yes", "on", "1", 1, "true", true ] } }, "title": "UpdateSubscriptionRequest" }, "User": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "string", "null" ] }, "project_id": { "type": [ "integer", "null" ] }, "role_id": { "type": "integer" }, "branch_id": { "type": [ "integer", "null" ] }, "department_id": { "type": [ "integer", "null" ] }, "avatar_id": { "type": [ "integer", "null" ] }, "employment_contract_id": { "type": [ "integer", "null" ] }, "login": { "type": [ "string", "null" ] }, "system_account_id": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "middle_name": { "type": [ "string", "null" ] }, "birthday": { "type": [ "string", "null" ] }, "employment_date": { "type": [ "string", "null" ] }, "dismissal_date": { "type": [ "string", "null" ] }, "is_banned": { "type": "boolean" }, "is_agent": { "type": "boolean" }, "agent_description": { "type": [ "string", "null" ] }, "is_sick": { "type": "integer" }, "creator_id": { "type": [ "integer", "null" ] }, "active_time": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "code", "project_id", "role_id", "branch_id", "department_id", "avatar_id", "employment_contract_id", "login", "system_account_id", "phone", "first_name", "last_name", "middle_name", "birthday", "employment_date", "dismissal_date", "is_banned", "is_agent", "agent_description", "is_sick", "creator_id", "active_time", "created_at", "updated_at" ], "title": "User" }, "UserCollection": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } }, "usersCount": { "type": "integer" } }, "required": [ "users", "usersCount" ], "title": "UserCollection" }, "UserNameCollection": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserNameResource" } }, "usersCount": { "type": "integer" } }, "required": [ "users", "usersCount" ], "title": "UserNameCollection" }, "UserNameResource": { "type": "object", "properties": { "id": { "type": "string" }, "avatar": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "middle_name": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "avatar", "first_name", "last_name", "middle_name", "name" ], "title": "UserNameResource" }, "UserResource": { "type": "array", "items": [], "title": "UserResource" }, "VerifyPhoneNumberChangeRequest": { "type": "object", "properties": { "password": { "type": "string" } }, "required": [ "password" ], "title": "VerifyPhoneNumberChangeRequest" }, "WarehouseCollection": { "anyOf": [ { "type": "object", "properties": { "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseResource" } }, "warehousesCount": { "type": "integer" } }, "required": [ "warehouses", "warehousesCount" ] }, { "type": "array", "items": [] } ], "title": "WarehouseCollection" }, "WarehouseResource": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "avatar": { "anyOf": [ { "$ref": "#/components/schemas/FileResource" }, { "type": "null" } ] }, "owned_by_us": { "type": "boolean" }, "address": { "type": [ "string", "null" ] }, "storage_capacity": { "type": [ "integer", "null" ] }, "storage_unit": { "anyOf": [ { "$ref": "#/components/schemas/StorageUnitResource" }, { "type": "null" } ] }, "city": { "$ref": "#/components/schemas/DictionaryResource" }, "counterparty": { "anyOf": [ { "$ref": "#/components/schemas/CounterpartyResource" }, { "type": "null" } ] }, "is_price_from_inventories": { "type": "boolean" } }, "required": [ "id", "code", "name", "avatar", "owned_by_us", "address", "storage_capacity", "storage_unit", "city", "counterparty", "is_price_from_inventories" ], "title": "WarehouseResource" }, "WebhookDeliveryCollection": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryResource" }, "title": "WebhookDeliveryCollection" }, "WebhookDeliveryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "application_webhook_id": { "type": "integer" }, "event": { "type": "string" }, "event_id": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" }, "attempts": { "type": "integer" }, "next_attempt_at": { "type": [ "string", "null" ] }, "last_status_code": { "type": [ "integer", "null" ] }, "last_error": { "type": [ "string", "null" ] }, "delivered_at": { "type": [ "string", "null" ] }, "failed_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "application_webhook_id", "event", "event_id", "url", "status", "attempts", "next_attempt_at", "last_status_code", "last_error", "delivered_at", "failed_at", "created_at" ], "title": "WebhookDeliveryResource" }, "CallbackAuthError": { "type": "object", "additionalProperties": false, "required": [ "code", "message", "next_action", "retry_after_seconds", "request_id" ], "properties": { "code": { "type": "string", "enum": [ "callback_auth_invalid_request", "application_token_missing", "application_token_invalid", "callback_auth_session_not_found", "callback_auth_not_verified", "callback_auth_expired", "callback_auth_exchange_window_closed", "callback_auth_session_already_started", "callback_auth_challenge_already_active", "callback_challenge_already_active", "callback_auth_rate_limited", "callback_auth_busy", "counterparty_phone_identity_busy", "counterparty_phone_identity_conflict", "callback_auth_start_unavailable", "callback_auth_verification_unavailable", "callback_auth_internal_error", "callback_auth_access_denied" ], "description": "Stable public reason; use this field instead of parsing message." }, "message": { "type": "string", "description": "Safe explanation for the user; wording is not a machine contract." }, "next_action": { "type": "string", "enum": [ "fix_input", "contact_support", "restart", "poll", "wait" ], "description": "Client action. poll checks the current session; wait never means starting a new init automatically." }, "retry_after_seconds": { "type": [ "integer", "null" ], "minimum": 0, "description": "Known delay in seconds, or null when unknown. When Retry-After is present its value matches this field." }, "request_id": { "type": "string", "format": "uuid", "description": "Server-generated identifier for support, also returned in X-Request-ID. Client-provided request identifiers are not trusted." } }, "x-gigma-error-catalog": { "callback_auth_invalid_request": { "message": "\u041f\u0440\u043e\u0432\u0435\u0440\u044c\u0442\u0435 \u0432\u0432\u0435\u0434\u0451\u043d\u043d\u044b\u0435 \u0434\u0430\u043d\u043d\u044b\u0435.", "next_action": "fix_input" }, "application_token_missing": { "message": "\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043d\u0435 \u043d\u0430\u0441\u0442\u0440\u043e\u0435\u043d\u043e \u0434\u043b\u044f \u0432\u0445\u043e\u0434\u0430. \u041e\u0431\u0440\u0430\u0442\u0438\u0442\u0435\u0441\u044c \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443.", "next_action": "contact_support" }, "application_token_invalid": { "message": "\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043d\u0435 \u043d\u0430\u0441\u0442\u0440\u043e\u0435\u043d\u043e \u0434\u043b\u044f \u0432\u0445\u043e\u0434\u0430. \u041e\u0431\u0440\u0430\u0442\u0438\u0442\u0435\u0441\u044c \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443.", "next_action": "contact_support" }, "callback_auth_session_not_found": { "message": "\u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0432\u0445\u043e\u0434\u0430 \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430. \u041d\u0430\u0447\u043d\u0438\u0442\u0435 \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443.", "next_action": "restart" }, "callback_auth_not_verified": { "message": "\u0417\u0432\u043e\u043d\u043e\u043a \u0435\u0449\u0451 \u043d\u0435 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043d. \u041f\u0440\u043e\u0434\u043e\u043b\u0436\u0438\u0442\u0435 \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0443.", "next_action": "poll" }, "callback_auth_expired": { "message": "\u0412\u0440\u0435\u043c\u044f \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0438\u0441\u0442\u0435\u043a\u043b\u043e. \u041d\u0430\u0447\u043d\u0438\u0442\u0435 \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443.", "next_action": "restart" }, "callback_auth_exchange_window_closed": { "message": "\u0412\u0440\u0435\u043c\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0442\u043e\u043a\u0435\u043d\u0430 \u0438\u0441\u0442\u0435\u043a\u043b\u043e. \u041d\u0430\u0447\u043d\u0438\u0442\u0435 \u043d\u043e\u0432\u0443\u044e \u043f\u043e\u043f\u044b\u0442\u043a\u0443.", "next_action": "restart" }, "callback_auth_session_already_started": { "message": "\u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0432\u0445\u043e\u0434\u0430 \u0443\u0436\u0435 \u043d\u0430\u0447\u0430\u0442\u0430. \u041d\u0435 \u0437\u0430\u043f\u0443\u0441\u043a\u0430\u0439\u0442\u0435 \u043d\u043e\u0432\u0443\u044e \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438.", "next_action": "wait" }, "callback_auth_challenge_already_active": { "message": "\u041f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u0435 \u0437\u0432\u043e\u043d\u043a\u043e\u043c \u0443\u0436\u0435 \u0437\u0430\u043f\u0443\u0449\u0435\u043d\u043e. \u041f\u043e\u0434\u043e\u0436\u0434\u0438\u0442\u0435.", "next_action": "wait" }, "callback_challenge_already_active": { "message": "\u041f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u0435 \u0437\u0432\u043e\u043d\u043a\u043e\u043c \u0443\u0436\u0435 \u0437\u0430\u043f\u0443\u0449\u0435\u043d\u043e. \u041f\u043e\u0434\u043e\u0436\u0434\u0438\u0442\u0435.", "next_action": "wait" }, "callback_auth_rate_limited": { "message": "\u041f\u0440\u0435\u0432\u044b\u0448\u0435\u043d \u043b\u0438\u043c\u0438\u0442 \u0437\u0430\u043f\u0440\u043e\u0441\u043e\u0432. \u041f\u043e\u0434\u043e\u0436\u0434\u0438\u0442\u0435 \u043f\u0435\u0440\u0435\u0434 \u043f\u043e\u0432\u0442\u043e\u0440\u043e\u043c.", "next_action": "wait" }, "callback_auth_busy": { "message": "\u041f\u043e\u043f\u044b\u0442\u043a\u0430 \u0432\u0445\u043e\u0434\u0430 \u043e\u0431\u0440\u0430\u0431\u0430\u0442\u044b\u0432\u0430\u0435\u0442\u0441\u044f. \u041f\u043e\u0434\u043e\u0436\u0434\u0438\u0442\u0435 \u043f\u0435\u0440\u0435\u0434 \u043f\u043e\u0432\u0442\u043e\u0440\u043e\u043c.", "next_action": "wait" }, "counterparty_phone_identity_busy": { "message": "\u0412\u0445\u043e\u0434 \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e \u0437\u0430\u043d\u044f\u0442. \u041f\u043e\u0434\u043e\u0436\u0434\u0438\u0442\u0435 \u043f\u0435\u0440\u0435\u0434 \u043f\u043e\u0432\u0442\u043e\u0440\u043e\u043c.", "next_action": "wait" }, "counterparty_phone_identity_conflict": { "message": "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u043e\u043f\u0440\u0435\u0434\u0435\u043b\u0438\u0442\u044c \u0443\u0447\u0451\u0442\u043d\u0443\u044e \u0437\u0430\u043f\u0438\u0441\u044c. \u041e\u0431\u0440\u0430\u0442\u0438\u0442\u0435\u0441\u044c \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443.", "next_action": "contact_support" }, "callback_auth_start_unavailable": { "message": "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u043f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0440\u0435\u0437\u0443\u043b\u044c\u0442\u0430\u0442 \u0437\u0430\u043f\u0443\u0441\u043a\u0430 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f. \u041d\u0435 \u043f\u043e\u0432\u0442\u043e\u0440\u044f\u0439\u0442\u0435 \u0437\u0430\u043f\u0443\u0441\u043a \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438; \u043e\u0431\u0440\u0430\u0442\u0438\u0442\u0435\u0441\u044c \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443.", "next_action": "contact_support" }, "callback_auth_verification_unavailable": { "message": "\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430.", "next_action": "poll" }, "callback_auth_internal_error": { "message": "\u041d\u0435 \u0443\u0434\u0430\u043b\u043e\u0441\u044c \u0437\u0430\u0432\u0435\u0440\u0448\u0438\u0442\u044c \u0432\u0445\u043e\u0434. \u041e\u0431\u0440\u0430\u0442\u0438\u0442\u0435\u0441\u044c \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443 \u0438 \u0441\u043e\u043e\u0431\u0449\u0438\u0442\u0435 \u043d\u043e\u043c\u0435\u0440 \u043e\u0431\u0440\u0430\u0449\u0435\u043d\u0438\u044f.", "next_action": "contact_support" }, "callback_auth_access_denied": { "message": "\u0412\u0445\u043e\u0434 \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u0435\u043d. \u041e\u0431\u0440\u0430\u0442\u0438\u0442\u0435\u0441\u044c \u0432 \u043f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0443.", "next_action": "contact_support" } } }, "CallbackAuthWarning": { "type": "object", "additionalProperties": false, "required": [ "code", "message", "next_action", "retry_after_seconds", "request_id" ], "properties": { "code": { "type": "string", "enum": [ "callback_auth_verification_unavailable" ], "description": "Stable public reason; use this field instead of parsing message." }, "message": { "type": "string", "description": "Safe explanation for the user; wording is not a machine contract." }, "next_action": { "type": "string", "enum": [ "poll" ], "description": "Client action. poll checks the current session; wait never means starting a new init automatically." }, "retry_after_seconds": { "type": [ "integer", "null" ], "minimum": 0, "description": "Known delay in seconds, or null when unknown. When Retry-After is present its value matches this field." }, "request_id": { "type": "string", "format": "uuid", "description": "Server-generated identifier for support, also returned in X-Request-ID. Client-provided request identifiers are not trusted." } }, "x-gigma-error-catalog": { "callback_auth_verification_unavailable": { "message": "\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0435\u043d\u0438\u044f \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e \u043d\u0435\u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430.", "next_action": "poll" } } } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }