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

package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts

@@ -68,6 +68,8 @@ export = LogisticsPartnerModel;
  *   first-mile service is available or not.
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
  *   service is available or not.
+ * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
+ *   region is first-mile serviceable or not in return pickup.
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
  *   (COD) payments allowed in the specified region.
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
@@ -88,6 +90,8 @@ export = LogisticsPartnerModel;
  *   first-mile service is available or not.
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
  *   service is available or not.
+ * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
+ *   region is first-mile serviceable or not in return pickup.
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
  *   (COD) payments allowed in the specified region.
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
@@ -117,6 +121,8 @@ export = LogisticsPartnerModel;
  *   first-mile service is available or not.
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
  *   service is available or not.
+ * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
+ *   region is first-mile serviceable or not in return pickup.
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
  *   (COD) payments allowed in the specified region.
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
@@ -147,6 +153,8 @@ export = LogisticsPartnerModel;
  *   first-mile service is available or not.
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
  *   service is available or not.
+ * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
+ *   region is first-mile serviceable or not in return pickup.
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
  *   (COD) payments allowed in the specified region.
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
@@ -306,8 +314,8 @@ export = LogisticsPartnerModel;
  *   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
  */
 /**
@@ -324,8 +332,8 @@ export = LogisticsPartnerModel;
  *   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
  */
 /**
@@ -372,6 +380,102 @@ export = LogisticsPartnerModel;
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
  *   quantity of items allowed in a non-quality check shipment.
  */
+/**
+ * @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] - Unique identifier of courier partner scheme.
+ * @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 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 courierPartnerSchemeV2List
+ * @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
+ * @property {Page} page
+ */
 /**
  * @typedef ArithmeticOperations
  * @property {number} [lt]
@@ -380,9 +484,10 @@ export = LogisticsPartnerModel;
  * @property {number} [gte]
  */
 /**
- * @typedef CourierPartnerSchemeUpdateDetails
+ * @typedef CourierPartnerSchemeV2UpdateDetails
  * @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
@@ -391,9 +496,17 @@ export = LogisticsPartnerModel;
  *   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 {CourierPartnerSchemeFeatures} feature
+ * @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 GetCountries
@@ -442,7 +555,7 @@ export = LogisticsPartnerModel;
 declare class LogisticsPartnerModel {
 }
 declare namespace LogisticsPartnerModel {
-    export { BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, ErrorResult, FailureResult, BulkRegionServiceabilityTatResult, Page, CourierAccountUpdateDetails, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatUpdateDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccount, CourierAccountDetailsBody, CourierPartnerAccountFailureResult, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeModel, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
+    export { BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, ErrorResult, FailureResult, BulkRegionServiceabilityTatResult, Page, CourierAccountUpdateDetails, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatUpdateDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccount, CourierAccountDetailsBody, CourierPartnerAccountFailureResult, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeModel, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeV2Features, CourierPartnerSchemeV2DetailsModel, CourierPartnerV2SchemeModel, courierPartnerSchemeV2List, ArithmeticOperations, CourierPartnerSchemeV2UpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
 }
 /** @returns {BulkRegionServiceabilityTatDetails} */
 declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
