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

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

@@ -15,6 +15,10 @@ export = ServiceabilityPlatformValidator;
  * @typedef CreateCourierPartnerAccountParam
  * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
  */
+/**
+ * @typedef CreateCourierPartnerSchemeParam
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
+ */
 /**
  * @typedef CreatePackageMaterialParam
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
@@ -57,6 +61,15 @@ export = ServiceabilityPlatformValidator;
  * @property {string} [endDate] - Fetch job history before a particule date
  */
 /** @typedef GetCompanyConfigurationParam */
+/**
+ * @typedef GetCountriesParam
+ * @property {boolean} [onboarding] - Only fetch countries which allowed for
+ *   onboard on Platform.
+ * @property {number} [pageNo] - Page number.
+ * @property {number} [pageSize] - Page size.
+ * @property {string} [q] - Search.
+ * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
+ */
 /**
  * @typedef GetCourierPartnerAccountParam
  * @property {string} accountId - Unique ID of courier partner account
@@ -69,6 +82,20 @@ export = ServiceabilityPlatformValidator;
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
  * @property {string} [transportType] - Filters dp accounts based on transport_type
  */
+/**
+ * @typedef GetCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique Identifier of Scheme
+ */
+/**
+ * @typedef GetCourierPartnerSchemesParam
+ * @property {string} [schemeType] - Indicates whether a scheme is created by an
+ *   admin for global purposes or customized for a specific company.
+ * @property {string} [paymentMode] - Indicates payment mode for a scheme.
+ * @property {string[]} [capabilities] - Indicates whether the scheme possesses
+ *   certain capabilities.
+ * @property {string[]} [schemeIds] - List of scheme ids which need to be
+ *   returned in the response.
+ */
 /**
  * @typedef GetOptimalLocationsParam
  * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
@@ -96,6 +123,12 @@ export = ServiceabilityPlatformValidator;
  * @typedef GetPackageMaterialsParam
  * @property {string} packageMaterialId - Unique identifier for a Package. Material
  */
+/**
+ * @typedef GetSampleFileServiceabilityStatusParam
+ * @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} [batchId] - Batch id of the execution
+ */
 /**
  * @typedef GetServiceabilityParam
  * @property {string} extensionId - Unique Identifier of courier partner extension.
@@ -119,6 +152,10 @@ export = ServiceabilityPlatformValidator;
  * @property {string} [pincode] - Pincode value to search zones
  * @property {string} [sector] - Sector value to search zones
  */
+/**
+ * @typedef SampleFileServiceabilityParam
+ * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
+ */
 /**
  * @typedef UpdateCompanyConfigurationParam
  * @property {ServiceabilityPlatformModel.CompanyConfig} body
@@ -128,6 +165,11 @@ export = ServiceabilityPlatformValidator;
  * @property {string} accountId - Unique ID of courier partner account
  * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
  */
+/**
+ * @typedef UpdateCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique Identifier of Scheme
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
+ */
 /**
  * @typedef UpdatePackageMaterialRuleParam
  * @property {string} ruleId - A `package_material_rule_id` is a unique
@@ -158,6 +200,8 @@ declare class ServiceabilityPlatformValidator {
     static bulkTat(): BulkTatParam;
     /** @returns {CreateCourierPartnerAccountParam} */
     static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
+    /** @returns {CreateCourierPartnerSchemeParam} */
+    static createCourierPartnerScheme(): CreateCourierPartnerSchemeParam;
     /** @returns {CreatePackageMaterialParam} */
     static createPackageMaterial(): CreatePackageMaterialParam;
     /** @returns {CreatePackageMaterialRuleParam} */
