@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-beta.3

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -223,6 +223,7 @@ export = OrderPlatformModel;
  * @property {boolean} [lock_after_transition] - Lock Shipment After Transition
  * @property {boolean} [unlock_before_transition] - Unlock Shipment After Transition
  * @property {boolean} [task] - To Run Status Update as a background Task
+ * @property {boolean} [resume_tasks_after_unlock] - Resume Tasks After Unlock
  */
 /**
  * @typedef ShipmentsResponse
@@ -646,20 +647,23 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef Charge
- * @property {string} name
- * @property {Object} amount
+ * @property {string} name - The name of the charge.
+ * @property {Object} amount - The monetary value of the charge, including value
+ *   and currency details.
  * @property {Tax} [tax]
- * @property {string} [code]
- * @property {string} type
+ * @property {string} [code] - An optional code associated with the charge for
+ *   internal tracking.
+ * @property {string} type - The category or type of the charge.
  */
 /**
  * @typedef LineItem
  * @property {Charge[]} [charges]
- * @property {Object} [meta]
- * @property {string} [custom_message]
- * @property {number} [quantity]
- * @property {string} seller_identifier
- * @property {string} [external_line_id]
+ * @property {Object} [meta] - Meta data of the articles or line items.
+ * @property {string} [custom_message] - Meta data of the articles or line items.
+ * @property {number} [quantity] - Quantity of the articles or line items.
+ * @property {string} seller_identifier - Seller identifier of the articles or line items.
+ * @property {string} [external_line_id] - External unique identifier of the
+ *   articles or line items.
  */
 /**
  * @typedef ProcessingDates
@@ -673,12 +677,16 @@ export = OrderPlatformModel;
 /**
  * @typedef Shipment
  * @property {LineItem[]} line_items
- * @property {string} [external_shipment_id]
+ * @property {string} [external_shipment_id] - External shipment identifier or
+ *   marketplace's unique shipment identifier.
  * @property {ProcessingDates} [processing_dates]
- * @property {Object} [meta]
- * @property {number} [priority]
- * @property {number} location_id
- * @property {string} [order_type]
+ * @property {Object} [meta] - Meta data of the shipment.
+ * @property {number} [priority] - Integer value indicating high and low priority.
+ * @property {number} location_id - Location Identifier or Store/Fulfillment
+ *   Identifier of the shipment.
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
+ *   If the customer wants the order home-delivered PickAtStore - If the
+ *   customer wants the handover of an order at the store itself.
  * @property {string} [parent_type]
  * @property {string} [store_invoice_id]
  * @property {string} [lock_status]
@@ -707,6 +715,16 @@ export = OrderPlatformModel;
  * @property {Prices} [price]
  * @property {ShipmentGstDetails} [gst]
  */
+/**
+ * @typedef ShipmentRequestData
+ * @property {LineItem[]} line_items
+ * @property {ProcessingDates} [processing_dates]
+ * @property {Object} [meta] - Meta data of the shipment.
+ * @property {number} [priority] - Integer value indicating high and low priority.
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
+ *   If the customer wants the order home-delivered PickAtStore - If the
+ *   customer wants the handover of an order at the store itself.
+ */
 /**
  * @typedef ShippingInfo
  * @property {string} [alternate_mobile_number]
@@ -801,6 +819,7 @@ export = OrderPlatformModel;
 /**
  * @typedef CreateOrderAPI
  * @property {Shipment[]} shipments
+ * @property {ShipmentRequestData} [shipment_request_data]
  * @property {ShippingInfo} shipping_info
  * @property {BillingInfo} billing_info
  * @property {Object} [currency_info]
@@ -1901,6 +1920,9 @@ export = OrderPlatformModel;
  * @property {string} [shipment_created_ts]
  * @property {Currency} [currency]
  * @property {CurrencyInfo} [currency_info]
+ * @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
+ *   LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
+ *   else false.
  */
 /**
  * @typedef ShipmentInternalPlatformViewResponse
@@ -2345,6 +2367,9 @@ export = OrderPlatformModel;
  * @property {string} [credit_note_id]
  * @property {boolean} [is_self_ship]
  * @property {string} [mode_of_payment]
+ * @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
+ *   LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
+ *   else false.
  */
 /**
  * @typedef ShipmentInfoResponse
@@ -2868,7 +2893,7 @@ export = OrderPlatformModel;
 declare class OrderPlatformModel {
 }
 declare namespace OrderPlatformModel {
-    export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Attributes, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
+    export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShipmentRequestData, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Attributes, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
 }
 /** @returns {InvalidateShipmentCachePayload} */
 declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -3267,6 +3292,10 @@ type UpdateShipmentStatusRequest = {
      * - To Run Status Update as a background Task
      */
     task?: boolean;
+    /**
+     * - Resume Tasks After Unlock
+     */
+    resume_tasks_after_unlock?: boolean;
 };
 /** @returns {ShipmentsResponse} */
 declare function ShipmentsResponse(): ShipmentsResponse;
