import { AxiosResponse } from 'axios';
import { IOrder } from 'platform-proxies';
import { ToastOrder } from '../../toast/interface';
import { ICreatedProviderOrder } from './provider-order.interface';
import { IVendor } from './vendor.interface';

export type ProviderOrder = ToastOrder;

export interface IProviderService {
    /**
     * Prepare order object for specific vendor-provider service
     * @param {IVendor} vendor
     * @param {IOrder} order in our system
     * @return {Promise<Partial<ProviderOrder>>}
     * @throws {Error}
     */
    prepareOrderObject(vendor: IVendor, order: IOrder): Promise<Partial<ProviderOrder>>;

    /**
     * Create order in specific vendor-provider service
     * @param {IVendor} vendor
     * @param {Partial<ProviderOrder>} providerOrder
     * @return {Promise<AxiosResponse<ProviderOrder>>}
     * @throws {AxiosException}
     */
    createOrder(vendor: IVendor, providerOrder: Partial<ProviderOrder>): Promise<AxiosResponse<ProviderOrder>>;

    /**
     * Retrieve provider order id from provider order
     * @param {ProviderOrder} providerOrder
     * @return {string | undefined}
     */
    getProviderOrderId(providerOrder: ProviderOrder): string | undefined;

    /**
     * Retrieve base provider order information
     * @param {ProviderOrder} providerOrder
     * @return {ICreatedProviderOrder}
     */
    transformProviderOrder(providerOrder: ProviderOrder): ICreatedProviderOrder;

    /**
     * Refund order in specific vendor-provider service
     * @param {IVendor} vendor
     * @param {IOrder} order
     * @return {Promise<AxiosResponse<any>>}
     * @throws {AxiosException|MethodNotAllowedException|Error}
     */
    refund(vendor: IVendor, order: IOrder): Promise<AxiosResponse<any>>;

    /**
     * Notify of an error when creating an order
     * @param {IOrder} order
     * @param {Error} error
     * @return {Promise<void>}
     */
    notifyCreateOrderError(order: IOrder, error: Error): Promise<void>;

    /**
     * Notify of any critical error
     * @param {IOrder} order
     * @param {Error} error
     * @return {Promise<void>}
     */
    notifyError(order: IOrder, error: Error): Promise<void>;

    /**
     * Check if created provider order has valid information
     * @param {IOrder} order
     * @param {ProviderOrder} providerOrder
     * @return {Promise<boolean>}
     * @throws {Error} if order has some issue
     */
    checkCreatedOrderPrice(order: IOrder, providerOrder: ProviderOrder): Promise<void>;

    /**
     * Notify system about issue between order in our system and provider order
     * @param {IVendor} vendor
     * @param {IOrder} order
     * @param {Error} error
     */
    notifyCreatedOrderPriceError(vendor: IVendor, order: IOrder, error: Error);
}