@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

package/sdk/application/Order/OrderApplicationValidator.d.ts

@@ -1,279 +0,0 @@
-export = OrderApplicationValidator;
-/**
- * @typedef GetCustomerDetailsByShipmentIdParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-/**
- * @typedef GetInvoiceByShipmentIdParam
- * @property {string} shipmentId - ID of the shipment.
- */
-/**
- * @typedef GetOrderByIdParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking an order.
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
- */
-/**
- * @typedef GetOrdersParam
- * @property {number} [status] - A filter to retrieve orders by their current
- *   status such as 'placed', 'delivered' etc.
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1.
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- *   Default value is 10.
- * @property {string} [fromDate] - The date from which the orders should be retrieved.
- * @property {string} [toDate] - The date till which the orders should be retrieved.
- * @property {string} [startDate] - Start date in UTC (ISO-8601 format).
- * @property {string} [endDate] - End date in UTC (ISO-8601 format).
- * @property {string} [customMeta] - A filter and retrieve data using special
- *   fields included for special use-cases.
- * @property {boolean} [allowInactive] - Flag indicating whether inactive
- *   shipments are allowed.
- */
-/**
- * @typedef GetPosOrderByIdParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- */
-/**
- * @typedef GetShipmentBagReasonsParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {string} bagId - ID of the bag. An shipment may contain multiple
- *   items and may get divided into one or more bags, each having its own ID.
- */
-/**
- * @typedef GetShipmentByIdParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
- */
-/**
- * @typedef GetShipmentReasonsParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-/**
- * @typedef SendOtpToShipmentCustomerParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-/**
- * @typedef TrackShipmentParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-/**
- * @typedef UpdateShipmentStatusParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {OrderApplicationModel.UpdateShipmentStatusRequestSchema} body
- */
-/**
- * @typedef VerifyOtpShipmentCustomerParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {OrderApplicationModel.VerifyOtp} body
- */
-declare class OrderApplicationValidator {
-    /** @returns {GetCustomerDetailsByShipmentIdParam} */
-    static getCustomerDetailsByShipmentId(): GetCustomerDetailsByShipmentIdParam;
-    /** @returns {GetInvoiceByShipmentIdParam} */
-    static getInvoiceByShipmentId(): GetInvoiceByShipmentIdParam;
-    /** @returns {GetOrderByIdParam} */
-    static getOrderById(): GetOrderByIdParam;
-    /** @returns {GetOrdersParam} */
-    static getOrders(): GetOrdersParam;
-    /** @returns {GetPosOrderByIdParam} */
-    static getPosOrderById(): GetPosOrderByIdParam;
-    /** @returns {GetShipmentBagReasonsParam} */
-    static getShipmentBagReasons(): GetShipmentBagReasonsParam;
-    /** @returns {GetShipmentByIdParam} */
-    static getShipmentById(): GetShipmentByIdParam;
-    /** @returns {GetShipmentReasonsParam} */
-    static getShipmentReasons(): GetShipmentReasonsParam;
-    /** @returns {SendOtpToShipmentCustomerParam} */
-    static sendOtpToShipmentCustomer(): SendOtpToShipmentCustomerParam;
-    /** @returns {TrackShipmentParam} */
-    static trackShipment(): TrackShipmentParam;
-    /** @returns {UpdateShipmentStatusParam} */
-    static updateShipmentStatus(): UpdateShipmentStatusParam;
-    /** @returns {VerifyOtpShipmentCustomerParam} */
-    static verifyOtpShipmentCustomer(): VerifyOtpShipmentCustomerParam;
-}
-declare namespace OrderApplicationValidator {
-    export { GetCustomerDetailsByShipmentIdParam, GetInvoiceByShipmentIdParam, GetOrderByIdParam, GetOrdersParam, GetPosOrderByIdParam, GetShipmentBagReasonsParam, GetShipmentByIdParam, GetShipmentReasonsParam, SendOtpToShipmentCustomerParam, TrackShipmentParam, UpdateShipmentStatusParam, VerifyOtpShipmentCustomerParam };
-}
-type GetCustomerDetailsByShipmentIdParam = {
-    /**
-     * - A unique number used for identifying and
-     * tracking your orders.
-     */
-    orderId: string;
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-};
-type GetInvoiceByShipmentIdParam = {
-    /**
-     * - ID of the shipment.
-     */
-    shipmentId: string;
-};
-type GetOrderByIdParam = {
-    /**
-     * - A unique number used for identifying and
-     * tracking an order.
-     */
-    orderId: string;
-    /**
-     * - Flag to allow inactive shipments.
-     */
-    allowInactive?: boolean;
-};
-type GetOrdersParam = {
-    /**
-     * - A filter to retrieve orders by their current
-     * status such as 'placed', 'delivered' etc.
-     */
-    status?: number;
-    /**
-     * - The page number to navigate through the given
-     * set of results. Default value is 1.
-     */
-    pageNo?: number;
-    /**
-     * - The number of items to retrieve in each page.
-     * Default value is 10.
-     */
-    pageSize?: number;
-    /**
-     * - The date from which the orders should be retrieved.
-     */
-    fromDate?: string;
-    /**
-     * - The date till which the orders should be retrieved.
-     */
-    toDate?: string;
-    /**
-     * - Start date in UTC (ISO-8601 format).
-     */
-    startDate?: string;
-    /**
-     * - End date in UTC (ISO-8601 format).
-     */
-    endDate?: string;
-    /**
-     * - A filter and retrieve data using special
-     * fields included for special use-cases.
-     */
-    customMeta?: string;
-    /**
-     * - Flag indicating whether inactive
-     * shipments are allowed.
-     */
-    allowInactive?: boolean;
-};
-type GetPosOrderByIdParam = {
-    /**
-     * - A unique number used for identifying and
-     * tracking your orders.
-     */
-    orderId: string;
-};
-type GetShipmentBagReasonsParam = {
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-    /**
-     * - ID of the bag. An shipment may contain multiple
-     * items and may get divided into one or more bags, each having its own ID.
-     */
-    bagId: string;
-};
-type GetShipmentByIdParam = {
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-    /**
-     * - Flag to allow inactive shipments.
-     */
-    allowInactive?: boolean;
-};
-type GetShipmentReasonsParam = {
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-};
-type SendOtpToShipmentCustomerParam = {
-    /**
-     * - A unique number used for identifying and
-     * tracking your orders.
-     */
-    orderId: string;
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-};
-type TrackShipmentParam = {
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-};
-type UpdateShipmentStatusParam = {
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-    body: OrderApplicationModel.UpdateShipmentStatusRequestSchema;
-};
-type VerifyOtpShipmentCustomerParam = {
-    /**
-     * - A unique number used for identifying and
-     * tracking your orders.
-     */
-    orderId: string;
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-    body: OrderApplicationModel.VerifyOtp;
-};
-import OrderApplicationModel = require("./OrderApplicationModel");

