@gofynd/fdk-client-javascript 3.4.4 → 3.6.0

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

@@ -15,6 +15,10 @@ export = ServiceabilityPlatformModel;
  * @property {CourierPartnerSchemes} [cp_schemes]
  * @property {string} [id] - Unique identifier for the fulfillment option.
  */
+/**
+ * @typedef FulfillmentOptionsList
+ * @property {FulfillmentOptionItem[]} [items] - List of fulfillment option items.
+ */
 /**
  * @typedef FulfillmentOptionProducts
  * @property {FulfillmentOptionProduct} [items]
@@ -726,7 +730,6 @@ export = ServiceabilityPlatformModel;
  * @property {number} [company_id] - The unique identifier for the company.
  * @property {string} name - The name of the package material.
  * @property {string} [id] - Unique identifier for the package material.
- * @property {number} [item_id] - Unique identifier for the item.
  * @property {number} width - The width of the package material.
  * @property {number} height - The height of the package material.
  * @property {number} length - The length of the package material.
@@ -801,7 +804,6 @@ export = ServiceabilityPlatformModel;
  * @property {boolean} [is_active] - Indicates if the package item is active.
  * @property {string} [size] - The size of the package item.
  * @property {number} [company_id] - The company ID associated with the package item.
- * @property {number} [item_id] - The unique identifier for the package item.
  * @property {number} [max_weight] - The maximum weight(grams) of the package item.
  * @property {Object[]} [media] - Additional media associated with the package item.
  * @property {number} [package_vol_weight] - The volumetric weight(grams) of the
@@ -1192,6 +1194,15 @@ export = ServiceabilityPlatformModel;
  * @property {string} [scheme_id] - Unique identifier for the courier partner scheme.
  * @property {string} [cp_ext_id] - Unique identifier for the courier partner.
  */
+/**
+ * @typedef FulfillmentOptionItem
+ * @property {string} [slug] - Unique identifier for the delivery type.
+ * @property {string} [description] - Description of the delivery service.
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
+ * @property {string} [id] - Unique ID of the delivery service.
+ * @property {string} [type] - Type of fulfillment option.
+ * @property {string} [name] - Name of the delivery service.
+ */
 /**
  * @typedef FulfillmentOptionProduct
  * @property {number} [uid] - Unique identifier for the product.
@@ -2281,7 +2292,7 @@ export = ServiceabilityPlatformModel;
 declare class ServiceabilityPlatformModel {
 }
 declare namespace ServiceabilityPlatformModel {
-    export { FulfillmentOption, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
+    export { FulfillmentOption, FulfillmentOptionsList, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionItem, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
 }
 /** @returns {FulfillmentOption} */
 declare function FulfillmentOption(): FulfillmentOption;
@@ -2327,6 +2338,14 @@ type FulfillmentOption = {
      */
     id?: string;
 };
