@longvansoftware/service-js-client 1.0.2

package/dist/src/lib/order/index.d.ts

@@ -0,0 +1,452 @@
+import { LineItem, DiscountCampaign, CancelOrder, MemberDiscount, CampaignPromotion, OrderQuery } from "../../types/order";
+import { Service } from "../serviceSDK";
+/**
+ * Represents a service for managing orders.
+ */
+export declare class OrderService extends Service {
+    /**
+     * Constructs a new OrderService instance.
+     * @param endpoint - The endpoint URL for the service.
+     * @param orgId - The organization ID.
+     * @param storeId - The store ID.
+     */
+    constructor(endpoint: string, orgId: string, storeId: string);
+    setToken(token: string): void;
+    /**
+     * Creates a new order.
+     * @param orderData - The data for the order.
+     * @param platform - The platform for the order.
+     * @param createDraft - Indicates whether to create a draft order.
+     * @returns A promise that resolves with the created order.
+     * @throws If an error occurs while creating the order.
+     */
+    createOrder(orderData: any, platform: string, createDraft: boolean): Promise<any>;
+    /**
+     * Creates a temporary order.
+     *
+     * @param orderData - The data for the order.
+     * @param platform - The platform for the order.
+     * @returns A promise that resolves to the response from the server.
+     * @throws If an error occurs during the API call.
+     */
+    createOrderTemp(orderData: any, platform: string): Promise<any>;
+    /**
+     * Completes multiple orders.
+     * @param orderIds - The IDs of the orders to complete.
+     * @returns A promise that resolves when the orders are completed.
+     * @throws If an error occurs while completing the orders.
+     */
+    completeOrder(orderIds: string[]): Promise<any>;
+    /**
+     * Adds a voucher to an order.
+     * @param orderId - The ID of the order.
+     * @param voucherCode - The voucher code.
+     * @returns A promise that resolves when the voucher is added.
+     * @throws If an error occurs while adding the voucher.
+     */
+    addVoucher(orderId: string, voucherCode: string): Promise<any>;
+    /**
+     * Removes a voucher from an order.
+     * @param orderId - The ID of the order.
+     * @param voucherCode - The voucher code.
+     * @returns A promise that resolves when the voucher is removed.
+     * @throws If an error occurs while removing the voucher.
+     */
+    removeVoucher(orderId: string, voucherCode: string): Promise<any>;
+    /**
+     * Updates the VAT (Value Added Tax) for an order.
+     * @param orderId - The ID of the order.
+     * @param vatFee - The VAT fee.
+     * @param vatType - The VAT type. (e.g., VALUE_GOODS, PRODUCT, etc.    )
+     * @returns A promise that resolves when the VAT is updated.
+     * @throws If an error occurs while updating the VAT.
+     */
+    updateVAT(orderId: string, vatFee: number, vatType: string): Promise<any>;
+    /**
+     * Updates the customer and shipping address for an order.
+     * @param orderId - The ID of the order.
+     * @param customerData - The data for the customer.
+     * @param shippingAddress - The shipping address.
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateCustomerAndShippingAddress(orderId: string, customerData: string, shippingAddress: string): Promise<any>;
+    /**
+     * Retrieves the order line items for a specific order.
+     * @param partnerId - The partner ID.
+     * @returns A promise that resolves with the order line items.
+     * @throws If an error occurs while retrieving the order line items.
+     */
+    /**
+     * Adds order line items to an order.
+     * @param orderId - The ID of the order.
+     * @param lineItems - The line items to add.
+     * @returns A promise that resolves when the line items are added.
+     * @throws If an error occurs while adding the line items.
+     */
+    addOrderLineItems(orderId: string, lineItems: LineItem[]): Promise<any>;
+    /**
+     * Update Quantity in an order
+     * @param orderId - The id of the order .
+     * @param orderItemId - The id of order item.
+     * @param quantity - Quantity of profuct in order.
+     * @returns A promise that resolves with the created order.
+     * @throws If an error occurs while creating the order.
+     */
+    updateQuantityProductInOrder(orderId: string, orderItemId: string, quantity: number): Promise<any>;
+    /**
+     *Updates sale Employee
+     * @param orderId - The ID of the order.
+     * @param saleId - The Id of saler.
+     * @param updatedBy - Who update.
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateSaleEmployee(orderId: string, saleId: string, updatedBy: string): Promise<any>;
+    /**
+     *Update type of order
+     * @param orderId - The ID of the order.
+     * @param orderType - The type of order.
+     * @param updatedBy - Id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateOrderType(orderId: string, orderType: string, updatedBy: string): Promise<any>;
+    /**
+     * Update new price in order
+     * @param orderId - The ID of the order.
+     * @param orderItemId - The id of order.
+     * @param priceNew - the new price after update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updatePriceInOrder(orderId: string, orderItemId: string, priceNew: number): Promise<any>;
+    /**
+     * Update discount price in order
+     * @param orderId - The ID of the order.
+     * @param orderItemId - The id of order.
+     * @param requestData - The request data
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateDiscountPriceInOrder(orderId: string, orderItemId: string, requestData: DiscountCampaign): Promise<any>;
+    /**
+     * Update cancel order
+     * @param orderId - The ID of the order.
+     * @param requestData
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateCancelOrder(orderId: string, requestData: CancelOrder): Promise<any>;
+    /**
+     * Update status of return order
+     * @param orderId - The ID of the order.
+     * @param statusNew - the new status of order
+     * @param updatedBy - Id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateStatusReturnOrder(orderId: string, statusNew: string, updatedBy: string): Promise<any>;
+    /**
+     * Update Shipping service
+     * @param orderId - The ID of the order.
+     * @param shippingServiceId - the id of shipping service
+     * @param updatedBy - Id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateShippngService(orderId: string, shippingServiceId: string, updatedBy: string): Promise<any>;
+    /**
+     * Update shipping order
+     * @param orderId - The ID of the order.
+     * @param shippingId - the id of shipping
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateShippingOrder(orderId: string, shippingId: string): Promise<any>;
+    /**
+     * Update shipping fee
+     * @param orderId - The ID of the order.
+     * @param shippingFee - the fee of shipping
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateShippingFee(orderId: string, shipingFee: Number): Promise<any>;
+    /**
+     * Update Financial Status after payment success
+     * @param orderId - The ID of the order.
+     * @param financialStatus - the status of financial
+     * @param updatedBy - Id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateFinancialStatus(orderId: string, financialStatus: string, updatedBy: string): Promise<any>;
+    /**
+     * Update warehouse of order
+     * @param orderId - The ID of the order.
+     * @param warehouseId - the status of warehouse
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateWareHouseOrder(orderId: String, warehouseId: string): Promise<any>;
+    /**
+     * Update voucher
+     * @param orderId - The ID of the order.
+     * @param voucherCode - the code of voucher
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateVoucher(orderId: string, voucherCode: string): Promise<any>;
+    /**
+     * Update Vat
+     * @param orderId - The ID of the order.
+     * @param vatFee - The fee of VAT
+     * @param vatType - The type of vat
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateVat(orderId: string, vatFee: number, vatType: string): Promise<any>;
+    /**
+     * Update Status of l order
+     * @param orderId - The ID of the order.
+     * @param status - The status of sell order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateStatusSellOrder(orderId: string, status: string): Promise<any>;
+    /**
+     * Update date remain in total price
+     * @param orderId - The ID of the order.
+     * @param updatedBy - Id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateRemainToTalPrice(orderId: string, updatedBy: string): Promise<any>;
+    /**
+     * Update date create order
+     * @param orderId - The ID of the order.
+     * @param orderDate - The date of order
+     * @param updatedBy - Id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateDateCreateOrder(orderId: string, orderDate: number, updatedBy: string): Promise<any>;
+    /**
+     * Update membership discount
+     * @param orderId - The ID of the order.
+     * @param requestData
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateMemberDiscount(orderId: string, requestData: MemberDiscount): Promise<any>;
+    /**
+     * Update status editable order
+     * @param orderId - The ID of the order.
+     * @param editable - The editable of
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateEditableOrder(orderId: string, editable: boolean): Promise<any>;
+    /**
+     * Update discount
+     * @param orderId - The ID of the order.
+     * @param requestData
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateDiscount(orderId: string, requestData: MemberDiscount): Promise<any>;
+    /**
+     * Update info campaign promotion
+     * @param orderId - The ID of the order.
+     * @param requestData
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateInfoCampaignPromotion(orderId: string, requestData: CampaignPromotion): Promise<any>;
+    /**
+     * Get list shipping service
+     * @param shippingCarrierId - The ID of the campaign
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListShippingService(shippingCarrierId: string): Promise<any>;
+    /**
+     * Get info sell order
+     * @param orderId - The ID of the order.
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getInfoSellOrder(orderId: string): Promise<any>;
+    /**
+     * Get info return order
+     * @param orderId - The ID of the order.
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getInfoReturnOrder(orderId: string): Promise<any>;
+    /**
+     * Get list type order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListTypeOrder(): Promise<any>;
+    /**
+     * GEt list shipping carrier
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListShippingCarrier(): Promise<any>;
+    /**
+     * Get list sell order
+     * @param orderId
+     * @param requestData
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListSellOrder(requestData: OrderQuery): Promise<any>;
+    getDiaries(requestData: OrderQuery): Promise<any>;
+    /**
+     * Get list sale order status
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListSaleOrderStatus(): Promise<any>;
+    /**
+     * Get list return order
+     * @param orderId - The id of the order
+     * @param requestData
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListReturnOrder(orderId: string, requestData: OrderQuery): Promise<any>;
+    /**
+     * Get list return order status
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListReturnOrderStatus(): Promise<any>;
+    /**
+     * remove draft order
+     * @param orderId - The id of order
+     * @param updatedBy - Thi id of person update
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    removeDraftOrder(orderId: string, updatedBy: string): Promise<any>;
+    /**
+     * Cancel product in order
+     * @param orderId - The id of order
+     * @param orderItemId - Thi id of item order
+     * @param reason - The reason of cancel product in order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    cancelProductInOrder(orderId: string, orderItemId: string, reason: string): Promise<any>;
+    /**
+     * Remove Product in order
+     * @param orderId - The id of order
+     * @param orderItemId - Thi id of item order
+     * @param reason - The reason of cancel product in order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    removeProductInOrder(orderId: string, orderItemId: string, reason: string): Promise<any>;
+    /**
+     * Print order pdf
+     * @param orderId - The id of order
+     * @param paymentMethod - Thi id of item order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    printOrderPdf(orderId: string, paymentMethod: string): Promise<any>;
+    /**
+     * Print order HTML
+     * @param orderId - The id of order
+     * @param paymentMethod - Thi id of item order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    printOrderHtml(orderId: string, paymentMethod: string): Promise<any>;
+    /**
+     * Create an orderReturn
+     * @param orderData - The id of order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    createOrderReturn(orderData: any): Promise<any>;
+    /**
+     * Caculate the order
+     * @param orderData - The data from the order
+     * @returns A promise that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    calculateOrder(orderData: any): Promise<any>;
+    /**
+     * get amount product able order
+     * @param productIds - The id of product
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getQuantityAbleOrder(productIds: string[]): Promise<any>;
+    /**
+     * updatee note without login
+     * @param orderId - The id of the order
+     * @param noteId - The id of the note
+     * @param note - The content of the note
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    updateNoteWithoutLogin(orderId: string, noteId: string, note: string): Promise<any>;
+    /**
+     * add voucher without login
+     * @param orderId - The id of the order
+     * @param voucherCode - The code of voucher
+     * @param updatedBy
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    addVoucherWithoutLogin(orderId: string, voucherCode: string, updatedBy: "SYSTEM"): Promise<any>;
+    /**
+     * delete voucher without login
+     * @param orderId - The id of the order
+     * @param voucherCode - The code of voucher
+     * @param updatedBy
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    deleteVoucherLogin(orderId: string, voucherCode: string, updatedBy: "SYSTEM"): Promise<any>;
+    /**
+     * get list  note without login
+     * @param orderId - The id of the order
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListNoteWithoutLogin(orderId: string): Promise<any>;
+    /**
+     * create note without login
+     * @param orderId - The id of the order
+     * @param createdBy
+     * @param note
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    createNoteWithoutLogin(orderId: string, createdBy: string, note: string): Promise<any>;
+    /**
+     * get list order realation
+     * @param orderIds
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    getListOrderRelationsWithoutLogin(orderIds: string[]): Promise<any>;
+    /**
+     * get list order realation
+     * @param orderId - The id of order
+     * @param noteId - The id of note
+     * @param deletedBy - The id of person delete
+     * @returns A prom that resolves when the customer and shipping address are updated.
+     * @throws If an error occurs while updating the customer and shipping address.
+     */
+    deleteNoteWithoutLogin(orderId: string, noteId: string, deletedBy: string): Promise<any>;
+    updateOrderDescription(orderId: string, description: string): Promise<any>;
+    getOrderDetail(orderId: string): Promise<any>;
+}