@gofynd/fdk-client-javascript 1.4.5 → 1.4.7

package/README.md

@@ -214,7 +214,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.5' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.7' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.4.5",
+  "version": "1.4.7",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -19,7 +19,7 @@
     "loglevel": "^1.8.1",
     "query-string": "^7.1.3",
     "@gofynd/fp-signature": "^1.0.1",
-    "@gofynd/flick": "^1.0.6"
+    "@gofynd/flick": "^1.0.7"
   },
   "devDependencies": {
     "axios-cookiejar-support": "^4.0.6",

package/sdk/application/ApplicationClient.d.ts

@@ -19,11 +19,11 @@ declare class ApplicationClient {
     logistic: Logistic;
     order: Order;
     payment: Payment;
-    posCart: PosCart;
     rewards: Rewards;
     share: Share;
     theme: Theme;
     user: User;
+    webhook: Webhook;
     /**
      * Sets the cookie for the application.
      *
@@ -67,8 +67,8 @@ import Lead = require("./Lead/LeadApplicationClient");
 import Logistic = require("./Logistic/LogisticApplicationClient");
 import Order = require("./Order/OrderApplicationClient");
 import Payment = require("./Payment/PaymentApplicationClient");
-import PosCart = require("./PosCart/PosCartApplicationClient");
 import Rewards = require("./Rewards/RewardsApplicationClient");
 import Share = require("./Share/ShareApplicationClient");
 import Theme = require("./Theme/ThemeApplicationClient");
 import User = require("./User/UserApplicationClient");
+import Webhook = require("./Webhook/WebhookApplicationClient");

package/sdk/application/ApplicationClient.js

@@ -9,11 +9,11 @@ const Lead = require("./Lead/LeadApplicationClient");
 const Logistic = require("./Logistic/LogisticApplicationClient");
 const Order = require("./Order/OrderApplicationClient");
 const Payment = require("./Payment/PaymentApplicationClient");
-const PosCart = require("./PosCart/PosCartApplicationClient");
 const Rewards = require("./Rewards/RewardsApplicationClient");
 const Share = require("./Share/ShareApplicationClient");
 const Theme = require("./Theme/ThemeApplicationClient");
 const User = require("./User/UserApplicationClient");
+const Webhook = require("./Webhook/WebhookApplicationClient");
 const { FDKClientValidationError } = require("../common/FDKError");
 const { Logger } = require("../common/Logger");
 const { convertStringToBase64 } = require("../common/utils");
@@ -38,11 +38,11 @@ class ApplicationClient {
     this.logistic = new Logistic(config);
     this.order = new Order(config);
     this.payment = new Payment(config);
-    this.posCart = new PosCart(config);
     this.rewards = new Rewards(config);
     this.share = new Share(config);
     this.theme = new Theme(config);
     this.user = new User(config);
+    this.webhook = new Webhook(config);
     if (
       typeof window != "undefined" &&
       config.options &&

package/sdk/application/Catalog/CatalogApplicationClient.d.ts

@@ -164,7 +164,7 @@ declare class Catalog {
      *   - Success response
      *
      * @name getCollections
-     * @summary: List Collection
+     * @summary: List collections
      * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
      */
     getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
@@ -174,7 +174,7 @@ declare class Catalog {
      * @param {string[]} [arg.tag] - List of tags to filter collections
      * @param {string} [arg.q] - Name of the collection to filter collection
      * @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
-     * @summary: List Collection
+     * @summary: List collections
      * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names.
      */
     getCollectionsPaginator({ pageSize, tag, q }?: {
@@ -223,7 +223,7 @@ declare class Catalog {
      * @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
      *   Success response
      * @name getFollowedListing
-     * @summary: List followed products/brands
+     * @summary: List followed products, brands
      * @description: Retrieve a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
      */
     getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponse>;
@@ -233,7 +233,7 @@ declare class Catalog {
      *   products, brands, or collections.
      * @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
      * @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
-     * @summary: List followed products/brands
+     * @summary: List followed products, brands
      * @description: Retrieve a list of products or brands the user is following.
      */
     getFollowedListingPaginator({ collectionType, pageSize }?: {
@@ -449,7 +449,7 @@ declare class Catalog {
      * @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
      *   Success response
      * @name getProductVariantsBySlug
-     * @summary: List product variant
+     * @summary: List product variants
      * @description: Retrieves all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
      */
     getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponse>;

package/sdk/application/Catalog/CatalogApplicationClient.js

@@ -759,7 +759,7 @@ class Catalog {
    *   - Success response
    *
    * @name getCollections
-   * @summary: List Collection
+   * @summary: List collections
    * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
    */
   async getCollections(
@@ -841,7 +841,7 @@ class Catalog {
    * @param {string[]} [arg.tag] - List of tags to filter collections
    * @param {string} [arg.q] - Name of the collection to filter collection
    * @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
-   * @summary: List Collection
+   * @summary: List collections
    * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names.
    */
   getCollectionsPaginator({ pageSize, tag, q } = {}) {
@@ -1114,7 +1114,7 @@ class Catalog {
    * @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
    *   Success response
    * @name getFollowedListing
-   * @summary: List followed products/brands
+   * @summary: List followed products, brands
    * @description: Retrieve a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
    */
   async getFollowedListing(
@@ -1196,7 +1196,7 @@ class Catalog {
    *   products, brands, or collections.
    * @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
    * @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
-   * @summary: List followed products/brands
+   * @summary: List followed products, brands
    * @description: Retrieve a list of products or brands the user is following.
    */
   getFollowedListingPaginator({ collectionType, pageSize } = {}) {
@@ -2380,7 +2380,7 @@ class Catalog {
    * @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
    *   Success response
    * @name getProductVariantsBySlug
-   * @summary: List product variant
+   * @summary: List product variants
    * @description: Retrieves all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
    */
   async getProductVariantsBySlug(

package/sdk/application/Catalog/CatalogApplicationModel.d.ts

@@ -220,6 +220,7 @@ export = CatalogApplicationModel;
  * @typedef ProductSizes
  * @property {ProductSize[]} [sizes]
  * @property {ProductSizesPrice} [price]
+ * @property {ProductSizesPrice} [price_per_piece]
  * @property {SizeChart} [size_chart]
  * @property {boolean} [sellable]
  * @property {boolean} [multi_size]
@@ -266,6 +267,7 @@ export = CatalogApplicationModel;
  * @property {string} [name]
  * @property {string} [value]
  * @property {string} [slug]
+ * @property {Object} [_custom_json]
  * @property {ProductListingAction} [action]
  */
 /**
@@ -274,6 +276,7 @@ export = CatalogApplicationModel;
  * @property {string} [header]
  * @property {ProductVariantItemResponse[]} [items]
  * @property {string} [key]
+ * @property {string} [logo]
  */
 /**
  * @typedef ProductVariantsResponse
@@ -1303,6 +1306,7 @@ declare function ProductSizes(): ProductSizes;
 type ProductSizes = {
     sizes?: ProductSize[];
     price?: ProductSizesPrice;
+    price_per_piece?: ProductSizesPrice;
     size_chart?: SizeChart;
     sellable?: boolean;
     multi_size?: boolean;
@@ -1355,6 +1359,7 @@ type ProductVariantItemResponse = {
     name?: string;
     value?: string;
     slug?: string;
+    _custom_json?: any;
     action?: ProductListingAction;
 };
 /** @returns {ProductVariantResponse} */
@@ -1364,6 +1369,7 @@ type ProductVariantResponse = {
     header?: string;
     items?: ProductVariantItemResponse[];
     key?: string;
+    logo?: string;
 };
 /** @returns {ProductVariantsResponse} */
 declare function ProductVariantsResponse(): ProductVariantsResponse;

package/sdk/application/Catalog/CatalogApplicationModel.js

@@ -249,6 +249,7 @@ const Joi = require("joi");
  * @typedef ProductSizes
  * @property {ProductSize[]} [sizes]
  * @property {ProductSizesPrice} [price]
+ * @property {ProductSizesPrice} [price_per_piece]
  * @property {SizeChart} [size_chart]
  * @property {boolean} [sellable]
  * @property {boolean} [multi_size]
@@ -301,6 +302,7 @@ const Joi = require("joi");
  * @property {string} [name]
  * @property {string} [value]
  * @property {string} [slug]
+ * @property {Object} [_custom_json]
  * @property {ProductListingAction} [action]
  */
 
@@ -310,6 +312,7 @@ const Joi = require("joi");
  * @property {string} [header]
  * @property {ProductVariantItemResponse[]} [items]
  * @property {string} [key]
+ * @property {string} [logo]
  */
 
 /**
@@ -1400,6 +1403,7 @@ class CatalogApplicationModel {
     return Joi.object({
       sizes: Joi.array().items(CatalogApplicationModel.ProductSize()),
       price: CatalogApplicationModel.ProductSizesPrice(),
+      price_per_piece: CatalogApplicationModel.ProductSizesPrice(),
       size_chart: CatalogApplicationModel.SizeChart(),
       sellable: Joi.boolean(),
       multi_size: Joi.boolean(),
@@ -1470,6 +1474,7 @@ class CatalogApplicationModel {
       name: Joi.string().allow(""),
       value: Joi.string().allow(""),
       slug: Joi.string().allow(""),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
       action: CatalogApplicationModel.ProductListingAction(),
     });
   }
@@ -1483,6 +1488,7 @@ class CatalogApplicationModel {
         CatalogApplicationModel.ProductVariantItemResponse()
       ),
       key: Joi.string().allow(""),
+      logo: Joi.string().allow(""),
     });
   }
 

package/sdk/application/Content/ContentApplicationModel.d.ts

@@ -119,6 +119,7 @@ export = ContentApplicationModel;
  * @property {string} [reading_time]
  * @property {string} [slug]
  * @property {string[]} [tags]
+ * @property {string} [publish_date]
  * @property {SEO} [seo]
  * @property {CronSchedule} [_schedule]
  * @property {string} [title]
@@ -727,6 +728,7 @@ type BlogSchema = {
     reading_time?: string;
     slug?: string;
     tags?: string[];
+    publish_date?: string;
     seo?: SEO;
     _schedule?: CronSchedule;
     title?: string;

package/sdk/application/Content/ContentApplicationModel.js

@@ -136,6 +136,7 @@ const Joi = require("joi");
  * @property {string} [reading_time]
  * @property {string} [slug]
  * @property {string[]} [tags]
+ * @property {string} [publish_date]
  * @property {SEO} [seo]
  * @property {CronSchedule} [_schedule]
  * @property {string} [title]
@@ -833,6 +834,7 @@ class ContentApplicationModel {
       reading_time: Joi.string().allow(""),
       slug: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
+      publish_date: Joi.string().allow(""),
       seo: ContentApplicationModel.SEO(),
       _schedule: ContentApplicationModel.CronSchedule(),
       title: Joi.string().allow(""),

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -772,7 +772,7 @@ class LogisticApplicationModel {
       display_name: Joi.string().allow(""),
       iso2: Joi.string().allow(""),
       iso3: Joi.string().allow(""),
-      timezones: Joi.array().items(Joi.string().allow("")),
+      timezones: Joi.array().items(Joi.string().allow("")).allow(null, ""),
       hierarchy: Joi.array().items(LogisticApplicationModel.CountryHierarchy()),
       phone_code: Joi.string().allow(""),
       latitude: Joi.string().allow(""),
@@ -900,7 +900,7 @@ class LogisticApplicationModel {
       display_name: Joi.string().allow(""),
       iso2: Joi.string().allow(""),
       iso3: Joi.string().allow(""),
-      timezones: Joi.array().items(Joi.string().allow("")),
+      timezones: Joi.array().items(Joi.string().allow("")).allow(null, ""),
       hierarchy: Joi.array().items(LogisticApplicationModel.CountryHierarchy()),
       phone_code: Joi.string().allow(""),
       latitude: Joi.string().allow(""),

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

@@ -47,7 +47,7 @@ declare class Order {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
      * @name getOrderById
-     * @summary: Get a order
+     * @summary: Get an order
      * @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
      */
     getOrderById({ orderId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;

package/sdk/application/Order/OrderApplicationClient.js

@@ -221,7 +221,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
    * @name getOrderById
-   * @summary: Get a order
+   * @summary: Get an order
    * @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
    */
   async getOrderById(

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

@@ -33,6 +33,20 @@ export = OrderApplicationModel;
  * @property {string} [logo]
  * @property {string} [display_name]
  */
+/**
+ * @typedef ShipmentPaymentInfo
+ * @property {string} [mop] - Stands for "Mode of Payment". This is a short code
+ *   (like "COD" for Cash On Delivery) that represents the payment method used.
+ * @property {string} [payment_mode] - Information about the payment mode,
+ *   indicates whether COD or PREPAID
+ * @property {string} [status] - Indicates the current status of the payment,
+ *   Paid or Unpaid
+ * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI
+ * @property {string} [logo] - A URL to an image representing the payment method
+ * @property {string} [display_name] - The name of the payment method as it
+ *   should be displayed to the user
+ * @property {number} [amount] - Amount paid using this payment method
+ */
 /**
  * @typedef ShipmentUserInfo
  * @property {string} [first_name]
@@ -232,7 +246,7 @@ export = OrderApplicationModel;
  * @property {string[]} [tags]
  */
 /**
- * @typedef DeliveryAddress
+ * @typedef Address
  * @property {string} [pincode]
  * @property {string} [phone]
  * @property {number} [latitude]
@@ -260,7 +274,9 @@ export = OrderApplicationModel;
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
- * @property {ShipmentPayment[]} [payment_info]
+ * @property {ShipmentPaymentInfo[]} [payment_info] - "Array of objects
+ *   containing payment methods used for placing an order. Each object will
+ *   provide information about corresponding payment method with relevant details."
  * @property {string} [order_type]
  * @property {boolean} [show_download_invoice]
  * @property {boolean} [can_cancel]
@@ -291,7 +307,8 @@ export = OrderApplicationModel;
  * @property {boolean} [beneficiary_details]
  * @property {FulfillingCompany} [fulfilling_company]
  * @property {boolean} [can_return]
- * @property {DeliveryAddress} [delivery_address]
+ * @property {Address} [delivery_address]
+ * @property {Address} [billing_address]
  * @property {string} [track_url]
  * @property {string} [order_id]
  * @property {string} [need_help_url]
@@ -316,6 +333,7 @@ export = OrderApplicationModel;
 /**
  * @typedef OrderSchema
  * @property {number} [total_shipments_in_order]
+ * @property {string} [gstin_code]
  * @property {UserInfo} [user_info]
  * @property {BreakupValues[]} [breakup_values]
  * @property {string} [order_created_time]
@@ -536,7 +554,7 @@ export = OrderApplicationModel;
 declare class OrderApplicationModel {
 }
 declare namespace OrderApplicationModel {
-    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, DeliveryAddress, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, OrderRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
+    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentPaymentInfo, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, Address, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, OrderRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
 }
 /** @returns {OrderPage} */
 declare function OrderPage(): OrderPage;
@@ -576,6 +594,42 @@ type ShipmentPayment = {
     logo?: string;
     display_name?: string;
 };
+/** @returns {ShipmentPaymentInfo} */
+declare function ShipmentPaymentInfo(): ShipmentPaymentInfo;
+type ShipmentPaymentInfo = {
+    /**
+     * - Stands for "Mode of Payment". This is a short code
+     * (like "COD" for Cash On Delivery) that represents the payment method used.
+     */
+    mop?: string;
+    /**
+     * - Information about the payment mode,
+     * indicates whether COD or PREPAID
+     */
+    payment_mode?: string;
+    /**
+     * - Indicates the current status of the payment,
+     * Paid or Unpaid
+     */
+    status?: string;
+    /**
+     * - Information about the payment source. For eg, NB_ICICI
+     */
+    mode?: string;
+    /**
+     * - A URL to an image representing the payment method
+     */
+    logo?: string;
+    /**
+     * - The name of the payment method as it
+     * should be displayed to the user
+     */
+    display_name?: string;
+    /**
+     * - Amount paid using this payment method
+     */
+    amount?: number;
+};
 /** @returns {ShipmentUserInfo} */
 declare function ShipmentUserInfo(): ShipmentUserInfo;
 type ShipmentUserInfo = {
@@ -794,9 +848,9 @@ declare function Article(): Article;
 type Article = {
     tags?: string[];
 };
-/** @returns {DeliveryAddress} */
-declare function DeliveryAddress(): DeliveryAddress;
-type DeliveryAddress = {
+/** @returns {Address} */
+declare function Address(): Address;
+type Address = {
     pincode?: string;
     phone?: string;
     latitude?: number;
@@ -825,7 +879,12 @@ type DeliveryAddress = {
 declare function Shipments(): Shipments;
 type Shipments = {
     payment?: ShipmentPayment;
-    payment_info?: ShipmentPayment[];
+    /**
+     * - "Array of objects
+     * containing payment methods used for placing an order. Each object will
+     * provide information about corresponding payment method with relevant details."
+     */
+    payment_info?: ShipmentPaymentInfo[];
     order_type?: string;
     show_download_invoice?: boolean;
     can_cancel?: boolean;
@@ -856,7 +915,8 @@ type Shipments = {
     beneficiary_details?: boolean;
     fulfilling_company?: FulfillingCompany;
     can_return?: boolean;
-    delivery_address?: DeliveryAddress;
+    delivery_address?: Address;
+    billing_address?: Address;
     track_url?: string;
     order_id?: string;
     need_help_url?: string;
@@ -884,6 +944,7 @@ type BagsForReorder = {
 declare function OrderSchema(): OrderSchema;
 type OrderSchema = {
     total_shipments_in_order?: number;
+    gstin_code?: string;
     user_info?: UserInfo;
     breakup_values?: BreakupValues[];
     order_created_time?: string;

package/sdk/application/Order/OrderApplicationModel.js

@@ -38,6 +38,21 @@ const Joi = require("joi");
  * @property {string} [display_name]
  */
 
+/**
+ * @typedef ShipmentPaymentInfo
+ * @property {string} [mop] - Stands for "Mode of Payment". This is a short code
+ *   (like "COD" for Cash On Delivery) that represents the payment method used.
+ * @property {string} [payment_mode] - Information about the payment mode,
+ *   indicates whether COD or PREPAID
+ * @property {string} [status] - Indicates the current status of the payment,
+ *   Paid or Unpaid
+ * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI
+ * @property {string} [logo] - A URL to an image representing the payment method
+ * @property {string} [display_name] - The name of the payment method as it
+ *   should be displayed to the user
+ * @property {number} [amount] - Amount paid using this payment method
+ */
+
 /**
  * @typedef ShipmentUserInfo
  * @property {string} [first_name]
@@ -257,7 +272,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef DeliveryAddress
+ * @typedef Address
  * @property {string} [pincode]
  * @property {string} [phone]
  * @property {number} [latitude]
@@ -286,7 +301,9 @@ const Joi = require("joi");
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
- * @property {ShipmentPayment[]} [payment_info]
+ * @property {ShipmentPaymentInfo[]} [payment_info] - "Array of objects
+ *   containing payment methods used for placing an order. Each object will
+ *   provide information about corresponding payment method with relevant details."
  * @property {string} [order_type]
  * @property {boolean} [show_download_invoice]
  * @property {boolean} [can_cancel]
@@ -317,7 +334,8 @@ const Joi = require("joi");
  * @property {boolean} [beneficiary_details]
  * @property {FulfillingCompany} [fulfilling_company]
  * @property {boolean} [can_return]
- * @property {DeliveryAddress} [delivery_address]
+ * @property {Address} [delivery_address]
+ * @property {Address} [billing_address]
  * @property {string} [track_url]
  * @property {string} [order_id]
  * @property {string} [need_help_url]
@@ -345,6 +363,7 @@ const Joi = require("joi");
 /**
  * @typedef OrderSchema
  * @property {number} [total_shipments_in_order]
+ * @property {string} [gstin_code]
  * @property {UserInfo} [user_info]
  * @property {BreakupValues[]} [breakup_values]
  * @property {string} [order_created_time]
@@ -647,6 +666,19 @@ class OrderApplicationModel {
     });
   }
 
+  /** @returns {ShipmentPaymentInfo} */
+  static ShipmentPaymentInfo() {
+    return Joi.object({
+      mop: Joi.string().allow(""),
+      payment_mode: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      mode: Joi.string().allow(""),
+      logo: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      amount: Joi.number(),
+    });
+  }
+
   /** @returns {ShipmentUserInfo} */
   static ShipmentUserInfo() {
     return Joi.object({
@@ -911,8 +943,8 @@ class OrderApplicationModel {
     });
   }
 
-  /** @returns {DeliveryAddress} */
-  static DeliveryAddress() {
+  /** @returns {Address} */
+  static Address() {
     return Joi.object({
       pincode: Joi.string().allow(""),
       phone: Joi.string().allow(""),
@@ -944,7 +976,9 @@ class OrderApplicationModel {
   static Shipments() {
     return Joi.object({
       payment: OrderApplicationModel.ShipmentPayment(),
-      payment_info: Joi.array().items(OrderApplicationModel.ShipmentPayment()),
+      payment_info: Joi.array().items(
+        OrderApplicationModel.ShipmentPaymentInfo()
+      ),
       order_type: Joi.string().allow("").allow(null),
       show_download_invoice: Joi.boolean(),
       can_cancel: Joi.boolean(),
@@ -977,7 +1011,8 @@ class OrderApplicationModel {
       beneficiary_details: Joi.boolean(),
       fulfilling_company: OrderApplicationModel.FulfillingCompany(),
       can_return: Joi.boolean(),
-      delivery_address: OrderApplicationModel.DeliveryAddress(),
+      delivery_address: OrderApplicationModel.Address(),
+      billing_address: OrderApplicationModel.Address(),
       track_url: Joi.string().allow(""),
       order_id: Joi.string().allow(""),
       need_help_url: Joi.string().allow(""),
@@ -1011,6 +1046,7 @@ class OrderApplicationModel {
   static OrderSchema() {
     return Joi.object({
       total_shipments_in_order: Joi.number(),
+      gstin_code: Joi.string().allow(""),
       user_info: OrderApplicationModel.UserInfo(),
       breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
       order_created_time: Joi.string().allow(""),

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

@@ -14,7 +14,7 @@ export = OrderApplicationValidator;
 /**
  * @typedef GetOrderByIdParam
  * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
+ *   tracking an order.
  * @property {boolean} [allowInactive] - Flag to allow inactive shipments
  */
 /**
@@ -133,7 +133,7 @@ type GetInvoiceByShipmentIdParam = {
 type GetOrderByIdParam = {
     /**
      * - A unique number used for identifying and
-     * tracking your orders.
+     * tracking an order.
      */
     orderId: string;
     /**

package/sdk/application/Order/OrderApplicationValidator.js

@@ -19,7 +19,7 @@ const OrderApplicationModel = require("./OrderApplicationModel");
 /**
  * @typedef GetOrderByIdParam
  * @property {string} orderId - A unique number used for identifying and
- *   tracking your orders.
+ *   tracking an order.
  * @property {boolean} [allowInactive] - Flag to allow inactive shipments
  */