/* tslint:disable */ /* eslint-disable */ /** * Timeweb Cloud API * # Введение API Timeweb Cloud позволяет вам управлять ресурсами в облаке программным способом с использованием обычных HTTP-запросов. Множество функций, которые доступны в панели управления Timeweb Cloud, также доступны через API, что позволяет вам автоматизировать ваши собственные сценарии. В этой документации сперва будет описан общий дизайн и принципы работы API, а после этого конкретные конечные точки. Также будут приведены примеры запросов к ним. ## Запросы Запросы должны выполняться по протоколу `HTTPS`, чтобы гарантировать шифрование транзакций. Поддерживаются следующие методы запроса: |Метод|Применение| |--- |--- | |GET|Извлекает данные о коллекциях и отдельных ресурсах.| |POST|Для коллекций создает новый ресурс этого типа. Также используется для выполнения действий с конкретным ресурсом.| |PUT|Обновляет существующий ресурс.| |PATCH|Некоторые ресурсы поддерживают частичное обновление, то есть обновление только части атрибутов ресурса, в этом случае вместо метода PUT будет использован PATCH.| |DELETE|Удаляет ресурс.| Методы `POST`, `PUT` и `PATCH` могут включать объект в тело запроса с типом содержимого `application/json`. ### Параметры в запросах Некоторые коллекции поддерживают пагинацию, поиск или сортировку в запросах. В параметрах запроса требуется передать: - `limit` — обозначает количество записей, которое необходимо вернуть - `offset` — указывает на смещение, относительно начала списка - `search` — позволяет указать набор символов для поиска - `sort` — можно задать правило сортировки коллекции ## Ответы Запросы вернут один из следующих кодов состояния ответа HTTP: |Статус|Описание| |--- |--- | |200 OK|Действие с ресурсом было выполнено успешно.| |201 Created|Ресурс был успешно создан. При этом ресурс может быть как уже готовым к использованию, так и находиться в процессе запуска.| |204 No Content|Действие с ресурсом было выполнено успешно, и ответ не содержит дополнительной информации в теле.| |400 Bad Request|Был отправлен неверный запрос, например, в нем отсутствуют обязательные параметры и т. д. Тело ответа будет содержать дополнительную информацию об ошибке.| |401 Unauthorized|Ошибка аутентификации.| |403 Forbidden|Аутентификация прошла успешно, но недостаточно прав для выполнения действия.| |404 Not Found|Запрашиваемый ресурс не найден.| |409 Conflict|Запрос конфликтует с текущим состоянием.| |423 Locked|Ресурс из запроса заблокирован от применения к нему указанного метода.| |429 Too Many Requests|Был достигнут лимит по количеству запросов в единицу времени.| |500 Internal Server Error|При выполнении запроса произошла какая-то внутренняя ошибка. Чтобы решить эту проблему, лучше всего создать тикет в панели управления.| ### Структура успешного ответа Все конечные точки будут возвращать данные в формате `JSON`. Ответы на `GET`-запросы будут иметь на верхнем уровне следующую структуру атрибутов: |Название поля|Тип|Описание| |--- |--- |--- | |[entity_name]|object, object[], string[], number[], boolean|Динамическое поле, которое будет меняться в зависимости от запрашиваемого ресурса и будет содержать все атрибуты, необходимые для описания этого ресурса. Например, при запросе списка баз данных будет возвращаться поле `dbs`, а при запросе конкретного облачного сервера `server`. Для некоторых конечных точек в ответе может возвращаться сразу несколько ресурсов.| |meta|object|Опционально. Объект, который содержит вспомогательную информацию о ресурсе. Чаще всего будет встречаться при запросе коллекций и содержать поле `total`, которое будет указывать на количество элементов в коллекции.| |response_id|string|Опционально. В большинстве случаев в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID— так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот ID, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.| Пример запроса на получение списка SSH-ключей: ``` HTTP/2.0 200 OK { \"ssh_keys\":[ { \"body\":\"ssh-rsa AAAAB3NzaC1sdfghjkOAsBwWhs= example@device.local\", \"created_at\":\"2021-09-15T19:52:27Z\", \"expired_at\":null, \"id\":5297, \"is_default\":false, \"name\":\"example@device.local\", \"used_at\":null, \"used_by\":[] } ], \"meta\":{ \"total\":1 }, \"response_id\":\"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\" } ``` ### Структура ответа с ошибкой |Название поля|Тип|Описание| |--- |--- |--- | |status_code|number|Короткий числовой идентификатор ошибки.| |error_code|string|Короткий текстовый идентификатор ошибки, который уточняет числовой идентификатор и удобен для программной обработки. Самый простой пример — это код `not_found` для ошибки 404.| |message|string, string[]|Опционально. В большинстве случаев в ответе будет содержаться человекочитаемое подробное описание ошибки или ошибок, которые помогут понять, что нужно исправить.| |response_id|string|Опционально. В большинстве случае в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID — так мы сможем найти ответ на него намного быстрее.| Пример: ``` HTTP/2.0 403 Forbidden { \"status_code\": 403, \"error_code\": \"forbidden\", \"message\": \"You do not have access for the attempted action\", \"response_id\": \"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\" } ``` ## Статусы ресурсов Важно учесть, что при создании большинства ресурсов внутри платформы вам будет сразу возвращен ответ от сервера со статусом `200 OK` или `201 Created` и ID созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в *состоянии запуска*. Для того чтобы понять, в каком состоянии сейчас находится ваш ресурс, мы добавили поле `status` в ответ на получение информации о ресурсе. Список статусов будет отличаться в зависимости от типа ресурса. Увидеть поддерживаемый список статусов вы сможете в описании каждого конкретного ресурса. ## Ограничение скорости запросов (Rate Limiting) Чтобы обеспечить стабильность для всех пользователей, Timeweb Cloud защищает API от всплесков входящего трафика, анализируя количество запросов c каждого аккаунта к каждой конечной точке. Если ваше приложение отправляет более 20 запросов в секунду на одну конечную точку, то для этого запроса API может вернуть код состояния HTTP `429 Too Many Requests`. ## Аутентификация Доступ к API осуществляется с помощью JWT-токена. Токенами можно управлять внутри панели управления Timeweb Cloud в разделе *API и Terraform*. Токен необходимо передавать в заголовке каждого запроса в формате: ``` Authorization: Bearer $TIMEWEB_CLOUD_TOKEN ``` ## Формат примеров API Примеры в этой документации описаны с помощью `curl`, HTTP-клиента командной строки. На компьютерах `Linux` и `macOS` обычно по умолчанию установлен `curl`, и он доступен для загрузки на всех популярных платформах, включая `Windows`. Каждый пример разделен на несколько строк символом `\\`, который совместим с `bash`. Типичный пример выглядит так: ``` curl -X PATCH -H \"Content-Type: application/json\" -H \"Authorization: Bearer $TIMEWEB_CLOUD_TOKEN\" -d \'{\"name\":\"Cute Corvus\",\"comment\":\"Development Server\"}\' \"https://api.timeweb.cloud/api/v1/dedicated/1051\" ``` - Параметр `-X` задает метод запроса. Для согласованности метод будет указан во всех примерах, даже если он явно не требуется для методов `GET`. - Строки `-H` задают требуемые HTTP-заголовки. - Примеры, для которых требуется объект JSON в теле запроса, передают требуемые данные через параметр `-d`. Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на `Linux` это можно сделать с помощью команды: ``` TIMEWEB_CLOUD_TOKEN=\"token\" ``` После этого токен будет автоматически подставляться в ваши запросы. Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на IDы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов. ## Версионирование API построено согласно принципам [семантического версионирования](https://semver.org/lang/ru). Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии. Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос `/api/v1/servers` указывает, что этот метод имеет версию 1. * * The version of the OpenAPI document: 1.0.0 * Contact: info@timeweb.cloud * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateDatabaseBackup409Response, CreateDomainMailbox201Response, CreateDomainMailboxRequest, CreateMultipleDomainMailboxes201Response, CreateMultipleDomainMailboxesRequest, GetAccountStatus403Response, GetDomainMailInfo200Response, GetFinances400Response, GetFinances401Response, GetFinances429Response, GetFinances500Response, GetImage404Response, GetMailboxes200Response, UpdateDomainMailInfoRequest, UpdateMailbox, UpdateMailboxV2, UpdateMailboxV2200Response, } from '../models/index'; import { CreateDatabaseBackup409ResponseFromJSON, CreateDatabaseBackup409ResponseToJSON, CreateDomainMailbox201ResponseFromJSON, CreateDomainMailbox201ResponseToJSON, CreateDomainMailboxRequestFromJSON, CreateDomainMailboxRequestToJSON, CreateMultipleDomainMailboxes201ResponseFromJSON, CreateMultipleDomainMailboxes201ResponseToJSON, CreateMultipleDomainMailboxesRequestFromJSON, CreateMultipleDomainMailboxesRequestToJSON, GetAccountStatus403ResponseFromJSON, GetAccountStatus403ResponseToJSON, GetDomainMailInfo200ResponseFromJSON, GetDomainMailInfo200ResponseToJSON, GetFinances400ResponseFromJSON, GetFinances400ResponseToJSON, GetFinances401ResponseFromJSON, GetFinances401ResponseToJSON, GetFinances429ResponseFromJSON, GetFinances429ResponseToJSON, GetFinances500ResponseFromJSON, GetFinances500ResponseToJSON, GetImage404ResponseFromJSON, GetImage404ResponseToJSON, GetMailboxes200ResponseFromJSON, GetMailboxes200ResponseToJSON, UpdateDomainMailInfoRequestFromJSON, UpdateDomainMailInfoRequestToJSON, UpdateMailboxFromJSON, UpdateMailboxToJSON, UpdateMailboxV2FromJSON, UpdateMailboxV2ToJSON, UpdateMailboxV2200ResponseFromJSON, UpdateMailboxV2200ResponseToJSON, } from '../models/index'; export interface CreateDomainMailboxOperationRequest { domain: string; createDomainMailboxRequest: CreateDomainMailboxRequest; } export interface CreateMultipleDomainMailboxesOperationRequest { domain: string; createMultipleDomainMailboxesRequest: CreateMultipleDomainMailboxesRequest; } export interface DeleteMailboxRequest { domain: string; mailbox: string; } export interface GetDomainMailInfoRequest { domain: string; } export interface GetDomainMailboxesRequest { domain: string; limit?: number; offset?: number; search?: string; } export interface GetMailboxRequest { domain: string; mailbox: string; } export interface GetMailboxesRequest { limit?: number; offset?: number; search?: string; } export interface UpdateDomainMailInfoOperationRequest { domain: string; updateDomainMailInfoRequest: UpdateDomainMailInfoRequest; } export interface UpdateMailboxRequest { domain: string; mailbox: string; updateMailbox: UpdateMailbox; } export interface UpdateMailboxV2Request { domain: string; mailbox: string; updateMailboxV2: UpdateMailboxV2; } /** * */ export class MailApi extends runtime.BaseAPI { /** * Чтобы создать почтовый ящик, отправьте POST-запрос на `/api/v1/mail/domains/{domain}`. * Создание почтового ящика */ async createDomainMailboxRaw(requestParameters: CreateDomainMailboxOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling createDomainMailbox.'); } if (requestParameters.createDomainMailboxRequest === null || requestParameters.createDomainMailboxRequest === undefined) { throw new runtime.RequiredError('createDomainMailboxRequest','Required parameter requestParameters.createDomainMailboxRequest was null or undefined when calling createDomainMailbox.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))), method: 'POST', headers: headerParameters, query: queryParameters, body: CreateDomainMailboxRequestToJSON(requestParameters.createDomainMailboxRequest), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => CreateDomainMailbox201ResponseFromJSON(jsonValue)); } /** * Чтобы создать почтовый ящик, отправьте POST-запрос на `/api/v1/mail/domains/{domain}`. * Создание почтового ящика */ async createDomainMailbox(requestParameters: CreateDomainMailboxOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.createDomainMailboxRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы создать почтовый ящики, отправьте POST-запрос на `/api/v1/mail/domains/{domain}/batch`. * Множественное создание почтовых ящиков */ async createMultipleDomainMailboxesRaw(requestParameters: CreateMultipleDomainMailboxesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling createMultipleDomainMailboxes.'); } if (requestParameters.createMultipleDomainMailboxesRequest === null || requestParameters.createMultipleDomainMailboxesRequest === undefined) { throw new runtime.RequiredError('createMultipleDomainMailboxesRequest','Required parameter requestParameters.createMultipleDomainMailboxesRequest was null or undefined when calling createMultipleDomainMailboxes.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}/batch`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))), method: 'POST', headers: headerParameters, query: queryParameters, body: CreateMultipleDomainMailboxesRequestToJSON(requestParameters.createMultipleDomainMailboxesRequest), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => CreateMultipleDomainMailboxes201ResponseFromJSON(jsonValue)); } /** * Чтобы создать почтовый ящики, отправьте POST-запрос на `/api/v1/mail/domains/{domain}/batch`. * Множественное создание почтовых ящиков */ async createMultipleDomainMailboxes(requestParameters: CreateMultipleDomainMailboxesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.createMultipleDomainMailboxesRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы удалить почтовый ящик, отправьте DELETE-запрос на `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`. * Удаление почтового ящика */ async deleteMailboxRaw(requestParameters: DeleteMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling deleteMailbox.'); } if (requestParameters.mailbox === null || requestParameters.mailbox === undefined) { throw new runtime.RequiredError('mailbox','Required parameter requestParameters.mailbox was null or undefined when calling deleteMailbox.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))).replace(`{${"mailbox"}}`, encodeURIComponent(String(requestParameters.mailbox))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Чтобы удалить почтовый ящик, отправьте DELETE-запрос на `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`. * Удаление почтового ящика */ async deleteMailbox(requestParameters: DeleteMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteMailboxRaw(requestParameters, initOverrides); } /** * Чтобы получить почтовую информацию о домене, отправьте GET-запрос на `/api/v1/mail/domains/{domain}/info`. * Получение почтовой информации о домене */ async getDomainMailInfoRaw(requestParameters: GetDomainMailInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling getDomainMailInfo.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}/info`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetDomainMailInfo200ResponseFromJSON(jsonValue)); } /** * Чтобы получить почтовую информацию о домене, отправьте GET-запрос на `/api/v1/mail/domains/{domain}/info`. * Получение почтовой информации о домене */ async getDomainMailInfo(requestParameters: GetDomainMailInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getDomainMailInfoRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы получить список почтовых ящиков домена, отправьте GET-запрос на `/api/v1/mail/domains/{domain}`. * Получение списка почтовых ящиков домена */ async getDomainMailboxesRaw(requestParameters: GetDomainMailboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling getDomainMailboxes.'); } const queryParameters: any = {}; if (requestParameters.limit !== undefined) { queryParameters['limit'] = requestParameters.limit; } if (requestParameters.offset !== undefined) { queryParameters['offset'] = requestParameters.offset; } if (requestParameters.search !== undefined) { queryParameters['search'] = requestParameters.search; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetMailboxes200ResponseFromJSON(jsonValue)); } /** * Чтобы получить список почтовых ящиков домена, отправьте GET-запрос на `/api/v1/mail/domains/{domain}`. * Получение списка почтовых ящиков домена */ async getDomainMailboxes(requestParameters: GetDomainMailboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getDomainMailboxesRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы получить почтовый ящик, отправьте GET-запрос на `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`. * Получение почтового ящика */ async getMailboxRaw(requestParameters: GetMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling getMailbox.'); } if (requestParameters.mailbox === null || requestParameters.mailbox === undefined) { throw new runtime.RequiredError('mailbox','Required parameter requestParameters.mailbox was null or undefined when calling getMailbox.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))).replace(`{${"mailbox"}}`, encodeURIComponent(String(requestParameters.mailbox))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => CreateDomainMailbox201ResponseFromJSON(jsonValue)); } /** * Чтобы получить почтовый ящик, отправьте GET-запрос на `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`. * Получение почтового ящика */ async getMailbox(requestParameters: GetMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getMailboxRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы получить список почтовых ящиков аккаунта, отправьте GET-запрос на `/api/v1/mail`. * Получение списка почтовых ящиков аккаунта */ async getMailboxesRaw(requestParameters: GetMailboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; if (requestParameters.limit !== undefined) { queryParameters['limit'] = requestParameters.limit; } if (requestParameters.offset !== undefined) { queryParameters['offset'] = requestParameters.offset; } if (requestParameters.search !== undefined) { queryParameters['search'] = requestParameters.search; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetMailboxes200ResponseFromJSON(jsonValue)); } /** * Чтобы получить список почтовых ящиков аккаунта, отправьте GET-запрос на `/api/v1/mail`. * Получение списка почтовых ящиков аккаунта */ async getMailboxes(requestParameters: GetMailboxesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getMailboxesRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы изменить почтовую информацию о домене, отправьте PATCH-запрос на `/api/v1/mail/domains/{domain}/info`. * Изменение почтовой информации о домене */ async updateDomainMailInfoRaw(requestParameters: UpdateDomainMailInfoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling updateDomainMailInfo.'); } if (requestParameters.updateDomainMailInfoRequest === null || requestParameters.updateDomainMailInfoRequest === undefined) { throw new runtime.RequiredError('updateDomainMailInfoRequest','Required parameter requestParameters.updateDomainMailInfoRequest was null or undefined when calling updateDomainMailInfo.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}/info`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))), method: 'PATCH', headers: headerParameters, query: queryParameters, body: UpdateDomainMailInfoRequestToJSON(requestParameters.updateDomainMailInfoRequest), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetDomainMailInfo200ResponseFromJSON(jsonValue)); } /** * Чтобы изменить почтовую информацию о домене, отправьте PATCH-запрос на `/api/v1/mail/domains/{domain}/info`. * Изменение почтовой информации о домене */ async updateDomainMailInfo(requestParameters: UpdateDomainMailInfoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.updateDomainMailInfoRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы изменить почтовый ящик, отправьте PATCH-запрос на `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`. * Изменение почтового ящика */ async updateMailboxRaw(requestParameters: UpdateMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling updateMailbox.'); } if (requestParameters.mailbox === null || requestParameters.mailbox === undefined) { throw new runtime.RequiredError('mailbox','Required parameter requestParameters.mailbox was null or undefined when calling updateMailbox.'); } if (requestParameters.updateMailbox === null || requestParameters.updateMailbox === undefined) { throw new runtime.RequiredError('updateMailbox','Required parameter requestParameters.updateMailbox was null or undefined when calling updateMailbox.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))).replace(`{${"mailbox"}}`, encodeURIComponent(String(requestParameters.mailbox))), method: 'PATCH', headers: headerParameters, query: queryParameters, body: UpdateMailboxToJSON(requestParameters.updateMailbox), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => CreateDomainMailbox201ResponseFromJSON(jsonValue)); } /** * Чтобы изменить почтовый ящик, отправьте PATCH-запрос на `/api/v1/mail/domains/{domain}/mailboxes/{mailbox}`. * Изменение почтового ящика */ async updateMailbox(requestParameters: UpdateMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.updateMailboxRaw(requestParameters, initOverrides); return await response.value(); } /** * Чтобы изменить почтовый ящик, отправьте PATCH-запрос на `/api/v2/mail/domains/{domain}/mailboxes/{mailbox}`. * Изменение почтового ящика */ async updateMailboxV2Raw(requestParameters: UpdateMailboxV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.domain === null || requestParameters.domain === undefined) { throw new runtime.RequiredError('domain','Required parameter requestParameters.domain was null or undefined when calling updateMailboxV2.'); } if (requestParameters.mailbox === null || requestParameters.mailbox === undefined) { throw new runtime.RequiredError('mailbox','Required parameter requestParameters.mailbox was null or undefined when calling updateMailboxV2.'); } if (requestParameters.updateMailboxV2 === null || requestParameters.updateMailboxV2 === undefined) { throw new runtime.RequiredError('updateMailboxV2','Required parameter requestParameters.updateMailboxV2 was null or undefined when calling updateMailboxV2.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("Bearer", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } const response = await this.request({ path: `/api/v2/mail/domains/{domain}/mailboxes/{mailbox}`.replace(`{${"domain"}}`, encodeURIComponent(String(requestParameters.domain))).replace(`{${"mailbox"}}`, encodeURIComponent(String(requestParameters.mailbox))), method: 'PATCH', headers: headerParameters, query: queryParameters, body: UpdateMailboxV2ToJSON(requestParameters.updateMailboxV2), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => UpdateMailboxV2200ResponseFromJSON(jsonValue)); } /** * Чтобы изменить почтовый ящик, отправьте PATCH-запрос на `/api/v2/mail/domains/{domain}/mailboxes/{mailbox}`. * Изменение почтового ящика */ async updateMailboxV2(requestParameters: UpdateMailboxV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.updateMailboxV2Raw(requestParameters, initOverrides); return await response.value(); } }