@@ -3820,20 +3849,50 @@ type Tax = {
 /** @returns {Charge} */
 declare function Charge(): Charge;
 type Charge = {
+    /**
+     * - The name of the charge.
+     */
     name: string;
+    /**
+     * - The monetary value of the charge, including value
+     * and currency details.
+     */
     amount: any;
     tax?: Tax;
+    /**
+     * - An optional code associated with the charge for
+     * internal tracking.
+     */
     code?: string;
+    /**
+     * - The category or type of the charge.
+     */
     type: string;
 };
 /** @returns {LineItem} */
 declare function LineItem(): LineItem;
 type LineItem = {
     charges?: Charge[];
+    /**
+     * - Meta data of the articles or line items.
+     */
     meta?: any;
+    /**
+     * - Meta data of the articles or line items.
+     */
     custom_message?: string;
+    /**
+     * - Quantity of the articles or line items.
+     */
     quantity?: number;
+    /**
+     * - Seller identifier of the articles or line items.
+     */
     seller_identifier: string;
+    /**
+     * - External unique identifier of the
+     * articles or line items.
+     */
     external_line_id?: string;
 };
 /** @returns {ProcessingDates} */
@@ -3850,11 +3909,30 @@ type ProcessingDates = {
 declare function Shipment(): Shipment;
 type Shipment = {
     line_items: LineItem[];
+    /**
+     * - External shipment identifier or
+     * marketplace's unique shipment identifier.
+     */
     external_shipment_id?: string;
     processing_dates?: ProcessingDates;
+    /**
+     * - Meta data of the shipment.
+     */
     meta?: any;
+    /**
+     * - Integer value indicating high and low priority.
+     */
     priority?: number;
+    /**
+     * - Location Identifier or Store/Fulfillment
+     * Identifier of the shipment.
+     */
     location_id: number;
+    /**
+     * - The order type of shipment HomeDelivery -
+     * If the customer wants the order home-delivered PickAtStore - If the
+     * customer wants the handover of an order at the store itself.
+     */
     order_type?: string;
     parent_type?: string;
     store_invoice_id?: string;
@@ -3884,6 +3962,26 @@ type Shipment = {
     price?: Prices;
     gst?: ShipmentGstDetails;
 };
+/** @returns {ShipmentRequestData} */
+declare function ShipmentRequestData(): ShipmentRequestData;
+type ShipmentRequestData = {
+    line_items: LineItem[];
+    processing_dates?: ProcessingDates;
+    /**
+     * - Meta data of the shipment.
+     */
+    meta?: any;
+    /**
+     * - Integer value indicating high and low priority.
+     */
+    priority?: number;
+    /**
+     * - The order type of shipment HomeDelivery -
+     * If the customer wants the order home-delivered PickAtStore - If the
+     * customer wants the handover of an order at the store itself.
+     */
+    order_type?: string;
+};
 /** @returns {ShippingInfo} */
 declare function ShippingInfo(): ShippingInfo;
 type ShippingInfo = {
@@ -3991,6 +4089,7 @@ type PaymentInfo = {
 declare function CreateOrderAPI(): CreateOrderAPI;
 type CreateOrderAPI = {
     shipments: Shipment[];
+    shipment_request_data?: ShipmentRequestData;
     shipping_info: ShippingInfo;
     billing_info: BillingInfo;
     currency_info?: any;
@@ -5371,6 +5470,12 @@ type ShipmentItem = {
     shipment_created_ts?: string;
     currency?: Currency;
     currency_info?: CurrencyInfo;
+    /**
+     * - Flag to show NDR actions based on
+     * LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
+     * else false.
+     */
+    is_lapa_enabled?: boolean;
 };
 /** @returns {ShipmentInternalPlatformViewResponse} */
 declare function ShipmentInternalPlatformViewResponse(): ShipmentInternalPlatformViewResponse;
@@ -5851,6 +5956,12 @@ type PlatformShipment = {
     credit_note_id?: string;
     is_self_ship?: boolean;
     mode_of_payment?: string;
+    /**
+     * - Flag to show NDR actions based on
+     * LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
+     * else false.
+     */
+    is_lapa_enabled?: boolean;
 };
 /** @returns {ShipmentInfoResponse} */
 declare function ShipmentInfoResponse(): ShipmentInfoResponse;

package/sdk/platform/Order/OrderPlatformModel.js

@@ -255,6 +255,7 @@ const Joi = require("joi");
  * @property {boolean} [lock_after_transition] - Lock Shipment After Transition
  * @property {boolean} [unlock_before_transition] - Unlock Shipment After Transition
  * @property {boolean} [task] - To Run Status Update as a background Task
+ * @property {boolean} [resume_tasks_after_unlock] - Resume Tasks After Unlock
  */
 
 /**
@@ -730,21 +731,24 @@ const Joi = require("joi");
 
 /**
  * @typedef Charge
- * @property {string} name
- * @property {Object} amount
+ * @property {string} name - The name of the charge.
+ * @property {Object} amount - The monetary value of the charge, including value
+ *   and currency details.
  * @property {Tax} [tax]
- * @property {string} [code]
- * @property {string} type
+ * @property {string} [code] - An optional code associated with the charge for
+ *   internal tracking.
+ * @property {string} type - The category or type of the charge.
  */
 
 /**
  * @typedef LineItem
  * @property {Charge[]} [charges]
- * @property {Object} [meta]
- * @property {string} [custom_message]
- * @property {number} [quantity]
- * @property {string} seller_identifier
- * @property {string} [external_line_id]
+ * @property {Object} [meta] - Meta data of the articles or line items.
+ * @property {string} [custom_message] - Meta data of the articles or line items.
+ * @property {number} [quantity] - Quantity of the articles or line items.
+ * @property {string} seller_identifier - Seller identifier of the articles or line items.
+ * @property {string} [external_line_id] - External unique identifier of the
+ *   articles or line items.
  */
 
 /**
@@ -760,12 +764,16 @@ const Joi = require("joi");
 /**
  * @typedef Shipment
  * @property {LineItem[]} line_items
- * @property {string} [external_shipment_id]
+ * @property {string} [external_shipment_id] - External shipment identifier or
+ *   marketplace's unique shipment identifier.
  * @property {ProcessingDates} [processing_dates]
- * @property {Object} [meta]
- * @property {number} [priority]
- * @property {number} location_id
- * @property {string} [order_type]
+ * @property {Object} [meta] - Meta data of the shipment.
+ * @property {number} [priority] - Integer value indicating high and low priority.
+ * @property {number} location_id - Location Identifier or Store/Fulfillment
+ *   Identifier of the shipment.
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
+ *   If the customer wants the order home-delivered PickAtStore - If the
+ *   customer wants the handover of an order at the store itself.
  * @property {string} [parent_type]
  * @property {string} [store_invoice_id]
  * @property {string} [lock_status]
@@ -795,6 +803,17 @@ const Joi = require("joi");
  * @property {ShipmentGstDetails} [gst]
  */
 
+/**
+ * @typedef ShipmentRequestData
+ * @property {LineItem[]} line_items
+ * @property {ProcessingDates} [processing_dates]
+ * @property {Object} [meta] - Meta data of the shipment.
+ * @property {number} [priority] - Integer value indicating high and low priority.
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
+ *   If the customer wants the order home-delivered PickAtStore - If the
+ *   customer wants the handover of an order at the store itself.
+ */
+
 /**
  * @typedef ShippingInfo
  * @property {string} [alternate_mobile_number]
@@ -895,6 +914,7 @@ const Joi = require("joi");
 /**
  * @typedef CreateOrderAPI
  * @property {Shipment[]} shipments
+ * @property {ShipmentRequestData} [shipment_request_data]
  * @property {ShippingInfo} shipping_info
  * @property {BillingInfo} billing_info
  * @property {Object} [currency_info]
@@ -2122,6 +2142,9 @@ const Joi = require("joi");
  * @property {string} [shipment_created_ts]
  * @property {Currency} [currency]
  * @property {CurrencyInfo} [currency_info]
+ * @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
+ *   LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
+ *   else false.
  */
 
 /**
@@ -2602,6 +2625,9 @@ const Joi = require("joi");
  * @property {string} [credit_note_id]
  * @property {boolean} [is_self_ship]
  * @property {string} [mode_of_payment]
+ * @property {boolean} [is_lapa_enabled] - Flag to show NDR actions based on
+ *   LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true,
+ *   else false.
  */
 
 /**
@@ -3488,6 +3514,7 @@ class OrderPlatformModel {
       lock_after_transition: Joi.boolean(),
       unlock_before_transition: Joi.boolean(),
       task: Joi.boolean(),
+      resume_tasks_after_unlock: Joi.boolean(),
     });
   }
 
@@ -4148,6 +4175,17 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {ShipmentRequestData} */
+  static ShipmentRequestData() {
+    return Joi.object({
+      line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
+      processing_dates: OrderPlatformModel.ProcessingDates(),
+      meta: Joi.any(),
+      priority: Joi.number(),
+      order_type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ShippingInfo} */
   static ShippingInfo() {
     return Joi.object({
@@ -4261,6 +4299,7 @@ class OrderPlatformModel {
   static CreateOrderAPI() {
     return Joi.object({
       shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
+      shipment_request_data: OrderPlatformModel.ShipmentRequestData(),
       shipping_info: OrderPlatformModel.ShippingInfo().required(),
       billing_info: OrderPlatformModel.BillingInfo().required(),
       currency_info: Joi.any(),
@@ -5766,6 +5805,7 @@ class OrderPlatformModel {
       shipment_created_ts: Joi.string().allow(""),
       currency: OrderPlatformModel.Currency(),
       currency_info: OrderPlatformModel.CurrencyInfo(),
+      is_lapa_enabled: Joi.boolean(),
     });
   }
 
@@ -6326,6 +6366,7 @@ class OrderPlatformModel {
       credit_note_id: Joi.string().allow("").allow(null),
       is_self_ship: Joi.boolean().allow(null),
       mode_of_payment: Joi.string().allow("").allow(null),
+      is_lapa_enabled: Joi.boolean(),
     });
   }
 

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -425,6 +425,7 @@ export = PaymentPlatformModel;
  */
 /**
  * @typedef SetCODForUserRequest
+ * @property {string} [business_unit] - Business unit
  * @property {string} mobileno - Mobile No. of User
  * @property {boolean} is_active - Either true or false
  * @property {string} merchant_user_id - Merchant User id
@@ -591,6 +592,8 @@ export = PaymentPlatformModel;
  * @typedef LinkStatus
  * @property {string} status - Link action status
  * @property {string} message - Message
+ * @property {boolean} [is_payment_done] - This key specifies payment done
+ *   status of payment link.
  */
 /**
  * @typedef ResendOrCancelPaymentResponse
@@ -2270,6 +2273,10 @@ type GetUserCODLimitResponse = {
 /** @returns {SetCODForUserRequest} */
 declare function SetCODForUserRequest(): SetCODForUserRequest;
 type SetCODForUserRequest = {
+    /**
+     * - Business unit
+     */
+    business_unit?: string;
     /**
      * - Mobile No. of User
      */
@@ -2740,6 +2747,11 @@ type LinkStatus = {
      * - Message
      */
     message: string;
+    /**
+     * - This key specifies payment done
+     * status of payment link.
+     */
+    is_payment_done?: boolean;
 };
 /** @returns {ResendOrCancelPaymentResponse} */
 declare function ResendOrCancelPaymentResponse(): ResendOrCancelPaymentResponse;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -479,6 +479,7 @@ const Joi = require("joi");
 
 /**
  * @typedef SetCODForUserRequest
+ * @property {string} [business_unit] - Business unit
  * @property {string} mobileno - Mobile No. of User
  * @property {boolean} is_active - Either true or false
  * @property {string} merchant_user_id - Merchant User id
@@ -664,6 +665,8 @@ const Joi = require("joi");
  * @typedef LinkStatus
  * @property {string} status - Link action status
  * @property {string} message - Message
+ * @property {boolean} [is_payment_done] - This key specifies payment done
+ *   status of payment link.
  */
 
 /**
@@ -1919,6 +1922,7 @@ class PaymentPlatformModel {
   /** @returns {SetCODForUserRequest} */
   static SetCODForUserRequest() {
     return Joi.object({
+      business_unit: Joi.string().allow(""),
       mobileno: Joi.string().allow("").required(),
       is_active: Joi.boolean().required(),
       merchant_user_id: Joi.string().allow("").required(),
@@ -2139,6 +2143,7 @@ class PaymentPlatformModel {
     return Joi.object({
       status: Joi.string().allow("").required(),
       message: Joi.string().allow("").required(),
+      is_payment_done: Joi.boolean(),
     });
   }
 

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

@@ -245,7 +245,7 @@ declare class Serviceability {
      * @summary: Get zones
      * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
      */
-    getZones({ pageNo, pageSize, isActive, channelId, q, country, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
+    getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
     /**
      * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
      *   - Arg object

package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js

@@ -1730,7 +1730,7 @@ class Serviceability {
       isActive,
       channelId,
       q,
-      country,
+      countryIsoCode,
       state,
       city,
       pincode,
@@ -1746,7 +1746,7 @@ class Serviceability {
         isActive,
         channelId,
         q,
-        country,
+        countryIsoCode,
         state,
         city,
         pincode,
@@ -1768,7 +1768,7 @@ class Serviceability {
         isActive,
         channelId,
         q,
-        country,
+        countryIsoCode,
         state,
         city,
         pincode,
@@ -1789,7 +1789,7 @@ class Serviceability {
     query_params["is_active"] = isActive;
     query_params["channel_id"] = channelId;
     query_params["q"] = q;
-    query_params["country"] = country;
+    query_params["country_iso_code"] = countryIsoCode;
     query_params["state"] = state;
     query_params["city"] = city;
     query_params["pincode"] = pincode;

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

@@ -521,6 +521,15 @@ export = ServiceabilityPlatformModel;
  * @property {string} stage
  * @property {boolean} is_own_account
  */
+/**
+ * @typedef CourierAccountRequestBody
+ * @property {string} extension_id
+ * @property {string} [account_id]
+ * @property {string} scheme_id
+ * @property {boolean} is_self_ship
+ * @property {string} stage
+ * @property {boolean} is_own_account
+ */
 /**
  * @typedef ErrorResponse
  * @property {string} value
@@ -994,7 +1003,7 @@ export = ServiceabilityPlatformModel;
 declare class ServiceabilityPlatformModel {
 }
 declare namespace ServiceabilityPlatformModel {
-    export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
+    export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
 }
 /** @returns {UpdateZoneConfigRequest} */
 declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
@@ -1591,6 +1600,16 @@ type CourierAccount = {
     stage: string;
     is_own_account: boolean;
 };
+/** @returns {CourierAccountRequestBody} */
+declare function CourierAccountRequestBody(): CourierAccountRequestBody;
+type CourierAccountRequestBody = {
+    extension_id: string;
+    account_id?: string;
+    scheme_id: string;
+    is_self_ship: boolean;
+    stage: string;
+    is_own_account: boolean;
+};
 /** @returns {ErrorResponse} */
 declare function ErrorResponse(): ErrorResponse;
 type ErrorResponse = {

package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js

@@ -595,6 +595,16 @@ const Joi = require("joi");
  * @property {boolean} is_own_account
  */
 
+/**
+ * @typedef CourierAccountRequestBody
+ * @property {string} extension_id
+ * @property {string} [account_id]
+ * @property {string} scheme_id
+ * @property {boolean} is_self_ship
+ * @property {string} stage
+ * @property {boolean} is_own_account
+ */
+
 /**
  * @typedef ErrorResponse
  * @property {string} value
@@ -1865,10 +1875,10 @@ class ServiceabilityPlatformModel {
   /** @returns {ArithmeticOperations} */
   static ArithmeticOperations() {
     return Joi.object({
-      lt: Joi.number(),
-      gt: Joi.number(),
-      lte: Joi.number(),
-      gte: Joi.number(),
+      lt: Joi.number().allow(null),
+      gt: Joi.number().allow(null),
+      lte: Joi.number().allow(null),
+      gte: Joi.number().allow(null),
     });
   }
 
@@ -1908,6 +1918,18 @@ class ServiceabilityPlatformModel {
     });
   }
 
+  /** @returns {CourierAccountRequestBody} */
+  static CourierAccountRequestBody() {
+    return Joi.object({
+      extension_id: Joi.string().allow("").required(),
+      account_id: Joi.string().allow(""),
+      scheme_id: Joi.string().allow("").required(),
+      is_self_ship: Joi.boolean().required(),
+      stage: Joi.string().allow("").required(),
+      is_own_account: Joi.boolean().required(),
+    });
+  }
+
   /** @returns {ErrorResponse} */
   static ErrorResponse() {
     return Joi.object({