@gofynd/fdk-client-javascript 3.27.0 → 3.28.0

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -975,6 +975,24 @@ const Joi = require("joi");
  * @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
  */
 
+/**
+ * @typedef OrderMetaUpdate
+ * @property {string} pan_no - Valid Indian PAN (Permanent Account Number).
+ *   Format: 5 letters, 4 digits, 1 letter (e.g. AAAAA9999A). Case-insensitive;
+ *   stored in uppercase.
+ */
+
+/**
+ * @typedef OrderMetaResult
+ * @property {string} [message] - Success message indicating order meta was updated.
+ */
+
+/**
+ * @typedef OrderMetaErrorResult
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {string} [message] - Error message describing the failure.
+ */
+
 /**
  * @typedef AddressDetail
  * @property {Object} [google_map_point] - Google map point of location
@@ -1403,6 +1421,25 @@ const Joi = require("joi");
  * @property {CreditAccountSummary} [account]
  */
 
+/**
+ * @typedef OrderTransactionList
+ * @property {boolean} [success] - Whether the request was successful.
+ * @property {OrderTransactionItem[]} [items] - List of transactions ordered by
+ *   created_on ascending.
+ */
+
+/**
+ * @typedef OrderTransactionItem
+ * @property {string} [transaction_id] - Merchant transaction ID.
+ * @property {string} [payment_mode] - Payment mode name (e.g. UPI, Card, COD).
+ * @property {string} [logo] - Payment mode logo URL. Returns the small logo if
+ *   available, falls back to large logo. Null if no logo is configured.
+ * @property {number} [amount] - Transaction amount.
+ * @property {string} [status] - Latest transaction status (e.g. complete,
+ *   pending, failed, cancelled).
+ * @property {string} [created_on] - Transaction creation timestamp (ISO 8601).
+ */
+
 /**
  * @typedef OperationResponseSchema
  * @property {boolean} success - Indicates if the operation was successful
@@ -2571,6 +2608,28 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {OrderMetaUpdate} */
+  static OrderMetaUpdate() {
+    return Joi.object({
+      pan_no: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {OrderMetaResult} */
+  static OrderMetaResult() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {OrderMetaErrorResult} */
+  static OrderMetaErrorResult() {
+    return Joi.object({
+      success: Joi.boolean(),
+      message: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {AddressDetail} */
   static AddressDetail() {
     return Joi.object({
@@ -3053,6 +3112,26 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {OrderTransactionList} */
+  static OrderTransactionList() {
+    return Joi.object({
+      success: Joi.boolean(),
+      items: Joi.array().items(PaymentPlatformModel.OrderTransactionItem()),
+    });
+  }
+
+  /** @returns {OrderTransactionItem} */
+  static OrderTransactionItem() {
+    return Joi.object({
+      transaction_id: Joi.string().allow(""),
+      payment_mode: Joi.string().allow("").allow(null),
+      logo: Joi.string().allow("").allow(null),
+      amount: Joi.number().allow(null),
+      status: Joi.string().allow("").allow(null),
+      created_on: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {OperationResponseSchema} */
   static OperationResponseSchema() {
     return Joi.object({

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

@@ -517,6 +517,20 @@ declare class Serviceability {
      * @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchApplicationConfiguration/).
      */
     patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
+    /**
+     * @param {ServiceabilityPlatformApplicationValidator.PatchZoneProductsAtomicParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ServiceabilityPlatformModel.ZoneProductsAtomicPatchResult>}
+     *   - Success response
+     *
+     * @name patchZoneProductsAtomic
+     * @summary: Atomically add or remove products on zones (concurrency-safe)
+     * @description: Synchronously adds or removes products on one or more zones. Each item is applied with an atomic MongoDB array operator (`$addToSet` for add, `$pull` for remove) rather than a read-modify-write of the whole product list, so concurrent writes to the same zone never lose each other's changes. `product_type` must match the existing zone's product type. Product ids are not validated against the catalog (this is a synchronous API; callers send already-known ids). Returns a per-item status and a summary; per-item failures (e.g. zone not found, product type mismatch) do not fail the whole request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchZoneProductsAtomic/).
+     */
+    patchZoneProductsAtomic({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchZoneProductsAtomicParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneProductsAtomicPatchResult>;
     /**
      * @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js

@@ -3324,6 +3324,89 @@ class Serviceability {
     return response;
   }
 
+  /**
+   * @param {ServiceabilityPlatformApplicationValidator.PatchZoneProductsAtomicParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ServiceabilityPlatformModel.ZoneProductsAtomicPatchResult>}
+   *   - Success response
+   *
+   * @name patchZoneProductsAtomic
+   * @summary: Atomically add or remove products on zones (concurrency-safe)
+   * @description: Synchronously adds or removes products on one or more zones. Each item is applied with an atomic MongoDB array operator (`$addToSet` for add, `$pull` for remove) rather than a read-modify-write of the whole product list, so concurrent writes to the same zone never lose each other's changes. `product_type` must match the existing zone's product type. Product ids are not validated against the catalog (this is a synchronous API; callers send already-known ids). Returns a per-item status and a summary; per-item failures (e.g. zone not found, product type mismatch) do not fail the whole request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchZoneProductsAtomic/).
+   */
+  async patchZoneProductsAtomic(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ServiceabilityPlatformApplicationValidator.patchZoneProductsAtomic().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ServiceabilityPlatformApplicationValidator.patchZoneProductsAtomic().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Serviceability > patchZoneProductsAtomic \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/logistics/v2.0/company/${this.config.companyId}/application/${this.applicationId}/zones/bulk/products/patch`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ServiceabilityPlatformModel.ZoneProductsAtomicPatchResult().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Serviceability > patchZoneProductsAtomic \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
    *   - Arg object

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

@@ -181,6 +181,10 @@ export = ServiceabilityPlatformApplicationValidator;
  * @typedef PatchApplicationConfigurationParam
  * @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
  */
+/**
+ * @typedef PatchZoneProductsAtomicParam
+ * @property {ServiceabilityPlatformModel.ZoneProductsAtomicPatchDetails} body
+ */
 /**
  * @typedef PutFulfillmentOptionParam
  * @property {string} slug - Slug of the fulfillment option for retrieving details.
@@ -336,6 +340,8 @@ declare class ServiceabilityPlatformApplicationValidator {
     static insertApplicationConfig(): InsertApplicationConfigParam;
     /** @returns {PatchApplicationConfigurationParam} */
     static patchApplicationConfiguration(): PatchApplicationConfigurationParam;
+    /** @returns {PatchZoneProductsAtomicParam} */
+    static patchZoneProductsAtomic(): PatchZoneProductsAtomicParam;
     /** @returns {PutFulfillmentOptionParam} */
     static putFulfillmentOption(): PutFulfillmentOptionParam;
     /** @returns {UpdateBulkGeoAreaParam} */
@@ -370,7 +376,7 @@ declare class ServiceabilityPlatformApplicationValidator {
     static validateBulkFulfillmentOptions(): ValidateBulkFulfillmentOptionsParam;
 }
 declare namespace ServiceabilityPlatformApplicationValidator {
-    export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreatePolygonParam, CreateShipmentsParam, CreateStoreRulesParam, CreateZoneParam, CreateZoneProductsBulkPatchJobParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, DownloadZoneProductsBulkSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationCourierPartnersListParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetPolygonParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZoneProductsBulkPatchJobStatusParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdatePolygonParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
+    export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreatePolygonParam, CreateShipmentsParam, CreateStoreRulesParam, CreateZoneParam, CreateZoneProductsBulkPatchJobParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, DownloadZoneProductsBulkSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationCourierPartnersListParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetPolygonParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZoneProductsBulkPatchJobStatusParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PatchZoneProductsAtomicParam, PutFulfillmentOptionParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdatePolygonParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
 }
 type CreateBulkExportParam = {
     body: ServiceabilityPlatformModel.BulkCreateZoneExport;
@@ -674,6 +680,9 @@ type InsertApplicationConfigParam = {
 type PatchApplicationConfigurationParam = {
     body: ServiceabilityPlatformModel.ApplicationConfigPatch;
 };
+type PatchZoneProductsAtomicParam = {
+    body: ServiceabilityPlatformModel.ZoneProductsAtomicPatchDetails;
+};
 type PutFulfillmentOptionParam = {
     /**
      * - Slug of the fulfillment option for retrieving details.

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -223,6 +223,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  * @property {ServiceabilityPlatformModel.ApplicationConfigPatch} body
  */
 
+/**
+ * @typedef PatchZoneProductsAtomicParam
+ * @property {ServiceabilityPlatformModel.ZoneProductsAtomicPatchDetails} body
+ */
+
 /**
  * @typedef PutFulfillmentOptionParam
  * @property {string} slug - Slug of the fulfillment option for retrieving details.
@@ -614,6 +619,13 @@ class ServiceabilityPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {PatchZoneProductsAtomicParam} */
+  static patchZoneProductsAtomic() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.ZoneProductsAtomicPatchDetails().required(),
+    }).required();
+  }
+
   /** @returns {PutFulfillmentOptionParam} */
   static putFulfillmentOption() {
     return Joi.object({

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

@@ -1269,6 +1269,39 @@ export = ServiceabilityPlatformModel;
  * @property {string} [result_file_url] - URL to the result file after
  *   processing is complete.
  */
+/**
+ * @typedef ZoneProductsAtomicPatchItem
+ * @property {string} zone_id - The unique identifier of the zone to patch.
+ * @property {string} product_type - The type the zone's product list is made
+ *   of. Must match the existing zone product type. Product ids are not
+ *   validated against the catalog for any type.
+ * @property {Object[]} values - Product identifiers to add or remove - uids for
+ *   item_id/product/department/category (integers) or tag strings.
+ * @property {string} action - Whether to add the values to, or remove them
+ *   from, the zone product list.
+ */
+/**
+ * @typedef ZoneProductsAtomicPatchDetails
+ * @property {ZoneProductsAtomicPatchItem[]} items - List of per-zone product
+ *   patch operations.
+ */
+/**
+ * @typedef ZoneProductsAtomicPatchResultItem
+ * @property {string} zone_id
+ * @property {string} product_type - The type the zone's product list is made
+ *   of. Mirrors the product_type sent in the patch request.
+ * @property {string} action
+ * @property {string} status
+ * @property {number} [values_count] - Number of products in the zone's product
+ *   list after a successful patch.
+ * @property {ZoneProductsAtomicPatchItemError[]} [error] - Present when status
+ *   is `failed`.
+ */
+/**
+ * @typedef ZoneProductsAtomicPatchResult
+ * @property {ZoneProductsAtomicPatchResultItem[]} items
+ * @property {ZoneProductsAtomicPatchSummary} summary
+ */
 /**
  * @typedef CourierPartnerToServiceability
  * @property {ServiceabilityLocation} [location]
@@ -2897,10 +2930,22 @@ export = ServiceabilityPlatformModel;
  * @property {boolean} has_next - Indicates whether more pages are available.
  * @property {number} total_records - Total number of records matching the criteria.
  */
+/**
+ * @typedef ZoneProductsAtomicPatchItemError
+ * @property {string} [type]
+ * @property {string} [value]
+ * @property {string} [message]
+ */
+/**
+ * @typedef ZoneProductsAtomicPatchSummary
+ * @property {number} total
+ * @property {number} success
+ * @property {number} failed
+ */
 declare class ServiceabilityPlatformModel {
 }
 declare namespace ServiceabilityPlatformModel {
-    export { GenerateShipmentsAndCourierPartnerResult, CourierPartnerDetails, PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, 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, StorePolygonServiceabilityRequestBody, StorePolygonServiceabilityResult, StorePolygonServiceabilityGetResult, ZoneProductsBulkPatchDetails, GetZoneProductsBulkPatchResult, CourierPartnerToServiceability, ServiceabilityLocation, CourierPartnerShipments, PromiseObject, PromiseData, PromiseMeta, CourierPartnerPromiseData, DeliveryTat, DeliveryTatSchema, CourierPartnerShipmentsMeta, ShipmentCourierPartnersResult, AreaCode, TAT, LocationDetailsServiceability, CourierPartnerShipmentsArticles, CourierPartnerArticlesPromise, CourierPartnerArticlesReturnReasons, CourierPartnerArticlesReturnReasonsMeta, ArticleWeight, ArticleAttributes, ArticleDimension, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, FulfillmentOptionDefaultFor, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, LatLong, StoreDistance, StoreTimingDetails, StoreTiming, Time, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, FoDetails, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, 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, StorePolygonServiceabilityRequestData, StorePolygonServiceabilityStore, StorePolygonServiceabilityStoreCoordinates, StorePolygonServiceabilityConfig, StorePolygonServiceabilityPolygon, StorePolygonServiceabilityFeature, StorePolygonServiceabilityGeometry, StorePolygonServiceabilityAttributes, StorePolygonServiceabilityReferenceCoordinates, StorePolygonServiceabilityStoreSummary, StorePolygonServiceabilityError, StorePolygonServiceabilityPagination };
+    export { GenerateShipmentsAndCourierPartnerResult, CourierPartnerDetails, PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, 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, StorePolygonServiceabilityRequestBody, StorePolygonServiceabilityResult, StorePolygonServiceabilityGetResult, ZoneProductsBulkPatchDetails, GetZoneProductsBulkPatchResult, ZoneProductsAtomicPatchItem, ZoneProductsAtomicPatchDetails, ZoneProductsAtomicPatchResultItem, ZoneProductsAtomicPatchResult, CourierPartnerToServiceability, ServiceabilityLocation, CourierPartnerShipments, PromiseObject, PromiseData, PromiseMeta, CourierPartnerPromiseData, DeliveryTat, DeliveryTatSchema, CourierPartnerShipmentsMeta, ShipmentCourierPartnersResult, AreaCode, TAT, LocationDetailsServiceability, CourierPartnerShipmentsArticles, CourierPartnerArticlesPromise, CourierPartnerArticlesReturnReasons, CourierPartnerArticlesReturnReasonsMeta, ArticleWeight, ArticleAttributes, ArticleDimension, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, FulfillmentOptionDefaultFor, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, LatLong, StoreDistance, StoreTimingDetails, StoreTiming, Time, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, FoDetails, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, 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, StorePolygonServiceabilityRequestData, StorePolygonServiceabilityStore, StorePolygonServiceabilityStoreCoordinates, StorePolygonServiceabilityConfig, StorePolygonServiceabilityPolygon, StorePolygonServiceabilityFeature, StorePolygonServiceabilityGeometry, StorePolygonServiceabilityAttributes, StorePolygonServiceabilityReferenceCoordinates, StorePolygonServiceabilityStoreSummary, StorePolygonServiceabilityError, StorePolygonServiceabilityPagination, ZoneProductsAtomicPatchItemError, ZoneProductsAtomicPatchSummary };
 }
 /** @returns {GenerateShipmentsAndCourierPartnerResult} */
 declare function GenerateShipmentsAndCourierPartnerResult(): GenerateShipmentsAndCourierPartnerResult;
@@ -6043,6 +6088,67 @@ type GetZoneProductsBulkPatchResult = {
      */
     result_file_url?: string;
 };
+/** @returns {ZoneProductsAtomicPatchItem} */
+declare function ZoneProductsAtomicPatchItem(): ZoneProductsAtomicPatchItem;
+type ZoneProductsAtomicPatchItem = {
+    /**
+     * - The unique identifier of the zone to patch.
+     */
+    zone_id: string;
+    /**
+     * - The type the zone's product list is made
+     * of. Must match the existing zone product type. Product ids are not
+     * validated against the catalog for any type.
+     */
+    product_type: string;
+    /**
+     * - Product identifiers to add or remove - uids for
+     * item_id/product/department/category (integers) or tag strings.
+     */
+    values: any[];
+    /**
+     * - Whether to add the values to, or remove them
+     * from, the zone product list.
+     */
+    action: string;
+};
+/** @returns {ZoneProductsAtomicPatchDetails} */
+declare function ZoneProductsAtomicPatchDetails(): ZoneProductsAtomicPatchDetails;
+type ZoneProductsAtomicPatchDetails = {
+    /**
+     * - List of per-zone product
+     * patch operations.
+     */
+    items: ZoneProductsAtomicPatchItem[];
+};
+/** @returns {ZoneProductsAtomicPatchResultItem} */
+declare function ZoneProductsAtomicPatchResultItem(): ZoneProductsAtomicPatchResultItem;
+type ZoneProductsAtomicPatchResultItem = {
+    zone_id: string;
+    /**
+     * - The type the zone's product list is made
+     * of. Mirrors the product_type sent in the patch request.
+     */
+    product_type: string;
+    action: string;
+    status: string;
+    /**
+     * - Number of products in the zone's product
+     * list after a successful patch.
+     */
+    values_count?: number;
+    /**
+     * - Present when status
+     * is `failed`.
+     */
+    error?: ZoneProductsAtomicPatchItemError[];
+};
+/** @returns {ZoneProductsAtomicPatchResult} */
+declare function ZoneProductsAtomicPatchResult(): ZoneProductsAtomicPatchResult;
+type ZoneProductsAtomicPatchResult = {
+    items: ZoneProductsAtomicPatchResultItem[];
+    summary: ZoneProductsAtomicPatchSummary;
+};
 /** @returns {CourierPartnerToServiceability} */
 declare function CourierPartnerToServiceability(): CourierPartnerToServiceability;
 type CourierPartnerToServiceability = {
@@ -10080,3 +10186,17 @@ type StorePolygonServiceabilityPagination = {
      */
     total_records: number;
 };
+/** @returns {ZoneProductsAtomicPatchItemError} */
+declare function ZoneProductsAtomicPatchItemError(): ZoneProductsAtomicPatchItemError;
+type ZoneProductsAtomicPatchItemError = {
+    type?: string;
+    value?: string;
+    message?: string;
+};
+/** @returns {ZoneProductsAtomicPatchSummary} */
+declare function ZoneProductsAtomicPatchSummary(): ZoneProductsAtomicPatchSummary;
+type ZoneProductsAtomicPatchSummary = {
+    total: number;
+    success: number;
+    failed: number;
+};

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -1389,6 +1389,43 @@ const Joi = require("joi");
  *   processing is complete.
  */
 
+/**
+ * @typedef ZoneProductsAtomicPatchItem
+ * @property {string} zone_id - The unique identifier of the zone to patch.
+ * @property {string} product_type - The type the zone's product list is made
+ *   of. Must match the existing zone product type. Product ids are not
+ *   validated against the catalog for any type.
+ * @property {Object[]} values - Product identifiers to add or remove - uids for
+ *   item_id/product/department/category (integers) or tag strings.
+ * @property {string} action - Whether to add the values to, or remove them
+ *   from, the zone product list.
+ */
+
+/**
+ * @typedef ZoneProductsAtomicPatchDetails
+ * @property {ZoneProductsAtomicPatchItem[]} items - List of per-zone product
+ *   patch operations.
+ */
+
+/**
+ * @typedef ZoneProductsAtomicPatchResultItem
+ * @property {string} zone_id
+ * @property {string} product_type - The type the zone's product list is made
+ *   of. Mirrors the product_type sent in the patch request.
+ * @property {string} action
+ * @property {string} status
+ * @property {number} [values_count] - Number of products in the zone's product
+ *   list after a successful patch.
+ * @property {ZoneProductsAtomicPatchItemError[]} [error] - Present when status
+ *   is `failed`.
+ */
+
+/**
+ * @typedef ZoneProductsAtomicPatchResult
+ * @property {ZoneProductsAtomicPatchResultItem[]} items
+ * @property {ZoneProductsAtomicPatchSummary} summary
+ */
+
 /**
  * @typedef CourierPartnerToServiceability
  * @property {ServiceabilityLocation} [location]
@@ -3194,6 +3231,20 @@ const Joi = require("joi");
  * @property {number} total_records - Total number of records matching the criteria.
  */
 
+/**
+ * @typedef ZoneProductsAtomicPatchItemError
+ * @property {string} [type]
+ * @property {string} [value]
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef ZoneProductsAtomicPatchSummary
+ * @property {number} total
+ * @property {number} success
+ * @property {number} failed
+ */
+
 class ServiceabilityPlatformModel {
   /** @returns {GenerateShipmentsAndCourierPartnerResult} */
   static GenerateShipmentsAndCourierPartnerResult() {
@@ -4689,6 +4740,49 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {ZoneProductsAtomicPatchItem} */
+  static ZoneProductsAtomicPatchItem() {
+    return Joi.object({
+      zone_id: Joi.string().allow("").required(),
+      product_type: Joi.string().allow("").required(),
+      values: Joi.array().items(Joi.any()).required(),
+      action: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {ZoneProductsAtomicPatchDetails} */
+  static ZoneProductsAtomicPatchDetails() {
+    return Joi.object({
+      items: Joi.array()
+        .items(ServiceabilityPlatformModel.ZoneProductsAtomicPatchItem())
+        .required(),
+    });
+  }
+
+  /** @returns {ZoneProductsAtomicPatchResultItem} */
+  static ZoneProductsAtomicPatchResultItem() {
+    return Joi.object({
+      zone_id: Joi.string().allow("").required(),
+      product_type: Joi.string().allow("").required(),
+      action: Joi.string().allow("").required(),
+      status: Joi.string().allow("").required(),
+      values_count: Joi.number(),
+      error: Joi.array()
+        .items(ServiceabilityPlatformModel.ZoneProductsAtomicPatchItemError())
+        .allow(null, ""),
+    });
+  }
+
+  /** @returns {ZoneProductsAtomicPatchResult} */
+  static ZoneProductsAtomicPatchResult() {
+    return Joi.object({
+      items: Joi.array()
+        .items(ServiceabilityPlatformModel.ZoneProductsAtomicPatchResultItem())
+        .required(),
+      summary: ServiceabilityPlatformModel.ZoneProductsAtomicPatchSummary().required(),
+    });
+  }
+
   /** @returns {CourierPartnerToServiceability} */
   static CourierPartnerToServiceability() {
     return Joi.object({
@@ -6670,5 +6764,23 @@ class ServiceabilityPlatformModel {
       total_records: Joi.number().required(),
     });
   }
+
+  /** @returns {ZoneProductsAtomicPatchItemError} */
+  static ZoneProductsAtomicPatchItemError() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ZoneProductsAtomicPatchSummary} */
+  static ZoneProductsAtomicPatchSummary() {
+    return Joi.object({
+      total: Joi.number().required(),
+      success: Joi.number().required(),
+      failed: Joi.number().required(),
+    });
+  }
 }
 module.exports = ServiceabilityPlatformModel;