@gofynd/fdk-client-javascript 3.7.0 → 3.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +7 -7
  4. package/sdk/application/Cart/CartApplicationClient.js +8 -8
  5. package/sdk/application/Payment/PaymentApplicationClient.d.ts +50 -0
  6. package/sdk/application/Payment/PaymentApplicationClient.js +210 -0
  7. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  8. package/sdk/application/Theme/ThemeApplicationClient.js +3 -1
  9. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
  10. package/sdk/platform/Cart/CartPlatformApplicationClient.js +96 -1
  11. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +37 -1
  12. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +24 -0
  13. package/sdk/platform/Cart/CartPlatformModel.d.ts +155 -29
  14. package/sdk/platform/Cart/CartPlatformModel.js +83 -14
  15. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +124 -6
  16. package/sdk/platform/Catalog/CatalogPlatformClient.js +1074 -175
  17. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1072 -45
  18. package/sdk/platform/Catalog/CatalogPlatformModel.js +714 -5
  19. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +193 -19
  20. package/sdk/platform/Catalog/CatalogPlatformValidator.js +167 -14
  21. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +9 -4
  22. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
  23. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  24. package/sdk/platform/Order/OrderPlatformClient.js +1 -1
  25. package/sdk/platform/Order/OrderPlatformModel.d.ts +55 -3
  26. package/sdk/platform/Order/OrderPlatformModel.js +31 -1
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +0 -10
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +0 -4
  29. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  30. package/sdk/public/Content/ContentPublicClient.js +4 -3
  31. package/sdk/public/Content/ContentPublicModel.d.ts +5 -0
  32. package/sdk/public/Content/ContentPublicModel.js +2 -0
  33. package/sdk/public/Content/ContentPublicValidator.d.ts +11 -3
  34. package/sdk/public/Content/ContentPublicValidator.js +7 -2
@@ -58,8 +58,9 @@ export = FileStoragePlatformModel;
58
58
  */
59
59
  /**
60
60
  * @typedef ProxyFileAccess
61
- * @property {Object} [data]
62
- * @property {Object} [support]
61
+ * @property {boolean} [success] - A boolean value indicating whether the proxy
62
+ * request was successful. Returns true when the external URL was successfully
63
+ * fetched and processed.
63
64
  */
64
65
  /**
65
66
  * @typedef DestinationNamespace
@@ -271,8 +272,12 @@ type FileUploadComplete = {
271
272
  /** @returns {ProxyFileAccess} */
272
273
  declare function ProxyFileAccess(): ProxyFileAccess;
273
274
  type ProxyFileAccess = {
274
- data?: any;
275
- support?: any;
275
+ /**
276
+ * - A boolean value indicating whether the proxy
277
+ * request was successful. Returns true when the external URL was successfully
278
+ * fetched and processed.
279
+ */
280
+ success?: boolean;
276
281
  };
277
282
  /** @returns {DestinationNamespace} */
278
283
  declare function DestinationNamespace(): DestinationNamespace;
@@ -66,8 +66,9 @@ const Joi = require("joi");
66
66
 
67
67
  /**
68
68
  * @typedef ProxyFileAccess
69
- * @property {Object} [data]
70
- * @property {Object} [support]
69
+ * @property {boolean} [success] - A boolean value indicating whether the proxy
70
+ * request was successful. Returns true when the external URL was successfully
71
+ * fetched and processed.
71
72
  */
72
73
 
73
74
  /**
@@ -310,8 +311,7 @@ class FileStoragePlatformModel {
310
311
  /** @returns {ProxyFileAccess} */
311
312
  static ProxyFileAccess() {
312
313
  return Joi.object({
313
- data: Joi.object().pattern(/\S/, Joi.any()),
314
- support: Joi.object().pattern(/\S/, Joi.any()),
314
+ success: Joi.boolean(),
315
315
  });
316
316
  }
317
317
 
