@gofynd/fdk-client-javascript 3.16.3 → 3.17.1

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

@@ -1,4 +1,16 @@
 export = LogisticsPartnerModel;
+/**
+ * @typedef RateZoneConfigurationDetails
+ * @property {StandardRateZone[]} [standard_zone_mapping] - List of standard
+ *   zones with name-slug pairs.
+ * @property {string[]} [custom_zones] - List of custom zone names.
+ */
+/**
+ * @typedef RateCardSampleFile
+ * @property {string} [type] - Denotes the type of action performed.
+ * @property {string} [file_path] - CDN path of the file.
+ * @property {string} [status] - Current status of the request.
+ */
 /**
  * @typedef CourierPartnerSchemeModelSchema
  * @property {CreatedBy} [created_by]
@@ -76,6 +88,54 @@ export = LogisticsPartnerModel;
  *   bulk region serviceability or TAT result items.
  * @property {Page} [page]
  */
+/**
+ * @typedef BulkRateCardJob
+ * @property {string} type - Denotes the type of data.
+ * @property {number} total - Total number of items in the batch.
+ * @property {number} failed - Number of failed items in the batch.
+ * @property {number} success - Number of successful items in the batch.
+ * @property {string} [action] - Action type for the bulk operation, either
+ *   import or export.
+ * @property {string} batch_id - A unique identifier for the performed batch operation.
+ * @property {string} status - Current status of the request.
+ * @property {Object[]} [failed_records] - Array of objects containing
+ *   validation error details for records that failed during bulk import or
+ *   export operations. Each object includes error messages describing missing
+ *   required fields or validation failures for individual records.
+ * @property {string} [file_path] - CDN path of the file.
+ * @property {string} [created_on] - The timestamp when the record was created.
+ * @property {string} [modified_on] - The timestamp when the record was last modified.
+ */
+/**
+ * @typedef BulkRateCardJobDetails
+ * @property {string} [file_path] - Path to the file used in the bulk operation.
+ * @property {string} rate_card_type - Rate card type for which bulk operation
+ *   will be performed.
+ * @property {string} action - Action type for the bulk operation, either import
+ *   or export.
+ * @property {number[]} [company_ids] - List of company IDs for which rate card
+ *   needs to be applied.
+ */
+/**
+ * @typedef SampleFileRateZoneRequestSchema
+ * @property {string} [zone_type] - Rate zone for which the sample file to be downloaded.
+ * @property {string} [country] - Name of the country.
+ * @property {string} [region] - Region for which the sample file to be downloaded.
+ */
+/**
+ * @typedef RateZoneBulkJobDetails
+ * @property {string} [action] - Action type for the bulk operation, either
+ *   import or export.
+ * @property {string} [file_path] - CDN path of the file.
+ * @property {string} [zone_type] - Rate zone for the bulk action.
+ * @property {string} [country] - Name of the country.
+ * @property {string} [region] - Region for the import and export.
+ */
+/**
+ * @typedef RateZoneBulkJobList
+ * @property {BulkRateCardJob[]} [items] - Array of bulk rate zone result items.
+ * @property {Page} [page]
+ */
 /**
  * @typedef RegionTatItemResult
  * @property {RegionTatResult[]} items - An array that contains items of region tat.
@@ -490,6 +550,11 @@ export = LogisticsPartnerModel;
  * @typedef ValidationErrors
  * @property {ValidationError[]} errors - A list of validation errors in the request.
  */