@@ -607,6 +720,11 @@ type ServiceabilityDetailsResult = {
      * service is available or not.
      */
     last_mile?: boolean;
+    /**
+     * - Boolean value indicating whether a
+     * region is first-mile serviceable or not in return pickup.
+     */
+    reverse_pickup?: boolean;
     /**
      * - Limit on the amount of cash on delivery
      * (COD) payments allowed in the specified region.
@@ -652,6 +770,11 @@ type ServiceabilityDetails = {
      * service is available or not.
      */
     last_mile?: boolean;
+    /**
+     * - Boolean value indicating whether a
+     * region is first-mile serviceable or not in return pickup.
+     */
+    reverse_pickup?: boolean;
     /**
      * - Limit on the amount of cash on delivery
      * (COD) payments allowed in the specified region.
@@ -718,6 +841,11 @@ type RegionServiceabilityResult = {
      * service is available or not.
      */
     last_mile?: boolean;
+    /**
+     * - Boolean value indicating whether a
+     * region is first-mile serviceable or not in return pickup.
+     */
+    reverse_pickup?: boolean;
     /**
      * - Limit on the amount of cash on delivery
      * (COD) payments allowed in the specified region.
@@ -788,6 +916,11 @@ type RegionServiceabilityDetails = {
      * service is available or not.
      */
     last_mile?: boolean;
+    /**
+     * - Boolean value indicating whether a
+     * region is first-mile serviceable or not in return pickup.
+     */
+    reverse_pickup?: boolean;
     /**
      * - Limit on the amount of cash on delivery
      * (COD) payments allowed in the specified region.
@@ -1170,8 +1303,8 @@ type CourierPartnerSchemeModel = {
      */
     payment_mode: string[];
     /**
-     * - Denotes whether the courier partner scheme is in
-     * enabled or disabled stage.
+     * - Indicates if the courier partner scheme is
+     * currently active or inactive.
      */
     stage: string;
     feature: CourierPartnerSchemeFeatures;
@@ -1213,8 +1346,8 @@ type CourierPartnerSchemeDetailsModel = {
      */
     payment_mode: string[];
     /**
-     * - Denotes whether the courier partner scheme is in
-     * enabled or disabled stage.
+     * - Indicates if the courier partner scheme is
+     * currently active or inactive.
      */
     stage: string;
     feature: CourierPartnerSchemeFeatures;
@@ -1324,6 +1457,232 @@ type CourierPartnerSchemeFeatures = {
      */
     non_qc_shipment_item_quantity?: number;
 };
+/** @returns {CourierPartnerSchemeV2Features} */
+declare function CourierPartnerSchemeV2Features(): CourierPartnerSchemeV2Features;
+type CourierPartnerSchemeV2Features = {
+    /**
+     * - Indicates if the courier partner offers
+     * doorstep quality check services.
+     */
+    doorstep_qc?: boolean;
+    /**
+     * - Specifies whether the courier partner supports QR
+     * code-based operations.
+     */
+    qr?: boolean;
+    /**
+     * - Denotes if the courier partner supports
+     * multi-part shipment services.
+     */
+    mps?: boolean;
+    /**
+     * - Indicates if the Non-Delivery Report (NDR)
+     * feature is supported by the courier partner.
+     */
+    ndr?: boolean;
+    /**
+     * - Specifies if the courier partner
+     * handles the transportation of dangerous goods.
+     */
+    dangerous_goods?: boolean;
+    /**
+     * - Indicates whether the courier partner
+     * manages the shipment of fragile goods.
+     */
+    fragile_goods?: boolean;
+    /**
+     * - Indicates if the courier partner
+     * handles restricted goods, as per regulatory guidelines.
+     */
+    restricted_goods?: boolean;
+    /**
+     * - Denotes if the courier partner
+     * provides cold storage facilities for goods.
+     */
+    cold_storage_goods?: boolean;
+    /**
+     * - Indicates if the courier partner
+     * supports doorstep exchange services.
+     */
+    doorstep_exchange?: boolean;
+    /**
+     * - Specifies if the courier partner
+     * offers doorstep return services.
+     */
+    doorstep_return?: boolean;
+    /**
+     * - Indicates if the courier partner
+     * provides product installation services upon delivery.
+     */
+    product_installation?: boolean;
+    /**
+     * - Specifies whether the courier
+     * partner supports open-box delivery, allowing customers to inspect goods
+     * before accepting.
+     */
+    openbox_delivery?: boolean;
+    /**
+     * - Indicates if the courier
+     * partner supports multiple pickups to a single drop location.
+     */
+    multi_pick_single_drop?: boolean;
+    /**
+     * - Indicates whether the courier
+     * partner supports single pickup to multiple drop locations.
+     */
+    single_pick_multi_drop?: boolean;
+    /**
+     * - Denotes if the courier partner
+     * offers services for multiple pickups to multiple drop locations.
+     */
+    multi_pick_multi_drop?: boolean;
+    /**
+     * - Specifies if the courier partner requires or
+     * supports the generation of e-waybills for shipments.
+     */
+    ewaybill?: boolean;
+};
+/** @returns {CourierPartnerSchemeV2DetailsModel} */
+declare function CourierPartnerSchemeV2DetailsModel(): CourierPartnerSchemeV2DetailsModel;
+type CourierPartnerSchemeV2DetailsModel = {
+    /**
+     * - Unique identifier of courier partner extension.
+     */
+    extension_id: string;
+    /**
+     * - Unique identifier of courier partner scheme.
+     */
+    scheme_id?: string;
+    /**
+     * - Name of the scheme.
+     */
+    name: string;
+    weight: ArithmeticOperations;
+    volumetric_weight?: ArithmeticOperations;
+    /**
+     * - Mode of transport associated with the
+     * courier partner scheme.
+     */
+    transport_type: string;
+    /**
+     * - Serviceable region associated with the courier
+     * partner scheme.
+     */
+    region: string;
+    /**
+     * - Type of delivery associated with the
+     * courier partner scheme.
+     */
+    delivery_type: string;
+    /**
+     * - Mode of payment associated with the
+     * courier partner scheme.
+     */
+    payment_mode: string[];
+    /**
+     * - Indicates if the courier partner scheme is
+     * currently active or inactive.
+     */
+    stage: string;
+    /**
+     * - Describes the type of status updates
+     * provided by the courier partner (e.g., real-time, periodic).
+     */
+    status_updates?: string;
+    /**
+     * - Indicates if the Non-Delivery Report
+     * (NDR) feature is supported by the courier partner.
+     */
+    ndr_attempts?: number;
+    /**
+     * - Defines the maximum quantity
+     * of items allowed in a quality check shipment.
+     */
+    qc_shipment_item_quantity?: number;
+    /**
+     * - Defines the maximum
+     * quantity of items allowed in a non-quality check shipment.
+     */
+    non_qc_shipment_item_quantity?: number;
+    feature: CourierPartnerSchemeV2Features;
+};
+/** @returns {CourierPartnerV2SchemeModel} */
+declare function CourierPartnerV2SchemeModel(): CourierPartnerV2SchemeModel;
+type CourierPartnerV2SchemeModel = {
+    /**
+     * - Unique identifier of courier partner extension.
+     */
+    extension_id: string;
+    /**
+     * - Unique identifier of courier partner scheme.
+     */
+    scheme_id: string;
+    /**
+     * - Unique identifier of company.
+     */
+    company_id?: string;
+    /**
+     * - Name of the scheme.
+     */
+    name: string;
+    weight: ArithmeticOperations;
+    volumetric_weight?: ArithmeticOperations;
+    /**
+     * - Mode of transport associated with the
+     * courier partner scheme.
+     */
+    transport_type: string;
+    /**
+     * - Serviceable region associated with the courier
+     * partner scheme.
+     */
+    region: string;
+    /**
+     * - Type of delivery associated with the
+     * courier partner scheme.
+     */
+    delivery_type: string;
+    /**
+     * - Mode of payment associated with the
+     * courier partner scheme.
+     */
+    payment_mode: string[];
+    /**
+     * - Indicates if the courier partner scheme is
+     * currently active or inactive.
+     */
+    stage: string;
+    /**
+     * - Describes the type of status updates
+     * provided by the courier partner (e.g., real-time, periodic).
+     */
+    status_updates?: string;
+    /**
+     * - Indicates if the Non-Delivery Report
+     * (NDR) feature is supported by the courier partner.
+     */
+    ndr_attempts?: number;
+    /**
+     * - Defines the maximum quantity
+     * of items allowed in a quality check shipment.
+     */
+    qc_shipment_item_quantity?: number;
+    /**
+     * - Defines the maximum
+     * quantity of items allowed in a non-quality check shipment.
+     */
+    non_qc_shipment_item_quantity?: number;
+    feature: CourierPartnerSchemeV2Features;
+};
+/** @returns {courierPartnerSchemeV2List} */
+declare function courierPartnerSchemeV2List(): courierPartnerSchemeV2List;
+type courierPartnerSchemeV2List = {
+    /**
+     * - List of courier partner schemes
+     */
+    items: CourierPartnerV2SchemeModel[];
+    page: Page;
+};
 /** @returns {ArithmeticOperations} */
 declare function ArithmeticOperations(): ArithmeticOperations;
 type ArithmeticOperations = {
@@ -1332,14 +1691,15 @@ type ArithmeticOperations = {
     lte?: number;
     gte?: number;
 };
-/** @returns {CourierPartnerSchemeUpdateDetails} */
-declare function CourierPartnerSchemeUpdateDetails(): CourierPartnerSchemeUpdateDetails;
-type CourierPartnerSchemeUpdateDetails = {
+/** @returns {CourierPartnerSchemeV2UpdateDetails} */
+declare function CourierPartnerSchemeV2UpdateDetails(): CourierPartnerSchemeV2UpdateDetails;
+type CourierPartnerSchemeV2UpdateDetails = {
     /**
      * - Name of the scheme.
      */
     name: string;
     weight: ArithmeticOperations;
+    volumetric_weight?: ArithmeticOperations;
     /**
      * - Mode of transport associated with the
      * courier partner scheme.
@@ -1361,11 +1721,31 @@ type CourierPartnerSchemeUpdateDetails = {
      */
     payment_mode: string[];
     /**
-     * - Denotes whether the courier partner scheme is in
-     * enabled or disabled stage.
+     * - Indicates if the courier partner scheme is
+     * currently active or inactive.
      */
     stage: string;
-    feature: CourierPartnerSchemeFeatures;
+    /**
+     * - Describes the type of status updates
+     * provided by the courier partner (e.g., real-time, periodic).
+     */
+    status_updates?: string;
+    /**
+     * - Indicates if the Non-Delivery Report
+     * (NDR) feature is supported by the courier partner.
+     */
+    ndr_attempts?: number;
+    /**
+     * - Defines the maximum quantity
+     * of items allowed in a quality check shipment.
+     */
+    qc_shipment_item_quantity?: number;
+    /**
+     * - Defines the maximum
+     * quantity of items allowed in a non-quality check shipment.
+     */
+    non_qc_shipment_item_quantity?: number;
+    feature: CourierPartnerSchemeV2Features;
 };
 /** @returns {GetCountries} */
 declare function GetCountries(): GetCountries;