@@ -172,10 +216,16 @@ declare class ServiceabilityPlatformValidator {
     static getBulkTat(): GetBulkTatParam;
     /** @returns {GetCompanyConfigurationParam} */
     static getCompanyConfiguration(): any;
+    /** @returns {GetCountriesParam} */
+    static getCountries(): GetCountriesParam;
     /** @returns {GetCourierPartnerAccountParam} */
     static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
     /** @returns {GetCourierPartnerAccountsParam} */
     static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
+    /** @returns {GetCourierPartnerSchemeParam} */
+    static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
+    /** @returns {GetCourierPartnerSchemesParam} */
+    static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
     /** @returns {GetOptimalLocationsParam} */
     static getOptimalLocations(): GetOptimalLocationsParam;
     /** @returns {GetPackageMaterialListParam} */
@@ -186,16 +236,22 @@ declare class ServiceabilityPlatformValidator {
     static getPackageMaterialRules(): GetPackageMaterialRulesParam;
     /** @returns {GetPackageMaterialsParam} */
     static getPackageMaterials(): GetPackageMaterialsParam;
+    /** @returns {GetSampleFileServiceabilityStatusParam} */
+    static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
     /** @returns {GetServiceabilityParam} */
     static getServiceability(): GetServiceabilityParam;
     /** @returns {GetZoneByIdParam} */
     static getZoneById(): GetZoneByIdParam;
     /** @returns {GetZonesParam} */
     static getZones(): GetZonesParam;
+    /** @returns {SampleFileServiceabilityParam} */
+    static sampleFileServiceability(): SampleFileServiceabilityParam;
     /** @returns {UpdateCompanyConfigurationParam} */
     static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
     /** @returns {UpdateCourierPartnerAccountParam} */
     static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
+    /** @returns {UpdateCourierPartnerSchemeParam} */
+    static updateCourierPartnerScheme(): UpdateCourierPartnerSchemeParam;
     /** @returns {UpdatePackageMaterialRuleParam} */
     static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
     /** @returns {UpdatePackageMaterialsParam} */
@@ -206,7 +262,7 @@ declare class ServiceabilityPlatformValidator {
     static updateZoneById(): UpdateZoneByIdParam;
 }
 declare namespace ServiceabilityPlatformValidator {
-    export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
+    export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
 }
 type BulkServiceabilityParam = {
     /**
@@ -233,6 +289,9 @@ type BulkTatParam = {
 type CreateCourierPartnerAccountParam = {
     body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
 };
+type CreateCourierPartnerSchemeParam = {
+    body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel;
+};
 type CreatePackageMaterialParam = {
     body: ServiceabilityPlatformModel.PackageMaterial;
 };
@@ -334,6 +393,29 @@ type GetBulkTatParam = {
      */
     endDate?: string;
 };
+type GetCountriesParam = {
+    /**
+     * - Only fetch countries which allowed for
+     * onboard on Platform.
+     */
+    onboarding?: boolean;
+    /**
+     * - Page number.
+     */
+    pageNo?: number;
+    /**
+     * - Page size.
+     */
+    pageSize?: number;
+    /**
+     * - Search.
+     */
+    q?: string;
+    /**
+     * - Fetch countries that has certain heirarchy present.
+     */
+    hierarchy?: string;
+};
 type GetCourierPartnerAccountParam = {
     /**
      * - Unique ID of courier partner account
@@ -362,6 +444,33 @@ type GetCourierPartnerAccountsParam = {
      */
     transportType?: string;
 };
+type GetCourierPartnerSchemeParam = {
+    /**
+     * - Unique Identifier of Scheme
+     */
+    schemeId: string;
+};
+type GetCourierPartnerSchemesParam = {
+    /**
+     * - Indicates whether a scheme is created by an
+     * admin for global purposes or customized for a specific company.
+     */
+    schemeType?: string;
+    /**
+     * - Indicates payment mode for a scheme.
+     */
+    paymentMode?: string;
+    /**
+     * - Indicates whether the scheme possesses
+     * certain capabilities.
+     */
+    capabilities?: string[];
+    /**
+     * - List of scheme ids which need to be
+     * returned in the response.
+     */
+    schemeIds?: string[];
+};
 type GetOptimalLocationsParam = {
     body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
 };
@@ -414,6 +523,20 @@ type GetPackageMaterialsParam = {
      */
     packageMaterialId: string;
 };
+type GetSampleFileServiceabilityStatusParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - Batch id of the execution
+     */
+    batchId?: string;
+};
 type GetServiceabilityParam = {
     /**
      * - Unique Identifier of courier partner extension.
@@ -476,6 +599,9 @@ type GetZonesParam = {
      */
     sector?: string;
 };
+type SampleFileServiceabilityParam = {
+    body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
+};
 type UpdateCompanyConfigurationParam = {
     body: ServiceabilityPlatformModel.CompanyConfig;
 };
@@ -486,6 +612,13 @@ type UpdateCourierPartnerAccountParam = {
     accountId: string;
     body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
 };
+type UpdateCourierPartnerSchemeParam = {
+    /**
+     * - Unique Identifier of Scheme
+     */
+    schemeId: string;
+    body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails;
+};
 type UpdatePackageMaterialRuleParam = {
     /**
      * - A `package_material_rule_id` is a unique

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -21,6 +21,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
  */
 
+/**
+ * @typedef CreateCourierPartnerSchemeParam
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
+ */
+
 /**
  * @typedef CreatePackageMaterialParam
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
@@ -70,6 +75,16 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /** @typedef GetCompanyConfigurationParam */
 
+/**
+ * @typedef GetCountriesParam
+ * @property {boolean} [onboarding] - Only fetch countries which allowed for
+ *   onboard on Platform.
+ * @property {number} [pageNo] - Page number.
+ * @property {number} [pageSize] - Page size.
+ * @property {string} [q] - Search.
+ * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
+ */
+
 /**
  * @typedef GetCourierPartnerAccountParam
  * @property {string} accountId - Unique ID of courier partner account
@@ -84,6 +99,22 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} [transportType] - Filters dp accounts based on transport_type
  */
 
+/**
+ * @typedef GetCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique Identifier of Scheme
+ */
+
+/**
+ * @typedef GetCourierPartnerSchemesParam
+ * @property {string} [schemeType] - Indicates whether a scheme is created by an
+ *   admin for global purposes or customized for a specific company.
+ * @property {string} [paymentMode] - Indicates payment mode for a scheme.
+ * @property {string[]} [capabilities] - Indicates whether the scheme possesses
+ *   certain capabilities.
+ * @property {string[]} [schemeIds] - List of scheme ids which need to be
+ *   returned in the response.
+ */
+
 /**
  * @typedef GetOptimalLocationsParam
  * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
@@ -116,6 +147,13 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} packageMaterialId - Unique identifier for a Package. Material
  */
 
+/**
+ * @typedef GetSampleFileServiceabilityStatusParam
+ * @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} [batchId] - Batch id of the execution
+ */
+
 /**
  * @typedef GetServiceabilityParam
  * @property {string} extensionId - Unique Identifier of courier partner extension.
@@ -142,6 +180,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {string} [sector] - Sector value to search zones
  */
 
+/**
+ * @typedef SampleFileServiceabilityParam
+ * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
+ */
+
 /**
  * @typedef UpdateCompanyConfigurationParam
  * @property {ServiceabilityPlatformModel.CompanyConfig} body
@@ -153,6 +196,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
  */
 
+/**
+ * @typedef UpdateCourierPartnerSchemeParam
+ * @property {string} schemeId - Unique Identifier of Scheme
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
+ */
+
 /**
  * @typedef UpdatePackageMaterialRuleParam
  * @property {string} ruleId - A `package_material_rule_id` is a unique
@@ -206,6 +255,13 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
+  /** @returns {CreateCourierPartnerSchemeParam} */
+  static createCourierPartnerScheme() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel().required(),
+    }).required();
+  }
+
   /** @returns {CreatePackageMaterialParam} */
   static createPackageMaterial() {
     return Joi.object({
@@ -271,6 +327,17 @@ class ServiceabilityPlatformValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetCountriesParam} */
+  static getCountries() {
+    return Joi.object({
+      onboarding: Joi.boolean(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      q: Joi.string().allow(""),
+      hierarchy: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetCourierPartnerAccountParam} */
   static getCourierPartnerAccount() {
     return Joi.object({
@@ -289,6 +356,23 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetCourierPartnerSchemeParam} */
+  static getCourierPartnerScheme() {
+    return Joi.object({
+      schemeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCourierPartnerSchemesParam} */
+  static getCourierPartnerSchemes() {
+    return Joi.object({
+      schemeType: Joi.string().allow(""),
+      paymentMode: Joi.string().allow(""),
+      capabilities: Joi.array().items(Joi.string().allow("")),
+      schemeIds: Joi.array().items(Joi.string().allow("")),
+    }).required();
+  }
+
   /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
@@ -330,6 +414,15 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetSampleFileServiceabilityStatusParam} */
+  static getSampleFileServiceabilityStatus() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      batchId: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetServiceabilityParam} */
   static getServiceability() {
     return Joi.object({
@@ -362,6 +455,13 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
+  /** @returns {SampleFileServiceabilityParam} */
+  static sampleFileServiceability() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails().required(),
+    }).required();
+  }
+
   /** @returns {UpdateCompanyConfigurationParam} */
   static updateCompanyConfiguration() {
     return Joi.object({
@@ -377,6 +477,14 @@ class ServiceabilityPlatformValidator {
     }).required();
   }
 
+  /** @returns {UpdateCourierPartnerSchemeParam} */
+  static updateCourierPartnerScheme() {
+    return Joi.object({
+      schemeId: Joi.string().allow("").required(),
+      body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails().required(),
+    }).required();
+  }
+
   /** @returns {UpdatePackageMaterialRuleParam} */
   static updatePackageMaterialRule() {
     return Joi.object({