+/**
+ * @typedef StandardRateZone
+ * @property {string} [zone_name] - User defined name of the zone for a particular slug.
+ * @property {string} [zone_slug] - Pre-defined slug for the standard zones.
+ */
 /**
  * @typedef CreatedBy
  * @property {string} [id] - Identifier of the user or system that created the object.
@@ -517,6 +582,7 @@ export = LogisticsPartnerModel;
  *   code-based operations.
  * @property {boolean} [mps] - Denotes if the courier partner supports
  *   multi-part shipment services.
+ * @property {boolean} [b2b] - Denotes if courier partner is business-to-business or not.
  * @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
@@ -652,8 +718,37 @@ export = LogisticsPartnerModel;
 declare class LogisticsPartnerModel {
 }
 declare namespace LogisticsPartnerModel {
-    export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, Error, Page, TATDetails, CourierPartnerSchemeModel, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
+    export { RateZoneConfigurationDetails, RateCardSampleFile, CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, BulkRateCardJob, BulkRateCardJobDetails, SampleFileRateZoneRequestSchema, RateZoneBulkJobDetails, RateZoneBulkJobList, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, StandardRateZone, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, Error, Page, TATDetails, CourierPartnerSchemeModel, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
 }
+/** @returns {RateZoneConfigurationDetails} */
+declare function RateZoneConfigurationDetails(): RateZoneConfigurationDetails;
+type RateZoneConfigurationDetails = {
+    /**
+     * - List of standard
+     * zones with name-slug pairs.
+     */
+    standard_zone_mapping?: StandardRateZone[];
+    /**
+     * - List of custom zone names.
+     */
+    custom_zones?: string[];
+};
+/** @returns {RateCardSampleFile} */
+declare function RateCardSampleFile(): RateCardSampleFile;
+type RateCardSampleFile = {
+    /**
+     * - Denotes the type of action performed.
+     */
+    type?: string;
+    /**
+     * - CDN path of the file.
+     */
+    file_path?: string;
+    /**
+     * - Current status of the request.
+     */
+    status?: string;
+};
 /** @returns {CourierPartnerSchemeModelSchema} */
 declare function CourierPartnerSchemeModelSchema(): CourierPartnerSchemeModelSchema;
 type CourierPartnerSchemeModelSchema = {
@@ -840,6 +935,131 @@ type BulkRegionServiceabilityTatResult = {
     items?: BulkRegionServiceabilityTatResultItemData[];
     page?: Page;
 };
+/** @returns {BulkRateCardJob} */
+declare function BulkRateCardJob(): BulkRateCardJob;
+type BulkRateCardJob = {
+    /**
+     * - Denotes the type of data.
+     */
+    type: string;
+    /**
+     * - Total number of items in the batch.
+     */
+    total: number;
+    /**
+     * - Number of failed items in the batch.
+     */
+    failed: number;
+    /**
+     * - Number of successful items in the batch.
+     */
+    success: number;
+    /**
+     * - Action type for the bulk operation, either
+     * import or export.
+     */
+    action?: string;
+    /**
+     * - A unique identifier for the performed batch operation.
+     */
+    batch_id: string;
+    /**
+     * - Current status of the request.
+     */
+    status: string;
+    /**
+     * - Array of objects containing
+     * validation error details for records that failed during bulk import or
+     * export operations. Each object includes error messages describing missing
+     * required fields or validation failures for individual records.
+     */
+    failed_records?: any[];
+    /**
+     * - CDN path of the file.
+     */
+    file_path?: string;
+    /**
+     * - The timestamp when the record was created.
+     */
+    created_on?: string;
+    /**
+     * - The timestamp when the record was last modified.
+     */
+    modified_on?: string;
+};
+/** @returns {BulkRateCardJobDetails} */
+declare function BulkRateCardJobDetails(): BulkRateCardJobDetails;
+type BulkRateCardJobDetails = {
+    /**
+     * - Path to the file used in the bulk operation.
+     */
+    file_path?: string;
+    /**
+     * - Rate card type for which bulk operation
+     * will be performed.
+     */
+    rate_card_type: string;
+    /**
+     * - Action type for the bulk operation, either import
+     * or export.
+     */
+    action: string;
+    /**
+     * - List of company IDs for which rate card
+     * needs to be applied.
+     */
+    company_ids?: number[];
+};
+/** @returns {SampleFileRateZoneRequestSchema} */
+declare function SampleFileRateZoneRequestSchema(): SampleFileRateZoneRequestSchema;
+type SampleFileRateZoneRequestSchema = {
+    /**
+     * - Rate zone for which the sample file to be downloaded.
+     */
+    zone_type?: string;
+    /**
+     * - Name of the country.
+     */
+    country?: string;
+    /**
+     * - Region for which the sample file to be downloaded.
+     */
+    region?: string;
+};
+/** @returns {RateZoneBulkJobDetails} */
+declare function RateZoneBulkJobDetails(): RateZoneBulkJobDetails;
+type RateZoneBulkJobDetails = {
+    /**
+     * - Action type for the bulk operation, either
+     * import or export.
+     */
+    action?: string;
+    /**
+     * - CDN path of the file.
+     */
+    file_path?: string;
+    /**
+     * - Rate zone for the bulk action.
+     */
+    zone_type?: string;
+    /**
+     * - Name of the country.
+     */
+    country?: string;
+    /**
+     * - Region for the import and export.
+     */
+    region?: string;
+};
+/** @returns {RateZoneBulkJobList} */
+declare function RateZoneBulkJobList(): RateZoneBulkJobList;
+type RateZoneBulkJobList = {
+    /**
+     * - Array of bulk rate zone result items.
+     */
+    items?: BulkRateCardJob[];
+    page?: Page;
+};
 /** @returns {RegionTatItemResult} */
 declare function RegionTatItemResult(): RegionTatItemResult;
 type RegionTatItemResult = {
@@ -1807,6 +2027,18 @@ type ValidationErrors = {
      */
     errors: ValidationError[];
 };
+/** @returns {StandardRateZone} */
+declare function StandardRateZone(): StandardRateZone;
+type StandardRateZone = {
+    /**
+     * - User defined name of the zone for a particular slug.
+     */
+    zone_name?: string;
+    /**
+     * - Pre-defined slug for the standard zones.
+     */
+    zone_slug?: string;
+};
 /** @returns {CreatedBy} */
 declare function CreatedBy(): CreatedBy;
 type CreatedBy = {
@@ -1865,6 +2097,10 @@ type CourierPartnerSchemeFeatures = {
      * multi-part shipment services.
      */
     mps?: boolean;
+    /**
+     * - Denotes if courier partner is business-to-business or not.
+     */
+    b2b?: boolean;
     /**
      * - Indicates if the Non-Delivery Report (NDR)
      * feature is supported by the courier partner.

package/sdk/partner/Logistics/LogisticsPartnerModel.js

@@ -1,5 +1,19 @@
 const Joi = require("joi");
 
+/**
+ * @typedef RateZoneConfigurationDetails
+ * @property {StandardRateZone[]} [standard_zone_mapping] - List of standard
+ *   zones with name-slug pairs.
+ * @property {string[]} [custom_zones] - List of custom zone names.
+ */
+
+/**
+ * @typedef RateCardSampleFile
+ * @property {string} [type] - Denotes the type of action performed.
+ * @property {string} [file_path] - CDN path of the file.
+ * @property {string} [status] - Current status of the request.
+ */
+
 /**
  * @typedef CourierPartnerSchemeModelSchema
  * @property {CreatedBy} [created_by]
@@ -84,6 +98,59 @@ const Joi = require("joi");
  * @property {Page} [page]
  */
 
+/**
+ * @typedef BulkRateCardJob
+ * @property {string} type - Denotes the type of data.
+ * @property {number} total - Total number of items in the batch.
+ * @property {number} failed - Number of failed items in the batch.
+ * @property {number} success - Number of successful items in the batch.
+ * @property {string} [action] - Action type for the bulk operation, either
+ *   import or export.
+ * @property {string} batch_id - A unique identifier for the performed batch operation.
+ * @property {string} status - Current status of the request.
+ * @property {Object[]} [failed_records] - Array of objects containing
+ *   validation error details for records that failed during bulk import or
+ *   export operations. Each object includes error messages describing missing
+ *   required fields or validation failures for individual records.
+ * @property {string} [file_path] - CDN path of the file.
+ * @property {string} [created_on] - The timestamp when the record was created.
+ * @property {string} [modified_on] - The timestamp when the record was last modified.
+ */
+
+/**
+ * @typedef BulkRateCardJobDetails
+ * @property {string} [file_path] - Path to the file used in the bulk operation.
+ * @property {string} rate_card_type - Rate card type for which bulk operation
+ *   will be performed.
+ * @property {string} action - Action type for the bulk operation, either import
+ *   or export.
+ * @property {number[]} [company_ids] - List of company IDs for which rate card
+ *   needs to be applied.
+ */
+
+/**
+ * @typedef SampleFileRateZoneRequestSchema
+ * @property {string} [zone_type] - Rate zone for which the sample file to be downloaded.
+ * @property {string} [country] - Name of the country.
+ * @property {string} [region] - Region for which the sample file to be downloaded.
+ */
+
+/**
+ * @typedef RateZoneBulkJobDetails
+ * @property {string} [action] - Action type for the bulk operation, either
+ *   import or export.
+ * @property {string} [file_path] - CDN path of the file.
+ * @property {string} [zone_type] - Rate zone for the bulk action.
+ * @property {string} [country] - Name of the country.
+ * @property {string} [region] - Region for the import and export.
+ */
+
+/**
+ * @typedef RateZoneBulkJobList
+ * @property {BulkRateCardJob[]} [items] - Array of bulk rate zone result items.
+ * @property {Page} [page]
+ */
+
 /**
  * @typedef RegionTatItemResult
  * @property {RegionTatResult[]} items - An array that contains items of region tat.
@@ -520,6 +587,12 @@ const Joi = require("joi");
  * @property {ValidationError[]} errors - A list of validation errors in the request.
  */
 
+/**
+ * @typedef StandardRateZone
+ * @property {string} [zone_name] - User defined name of the zone for a particular slug.
+ * @property {string} [zone_slug] - Pre-defined slug for the standard zones.
+ */
+
 /**
  * @typedef CreatedBy
  * @property {string} [id] - Identifier of the user or system that created the object.
@@ -550,6 +623,7 @@ const Joi = require("joi");
  *   code-based operations.
  * @property {boolean} [mps] - Denotes if the courier partner supports
  *   multi-part shipment services.
+ * @property {boolean} [b2b] - Denotes if courier partner is business-to-business or not.
  * @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
@@ -694,6 +768,25 @@ const Joi = require("joi");
  */
 
 class LogisticsPartnerModel {
+  /** @returns {RateZoneConfigurationDetails} */
+  static RateZoneConfigurationDetails() {
+    return Joi.object({
+      standard_zone_mapping: Joi.array().items(
+        LogisticsPartnerModel.StandardRateZone()
+      ),
+      custom_zones: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {RateCardSampleFile} */
+  static RateCardSampleFile() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      file_path: Joi.string().allow("").allow(null),
+      status: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {CourierPartnerSchemeModelSchema} */
   static CourierPartnerSchemeModelSchema() {
     return Joi.object({
@@ -779,6 +872,61 @@ class LogisticsPartnerModel {
     });
   }
 
+  /** @returns {BulkRateCardJob} */
+  static BulkRateCardJob() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+      total: Joi.number().required(),
+      failed: Joi.number().required(),
+      success: Joi.number().required(),
+      action: Joi.string().allow(""),
+      batch_id: Joi.string().allow("").required(),
+      status: Joi.string().allow("").required(),
+      failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
+      file_path: Joi.string().allow("").allow(null),
+      created_on: Joi.string().allow(""),
+      modified_on: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {BulkRateCardJobDetails} */
+  static BulkRateCardJobDetails() {
+    return Joi.object({
+      file_path: Joi.string().allow(""),
+      rate_card_type: Joi.string().allow("").required(),
+      action: Joi.string().allow("").required(),
+      company_ids: Joi.array().items(Joi.number()),
+    });
+  }
+
+  /** @returns {SampleFileRateZoneRequestSchema} */
+  static SampleFileRateZoneRequestSchema() {
+    return Joi.object({
+      zone_type: Joi.string().allow(""),
+      country: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {RateZoneBulkJobDetails} */
+  static RateZoneBulkJobDetails() {
+    return Joi.object({
+      action: Joi.string().allow(""),
+      file_path: Joi.string().allow("").allow(null),
+      zone_type: Joi.string().allow(""),
+      country: Joi.string().allow(""),
+      region: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {RateZoneBulkJobList} */
+  static RateZoneBulkJobList() {
+    return Joi.object({
+      items: Joi.array().items(LogisticsPartnerModel.BulkRateCardJob()),
+      page: LogisticsPartnerModel.Page(),
+    });
+  }
+
   /** @returns {RegionTatItemResult} */
   static RegionTatItemResult() {
     return Joi.object({
@@ -1129,6 +1277,14 @@ class LogisticsPartnerModel {
     });
   }
 
+  /** @returns {StandardRateZone} */
+  static StandardRateZone() {
+    return Joi.object({
+      zone_name: Joi.string().allow(""),
+      zone_slug: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {CreatedBy} */
   static CreatedBy() {
     return Joi.object({
@@ -1159,6 +1315,7 @@ class LogisticsPartnerModel {
       doorstep_qc: Joi.boolean(),
       qr: Joi.boolean(),
       mps: Joi.boolean(),
+      b2b: Joi.boolean(),
       ndr: Joi.boolean(),
       ndr_attempts: Joi.number(),
       dangerous_goods: Joi.boolean(),

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

@@ -25,4 +25,12 @@ declare class LogisticsValidator {
     static getCourierPartnerSchemes(): any;
     static updateCourierPartnerScheme(): any;
     static getCourierPartnerScheme(): any;
+    static getSampleFileRateCard(): any;
+    static bulkRateCard(): any;
+    static getBulkRateCard(): any;
+    static getSampleFileRateZone(): any;
+    static createRateZoneBulkJob(): any;
+    static getBulkRateZoneJobHistory(): any;
+    static getRateZoneConfig(): any;
+    static updateRateZoneConfiguration(): any;
 }

package/sdk/partner/Logistics/LogisticsPartnerValidator.js

@@ -252,6 +252,76 @@ class LogisticsValidator {
       schemeId: Joi.string().allow("").required(),
     }).required();
   }
+
+  static getSampleFileRateCard() {
+    return Joi.object({}).required();
+  }
+
+  static bulkRateCard() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      body: LogisticsModel.BulkRateCardJobDetails().required(),
+    }).required();
+  }
+
+  static getBulkRateCard() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      batchId: Joi.string().allow(""),
+      action: Joi.string().allow(""),
+      status: Joi.string().allow("").allow(null),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getSampleFileRateZone() {
+    return Joi.object({
+      body: LogisticsModel.SampleFileRateZoneRequestSchema().required(),
+    }).required();
+  }
+
+  static createRateZoneBulkJob() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      body: LogisticsModel.RateZoneBulkJobDetails().required(),
+    }).required();
+  }
+
+  static getBulkRateZoneJobHistory() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      batchId: Joi.string().allow(""),
+      action: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      zoneType: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getRateZoneConfig() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static updateRateZoneConfiguration() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      schemeId: Joi.string().allow("").required(),
+      body: LogisticsModel.RateZoneConfigurationDetails().required(),
+    }).required();
+  }
 }
 
 module.exports = LogisticsValidator;