@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts

@@ -1,30 +1,56 @@
 export = ServiceabilityPlatformApplicationValidator;
 /**
- * @typedef AddAppDpParam
- * @property {ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest} body
+ * @typedef CreateCourierPartnerRuleParam
+ * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 /**
- * @typedef DeleteAppDpParam
- * @property {number} courierPartnerId - A `courier_partner_id` is a unique
- *   identifier of a particular delivery partner.
+ * @typedef CreateStoreRulesParam
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
  */
-/** @typedef GetApplicationServiceabilityParam */
-/** @typedef GetDpApplicationRulesParam */
-/** @typedef GetSelfShipParam */
+/** @typedef GetApplicationConfigParam */
+/** @typedef GetApplicationConfigurationParam */
+/** @typedef GetApplicationServiceabilitySelfShipmentParam */
 /**
- * @typedef GetZoneFromPincodeViewParam
- * @property {ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest} body
+ * @typedef GetCourierPartnerRuleParam
+ * @property {string} ruleId - A `rule_id` is a unique identifier for a rule.
  */
 /**
- * @typedef GetZonesFromApplicationIdViewParam
+ * @typedef GetCourierPartnerRulesParam
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string[]} [zoneId] - List of zones to query for
- * @property {string} [q] - Search with name as a free text
+ * @property {string} [status] - Filter rules based on rule status
  */
 /**
- * @typedef UpdateApplicationServiceabilityParam
- * @property {ServiceabilityPlatformModel.ServiceabilityPayloadSchema} body
+ * @typedef GetStoreRuleParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
+ *   particular rule object.
+ */
+/**
+ * @typedef GetStoreRulesParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {string} [status]
+ */
+/**
+ * @typedef InsertApplicationConfigParam
+ * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
+ */
+/**
+ * @typedef PatchApplicationServiceabilitySelfShipmentParam
+ * @property {ServiceabilityPlatformModel.SelfShipResponse} body
+ */
+/**
+ * @typedef UpdateApplicationConfigurationParam
+ * @property {ServiceabilityPlatformModel.ApplicationConfig} body
+ */
+/**
+ * @typedef UpdateCourierPartnerRulePriorityParam
+ * @property {ServiceabilityPlatformModel.RulePriorityRequest} body
+ */
+/**
+ * @typedef UpdateCourierRuleParam
+ * @property {string} ruleId - A `rule_id` is a unique identifier for a particular Dp.
+ * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 /**
  * @typedef UpdatePincodeAuditHistoryParam
@@ -43,30 +69,44 @@ export = ServiceabilityPlatformApplicationValidator;
  * @property {ServiceabilityPlatformModel.PincodeMopData} body
  */
 /**
- * @typedef UpdateSelfShipParam
- * @property {ServiceabilityPlatformModel.SelfShipResponse} body
+ * @typedef UpdateStoreRulesParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
+ *   particular rule object.
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
  */
 /**
- * @typedef UpsertDpApplicationRulesParam
- * @property {ServiceabilityPlatformModel.DPApplicationRuleRequest} body
+ * @typedef UpdateStoreRulesConfigParam
+ * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
  */
 declare class ServiceabilityPlatformApplicationValidator {
-    /** @returns {AddAppDpParam} */
-    static addAppDp(): AddAppDpParam;
-    /** @returns {DeleteAppDpParam} */
-    static deleteAppDp(): DeleteAppDpParam;
-    /** @returns {GetApplicationServiceabilityParam} */
-    static getApplicationServiceability(): any;
-    /** @returns {GetDpApplicationRulesParam} */
-    static getDpApplicationRules(): any;
-    /** @returns {GetSelfShipParam} */
-    static getSelfShip(): any;
-    /** @returns {GetZoneFromPincodeViewParam} */
-    static getZoneFromPincodeView(): GetZoneFromPincodeViewParam;
-    /** @returns {GetZonesFromApplicationIdViewParam} */
-    static getZonesFromApplicationIdView(): GetZonesFromApplicationIdViewParam;
-    /** @returns {UpdateApplicationServiceabilityParam} */
-    static updateApplicationServiceability(): UpdateApplicationServiceabilityParam;
+    /** @returns {CreateCourierPartnerRuleParam} */
+    static createCourierPartnerRule(): CreateCourierPartnerRuleParam;
+    /** @returns {CreateStoreRulesParam} */
+    static createStoreRules(): CreateStoreRulesParam;
+    /** @returns {GetApplicationConfigParam} */
+    static getApplicationConfig(): any;
+    /** @returns {GetApplicationConfigurationParam} */
+    static getApplicationConfiguration(): any;
+    /** @returns {GetApplicationServiceabilitySelfShipmentParam} */
+    static getApplicationServiceabilitySelfShipment(): any;
+    /** @returns {GetCourierPartnerRuleParam} */
+    static getCourierPartnerRule(): GetCourierPartnerRuleParam;
+    /** @returns {GetCourierPartnerRulesParam} */
+    static getCourierPartnerRules(): GetCourierPartnerRulesParam;
+    /** @returns {GetStoreRuleParam} */
+    static getStoreRule(): GetStoreRuleParam;
+    /** @returns {GetStoreRulesParam} */
+    static getStoreRules(): GetStoreRulesParam;
+    /** @returns {InsertApplicationConfigParam} */
+    static insertApplicationConfig(): InsertApplicationConfigParam;
+    /** @returns {PatchApplicationServiceabilitySelfShipmentParam} */
+    static patchApplicationServiceabilitySelfShipment(): PatchApplicationServiceabilitySelfShipmentParam;
+    /** @returns {UpdateApplicationConfigurationParam} */
+    static updateApplicationConfiguration(): UpdateApplicationConfigurationParam;
+    /** @returns {UpdateCourierPartnerRulePriorityParam} */
+    static updateCourierPartnerRulePriority(): UpdateCourierPartnerRulePriorityParam;
+    /** @returns {UpdateCourierRuleParam} */
+    static updateCourierRule(): UpdateCourierRuleParam;
     /** @returns {UpdatePincodeAuditHistoryParam} */
     static updatePincodeAuditHistory(): UpdatePincodeAuditHistoryParam;
     /** @returns {UpdatePincodeBulkViewParam} */
@@ -75,28 +115,27 @@ declare class ServiceabilityPlatformApplicationValidator {
     static updatePincodeCoDListing(): UpdatePincodeCoDListingParam;
     /** @returns {UpdatePincodeMopViewParam} */
     static updatePincodeMopView(): UpdatePincodeMopViewParam;
-    /** @returns {UpdateSelfShipParam} */
-    static updateSelfShip(): UpdateSelfShipParam;
-    /** @returns {UpsertDpApplicationRulesParam} */
-    static upsertDpApplicationRules(): UpsertDpApplicationRulesParam;
+    /** @returns {UpdateStoreRulesParam} */
+    static updateStoreRules(): UpdateStoreRulesParam;
+    /** @returns {UpdateStoreRulesConfigParam} */
+    static updateStoreRulesConfig(): UpdateStoreRulesConfigParam;
 }
 declare namespace ServiceabilityPlatformApplicationValidator {
-    export { AddAppDpParam, DeleteAppDpParam, GetApplicationServiceabilityParam, GetDpApplicationRulesParam, GetSelfShipParam, GetZoneFromPincodeViewParam, GetZonesFromApplicationIdViewParam, UpdateApplicationServiceabilityParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateSelfShipParam, UpsertDpApplicationRulesParam };
+    export { CreateCourierPartnerRuleParam, CreateStoreRulesParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationServiceabilitySelfShipmentParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetStoreRuleParam, GetStoreRulesParam, InsertApplicationConfigParam, PatchApplicationServiceabilitySelfShipmentParam, UpdateApplicationConfigurationParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam };
 }
-type AddAppDpParam = {
-    body: ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest;
+type CreateCourierPartnerRuleParam = {
+    body: ServiceabilityPlatformModel.CourierPartnerRule;
+};
+type CreateStoreRulesParam = {
+    body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema;
 };
-type DeleteAppDpParam = {
+type GetCourierPartnerRuleParam = {
     /**
-     * - A `courier_partner_id` is a unique
-     * identifier of a particular delivery partner.
+     * - A `rule_id` is a unique identifier for a rule.
      */
-    courierPartnerId: number;
+    ruleId: string;
 };
-type GetZoneFromPincodeViewParam = {
-    body: ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest;
-};
-type GetZonesFromApplicationIdViewParam = {
+type GetCourierPartnerRulesParam = {
     /**
      * - Index of the item to start returning with
      */
@@ -106,16 +145,40 @@ type GetZonesFromApplicationIdViewParam = {
      */
     pageSize?: number;
     /**
-     * - List of zones to query for
+     * - Filter rules based on rule status
      */
-    zoneId?: string[];
+    status?: string;
+};
+type GetStoreRuleParam = {
     /**
-     * - Search with name as a free text
+     * - A `rule_uid` is a unique identifier for a
+     * particular rule object.
      */
-    q?: string;
+    ruleUid: string;
+};
+type GetStoreRulesParam = {
+    pageNo?: number;
+    pageSize?: number;
+    status?: string;
+};
+type InsertApplicationConfigParam = {
+    body: ServiceabilityPlatformModel.StoreRuleConfigData;
+};
+type PatchApplicationServiceabilitySelfShipmentParam = {
+    body: ServiceabilityPlatformModel.SelfShipResponse;
 };
-type UpdateApplicationServiceabilityParam = {
-    body: ServiceabilityPlatformModel.ServiceabilityPayloadSchema;
+type UpdateApplicationConfigurationParam = {
+    body: ServiceabilityPlatformModel.ApplicationConfig;
+};
+type UpdateCourierPartnerRulePriorityParam = {
+    body: ServiceabilityPlatformModel.RulePriorityRequest;
+};
+type UpdateCourierRuleParam = {
+    /**
+     * - A `rule_id` is a unique identifier for a particular Dp.
+     */
+    ruleId: string;
+    body: ServiceabilityPlatformModel.CourierPartnerRule;
 };
 type UpdatePincodeAuditHistoryParam = {
     body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest;
@@ -129,13 +192,18 @@ type UpdatePincodeCoDListingParam = {
 type UpdatePincodeMopViewParam = {
     body: ServiceabilityPlatformModel.PincodeMopData;
 };
-type UpdateSelfShipParam = {
-    body: ServiceabilityPlatformModel.SelfShipResponse;
+type UpdateStoreRulesParam = {
+    /**
+     * - A `rule_uid` is a unique identifier for a
+     * particular rule object.
+     */
+    ruleUid: string;
+    body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema;
 };
-type UpsertDpApplicationRulesParam = {
-    body: ServiceabilityPlatformModel.DPApplicationRuleRequest;
+type UpdateStoreRulesConfigParam = {
+    body: ServiceabilityPlatformModel.StoreRuleConfigData;
 };
-type GetApplicationServiceabilityParam = any;
-type GetDpApplicationRulesParam = any;
-type GetSelfShipParam = any;
+type GetApplicationConfigParam = any;
+type GetApplicationConfigurationParam = any;
+type GetApplicationServiceabilitySelfShipmentParam = any;
 import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -3,38 +3,70 @@ const Joi = require("joi");
 const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
- * @typedef AddAppDpParam
- * @property {ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest} body
+ * @typedef CreateCourierPartnerRuleParam
+ * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 
 /**
- * @typedef DeleteAppDpParam
- * @property {number} courierPartnerId - A `courier_partner_id` is a unique
- *   identifier of a particular delivery partner.
+ * @typedef CreateStoreRulesParam
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
  */
 
-/** @typedef GetApplicationServiceabilityParam */
+/** @typedef GetApplicationConfigParam */
 
-/** @typedef GetDpApplicationRulesParam */
+/** @typedef GetApplicationConfigurationParam */
 
-/** @typedef GetSelfShipParam */
+/** @typedef GetApplicationServiceabilitySelfShipmentParam */
 
 /**
- * @typedef GetZoneFromPincodeViewParam
- * @property {ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest} body
+ * @typedef GetCourierPartnerRuleParam
+ * @property {string} ruleId - A `rule_id` is a unique identifier for a rule.
  */
 
 /**
- * @typedef GetZonesFromApplicationIdViewParam
+ * @typedef GetCourierPartnerRulesParam
  * @property {number} [pageNo] - Index of the item to start returning with
  * @property {number} [pageSize] - Determines the items to be displayed in a page
- * @property {string[]} [zoneId] - List of zones to query for
- * @property {string} [q] - Search with name as a free text
+ * @property {string} [status] - Filter rules based on rule status
  */
 
 /**
- * @typedef UpdateApplicationServiceabilityParam
- * @property {ServiceabilityPlatformModel.ServiceabilityPayloadSchema} body
+ * @typedef GetStoreRuleParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
+ *   particular rule object.
+ */
+
+/**
+ * @typedef GetStoreRulesParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {string} [status]
+ */
+
+/**
+ * @typedef InsertApplicationConfigParam
+ * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
+ */
+
+/**
+ * @typedef PatchApplicationServiceabilitySelfShipmentParam
+ * @property {ServiceabilityPlatformModel.SelfShipResponse} body
+ */
+
+/**
+ * @typedef UpdateApplicationConfigurationParam
+ * @property {ServiceabilityPlatformModel.ApplicationConfig} body
+ */
+
+/**
+ * @typedef UpdateCourierPartnerRulePriorityParam
+ * @property {ServiceabilityPlatformModel.RulePriorityRequest} body
+ */
+
+/**
+ * @typedef UpdateCourierRuleParam
+ * @property {string} ruleId - A `rule_id` is a unique identifier for a particular Dp.
+ * @property {ServiceabilityPlatformModel.CourierPartnerRule} body
  */
 
 /**
@@ -58,66 +90,112 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  */
 
 /**
- * @typedef UpdateSelfShipParam
- * @property {ServiceabilityPlatformModel.SelfShipResponse} body
+ * @typedef UpdateStoreRulesParam
+ * @property {string} ruleUid - A `rule_uid` is a unique identifier for a
+ *   particular rule object.
+ * @property {ServiceabilityPlatformModel.CreateStoreRuleRequestSchema} body
  */
 
 /**
- * @typedef UpsertDpApplicationRulesParam
- * @property {ServiceabilityPlatformModel.DPApplicationRuleRequest} body
+ * @typedef UpdateStoreRulesConfigParam
+ * @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
  */
 
 class ServiceabilityPlatformApplicationValidator {
-  /** @returns {AddAppDpParam} */
-  static addAppDp() {
+  /** @returns {CreateCourierPartnerRuleParam} */
+  static createCourierPartnerRule() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest().required(),
+      body: ServiceabilityPlatformModel.CourierPartnerRule().required(),
     }).required();
   }
 
-  /** @returns {DeleteAppDpParam} */
-  static deleteAppDp() {
+  /** @returns {CreateStoreRulesParam} */
+  static createStoreRules() {
     return Joi.object({
-      courierPartnerId: Joi.number().required(),
+      body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {GetApplicationServiceabilityParam} */
-  static getApplicationServiceability() {
+  /** @returns {GetApplicationConfigParam} */
+  static getApplicationConfig() {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetDpApplicationRulesParam} */
-  static getDpApplicationRules() {
+  /** @returns {GetApplicationConfigurationParam} */
+  static getApplicationConfiguration() {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetSelfShipParam} */
-  static getSelfShip() {
+  /** @returns {GetApplicationServiceabilitySelfShipmentParam} */
+  static getApplicationServiceabilitySelfShipment() {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetZoneFromPincodeViewParam} */
-  static getZoneFromPincodeView() {
+  /** @returns {GetCourierPartnerRuleParam} */
+  static getCourierPartnerRule() {
+    return Joi.object({
+      ruleId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCourierPartnerRulesParam} */
+  static getCourierPartnerRules() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest().required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      status: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetStoreRuleParam} */
+  static getStoreRule() {
+    return Joi.object({
+      ruleUid: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetZonesFromApplicationIdViewParam} */
-  static getZonesFromApplicationIdView() {
+  /** @returns {GetStoreRulesParam} */
+  static getStoreRules() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      zoneId: Joi.array().items(Joi.string().allow("")),
-      q: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {InsertApplicationConfigParam} */
+  static insertApplicationConfig() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.StoreRuleConfigData().required(),
+    }).required();
+  }
+
+  /** @returns {PatchApplicationServiceabilitySelfShipmentParam} */
+  static patchApplicationServiceabilitySelfShipment() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.SelfShipResponse().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateApplicationConfigurationParam} */
+  static updateApplicationConfiguration() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.ApplicationConfig().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateCourierPartnerRulePriorityParam} */
+  static updateCourierPartnerRulePriority() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.RulePriorityRequest().required(),
     }).required();
   }
 
-  /** @returns {UpdateApplicationServiceabilityParam} */
-  static updateApplicationServiceability() {
+  /** @returns {UpdateCourierRuleParam} */
+  static updateCourierRule() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.ServiceabilityPayloadSchema().required(),
+      ruleId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.CourierPartnerRule().required(),
     }).required();
   }
 
@@ -149,17 +227,18 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {UpdateSelfShipParam} */
-  static updateSelfShip() {
+  /** @returns {UpdateStoreRulesParam} */
+  static updateStoreRules() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.SelfShipResponse().required(),
+      ruleUid: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.CreateStoreRuleRequestSchema().required(),
     }).required();
   }
 
-  /** @returns {UpsertDpApplicationRulesParam} */
-  static upsertDpApplicationRules() {
+  /** @returns {UpdateStoreRulesConfigParam} */
+  static updateStoreRulesConfig() {
     return Joi.object({
-      body: ServiceabilityPlatformModel.DPApplicationRuleRequest().required(),
+      body: ServiceabilityPlatformModel.StoreRuleConfigData().required(),
     }).required();
   }
 }