+/** @returns {FulfillmentOptionsList} */
+declare function FulfillmentOptionsList(): FulfillmentOptionsList;
+type FulfillmentOptionsList = {
+    /**
+     * - List of fulfillment option items.
+     */
+    items?: FulfillmentOptionItem[];
+};
 /** @returns {FulfillmentOptionProducts} */
 declare function FulfillmentOptionProducts(): FulfillmentOptionProducts;
 type FulfillmentOptionProducts = {
@@ -4130,10 +4149,6 @@ type PackageMaterialResult = {
      * - Unique identifier for the package material.
      */
     id?: string;
-    /**
-     * - Unique identifier for the item.
-     */
-    item_id?: number;
     /**
      * - The width of the package material.
      */
@@ -4332,10 +4347,6 @@ type PackageItem = {
      * - The company ID associated with the package item.
      */
     company_id?: number;
-    /**
-     * - The unique identifier for the package item.
-     */
-    item_id?: number;
     /**
      * - The maximum weight(grams) of the package item.
      */
@@ -5230,6 +5241,34 @@ type CourierPartnerScheme = {
      */
     cp_ext_id?: string;
 };
+/** @returns {FulfillmentOptionItem} */
+declare function FulfillmentOptionItem(): FulfillmentOptionItem;
+type FulfillmentOptionItem = {
+    /**
+     * - Unique identifier for the delivery type.
+     */
+    slug?: string;
+    /**
+     * - Description of the delivery service.
+     */
+    description?: string;
+    /**
+     * - Indicates if this is the default delivery option.
+     */
+    is_default?: boolean;
+    /**
+     * - Unique ID of the delivery service.
+     */
+    id?: string;
+    /**
+     * - Type of fulfillment option.
+     */
+    type?: string;
+    /**
+     * - Name of the delivery service.
+     */
+    name?: string;
+};
 /** @returns {FulfillmentOptionProduct} */
 declare function FulfillmentOptionProduct(): FulfillmentOptionProduct;
 type FulfillmentOptionProduct = {

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -17,6 +17,11 @@ const Joi = require("joi");
  * @property {string} [id] - Unique identifier for the fulfillment option.
  */
 
+/**
+ * @typedef FulfillmentOptionsList
+ * @property {FulfillmentOptionItem[]} [items] - List of fulfillment option items.
+ */
+
 /**
  * @typedef FulfillmentOptionProducts
  * @property {FulfillmentOptionProduct} [items]
@@ -799,7 +804,6 @@ const Joi = require("joi");
  * @property {number} [company_id] - The unique identifier for the company.
  * @property {string} name - The name of the package material.
  * @property {string} [id] - Unique identifier for the package material.
- * @property {number} [item_id] - Unique identifier for the item.
  * @property {number} width - The width of the package material.
  * @property {number} height - The height of the package material.
  * @property {number} length - The length of the package material.
@@ -878,7 +882,6 @@ const Joi = require("joi");
  * @property {boolean} [is_active] - Indicates if the package item is active.
  * @property {string} [size] - The size of the package item.
  * @property {number} [company_id] - The company ID associated with the package item.
- * @property {number} [item_id] - The unique identifier for the package item.
  * @property {number} [max_weight] - The maximum weight(grams) of the package item.
  * @property {Object[]} [media] - Additional media associated with the package item.
  * @property {number} [package_vol_weight] - The volumetric weight(grams) of the
@@ -1306,6 +1309,16 @@ const Joi = require("joi");
  * @property {string} [cp_ext_id] - Unique identifier for the courier partner.
  */
 
+/**
+ * @typedef FulfillmentOptionItem
+ * @property {string} [slug] - Unique identifier for the delivery type.
+ * @property {string} [description] - Description of the delivery service.
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
+ * @property {string} [id] - Unique ID of the delivery service.
+ * @property {string} [type] - Type of fulfillment option.
+ * @property {string} [name] - Name of the delivery service.
+ */
+
 /**
  * @typedef FulfillmentOptionProduct
  * @property {number} [uid] - Unique identifier for the product.
@@ -2535,6 +2548,15 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {FulfillmentOptionsList} */
+  static FulfillmentOptionsList() {
+    return Joi.object({
+      items: Joi.array().items(
+        ServiceabilityPlatformModel.FulfillmentOptionItem()
+      ),
+    });
+  }
+
   /** @returns {FulfillmentOptionProducts} */
   static FulfillmentOptionProducts() {
     return Joi.object({
@@ -3401,7 +3423,6 @@ class ServiceabilityPlatformModel {
       company_id: Joi.number(),
       name: Joi.string().allow("").required(),
       id: Joi.string().allow(""),
-      item_id: Joi.number(),
       width: Joi.number().required(),
       height: Joi.number().required(),
       length: Joi.number().required(),
@@ -3481,7 +3502,6 @@ class ServiceabilityPlatformModel {
       is_active: Joi.boolean(),
       size: Joi.string().allow(""),
       company_id: Joi.number(),
-      item_id: Joi.number(),
       max_weight: Joi.number(),
       media: Joi.array().items(Joi.any()),
       package_vol_weight: Joi.number(),
@@ -3910,6 +3930,18 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {FulfillmentOptionItem} */
+  static FulfillmentOptionItem() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      is_default: Joi.boolean(),
+      id: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {FulfillmentOptionProduct} */
   static FulfillmentOptionProduct() {
     return Joi.object({

package/sdk/public/PublicAPIClient.d.ts

@@ -11,7 +11,7 @@ declare class PublicAPIClient {
      * @param {object} query
      * @param {object} body
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): Promise<import("axios").AxiosResponse<any, any>>;
+    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
 }
 declare namespace PublicAPIClient {
     export { Options };