{
    "openapi": "3.0.3",
    "info": {
        "title": "Проверка Inbox API",
        "version": "1.0.0",
        "description": "Куда попало письмо: Inbox или Spam у Яндекса и diagnostic-ящика, SPF/DKIM live\n\nСгенерировано из карты методов tools docs. Канон вызова — этот server, не Host документации."
    },
    "servers": [
        {
            "url": "https://mailganer.com",
            "description": "Production"
        }
    ],
    "tags": [
        {
            "name": "inbox-checker"
        }
    ],
    "paths": {
        "/tools/inbox-checker/v1/status": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Сервис жив",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_status",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "ok": {
                                            "type": "boolean"
                                        },
                                        "service": {
                                            "type": "string"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/tools/inbox-checker/v1/providers": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Список провайдеров",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_providers",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "providers": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            },
                                            "description": "id, label, seed-ящики"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/tools/inbox-checker/v1/quota": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Квоты",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_quota",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "quota": {
                                            "type": "object",
                                            "additionalProperties": true,
                                            "description": "суточный лимит тестов"
                                        },
                                        "captcha": {
                                            "type": "object",
                                            "additionalProperties": true
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/tools/inbox-checker/v1/tests": {
            "post": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Запустить проверку попадания",
                "operationId": "inbox_checker_post_tools_inbox_checker_v1_tests",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "token": {
                                            "type": "string",
                                            "description": "id теста"
                                        },
                                        "status": {
                                            "type": "string"
                                        },
                                        "seeds": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            },
                                            "description": "куда слать пробные письма"
                                        },
                                        "providers": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        },
                                        "quota": {
                                            "type": "object",
                                            "additionalProperties": true
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "description": "Доступ: капча",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "sender": {
                                        "type": "string",
                                        "description": "From для автоотправки"
                                    },
                                    "providers": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        },
                                        "description": "id провайдеров; иначе все"
                                    },
                                    "auto_send": {
                                        "type": "boolean",
                                        "description": "по умолчанию true"
                                    },
                                    "captcha_token": {
                                        "type": "string",
                                        "description": "также smart_token"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/tools/inbox-checker/v1/tests/{token}": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Статус проверки",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_tests_token_",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "token": {
                                            "type": "string"
                                        },
                                        "status": {
                                            "type": "string"
                                        },
                                        "placements": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            },
                                            "description": "inbox / spam / missing по провайдерам"
                                        },
                                        "seeds": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "description": "токен результата"
                        },
                        "description": "токен результата"
                    }
                ]
            }
        },
        "/tools/inbox-checker/v1/tests/{token}/live": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Поток событий (SSE)",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_tests_token_live",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "(поток)": {
                                            "type": "string",
                                            "format": "binary",
                                            "description": "события статуса проверки"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "description": "токен результата"
                        },
                        "description": "токен результата"
                    }
                ]
            }
        },
        "/tools/inbox-checker/v1/tests/{token}/repoll": {
            "post": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Повторно опросить ящики",
                "operationId": "inbox_checker_post_tools_inbox_checker_v1_tests_token_repoll",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "token": {
                                            "type": "string"
                                        },
                                        "status": {
                                            "type": "string"
                                        },
                                        "placements": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "description": "токен результата"
                        },
                        "description": "токен результата"
                    }
                ]
            }
        },
        "/tools/inbox-checker/v1/tti/current": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Текущий TTI",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_tti_current",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "benchmark": {
                                            "type": "string"
                                        },
                                        "tti": {
                                            "type": "object",
                                            "additionalProperties": true,
                                            "description": "текущий замер"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "benchmark",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "description": "marketing или transactional"
                        },
                        "description": "marketing или transactional"
                    }
                ]
            }
        },
        "/tools/inbox-checker/v1/tti/history": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "История TTI",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_tti_history",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "points": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            },
                                            "description": "история замеров"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "benchmark",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": ""
                    },
                    {
                        "name": "hours",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "integer",
                            "description": "окно, макс. 90 суток"
                        },
                        "description": "окно, макс. 90 суток"
                    },
                    {
                        "name": "placement",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": ""
                    }
                ]
            }
        },
        "/tools/inbox-checker/v1/tti/benchmarks": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Бенчмарки TTI",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_tti_benchmarks",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "benchmarks": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/tools/inbox-checker/v1/tti/compare": {
            "get": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Сравнение TTI",
                "operationId": "inbox_checker_get_tools_inbox_checker_v1_tti_compare",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "compare": {
                                            "type": "object",
                                            "additionalProperties": true
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/tools/inbox-checker/v1/tti/run": {
            "post": {
                "tags": [
                    "inbox-checker"
                ],
                "summary": "Запустить замер TTI",
                "operationId": "inbox_checker_post_tools_inbox_checker_v1_tti_run",
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "ok": {
                                            "type": "boolean"
                                        },
                                        "run": {
                                            "type": "object",
                                            "additionalProperties": true
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "description": "Доступ: капча",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "benchmark": {
                                        "type": "string",
                                        "description": "marketing или transactional"
                                    },
                                    "captcha_token": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}