cdek
Version:
CDEK API client
103 lines (102 loc) • 7.55 kB
TypeScript
import { EventEmitter } from "./core/eventemitter.ts";
import type { ApiRequest, ApiResponse, ApiWebhook } from "./types/api.ts";
import type { InitOptions } from "./types/lib.ts";
export declare class Cdek extends EventEmitter<ApiWebhook.EventMap> {
private rest;
constructor(options: InitOptions);
/**
* Обработчик входящих вебхуков.
* Парсит запрос, определяет тип события и вызывает соответствующий event listener.
*/
webhookHandler(): (request: Request) => Promise<Response>;
/** Получение списка регионов */
getRegions(params?: ApiRequest.GetRegions): Promise<ApiResponse.GetRegions[]>;
/** Получение списка населенных пунктов */
getCities(params?: ApiRequest.GetCities): Promise<ApiResponse.GetCities[]>;
/** Получение локации по координатам */
getCityByCoordinates(latitude: number, longitude: number): Promise<ApiResponse.GetCities>;
/** Добавление подписки на вебхуки */
addWebhook(params?: ApiRequest.AddWebhook): Promise<ApiResponse.AddWebhook>;
/** Получение информации о подписке по UUID */
getWebhookByUUID(uuid: string): Promise<ApiResponse.GetWebhook>;
/** Получение списка всех подписок */
getWebhooks(): Promise<ApiResponse.GetWebhooks>;
/** Удаление подписки на вебхуки */
deleteWebhookByUUID(uuid: string): Promise<ApiResponse.DeleteWebhook>;
/** Регистрация заказа */
addOrder(params: ApiRequest.AddOrder): Promise<ApiResponse.AddOrder>;
/** Получение информации о заказе по UUID */
getOrderByUUID(uuid: string): Promise<ApiResponse.GetOrder>;
/** Получение информации о заказе по номеру СДЭК */
getOrderByCdekNumber(cdek_number: number): Promise<ApiResponse.GetOrder>;
/** Получение информации о заказе по номеру ИМ */
getOrderByImNumber(im_number: number): Promise<ApiResponse.GetOrder>;
/** Изменение заказа */
updateOrder(params: ApiRequest.UpdateOrder): Promise<ApiResponse.UpdateOrder>;
/** Удаление заказа */
deleteOrderByUUID(uuid: string): Promise<ApiResponse.DeleteOrder>;
/** Регистрация отказа */
addRefusal(order_uuid: string): Promise<ApiResponse.AddRefusal>;
/** Регистрация клиентского возврата */
createClientReturn(params: ApiRequest.CreateClientReturn): Promise<ApiResponse.CreateClientReturn>;
/** Регистрация заявки на вызов курьера */
addCourier(params: ApiRequest.AddCourier): Promise<ApiResponse.AddCourier>;
/** Получение информации о заявке на вызов курьера */
getCourierDetails(uuid: string): Promise<ApiResponse.GetCourierDetails>;
/** Удаление заявки на вызов курьера */
deleteCourier(uuid: string): Promise<ApiResponse.DeleteCourier>;
/** Получение всех заявок по заказу */
getIntakes(orderUuid: string): Promise<ApiResponse.GetCourierDetails[]>;
/** Формирование квитанции к заказу */
createOrderReceipt(params: ApiRequest.CreateOrderReceipt): Promise<ApiResponse.CreateOrderReceipt>;
/** Получение квитанции к заказу */
getOrderReceipt(uuid: string): Promise<ApiResponse.GetOrderReceipt>;
/** Скачивание квитанции по UUID */
downloadOrderReceiptByUUID(uuid: string): Promise<ReadableStream<Uint8Array>>;
/** Скачивание квитанции по URL */
downloadOrderReceiptByURL(url: string): Promise<ReadableStream<Uint8Array>>;
/** Формирование ШК места */
createBarcodeCP(params: ApiRequest.CreateBarcodeCP): Promise<ApiResponse.CreateBarcodeCP>;
/** Получение ШК места */
getBarcodeCP(uuid: string): Promise<ApiResponse.GetBarcodeCP>;
/** Скачивание ШК места по UUID */
downloadBarcodeCPByUUID(uuid: string): Promise<ReadableStream<Uint8Array>>;
/** Скачивание ШК места по URL */
downloadBarcodeCPByURL(url: string): Promise<ReadableStream<Uint8Array>>;
/** Регистрация договоренности о доставке */
addDeliveryAppointment(params: ApiRequest.AddDeliveryAppointment): Promise<ApiResponse.AddDeliveryAppointment>;
/** Получение информации о договоренности о доставке */
getDeliveryAppointment(uuid: string): Promise<ApiResponse.GetDeliveryAppointment>;
/** Получение интервалов доставки (для существующего заказа) */
getDeliveryIntervals(params: ApiRequest.GetDeliveryIntervals): Promise<ApiResponse.GetDeliveryIntervals>;
/** Регистрация преалерта */
addPrealert(params: ApiRequest.AddPrealert): Promise<ApiResponse.AddPrealert>;
/** Получение информации о преалерте */
getPrealert(uuid: string): Promise<ApiResponse.GetPrealert>;
/** Получение паспортных данных */
getPassportData(params: ApiRequest.GetPassportData): Promise<ApiResponse.GetPassportData>;
/** Получение информации о чеке */
getCashboxCheck(params: ApiRequest.GetCashboxCheck): Promise<ApiResponse.GetCashboxCheck>;
/** Получение реестра наложенных платежей */
getCashOnDeliveryRegistry(params: ApiRequest.GetCashOnDeliveryRegistry): Promise<ApiResponse.GetCashOnDeliveryRegistry>;
/** Получение информации о переводе наложенного платежа */
getCashOnDeliveryTransfer(params: ApiRequest.GetCashOnDeliveryTransfer): Promise<ApiResponse.GetCashOnDeliveryTransfer>;
/** Получение списка ПВЗ */
getPickupPoints(params?: ApiRequest.GetPickupPoints): Promise<ApiResponse.GetPickupPoints[]>;
/** Расчет по коду тарифа */
calculatorByTariff(params: ApiRequest.CalculatorByTariff): Promise<ApiResponse.CalculatorByTariff>;
/** Расчет по доступным тарифам */
calculatorByAvaibleTariffs(params: ApiRequest.CalculatorByAvaibleTariffs): Promise<ApiResponse.CalculatorByAvaibleTariffs>;
/** Получение списка всех доступных тарифов по договору */
availableTariffs(lang?: string): Promise<ApiResponse.CalculatorByAvaibleTariffs>;
/** Таможенный калькулятор (расчет пошлин) */
calculatorCustoms(params: ApiRequest.CalculatorCustoms): Promise<ApiResponse.CalculatorCustoms>;
/** Проверка доступности реверса */
checkReverseAvailability(params: ApiRequest.CheckReverseAvailability): Promise<void>;
/** Получение заказов с готовыми фото */
getFinishedOrders(params: ApiRequest.GetFinishedOrders): Promise<ApiResponse.GetFinishedOrders>;
/** Принудительное обновление токена */
refreshToken(): Promise<void>;
get token(): string | undefined;
get tokenExpire(): number | undefined;
}