omnisend-node-sdk/spec/Orders.js

🔹 Typesafe Omnisend API SDK for Node.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Orders = void 0;
const http_client_1 = require("../http-client");
class Orders {
    constructor(http) {
        /**
         * No description
         *
         * @tags Orders
         * @name GetOrdersOrderId
         * @summary Get order's info
         * @request GET:/orders/{orderID}
         * @secure
         */
        this.getOrdersOrderId = (orderId, params = {}) => this.http.request(Object.assign({ path: `/orders/${orderId}`, method: "GET", secure: true, format: "json" }, params));
        /**
         * @description Replace (update) existing order. All stored order data will be overwriten with request data. This method used to replace order with all its data.
         *
         * @tags Orders
         * @name PutOrdersOrderId
         * @summary Replace order
         * @request PUT:/orders/{orderID}
         * @secure
         */
        this.putOrdersOrderId = (orderId, data, params = {}) => this.http.request(Object.assign({ path: `/orders/${orderId}`, method: "PUT", body: data, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
        /**
         * @description Update order status.
         *
         * @tags Orders
         * @name PatchOrdersOrderId
         * @summary Update order status
         * @request PATCH:/orders/{orderID}
         * @secure
         */
        this.patchOrdersOrderId = (orderId, data, params = {}) => this.http.request(Object.assign({ path: `/orders/${orderId}`, method: "PATCH", body: data, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
        /**
         * @description **Curl example:** ```php curl -X DELETE "https://api.omnisend.com/v3/orders/4686288" ```
         *
         * @tags Orders
         * @name DeleteOrdersOrderId
         * @summary Delete order
         * @request DELETE:/orders/{orderID}
         * @secure
         */
        this.deleteOrdersOrderId = (orderId, params = {}) => this.http.request(Object.assign({ path: `/orders/${orderId}`, method: "DELETE", secure: true }, params));
        /**
         * @description **Sorting:** | **Parameter** | **Sort order** | **Description** | | --- | ---| --- | | createdAt | DESC | sort by order creation date - newest first | | updatedAt | DESC | sort by order update date - newest first | | orderSum | DESC | sort by order total sum - biggest on top |
         *
         * @tags Orders
         * @name GetOrders
         * @summary List orders
         * @request GET:/orders
         * @secure
         */
        this.getOrders = (query, params = {}) => this.http.request(Object.assign({ path: `/orders`, method: "GET", query, secure: true, format: "json" }, params));
        /**
         * @description While posting new order `email` or/and `phone` or/and `contactID` must be provided.
         *
         * @tags Orders
         * @name PostOrders
         * @summary Create new order
         * @request POST:/orders
         * @secure
         */
        this.postOrders = (data, params = {}) => this.http.request(Object.assign({ path: `/orders`, method: "POST", body: data, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
        this.http = http;
    }
}
exports.Orders = Orders;