@@ -796,7 +796,7 @@ declare class Order {
796
796
  *
797
797
  * @name updateShipmentStatus
798
798
  * @summary: Update a shipment's status
799
- * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
799
+ * @description: It is used for updating the shipment in the following scenarios:\n• Full Confirmation\n• Partial Confirmation\n• Change the status of a shipment\n• Full Cancellation\n• Partial Cancellation\n• Assign the shipment to DP. Click <a href=\"https://docs.fynd.com/partners/commerce/miscellaneous/updateShipmentStatus\">here</a> to get the example payload. Also, refer to the <a href=\"https://docs.fynd.com/partners/commerce/getting-started/oms-states/\">OMS Sates</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
800
800
  */
801
801
  updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
802
802
  /**
@@ -5251,7 +5251,7 @@ class Order {
5251
5251
  *
5252
5252
  * @name updateShipmentStatus
5253
5253
  * @summary: Update a shipment's status
5254
- * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
5254
+ * @description: It is used for updating the shipment in the following scenarios:\n• Full Confirmation\n• Partial Confirmation\n• Change the status of a shipment\n• Full Cancellation\n• Partial Cancellation\n• Assign the shipment to DP. Click <a href=\"https://docs.fynd.com/partners/commerce/miscellaneous/updateShipmentStatus\">here</a> to get the example payload. Also, refer to the <a href=\"https://docs.fynd.com/partners/commerce/getting-started/oms-states/\">OMS Sates</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
5255
5255
  */
5256
5256
  async updateShipmentStatus(
5257
5257
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1243,7 +1243,9 @@ export = OrderPlatformModel;
1243
1243
  * @typedef PaymentMethod
1244
1244
  * @property {string} collect_by - A string indicating the entity responsible
1245
1245
  * for collecting the payment.
1246
- * @property {string} mode - A string that specifies the mode of payment.
1246
+ * @property {string} mode - A string that specifies the mode of payment. Refer
1247
+ * to [API & references (in Nav bar) → Payment Modes] for a list of valid
1248
+ * payment methods.
1247
1249
  * @property {string} refund_by - A string that indicates the entity responsible
1248
1250
  * for processing refunds.
1249
1251
  * @property {string} name - A string representing the name of the payment method.
@@ -2917,6 +2919,21 @@ export = OrderPlatformModel;
2917
2919
  * a unique identifier for books, allowing for easier management and tracking
2918
2920
  * of book inventories in retail and library systems.
2919
2921
  */
2922
+ /**
2923
+ * @typedef TaxComponent
2924
+ * @property {string} [name] - The name or type of the tax component (e.g., GST,
2925
+ * VAT, Service Tax). This helps in identifying the specific tax being applied
2926
+ * to the transaction or item.
2927
+ * @property {number} [rate] - The percentage rate at which the tax is applied
2928
+ * to the taxable amount. This value is typically represented as a decimal
2929
+ * (e.g., 0.18 for 18% tax).
2930
+ * @property {number} [tax_amount] - The total monetary value of the tax
2931
+ * calculated for this component. This is derived by applying the tax rate to
2932
+ * the taxable amount.
2933
+ * @property {number} [taxable_amount] - The base amount on which the tax is
2934
+ * calculated, excluding the tax itself. This represents the value of goods or
2935
+ * services before tax is applied.
2936
+ */
2920
2937
  /**
2921
2938
  * @typedef FinancialBreakup
2922
2939
  * @property {number} refund_credit - The amount of refund credits applicable
@@ -2970,6 +2987,7 @@ export = OrderPlatformModel;
2970
2987
  * @property {number} total_units - The total number of units involved in the transaction.
2971
2988
  * @property {boolean} added_to_fynd_cash - Indicates whether the amount has
2972
2989
  * been added to Fynd cash for future use.
2990
+ * @property {TaxComponent[]} [taxes] - Applied Tax Components
2973
2991
  */
2974
2992
  /**
2975
2993
  * @typedef GSTDetailsData
@@ -5082,7 +5100,7 @@ export = OrderPlatformModel;
5082
5100
  declare class OrderPlatformModel {
5083
5101
  }
5084
5102
  declare namespace OrderPlatformModel {
5085
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, 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, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
5103
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, 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, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
5086
5104
  }
5087
5105
  /** @returns {InvalidateShipmentCachePayload} */
5088
5106
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -7542,7 +7560,9 @@ type PaymentMethod = {
7542
7560
  */
7543
7561
  collect_by: string;
7544
7562
  /**
7545
- * - A string that specifies the mode of payment.
7563
+ * - A string that specifies the mode of payment. Refer
7564
+ * to [API & references (in Nav bar) → Payment Modes] for a list of valid
7565
+ * payment methods.
7546
7566
  */
7547
7567
  mode: string;
7548
7568
  /**
@@ -11011,6 +11031,34 @@ type Identifier = {
11011
11031
  */
11012
11032
  isbn?: string;
11013
11033
  };
11034
+ /** @returns {TaxComponent} */
11035
+ declare function TaxComponent(): TaxComponent;
11036
+ type TaxComponent = {
11037
+ /**
11038
+ * - The name or type of the tax component (e.g., GST,
11039
+ * VAT, Service Tax). This helps in identifying the specific tax being applied
11040
+ * to the transaction or item.
11041
+ */
11042
+ name?: string;
11043
+ /**
11044
+ * - The percentage rate at which the tax is applied
11045
+ * to the taxable amount. This value is typically represented as a decimal
11046
+ * (e.g., 0.18 for 18% tax).
11047
+ */
11048
+ rate?: number;
11049
+ /**
11050
+ * - The total monetary value of the tax
11051
+ * calculated for this component. This is derived by applying the tax rate to
11052
+ * the taxable amount.
11053
+ */
11054
+ tax_amount?: number;
11055
+ /**
11056
+ * - The base amount on which the tax is
11057
+ * calculated, excluding the tax itself. This represents the value of goods or
11058
+ * services before tax is applied.
11059
+ */
11060
+ taxable_amount?: number;
11061
+ };
11014
11062
  /** @returns {FinancialBreakup} */
11015
11063
  declare function FinancialBreakup(): FinancialBreakup;
11016
11064
  type FinancialBreakup = {
@@ -11146,6 +11194,10 @@ type FinancialBreakup = {
11146
11194
  * been added to Fynd cash for future use.
11147
11195
  */
11148
11196
  added_to_fynd_cash: boolean;
11197
+ /**
11198
+ * - Applied Tax Components
11199
+ */
11200
+ taxes?: TaxComponent[];
11149
11201
  };
11150
11202
  /** @returns {GSTDetailsData} */
11151
11203
  declare function GSTDetailsData(): GSTDetailsData;
@@ -1353,7 +1353,9 @@ const Joi = require("joi");
1353
1353
  * @typedef PaymentMethod
1354
1354
  * @property {string} collect_by - A string indicating the entity responsible
1355
1355
  * for collecting the payment.
1356
- * @property {string} mode - A string that specifies the mode of payment.
1356
+ * @property {string} mode - A string that specifies the mode of payment. Refer
1357
+ * to [API & references (in Nav bar) → Payment Modes] for a list of valid
1358
+ * payment methods.
1357
1359
  * @property {string} refund_by - A string that indicates the entity responsible
1358
1360
  * for processing refunds.
1359
1361
  * @property {string} name - A string representing the name of the payment method.
@@ -3171,6 +3173,22 @@ const Joi = require("joi");
3171
3173
  * of book inventories in retail and library systems.
3172
3174
  */
3173
3175
 
3176
+ /**
3177
+ * @typedef TaxComponent
3178
+ * @property {string} [name] - The name or type of the tax component (e.g., GST,
3179
+ * VAT, Service Tax). This helps in identifying the specific tax being applied
3180
+ * to the transaction or item.
3181
+ * @property {number} [rate] - The percentage rate at which the tax is applied
3182
+ * to the taxable amount. This value is typically represented as a decimal
3183
+ * (e.g., 0.18 for 18% tax).
3184
+ * @property {number} [tax_amount] - The total monetary value of the tax
3185
+ * calculated for this component. This is derived by applying the tax rate to
3186
+ * the taxable amount.
3187
+ * @property {number} [taxable_amount] - The base amount on which the tax is
3188
+ * calculated, excluding the tax itself. This represents the value of goods or
3189
+ * services before tax is applied.
3190
+ */
3191
+
3174
3192
  /**
3175
3193
  * @typedef FinancialBreakup
3176
3194
  * @property {number} refund_credit - The amount of refund credits applicable
@@ -3224,6 +3242,7 @@ const Joi = require("joi");
3224
3242
  * @property {number} total_units - The total number of units involved in the transaction.
3225
3243
  * @property {boolean} added_to_fynd_cash - Indicates whether the amount has
3226
3244
  * been added to Fynd cash for future use.
3245
+ * @property {TaxComponent[]} [taxes] - Applied Tax Components
3227
3246
  */
3228
3247
 
3229
3248
  /**
@@ -8317,6 +8336,16 @@ class OrderPlatformModel {
8317
8336
  });
8318
8337
  }
8319
8338
 
8339
+ /** @returns {TaxComponent} */
8340
+ static TaxComponent() {
8341
+ return Joi.object({
8342
+ name: Joi.string().allow(""),
8343
+ rate: Joi.number(),
8344
+ tax_amount: Joi.number(),
8345
+ taxable_amount: Joi.number(),
8346
+ });
8347
+ }
8348
+
8320
8349
  /** @returns {FinancialBreakup} */
8321
8350
  static FinancialBreakup() {
8322
8351
  return Joi.object({
@@ -8348,6 +8377,7 @@ class OrderPlatformModel {
8348
8377
  identifiers: OrderPlatformModel.Identifier().required(),
8349
8378
  total_units: Joi.number().required(),
8350
8379
  added_to_fynd_cash: Joi.boolean().required(),
8380
+ taxes: Joi.array().items(OrderPlatformModel.TaxComponent()),
8351
8381
  });
8352
8382
  }
8353
8383
 
@@ -730,7 +730,6 @@ export = ServiceabilityPlatformModel;
730
730
  * @property {number} [company_id] - The unique identifier for the company.
731
731
  * @property {string} name - The name of the package material.
732
732
  * @property {string} [id] - Unique identifier for the package material.
733
- * @property {number} [item_id] - Unique identifier for the item.
734
733
  * @property {number} width - The width of the package material.
735
734
  * @property {number} height - The height of the package material.
736
735
  * @property {number} length - The length of the package material.
@@ -805,7 +804,6 @@ export = ServiceabilityPlatformModel;
805
804
  * @property {boolean} [is_active] - Indicates if the package item is active.
806
805
  * @property {string} [size] - The size of the package item.
807
806
  * @property {number} [company_id] - The company ID associated with the package item.
808
- * @property {number} [item_id] - The unique identifier for the package item.
809
807
  * @property {number} [max_weight] - The maximum weight(grams) of the package item.
810
808
  * @property {Object[]} [media] - Additional media associated with the package item.
811
809
  * @property {number} [package_vol_weight] - The volumetric weight(grams) of the
@@ -4151,10 +4149,6 @@ type PackageMaterialResult = {
4151
4149
  * - Unique identifier for the package material.
4152
4150
  */
4153
4151
  id?: string;
4154
- /**
4155
- * - Unique identifier for the item.
4156
- */
4157
- item_id?: number;
4158
4152
  /**
4159
4153
  * - The width of the package material.
4160
4154
  */
@@ -4353,10 +4347,6 @@ type PackageItem = {
4353
4347
  * - The company ID associated with the package item.
4354
4348
  */
4355
4349
  company_id?: number;
4356
- /**
4357
- * - The unique identifier for the package item.
4358
- */
4359
- item_id?: number;
4360
4350
  /**
4361
4351
  * - The maximum weight(grams) of the package item.
4362
4352
  */
@@ -804,7 +804,6 @@ const Joi = require("joi");
804
804
  * @property {number} [company_id] - The unique identifier for the company.
805
805
  * @property {string} name - The name of the package material.
806
806
  * @property {string} [id] - Unique identifier for the package material.
807
- * @property {number} [item_id] - Unique identifier for the item.
808
807
  * @property {number} width - The width of the package material.
809
808
  * @property {number} height - The height of the package material.
810
809
  * @property {number} length - The length of the package material.
@@ -883,7 +882,6 @@ const Joi = require("joi");
883
882
  * @property {boolean} [is_active] - Indicates if the package item is active.
884
883
  * @property {string} [size] - The size of the package item.
885
884
  * @property {number} [company_id] - The company ID associated with the package item.
886
- * @property {number} [item_id] - The unique identifier for the package item.
887
885
  * @property {number} [max_weight] - The maximum weight(grams) of the package item.
888
886
  * @property {Object[]} [media] - Additional media associated with the package item.
889
887
  * @property {number} [package_vol_weight] - The volumetric weight(grams) of the
@@ -3425,7 +3423,6 @@ class ServiceabilityPlatformModel {
3425
3423
  company_id: Joi.number(),
3426
3424
  name: Joi.string().allow("").required(),
3427
3425
  id: Joi.string().allow(""),
3428
- item_id: Joi.number(),
3429
3426
  width: Joi.number().required(),
3430
3427
  height: Joi.number().required(),
3431
3428
  length: Joi.number().required(),
@@ -3505,7 +3502,6 @@ class ServiceabilityPlatformModel {
3505
3502
  is_active: Joi.boolean(),
3506
3503
  size: Joi.string().allow(""),
3507
3504
  company_id: Joi.number(),
3508
- item_id: Joi.number(),
3509
3505
  max_weight: Joi.number(),
3510
3506
  media: Joi.array().items(Joi.any()),
3511
3507
  package_vol_weight: Joi.number(),
@@ -29,7 +29,7 @@ declare class Content {
29
29
  * @summary: Get All Languages
30
30
  * @description: Fetches complete list of languages supported by the platform with their locale codes and text directions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/content/getAllLanguages/).
31
31
  */
32
- getAllLanguages({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
32
+ getAllLanguages({ isEnabled, requestHeaders }?: ContentPublicValidator.GetAllLanguagesParam, { responseHeaders }?: object): Promise<any>;
33
33
  /**
34
34
  * @param {ContentPublicValidator.GetAllTagsParam} arg - Arg object.
35
35
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -161,5 +161,5 @@ declare class Content {
161
161
  */
162
162
  getPricingBanner({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.PricingBannerSchema>;
163
163
  }
164
- import ContentPublicModel = require("./ContentPublicModel");
165
164
  import ContentPublicValidator = require("./ContentPublicValidator");
165
+ import ContentPublicModel = require("./ContentPublicModel");
@@ -60,11 +60,11 @@ class Content {
60
60
  * @description: Fetches complete list of languages supported by the platform with their locale codes and text directions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/content/getAllLanguages/).
61
61
  */
62
62
  async getAllLanguages(
63
- { requestHeaders } = { requestHeaders: {} },
63
+ { isEnabled, requestHeaders } = { requestHeaders: {} },
64
64
  { responseHeaders } = { responseHeaders: false }
65
65
  ) {
66
66
  const { error } = ContentPublicValidator.getAllLanguages().validate(
67
- {},
67
+ { isEnabled },
68
68
  { abortEarly: false, allowUnknown: true }
69
69
  );
70
70
  if (error) {
@@ -75,7 +75,7 @@ class Content {
75
75
  const {
76
76
  error: warrning,
77
77
  } = ContentPublicValidator.getAllLanguages().validate(
78
- {},
78
+ { isEnabled },
79
79
  { abortEarly: false, allowUnknown: false }
80
80
  );
81
81
  if (warrning) {
@@ -86,6 +86,7 @@ class Content {
86
86
  }
87
87
 
88
88
  const query_params = {};
89
+ query_params["is_enabled"] = isEnabled;
89
90
 
90
91
  const xHeaders = {};
91
92
 
@@ -290,6 +290,7 @@ export = ContentPublicModel;
290
290
  * reference and display at the merchant panel.
291
291
  * @property {string} [display_name] - Translated name of the language in
292
292
  * English for easy reference and display at the website.
293
+ * @property {boolean} [is_enabled] - Indicates whether the language is enabled for use.
293
294
  */
294
295
  /**
295
296
  * @typedef Error
@@ -672,6 +673,10 @@ type Language = {
672
673
  * English for easy reference and display at the website.
673
674
  */
674
675
  display_name?: string;
676
+ /**
677
+ * - Indicates whether the language is enabled for use.
678
+ */
679
+ is_enabled?: boolean;
675
680
  };
676
681
  /** @returns {Error} */
677
682
  declare function Error(): Error;
@@ -326,6 +326,7 @@ const Joi = require("joi");
326
326
  * reference and display at the merchant panel.
327
327
  * @property {string} [display_name] - Translated name of the language in
328
328
  * English for easy reference and display at the website.
329
+ * @property {boolean} [is_enabled] - Indicates whether the language is enabled for use.
329
330
  */
330
331
 
331
332
  /**
@@ -763,6 +764,7 @@ class ContentPublicModel {
763
764
  direction: Joi.string().allow("").required(),
764
765
  name: Joi.string().allow("").required(),
765
766
  display_name: Joi.string().allow(""),
767
+ is_enabled: Joi.boolean(),
766
768
  });
767
769
  }
768
770
 
@@ -1,5 +1,8 @@
1
1
  export = ContentPublicValidator;
2
- /** @typedef GetAllLanguagesParam */
2
+ /**
3
+ * @typedef GetAllLanguagesParam
4
+ * @property {boolean} [isEnabled] - Filter languages by enabled status.
5
+ */
3
6
  /** @typedef GetAllTagsParam */
4
7
  /** @typedef GetAllTranslatableResourcesParam */
5
8
  /** @typedef GetAnalyticsTagsParam */
@@ -31,7 +34,7 @@ export = ContentPublicValidator;
31
34
  /** @typedef GetPricingBannerParam */
32
35
  declare class ContentPublicValidator {
33
36
  /** @returns {GetAllLanguagesParam} */
34
- static getAllLanguages(): any;
37
+ static getAllLanguages(): GetAllLanguagesParam;
35
38
  /** @returns {GetAllTagsParam} */
36
39
  static getAllTags(): any;
37
40
  /** @returns {GetAllTranslatableResourcesParam} */
@@ -62,6 +65,12 @@ declare class ContentPublicValidator {
62
65
  declare namespace ContentPublicValidator {
63
66
  export { GetAllLanguagesParam, GetAllTagsParam, GetAllTranslatableResourcesParam, GetAnalyticsTagsParam, GetBasicDetailsParam, GetCredentialsByEntityParam, GetCustomPageParam, GetFooterContentParam, GetHomePageContentParam, GetLanguageByLocaleParam, GetMenuContentParam, GetMenuContentByTypeParam, GetNavbarParam, GetPricingBannerParam };
64
67
  }
68
+ type GetAllLanguagesParam = {
69
+ /**
70
+ * - Filter languages by enabled status.
71
+ */
72
+ isEnabled?: boolean;
73
+ };
65
74
  type GetCredentialsByEntityParam = {
66
75
  /**
67
76
  * - Server Type
@@ -90,7 +99,6 @@ type GetMenuContentByTypeParam = {
90
99
  */
91
100
  type: string;
92
101
  };
93
- type GetAllLanguagesParam = any;
94
102
  type GetAllTagsParam = any;
95
103
  type GetAllTranslatableResourcesParam = any;
96
104
  type GetAnalyticsTagsParam = any;
@@ -2,7 +2,10 @@ const Joi = require("joi");
2
2
 
3
3
  const ContentPublicModel = require("./ContentPublicModel");
4
4
 
5
- /** @typedef GetAllLanguagesParam */
5
+ /**
6
+ * @typedef GetAllLanguagesParam
7
+ * @property {boolean} [isEnabled] - Filter languages by enabled status.
8
+ */
6
9
 
7
10
  /** @typedef GetAllTagsParam */
8
11
 
@@ -49,7 +52,9 @@ const ContentPublicModel = require("./ContentPublicModel");
49
52
  class ContentPublicValidator {
50
53
  /** @returns {GetAllLanguagesParam} */
51
54
  static getAllLanguages() {
52
- return Joi.object({});
55
+ return Joi.object({
56
+ isEnabled: Joi.boolean(),
57
+ });
53
58
  }
54
59
 
55
60
  /** @returns {GetAllTagsParam} */