@gofynd/fdk-client-javascript 1.1.1 → 1.1.3

package/sdk/application/Catalog/CatalogApplicationClient.js

@@ -523,6 +523,8 @@ class Catalog {
    *   will be passed in f parameter as shown in the example below. Double
    *   Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
    *   indicates a new filter paramater applied as an AND condition.
+   * @param {string} [arg.q] - The search query for entering partial or full
+   *   name of product, brand, category, or collection.
    * @param {boolean} [arg.filters] - This is a boolean value, True for
    *   fetching all filter parameters and False for disabling the filter parameters.
    * @param {string} [arg.sortOn] - The order in which the list of products
@@ -540,6 +542,7 @@ class Catalog {
   async getCollectionItemsBySlug({
     slug,
     f,
+    q,
     filters,
     sortOn,
     pageId,
@@ -548,7 +551,7 @@ class Catalog {
     pageType,
   } = {}) {
     const { error } = CatalogValidator.getCollectionItemsBySlug().validate(
-      { slug, f, filters, sortOn, pageId, pageSize, pageNo, pageType },
+      { slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -559,7 +562,7 @@ class Catalog {
     const {
       error: warrning,
     } = CatalogValidator.getCollectionItemsBySlug().validate(
-      { slug, f, filters, sortOn, pageId, pageSize, pageNo, pageType },
+      { slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -572,6 +575,7 @@ class Catalog {
 
     const query_params = {};
     query_params["f"] = f;
+    query_params["q"] = q;
     query_params["filters"] = filters;
     query_params["sort_on"] = sortOn;
     query_params["page_id"] = pageId;
@@ -620,6 +624,8 @@ class Catalog {
    *   will be passed in f parameter as shown in the example below. Double
    *   Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
    *   indicates a new filter paramater applied as an AND condition.
+   * @param {string} [arg.q] - The search query for entering partial or full
+   *   name of product, brand, category, or collection.
    * @param {boolean} [arg.filters] - This is a boolean value, True for
    *   fetching all filter parameters and False for disabling the filter parameters.
    * @param {string} [arg.sortOn] - The order in which the list of products
@@ -632,6 +638,7 @@ class Catalog {
   getCollectionItemsBySlugPaginator({
     slug,
     f,
+    q,
     filters,
     sortOn,
     pageSize,
@@ -644,6 +651,7 @@ class Catalog {
       const data = await this.getCollectionItemsBySlug({
         slug: slug,
         f: f,
+        q: q,
         filters: filters,
         sortOn: sortOn,
         pageId: pageId,
@@ -667,13 +675,14 @@ class Catalog {
    *   given set of results.
    * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
    * @param {string[]} [arg.tag] - List of tags to filter collections
+   * @param {string} [arg.q] - Name of the collection to filter collection
    * @returns {Promise<GetCollectionListingResponse>} - Success response
    * @summary: List all the collections
    * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
    */
-  async getCollections({ pageNo, pageSize, tag } = {}) {
+  async getCollections({ pageNo, pageSize, tag, q } = {}) {
     const { error } = CatalogValidator.getCollections().validate(
-      { pageNo, pageSize, tag },
+      { pageNo, pageSize, tag, q },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -682,7 +691,7 @@ class Catalog {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = CatalogValidator.getCollections().validate(
-      { pageNo, pageSize, tag },
+      { pageNo, pageSize, tag, q },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -697,6 +706,7 @@ class Catalog {
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
     query_params["tag"] = tag;
+    query_params["q"] = q;
 
     const xHeaders = {};
 
@@ -734,10 +744,11 @@ class Catalog {
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
    * @param {string[]} [arg.tag] - List of tags to filter collections
+   * @param {string} [arg.q] - Name of the collection to filter collection
    * @summary: List all the collections
    * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
    */
-  getCollectionsPaginator({ pageSize, tag } = {}) {
+  getCollectionsPaginator({ pageSize, tag, q } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
       const pageId = paginator.nextId;
@@ -747,6 +758,7 @@ class Catalog {
         pageNo: pageNo,
         pageSize: pageSize,
         tag: tag,
+        q: q,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,

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

@@ -56,6 +56,7 @@ declare class CatalogModel {
     static ProductCompareResponse(): any;
     static ProductDetail(): any;
     static ProductDetailAttribute(): any;
+    static ProductDetailCustomOrder(): any;
     static ProductDetailGroupedAttribute(): any;
     static ProductDetails(): any;
     static ProductFilters(): any;

package/sdk/application/Catalog/CatalogApplicationModel.js

@@ -436,6 +436,7 @@ class CatalogModel {
       categories: Joi.array().items(CatalogModel.ProductBrand()),
       category_map: CatalogModel.ProductCategoryMap(),
       color: Joi.string().allow(""),
+      custom_order: CatalogModel.ProductDetailCustomOrder(),
       description: Joi.string().allow(""),
       discount: Joi.string().allow(""),
       grouped_attributes: Joi.array().items(
@@ -452,6 +453,7 @@ class CatalogModel {
       name: Joi.string().allow(""),
       net_quantity: CatalogModel.NetQuantity(),
       price: CatalogModel.ProductListingPrice(),
+      product_group_tag: Joi.array().items(Joi.string().allow("")),
       product_online_date: Joi.string().allow(""),
       rating: Joi.number(),
       rating_count: Joi.number(),
@@ -473,6 +475,13 @@ class CatalogModel {
       value: Joi.string().allow(""),
     });
   }
+  static ProductDetailCustomOrder() {
+    return Joi.object({
+      is_custom_order: Joi.boolean(),
+      manufacturing_time: Joi.number(),
+      manufacturing_time_unit: Joi.string().allow(""),
+    });
+  }
   static ProductDetailGroupedAttribute() {
     return Joi.object({
       details: Joi.array().items(CatalogModel.ProductDetailAttribute()),
@@ -605,6 +614,7 @@ class CatalogModel {
       categories: Joi.array().items(CatalogModel.ProductBrand()),
       category_map: CatalogModel.ProductCategoryMap(),
       color: Joi.string().allow(""),
+      custom_order: CatalogModel.ProductDetailCustomOrder(),
       description: Joi.string().allow(""),
       discount: Joi.string().allow(""),
       grouped_attributes: Joi.array().items(
@@ -622,6 +632,7 @@ class CatalogModel {
       name: Joi.string().allow(""),
       net_quantity: CatalogModel.NetQuantity(),
       price: CatalogModel.ProductListingPrice(),
+      product_group_tag: Joi.array().items(Joi.string().allow("")),
       product_online_date: Joi.string().allow(""),
       rating: Joi.number(),
       rating_count: Joi.number(),
@@ -752,7 +763,9 @@ class CatalogModel {
   }
   static ProductSortOn() {
     return Joi.object({
+      display: Joi.string().allow(""),
       is_selected: Joi.boolean(),
+      logo: Joi.string().allow(""),
       name: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });

package/sdk/application/Catalog/CatalogApplicationValidator.js

@@ -45,6 +45,7 @@ class CatalogValidator {
     return Joi.object({
       slug: Joi.string().allow("").required(),
       f: Joi.string().allow(""),
+      q: Joi.string().allow(""),
       filters: Joi.boolean(),
       sortOn: Joi.string().allow(""),
       pageId: Joi.string().allow(""),
@@ -59,6 +60,7 @@ class CatalogValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       tag: Joi.array().items(Joi.string().allow("")),
+      q: Joi.string().allow(""),
     });
   }
 

package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts

@@ -39,16 +39,18 @@ declare class Configuration {
      *   retrieving staff members working at a particular ordering store.
      * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
      *   the details of a particular staff member.
+     * @param {string} [arg.userName] - User name of the member
      * @returns {Promise<AppStaffListResponse>} - Success response
      * @summary: Get a list of staff.
      * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
      */
-    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, }?: {
+    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, }?: {
         pageNo?: number;
         pageSize?: number;
         orderIncent?: boolean;
         orderingStore?: number;
         user?: string;
+        userName?: string;
     }): Promise<AppStaffListResponse>;
     /**
      * @param {Object} arg - Arg object.
@@ -59,14 +61,16 @@ declare class Configuration {
      *   retrieving staff members working at a particular ordering store.
      * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
      *   the details of a particular staff member.
+     * @param {string} [arg.userName] - User name of the member
      * @summary: Get a list of staff.
      * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
      */
-    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, }?: {
+    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, userName, }?: {
         pageSize?: number;
         orderIncent?: boolean;
         orderingStore?: number;
         user?: string;
+        userName?: string;
     }): Paginator;
     /**
      * @param {Object} arg - Arg object.
@@ -88,14 +92,14 @@ declare class Configuration {
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<Application>} - Success response
-     * @summary: Get current application details
-     * @description: Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
+     * @summary: Get current sales channel details
+     * @description: Use this API to get the current sales channel details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
      */
     getApplication({}?: any): Promise<Application>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<ApplicationDetail>} - Success response
-     * @summary: Get basic application details
+     * @summary: Get basic details of the application
      * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
      */
     getBasicDetails({}?: any): Promise<ApplicationDetail>;
@@ -141,7 +145,7 @@ declare class Configuration {
      * @param {Object} arg - Arg object.
      * @returns {Promise<LanguageResponse>} - Success response
      * @summary: Get list of languages
-     * @description: Use this API to get a list of languages supported in the application.
+     * @description: Use this API to get a list of languages supported in the application
      */
     getLanguages({}?: any): Promise<LanguageResponse>;
     /**
@@ -162,7 +166,7 @@ declare class Configuration {
      *   page. Default value is 10.
      * @param {string} [arg.q] - Store code or name of the ordering store.
      * @returns {Promise<OrderingStores>} - Success response
-     * @summary: Get deployment stores
+     * @summary: Get all deployment stores
      * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
      */
     getOrderingStores({ pageNo, pageSize, q }?: {
@@ -175,7 +179,7 @@ declare class Configuration {
      * @param {number} [arg.pageSize] - The number of items to retrieve in each
      *   page. Default value is 10.
      * @param {string} [arg.q] - Store code or name of the ordering store.
-     * @summary: Get deployment stores
+     * @summary: Get all deployment stores
      * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
      */
     getOrderingStoresPaginator({ pageSize, q }?: {
@@ -185,8 +189,8 @@ declare class Configuration {
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<ApplicationAboutResponse>} - Success response
-     * @summary: Get application, owner and seller information
-     * @description: Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
+     * @summary: Get sales channel, owner and seller information
+     * @description: Use this API to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
      */
     getOwnerInfo({}?: any): Promise<ApplicationAboutResponse>;
     /**

package/sdk/application/Configuration/ConfigurationApplicationClient.js

@@ -122,6 +122,7 @@ class Configuration {
    *   retrieving staff members working at a particular ordering store.
    * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
    *   the details of a particular staff member.
+   * @param {string} [arg.userName] - User name of the member
    * @returns {Promise<AppStaffListResponse>} - Success response
    * @summary: Get a list of staff.
    * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
@@ -132,9 +133,10 @@ class Configuration {
     orderIncent,
     orderingStore,
     user,
+    userName,
   } = {}) {
     const { error } = ConfigurationValidator.getAppStaffList().validate(
-      { pageNo, pageSize, orderIncent, orderingStore, user },
+      { pageNo, pageSize, orderIncent, orderingStore, user, userName },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -145,7 +147,7 @@ class Configuration {
     const {
       error: warrning,
     } = ConfigurationValidator.getAppStaffList().validate(
-      { pageNo, pageSize, orderIncent, orderingStore, user },
+      { pageNo, pageSize, orderIncent, orderingStore, user, userName },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -162,6 +164,7 @@ class Configuration {
     query_params["order_incent"] = orderIncent;
     query_params["ordering_store"] = orderingStore;
     query_params["user"] = user;
+    query_params["user_name"] = userName;
 
     const xHeaders = {};
 
@@ -204,6 +207,7 @@ class Configuration {
    *   retrieving staff members working at a particular ordering store.
    * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
    *   the details of a particular staff member.
+   * @param {string} [arg.userName] - User name of the member
    * @summary: Get a list of staff.
    * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
    */
@@ -212,6 +216,7 @@ class Configuration {
     orderIncent,
     orderingStore,
     user,
+    userName,
   } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
@@ -224,6 +229,7 @@ class Configuration {
         orderIncent: orderIncent,
         orderingStore: orderingStore,
         user: user,
+        userName: userName,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,
@@ -309,8 +315,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<Application>} - Success response
-   * @summary: Get current application details
-   * @description: Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
+   * @summary: Get current sales channel details
+   * @description: Use this API to get the current sales channel details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
    */
   async getApplication({} = {}) {
     const { error } = ConfigurationValidator.getApplication().validate(
@@ -373,7 +379,7 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<ApplicationDetail>} - Success response
-   * @summary: Get basic application details
+   * @summary: Get basic details of the application
    * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
    */
   async getBasicDetails({} = {}) {
@@ -755,7 +761,7 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @returns {Promise<LanguageResponse>} - Success response
    * @summary: Get list of languages
-   * @description: Use this API to get a list of languages supported in the application.
+   * @description: Use this API to get a list of languages supported in the application
    */
   async getLanguages({} = {}) {
     const { error } = ConfigurationValidator.getLanguages().validate(
@@ -886,7 +892,7 @@ class Configuration {
    *   page. Default value is 10.
    * @param {string} [arg.q] - Store code or name of the ordering store.
    * @returns {Promise<OrderingStores>} - Success response
-   * @summary: Get deployment stores
+   * @summary: Get all deployment stores
    * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
    */
   async getOrderingStores({ pageNo, pageSize, q } = {}) {
@@ -955,7 +961,7 @@ class Configuration {
    * @param {number} [arg.pageSize] - The number of items to retrieve in each
    *   page. Default value is 10.
    * @param {string} [arg.q] - Store code or name of the ordering store.
-   * @summary: Get deployment stores
+   * @summary: Get all deployment stores
    * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
    */
   getOrderingStoresPaginator({ pageSize, q } = {}) {
@@ -982,8 +988,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<ApplicationAboutResponse>} - Success response
-   * @summary: Get application, owner and seller information
-   * @description: Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
+   * @summary: Get sales channel, owner and seller information
+   * @description: Use this API to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
    */
   async getOwnerInfo({} = {}) {
     const { error } = ConfigurationValidator.getOwnerInfo().validate(

package/sdk/application/Configuration/ConfigurationApplicationModel.js

@@ -530,6 +530,7 @@ class ConfigurationModel {
   }
   static ListingPriceFeature() {
     return Joi.object({
+      sort: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
   }

package/sdk/application/Configuration/ConfigurationApplicationValidator.js

@@ -13,6 +13,7 @@ class ConfigurationValidator {
       orderIncent: Joi.boolean(),
       orderingStore: Joi.number(),
       user: Joi.string().allow(""),
+      userName: Joi.string().allow(""),
     });
   }
 

package/sdk/application/Content/ContentApplicationModel.js

@@ -347,6 +347,7 @@ class ContentModel {
   static Detail() {
     return Joi.object({
       description: Joi.string().allow(""),
+      image_url: Joi.string().allow(""),
       title: Joi.string().allow(""),
     });
   }
@@ -931,7 +932,9 @@ class ContentModel {
 
       "shipping-policy",
 
-      "return-policy"
+      "return-policy",
+
+      "order-status"
     );
   }
 }

package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts

@@ -11,7 +11,10 @@ declare class FileStorage {
     updateUrls(urls: any): void;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Name of the bucket created for storing objects.
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
      * @param {StartResponse} arg.body
      * @returns {Promise<CompleteResponse>} - Success response
      * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
@@ -50,7 +53,10 @@ declare class FileStorage {
     }): Promise<SignUrlResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Name of the bucket created for storing objects.
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
      * @param {StartRequest} arg.body
      * @returns {Promise<StartResponse>} - Success response
      * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.

package/sdk/application/FileStorage/FileStorageApplicationClient.js

@@ -36,7 +36,10 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Name of the bucket created for storing objects.
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
    * @param {StartResponse} arg.body
    * @returns {Promise<CompleteResponse>} - Success response
    * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
@@ -180,7 +183,10 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Name of the bucket created for storing objects.
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
    * @param {StartRequest} arg.body
    * @returns {Promise<StartResponse>} - Success response
    * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.

package/sdk/application/FileStorage/FileStorageApplicationModel.js

@@ -22,8 +22,8 @@ class FileStorageModel {
   }
   static CDN() {
     return Joi.object({
-      absolute_url: Joi.string().allow(""),
-      relative_url: Joi.string().allow(""),
+      absolute_url: Joi.string().allow("").required(),
+      relative_url: Joi.string().allow("").required(),
       url: Joi.string().allow("").required(),
     });
   }

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -108,14 +108,15 @@ class LogisticModel {
       articles: Joi.array().items(Joi.any()).required(),
       configuration: Joi.any().required(),
       identifier: Joi.string().allow("").required(),
-      ignored_locations: Joi.array().items(Joi.string().allow("")).required(),
+      ignored_locations: Joi.array().items(Joi.number()).required(),
       to_pincode: Joi.string().allow("").required(),
     });
   }
   static ReAssignStoreResponse() {
     return Joi.object({
-      articles: Joi.array().items(Joi.any()),
+      assigned_stores: Joi.array().items(Joi.any()),
       error: Joi.any().required(),
+      pystormbreaker_uuid: Joi.string().allow("").required(),
       success: Joi.boolean().required(),
       to_pincode: Joi.string().allow("").required(),
     });

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

@@ -13,6 +13,7 @@ declare class Order {
         getShipmentReasons: string;
         sendOtpToShipmentCustomer: string;
         trackShipment: string;
+        updateShipmentStatus: string;
         verifyOtpShipmentCustomer: string;
     };
     _urls: {};
@@ -82,13 +83,13 @@ declare class Order {
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId - A unique number used for identifying and
      *   tracking your orders.
-     * @returns {Promise<OrderList>} - Success response
+     * @returns {Promise<OrderById>} - Success response
      * @summary: Get POS Order
      * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
      */
     getPosOrderById({ orderId }?: {
         orderId: string;
-    }): Promise<OrderList>;
+    }): Promise<OrderById>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId - ID of the bag. An order may contain
@@ -155,6 +156,20 @@ declare class Order {
     trackShipment({ shipmentId }?: {
         shipmentId: string;
     }): Promise<ShipmentTrack>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.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.
+     * @param {UpdateShipmentStatusRequest} arg.body
+     * @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
+     * @summary: Update the shipment status
+     * @description: Use this API to update the status of a shipment using its shipment ID.
+     */
+    updateShipmentStatus({ shipmentId, body }?: {
+        shipmentId: string;
+        body: UpdateShipmentStatusRequest;
+    }): Promise<ShipmentApplicationStatusResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId - A unique number used for identifying and

package/sdk/application/Order/OrderApplicationClient.js

@@ -29,6 +29,8 @@ class Order {
         "/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/",
       trackShipment:
         "/service/application/order/v1.0/orders/shipments/{shipment_id}/track",
+      updateShipmentStatus:
+        "/service/application/order/v1.0/orders/shipments/{shipment_id}/status",
       verifyOtpShipmentCustomer:
         "/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/verify/",
     };
@@ -334,7 +336,7 @@ class Order {
    * @param {Object} arg - Arg object.
    * @param {string} arg.orderId - A unique number used for identifying and
    *   tracking your orders.
-   * @returns {Promise<OrderList>} - Success response
+   * @returns {Promise<OrderById>} - Success response
    * @summary: Get POS Order
    * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
    */
@@ -376,7 +378,7 @@ class Order {
       xHeaders
     );
 
-    const { error: res_error } = OrderModel.OrderList().validate(response, {
+    const { error: res_error } = OrderModel.OrderById().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -717,6 +719,72 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.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.
+   * @param {UpdateShipmentStatusRequest} arg.body
+   * @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
+   * @summary: Update the shipment status
+   * @description: Use this API to update the status of a shipment using its shipment ID.
+   */
+  async updateShipmentStatus({ shipmentId, body } = {}) {
+    const { error } = OrderValidator.updateShipmentStatus().validate(
+      { shipmentId, body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.updateShipmentStatus().validate(
+      { shipmentId, body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateShipmentStatus",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "put",
+      constructUrl({
+        url: this._urls["updateShipmentStatus"],
+        params: { shipmentId },
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = OrderModel.ShipmentApplicationStatusResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateShipmentStatus",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.orderId - A unique number used for identifying and