package/sdk/application/Order/OrderApplicationValidator.js

@@ -1,210 +0,0 @@
-const Joi = require("joi");
-
-const OrderApplicationModel = require("./OrderApplicationModel");
-
-/**
- * @typedef GetCustomerDetailsByShipmentIdParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-
-/**
- * @typedef GetInvoiceByShipmentIdParam
- * @property {string} shipmentId - ID of the shipment.
- */
-
-/**
- * @typedef GetOrderByIdParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking an order.
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
- */
-
-/**
- * @typedef GetOrdersParam
- * @property {number} [status] - A filter to retrieve orders by their current
- *   status such as 'placed', 'delivered' etc.
- * @property {number} [pageNo] - The page number to navigate through the given
- *   set of results. Default value is 1.
- * @property {number} [pageSize] - The number of items to retrieve in each page.
- *   Default value is 10.
- * @property {string} [fromDate] - The date from which the orders should be retrieved.
- * @property {string} [toDate] - The date till which the orders should be retrieved.
- * @property {string} [startDate] - Start date in UTC (ISO-8601 format).
- * @property {string} [endDate] - End date in UTC (ISO-8601 format).
- * @property {string} [customMeta] - A filter and retrieve data using special
- *   fields included for special use-cases.
- * @property {boolean} [allowInactive] - Flag indicating whether inactive
- *   shipments are allowed.
- */
-
-/**
- * @typedef GetPosOrderByIdParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- */
-
-/**
- * @typedef GetShipmentBagReasonsParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {string} bagId - ID of the bag. An shipment may contain multiple
- *   items and may get divided into one or more bags, each having its own ID.
- */
-
-/**
- * @typedef GetShipmentByIdParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
- */
-
-/**
- * @typedef GetShipmentReasonsParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-
-/**
- * @typedef SendOtpToShipmentCustomerParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-
-/**
- * @typedef TrackShipmentParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- */
-
-/**
- * @typedef UpdateShipmentStatusParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {OrderApplicationModel.UpdateShipmentStatusRequestSchema} body
- */
-
-/**
- * @typedef VerifyOtpShipmentCustomerParam
- * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {OrderApplicationModel.VerifyOtp} body
- */
-
-class OrderApplicationValidator {
-  /** @returns {GetCustomerDetailsByShipmentIdParam} */
-  static getCustomerDetailsByShipmentId() {
-    return Joi.object({
-      orderId: Joi.string().allow("").required(),
-      shipmentId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetInvoiceByShipmentIdParam} */
-  static getInvoiceByShipmentId() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetOrderByIdParam} */
-  static getOrderById() {
-    return Joi.object({
-      orderId: Joi.string().allow("").required(),
-      allowInactive: Joi.boolean(),
-    }).required();
-  }
-
-  /** @returns {GetOrdersParam} */
-  static getOrders() {
-    return Joi.object({
-      status: Joi.number(),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
-      customMeta: Joi.string().allow(""),
-      allowInactive: Joi.boolean(),
-    });
-  }
-
-  /** @returns {GetPosOrderByIdParam} */
-  static getPosOrderById() {
-    return Joi.object({
-      orderId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetShipmentBagReasonsParam} */
-  static getShipmentBagReasons() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-      bagId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetShipmentByIdParam} */
-  static getShipmentById() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-      allowInactive: Joi.boolean(),
-    }).required();
-  }
-
-  /** @returns {GetShipmentReasonsParam} */
-  static getShipmentReasons() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {SendOtpToShipmentCustomerParam} */
-  static sendOtpToShipmentCustomer() {
-    return Joi.object({
-      orderId: Joi.string().allow("").required(),
-      shipmentId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {TrackShipmentParam} */
-  static trackShipment() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {UpdateShipmentStatusParam} */
-  static updateShipmentStatus() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-      body: OrderApplicationModel.UpdateShipmentStatusRequestSchema().required(),
-    }).required();
-  }
-
-  /** @returns {VerifyOtpShipmentCustomerParam} */
-  static verifyOtpShipmentCustomer() {
-    return Joi.object({
-      orderId: Joi.string().allow("").required(),
-      shipmentId: Joi.string().allow("").required(),
-      body: OrderApplicationModel.VerifyOtp().required(),
-    }).required();
-  }
-}
-
-module.exports = OrderApplicationValidator;