@gofynd/fdk-client-javascript 0.1.35 → 0.1.36

package/sdk/platform/models/OrderValidator.js

@@ -1,110 +1,371 @@
 const Joi = require("joi");
 const Validator = require("../PlatformModels");
 class OrderValidator {
-  static shipmentStatusUpdate() {
+  static getShipments() {
     return Joi.object({
-      body: Validator.UpdateShipmentStatusBody().required(),
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+      searchId: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      isPrioritySort: Joi.boolean(),
+      excludeLockedShipments: Joi.boolean(),
+      paymentMethods: Joi.string().allow(""),
+      channelShipmentId: Joi.string().allow(""),
+      channelOrderId: Joi.string().allow(""),
+      customMeta: Joi.string().allow(""),
     }).required();
   }
 
-  static activityStatus() {
+  static getShipmentById() {
     return Joi.object({
-      bagId: Joi.string().allow("").required(),
+      channelShipmentId: Joi.string().allow(""),
+      shipmentId: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
     }).required();
   }
 
-  static storeProcessShipmentUpdate() {
+  static getOrderById() {
     return Joi.object({
-      body: Validator.UpdateProcessShipmenstRequestBody().required(),
+      orderId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static checkRefund() {
+  static getLaneConfig() {
     return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
+      superLane: Joi.string().allow(""),
+      groupEntity: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      paymentMode: Joi.string().allow(""),
+      bagStatus: Joi.string().allow(""),
     }).required();
   }
 
-  static shipmentBagsCanBreak() {
+  static getOrders() {
     return Joi.object({
-      body: Validator.CanBreakRequestBody().required(),
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      isPrioritySort: Joi.boolean(),
+      customMeta: Joi.string().allow(""),
     }).required();
   }
 
-  static getOrdersByCompanyId() {
+  static getMetricCount() {
     return Joi.object({
-      pageNo: Joi.string().allow(""),
-      pageSize: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
-      isPrioritySort: Joi.boolean(),
-      lockStatus: Joi.boolean(),
-      userId: Joi.string().allow(""),
-      q: Joi.string().allow(""),
-      stage: Joi.string().allow(""),
-      salesChannels: Joi.string().allow(""),
-      orderId: Joi.string().allow(""),
-      stores: Joi.string().allow(""),
-      deploymentStores: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      dp: Joi.string().allow(""),
-      filterType: Joi.string().allow(""),
     }).required();
   }
 
-  static getOrderLanesCountByCompanyId() {
+  static getfilters() {
+    return Joi.object({
+      view: Joi.string().allow("").required(),
+      groupEntity: Joi.string().allow(""),
+    }).required();
+  }
+
+  static createShipmentReport() {
     return Joi.object({
-      pageNo: Joi.string().allow(""),
-      pageSize: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
-      q: Joi.string().allow(""),
-      stage: Joi.string().allow(""),
-      salesChannels: Joi.string().allow(""),
-      orderId: Joi.string().allow(""),
-      stores: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      filterType: Joi.string().allow(""),
     }).required();
   }
 
-  static getOrderDetails() {
+  static getReportsShipmentListing() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
+  static upsertJioCode() {
+    return Joi.object({
+      body: Validator.JioCodeUpsertPayload().required(),
+    }).required();
+  }
+
+  static getBulkInvoice() {
+    return Joi.object({
+      batchId: Joi.string().allow("").required(),
+      docType: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getBulkInvoiceLabel() {
+    return Joi.object({
+      batchId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getBulkShipmentExcelFile() {
     return Joi.object({
-      orderId: Joi.string().allow(""),
-      next: Joi.string().allow(""),
-      previous: Joi.string().allow(""),
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchId: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      customerId: Joi.string().allow(""),
+      isPrioritySort: Joi.boolean(),
     }).required();
   }
 
-  static getPicklistOrdersByCompanyId() {
+  static getBulkList() {
     return Joi.object({
-      pageNo: Joi.string().allow(""),
-      pageSize: Joi.string().allow(""),
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchId: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
-      q: Joi.string().allow(""),
-      stage: Joi.string().allow(""),
-      salesChannels: Joi.string().allow(""),
-      orderId: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
       stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      customerId: Joi.string().allow(""),
+      isPrioritySort: Joi.boolean(),
+    }).required();
+  }
+
+  static getManifestList() {
+    return Joi.object({
       status: Joi.string().allow(""),
-      filterType: Joi.string().allow(""),
+      storeId: Joi.number(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      searchValue: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getManifestDetailsWithShipments() {
+    return Joi.object({
+      manifestId: Joi.string().allow("").required(),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      storeId: Joi.number().required(),
+      page: Joi.number(),
+      pageSize: Joi.number(),
+      lane: Joi.string().allow(""),
+      dpIds: Joi.number(),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getBulkActionFailedReport() {
+    return Joi.object({
+      batchId: Joi.string().allow("").required(),
+      reportType: Joi.string().allow(""),
     }).required();
   }
 
-  static getShipmentAddress() {
+  static getShipmentReasons() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
-      addressCategory: Joi.string().allow("").required(),
+      bagId: Joi.string().allow("").required(),
+      state: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static bulkActionProcessXlsxFile() {
+    return Joi.object({
+      body: Validator.BulkActionPayload().required(),
+    }).required();
+  }
+
+  static bulkActionDetails() {
+    return Joi.object({
+      batchId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getBagById() {
+    return Joi.object({
+      bagId: Joi.string().allow(""),
+      channelBagId: Joi.string().allow(""),
+      channelId: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getBags() {
+    return Joi.object({
+      bagIds: Joi.string().allow(""),
+      shipmentIds: Joi.string().allow(""),
+      orderIds: Joi.string().allow(""),
+      channelBagIds: Joi.string().allow(""),
+      channelShipmentIds: Joi.string().allow(""),
+      channelOrderIds: Joi.string().allow(""),
+      channelId: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
+  static invalidateShipmentCache() {
+    return Joi.object({
+      body: Validator.InvalidateShipmentCachePayload().required(),
     }).required();
   }
 
-  static updateShipmentAddress() {
+  static reassignLocation() {
+    return Joi.object({
+      body: Validator.StoreReassign().required(),
+    }).required();
+  }
+
+  static updateShipmentLock() {
+    return Joi.object({
+      body: Validator.UpdateShipmentLockPayload().required(),
+    }).required();
+  }
+
+  static getAnnouncements() {
+    return Joi.object({
+      date: Joi.string().allow(""),
+    }).required();
+  }
+
+  static updateAddress() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
+      name: Joi.string().allow(""),
+      address: Joi.string().allow(""),
+      addressType: Joi.string().allow(""),
+      pincode: Joi.string().allow(""),
+      phone: Joi.string().allow(""),
+      email: Joi.string().allow(""),
+      landmark: Joi.string().allow(""),
       addressCategory: Joi.string().allow("").required(),
-      body: Validator.UpdateShipmentAddressRequest().required(),
+      city: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+      country: Joi.string().allow(""),
+    }).required();
+  }
+
+  static click2Call() {
+    return Joi.object({
+      caller: Joi.string().allow("").required(),
+      receiver: Joi.string().allow("").required(),
+      bagId: Joi.string().allow("").required(),
+      callingTo: Joi.string().allow(""),
+      callerId: Joi.string().allow(""),
+    }).required();
+  }
+
+  static updateShipmentStatus() {
+    return Joi.object({
+      body: Validator.UpdateShipmentStatusRequest().required(),
+    }).required();
+  }
+
+  static processManifest() {
+    return Joi.object({
+      body: Validator.CreateOrderPayload().required(),
+    }).required();
+  }
+
+  static dispatchManifest() {
+    return Joi.object({
+      body: Validator.DispatchManifest().required(),
+    }).required();
+  }
+
+  static getRoleBasedActions() {
+    return Joi.object({}).required();
+  }
+
+  static getShipmentHistory() {
+    return Joi.object({
+      shipmentId: Joi.number(),
+      bagId: Joi.number(),
+    }).required();
+  }
+
+  static sendSmsNinja() {
+    return Joi.object({
+      body: Validator.SendSmsPayload().required(),
+    }).required();
+  }
+
+  static platformManualAssignDPToShipment() {
+    return Joi.object({
+      body: Validator.ManualAssignDPToShipment().required(),
+    }).required();
+  }
+
+  static updatePackagingDimensions() {
+    return Joi.object({
+      body: Validator.CreateOrderPayload().required(),
+    }).required();
+  }
+
+  static createOrder() {
+    return Joi.object({
+      body: Validator.CreateOrderAPI().required(),
+    }).required();
+  }
+
+  static createChannelConfig() {
+    return Joi.object({
+      body: Validator.CreateChannelConfigData().required(),
+    }).required();
+  }
+
+  static getChannelConfig() {
+    return Joi.object({}).required();
+  }
+
+  static uploadConsent() {
+    return Joi.object({
+      body: Validator.UploadConsent().required(),
     }).required();
   }
+
+  static orderUpdate() {
+    return Joi.object({
+      body: Validator.PlatformOrderUpdate().required(),
+    }).required();
+  }
+
+  static checkOrderStatus() {
+    return Joi.object({
+      body: Validator.OrderStatus().required(),
+    }).required();
+  }
+
+  static sendSmsNinjaPlatform() {
+    return Joi.object({}).required();
+  }
 }
 module.exports = OrderValidator;

package/sdk/public/client/ConfigurationPublicClient.d.ts

@@ -19,7 +19,7 @@ declare class Configuration {
     searchApplication({ authorization, query }?: {
         authorization?: string;
         query?: string;
-    }): Promise<any>;
+    }): Promise<ApplicationResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.locationType] - Provide location type to query on.
@@ -34,5 +34,5 @@ declare class Configuration {
     getLocations({ locationType, id }?: {
         locationType?: string;
         id?: string;
-    }): Promise<any>;
+    }): Promise<Locations>;
 }

package/sdk/public/client/InventoryPublicClient.d.ts

@@ -23,7 +23,7 @@ declare class Inventory {
     getJobCodesMetrics({ dailyJob, jobCode }?: {
         dailyJob?: boolean;
         jobCode?: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeObject>;
     /**
      * @param {Object} arg - Arg object.
      * @param {EmailJobMetrics} arg.body
@@ -32,8 +32,8 @@ declare class Inventory {
      * @description: Endpoint to save JobCode Metrics
      */
     saveJobCodesMetrics({ body }?: {
-        body: any;
-    }): Promise<any>;
+        body: EmailJobMetrics;
+    }): Promise<ResponseEnvelopeEmailJobMetrics>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.apikey - Api key
@@ -43,7 +43,7 @@ declare class Inventory {
      */
     getConfigByApiKey({ apikey }?: {
         apikey: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeSlingshotConfigurationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.userName - Integration id
@@ -55,7 +55,7 @@ declare class Inventory {
     getApiKey({ userName, password }?: {
         userName: string;
         password: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeApikeyModel>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.code - Job Code
@@ -65,7 +65,7 @@ declare class Inventory {
      */
     getJobByCode({ code }?: {
         code: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeJobConfigDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.integrationType - Integration Type
@@ -77,5 +77,5 @@ declare class Inventory {
     getJobConfigByIntegrationType({ integrationType, disable }?: {
         integrationType: string;
         disable?: boolean;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobConfigDTO>;
 }

package/sdk/public/client/WebhookPublicClient.d.ts

@@ -14,7 +14,7 @@ declare class Webhook {
      * @summary: Get All Webhook Events
      * @description: Get All Webhook Events
      */
-    fetchAllWebhookEvents({}?: any): Promise<any>;
+    fetchAllWebhookEvents({}?: any): Promise<EventConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {EventConfigBase[]} arg.body
@@ -23,6 +23,6 @@ declare class Webhook {
      * @description: Get Webhook Event Details for provided events
      */
     queryWebhookEventDetails({ body }?: {
-        body: any[];
-    }): Promise<any>;
+        body: EventConfigBase[];
+    }): Promise<EventConfigResponse>;
 }

package/tests/common/schema/action-url.json

@@ -18,6 +18,21 @@
         "path": "/brand/test/?department=men&department=women"
       }
     },
+    {
+      "name": "profile order shipments",
+      "action": {
+        "type": "page",
+        "page": {
+          "type": "profile-order-shipment",
+          "params": {
+            "shipmentid": [16720482187091110000]
+          }
+        }
+      },
+      "result": {
+        "path": "/profile/orders/shipment/16720482187091110000"
+      }
+    },
     {
       "name": "category listing query param  ",
       "action": {

package/tests/common/schema/url-action.json

@@ -275,6 +275,22 @@
         }
       }
     },
+    {
+      "name": "profile orders shipments",
+      "path": "/profile/orders/shipment/16720482187091110000",
+      "result": {
+        "action": {
+          "type": "page",
+          "page": {
+            "type": "profile-order-shipment",
+            "params": {
+              "shipmentid": [16720482187091110000]
+            }
+          }
+        }
+      }
+    },
+
     {
       "name": "faq with category",
       "path": "/faq/:category",