@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.5.0

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -1059,6 +1059,7 @@ const Joi = require("joi");
  * @property {string} [pickup_cutoff]
  * @property {string} [route_code]
  * @property {boolean} is_first_mile
+ * @property {boolean} [is_reverse_pickup]
  * @property {boolean} is_return
  * @property {boolean} is_installation
  * @property {boolean} is_last_mile
@@ -1066,24 +1067,47 @@ const Joi = require("joi");
 
 /**
  * @typedef CourierPartnerSchemeFeatures
- * @property {boolean} [doorstep_qc]
- * @property {boolean} [qr]
- * @property {boolean} [mps]
- * @property {boolean} [ndr]
- * @property {number} [ndr_attempts]
- * @property {boolean} [dangerous_goods]
- * @property {boolean} [fragile_goods]
- * @property {boolean} [restricted_goods]
- * @property {boolean} [cold_storage_goods]
- * @property {boolean} [doorstep_exchange]
- * @property {boolean} [doorstep_return]
- * @property {boolean} [product_installation]
- * @property {boolean} [openbox_delivery]
- * @property {string} [status_updates]
- * @property {boolean} [multi_pick_single_drop]
- * @property {boolean} [single_pick_multi_drop]
- * @property {boolean} [multi_pick_multi_drop]
- * @property {boolean} [ewaybill]
+ * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
+ *   doorstep quality check services.
+ * @property {boolean} [qr] - Specifies whether the courier partner supports QR
+ *   code-based operations.
+ * @property {boolean} [mps] - Denotes if the courier partner supports
+ *   multi-part shipment services.
+ * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
+ *   feature is supported by the courier partner.
+ * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
+ *   Non-Delivery Reports (NDR).
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
+ *   handles the transportation of dangerous goods.
+ * @property {boolean} [fragile_goods] - Indicates whether the courier partner
+ *   manages the shipment of fragile goods.
+ * @property {boolean} [restricted_goods] - Indicates if the courier partner
+ *   handles restricted goods, as per regulatory guidelines.
+ * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
+ *   provides cold storage facilities for goods.
+ * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
+ *   supports doorstep exchange services.
+ * @property {boolean} [doorstep_return] - Specifies if the courier partner
+ *   offers doorstep return services.
+ * @property {boolean} [product_installation] - Indicates if the courier partner
+ *   provides product installation services upon delivery.
+ * @property {boolean} [openbox_delivery] - Specifies whether the courier
+ *   partner supports open-box delivery, allowing customers to inspect goods
+ *   before accepting.
+ * @property {string} [status_updates] - Describes the type of status updates
+ *   provided by the courier partner (e.g., real-time, periodic).
+ * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
+ *   partner supports multiple pickups to a single drop location.
+ * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
+ *   partner supports single pickup to multiple drop locations.
+ * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
+ *   offers services for multiple pickups to multiple drop locations.
+ * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
+ *   supports the generation of e-waybills for shipments.
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
+ *   of items allowed in a quality check shipment.
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
+ *   quantity of items allowed in a non-quality check shipment.
  */
 
 /**
@@ -1101,8 +1125,8 @@ const Joi = require("joi");
  *   courier partner scheme.
  * @property {string[]} payment_mode - Mode of payment associated with the
  *   courier partner scheme.
- * @property {string} stage - Denotes whether the courier partner scheme is in
- *   enabled or disabled stage.
+ * @property {string} stage - Indicates if the courier partner scheme is
+ *   currently active or inactive.
  * @property {CourierPartnerSchemeFeatures} feature
  */
 
@@ -1352,6 +1376,176 @@ const Joi = require("joi");
  * @property {string} message - A brief description of the error.
  */
 
+/**
+ * @typedef CourierPartnerSchemeV2Features
+ * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
+ *   doorstep quality check services.
+ * @property {boolean} [qr] - Specifies whether the courier partner supports QR
+ *   code-based operations.
+ * @property {boolean} [mps] - Denotes if the courier partner supports
+ *   multi-part shipment services.
+ * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
+ *   feature is supported by the courier partner.
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
+ *   handles the transportation of dangerous goods.
+ * @property {boolean} [fragile_goods] - Indicates whether the courier partner
+ *   manages the shipment of fragile goods.
+ * @property {boolean} [restricted_goods] - Indicates if the courier partner
+ *   handles restricted goods, as per regulatory guidelines.
+ * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
+ *   provides cold storage facilities for goods.
+ * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
+ *   supports doorstep exchange services.
+ * @property {boolean} [doorstep_return] - Specifies if the courier partner
+ *   offers doorstep return services.
+ * @property {boolean} [product_installation] - Indicates if the courier partner
+ *   provides product installation services upon delivery.
+ * @property {boolean} [openbox_delivery] - Specifies whether the courier
+ *   partner supports open-box delivery, allowing customers to inspect goods
+ *   before accepting.
+ * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
+ *   partner supports multiple pickups to a single drop location.
+ * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
+ *   partner supports single pickup to multiple drop locations.
+ * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
+ *   offers services for multiple pickups to multiple drop locations.
+ * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
+ *   supports the generation of e-waybills for shipments.
+ */
+
+/**
+ * @typedef CourierPartnerSchemeV2DetailsModel
+ * @property {string} extension_id - Unique identifier of courier partner extension
+ * @property {string} [scheme_id]
+ * @property {string} name
+ * @property {ArithmeticOperations} weight
+ * @property {ArithmeticOperations} [volumetric_weight]
+ * @property {string} transport_type
+ * @property {string} region
+ * @property {string} delivery_type
+ * @property {string[]} payment_mode
+ * @property {string} stage
+ * @property {string} [status_updates] - Describes the type of status updates
+ *   provided by the courier partner (e.g., real-time, periodic).
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
+ *   (NDR) feature is supported by the courier partner.
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
+ *   of items allowed in a quality check shipment.
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
+ *   quantity of items allowed in a non-quality check shipment.
+ * @property {CourierPartnerSchemeV2Features} feature
+ */
+
+/**
+ * @typedef CourierPartnerV2SchemeModel
+ * @property {string} extension_id - Unique identifier of courier partner extension.
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
+ * @property {string} [company_id] - Unique identifier of company.
+ * @property {string} name - Name of the scheme.
+ * @property {ArithmeticOperations} weight
+ * @property {ArithmeticOperations} [volumetric_weight]
+ * @property {string} transport_type - Mode of transport associated with the
+ *   courier partner scheme.
+ * @property {string} region - Serviceable region associated with the courier
+ *   partner scheme.
+ * @property {string} delivery_type - Type of delivery associated with the
+ *   courier partner scheme.
+ * @property {string[]} payment_mode - Mode of payment associated with the
+ *   courier partner scheme.
+ * @property {string} stage - Indicates if the courier partner scheme is
+ *   currently active or inactive.
+ * @property {string} [status_updates] - Describes the type of status updates
+ *   provided by the courier partner (e.g., real-time, periodic).
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
+ *   (NDR) feature is supported by the courier partner.
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
+ *   of items allowed in a quality check shipment.
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
+ *   quantity of items allowed in a non-quality check shipment.
+ * @property {CourierPartnerSchemeV2Features} feature
+ */
+
+/**
+ * @typedef CourierPartnerSchemeV2UpdateDetails
+ * @property {string} name
+ * @property {ArithmeticOperations} weight
+ * @property {ArithmeticOperations} [volumetric_weight]
+ * @property {string} transport_type
+ * @property {string} region
+ * @property {string} delivery_type
+ * @property {string[]} payment_mode
+ * @property {string} stage
+ * @property {string} [status_updates] - Describes the type of status updates
+ *   provided by the courier partner (e.g., real-time, periodic).
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
+ *   (NDR) feature is supported by the courier partner.
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
+ *   of items allowed in a quality check shipment.
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
+ *   quantity of items allowed in a non-quality check shipment.
+ * @property {CourierPartnerSchemeV2Features} feature
+ */
+
+/**
+ * @typedef courierPartnerSchemeV2List
+ * @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
+ * @property {Page} page
+ */
+
+/**
+ * @typedef BulkRegionServiceabilityTatDetails
+ * @property {string} country
+ * @property {string} region
+ * @property {string} type
+ */
+
+/**
+ * @typedef BulkRegionServiceabilityTatResultItemData
+ * @property {string} [country] - Name of the country.
+ * @property {string} [region] - Name of the region for which the
+ *   tat/serviceability file needs to be downloaded.
+ * @property {string} [type] - Denotes the type of data.
+ * @property {string} [batch_id] - Unique identifier identifying the perticular request.
+ * @property {string} [status] - Current status of the request.
+ * @property {Object[]} [failed_records] - Information of records which failed
+ * @property {string} [file_path] - CDN path of the file.
+ */
+
+/**
+ * @typedef BulkRegionServiceabilityTatResult
+ * @property {BulkRegionServiceabilityTatResultItemData[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef HierarchyItems
+ * @property {string} [display_name]
+ * @property {string} [slug]
+ */
+
+/**
+ * @typedef GetCountriesItems
+ * @property {string} [id]
+ * @property {string} [name]
+ * @property {string} [iso2]
+ * @property {string} [iso3]
+ * @property {string[]} [timezones]
+ * @property {HierarchyItems[]} [hierarchy]
+ * @property {string} [phone_code]
+ * @property {string} [currency]
+ * @property {string} [type]
+ * @property {string} [latitude]
+ * @property {string} [longitude]
+ * @property {string} [display_name]
+ * @property {boolean} [has_next_hierarchy]
+ */
+
+/**
+ * @typedef GetCountries
+ * @property {GetCountriesItems[]} items
+ * @property {Page} page
+ */
+
 class ServiceabilityPlatformModel {
   /** @returns {UpdateZoneConfigDetails} */
   static UpdateZoneConfigDetails() {
@@ -2674,6 +2868,7 @@ class ServiceabilityPlatformModel {
       pickup_cutoff: Joi.string().allow("").allow(null),
       route_code: Joi.string().allow("").allow(null),
       is_first_mile: Joi.boolean().required(),
+      is_reverse_pickup: Joi.boolean().allow(null),
       is_return: Joi.boolean().required(),
       is_installation: Joi.boolean().required(),
       is_last_mile: Joi.boolean().required(),
@@ -2701,6 +2896,8 @@ class ServiceabilityPlatformModel {
       single_pick_multi_drop: Joi.boolean(),
       multi_pick_multi_drop: Joi.boolean(),
       ewaybill: Joi.boolean(),
+      qc_shipment_item_quantity: Joi.number().allow(null),
+      non_qc_shipment_item_quantity: Joi.number().allow(null),
     });
   }
 
@@ -3022,5 +3219,170 @@ class ServiceabilityPlatformModel {
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CourierPartnerSchemeV2Features} */
+  static CourierPartnerSchemeV2Features() {
+    return Joi.object({
+      doorstep_qc: Joi.boolean(),
+      qr: Joi.boolean(),
+      mps: Joi.boolean(),
+      ndr: Joi.boolean(),
+      dangerous_goods: Joi.boolean(),
+      fragile_goods: Joi.boolean(),
+      restricted_goods: Joi.boolean(),
+      cold_storage_goods: Joi.boolean(),
+      doorstep_exchange: Joi.boolean(),
+      doorstep_return: Joi.boolean(),
+      product_installation: Joi.boolean(),
+      openbox_delivery: Joi.boolean(),
+      multi_pick_single_drop: Joi.boolean(),
+      single_pick_multi_drop: Joi.boolean(),
+      multi_pick_multi_drop: Joi.boolean(),
+      ewaybill: Joi.boolean(),
+    });
+  }
+
+  /** @returns {CourierPartnerSchemeV2DetailsModel} */
+  static CourierPartnerSchemeV2DetailsModel() {
+    return Joi.object({
+      extension_id: Joi.string().allow("").required(),
+      scheme_id: Joi.string().allow(""),
+      name: Joi.string().allow("").required(),
+      weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
+      volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
+      transport_type: Joi.string().allow("").required(),
+      region: Joi.string().allow("").required(),
+      delivery_type: Joi.string().allow("").required(),
+      payment_mode: Joi.array().items(Joi.string().allow("")).required(),
+      stage: Joi.string().allow("").required(),
+      status_updates: Joi.string().allow(""),
+      ndr_attempts: Joi.number(),
+      qc_shipment_item_quantity: Joi.number().allow(null),
+      non_qc_shipment_item_quantity: Joi.number().allow(null),
+      feature: ServiceabilityPlatformModel.CourierPartnerSchemeV2Features().required(),
+    });
+  }
+
+  /** @returns {CourierPartnerV2SchemeModel} */
+  static CourierPartnerV2SchemeModel() {
+    return Joi.object({
+      extension_id: Joi.string().allow("").required(),
+      scheme_id: Joi.string().allow("").required(),
+      company_id: Joi.string().allow(""),
+      name: Joi.string().allow("").required(),
+      weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
+      volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
+      transport_type: Joi.string().allow("").required(),
+      region: Joi.string().allow("").required(),
+      delivery_type: Joi.string().allow("").required(),
+      payment_mode: Joi.array().items(Joi.string().allow("")).required(),
+      stage: Joi.string().allow("").required(),
+      status_updates: Joi.string().allow(""),
+      ndr_attempts: Joi.number(),
+      qc_shipment_item_quantity: Joi.number().allow(null),
+      non_qc_shipment_item_quantity: Joi.number().allow(null),
+      feature: ServiceabilityPlatformModel.CourierPartnerSchemeV2Features().required(),
+    });
+  }
+
+  /** @returns {CourierPartnerSchemeV2UpdateDetails} */
+  static CourierPartnerSchemeV2UpdateDetails() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+      weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
+      volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
+      transport_type: Joi.string().allow("").required(),
+      region: Joi.string().allow("").required(),
+      delivery_type: Joi.string().allow("").required(),
+      payment_mode: Joi.array().items(Joi.string().allow("")).required(),
+      stage: Joi.string().allow("").required(),
+      status_updates: Joi.string().allow(""),
+      ndr_attempts: Joi.number(),
+      qc_shipment_item_quantity: Joi.number().allow(null),
+      non_qc_shipment_item_quantity: Joi.number().allow(null),
+      feature: ServiceabilityPlatformModel.CourierPartnerSchemeV2Features().required(),
+    });
+  }
+
+  /** @returns {courierPartnerSchemeV2List} */
+  static courierPartnerSchemeV2List() {
+    return Joi.object({
+      items: Joi.array()
+        .items(ServiceabilityPlatformModel.CourierPartnerV2SchemeModel())
+        .required(),
+      page: ServiceabilityPlatformModel.Page().required(),
+    });
+  }
+
+  /** @returns {BulkRegionServiceabilityTatDetails} */
+  static BulkRegionServiceabilityTatDetails() {
+    return Joi.object({
+      country: Joi.string().allow("").required(),
+      region: Joi.string().allow("").required(),
+      type: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {BulkRegionServiceabilityTatResultItemData} */
+  static BulkRegionServiceabilityTatResultItemData() {
+    return Joi.object({
+      country: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      batch_id: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
+      file_path: Joi.string().allow("").allow(null),
+    });
+  }
+
+  /** @returns {BulkRegionServiceabilityTatResult} */
+  static BulkRegionServiceabilityTatResult() {
+    return Joi.object({
+      items: Joi.array().items(
+        ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData()
+      ),
+      page: ServiceabilityPlatformModel.Page(),
+    });
+  }
+
+  /** @returns {HierarchyItems} */
+  static HierarchyItems() {
+    return Joi.object({
+      display_name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {GetCountriesItems} */
+  static GetCountriesItems() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      iso2: Joi.string().allow(""),
+      iso3: Joi.string().allow(""),
+      timezones: Joi.array().items(Joi.string().allow("")),
+      hierarchy: Joi.array().items(
+        ServiceabilityPlatformModel.HierarchyItems()
+      ),
+      phone_code: Joi.string().allow(""),
+      currency: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      has_next_hierarchy: Joi.boolean(),
+    });
+  }
+
+  /** @returns {GetCountries} */
+  static GetCountries() {
+    return Joi.object({
+      items: Joi.array()
+        .items(ServiceabilityPlatformModel.GetCountriesItems())
+        .required(),
+      page: ServiceabilityPlatformModel.Page().required(),
+    });
+  }
 }
 module.exports = ServiceabilityPlatformModel;