@gofynd/fdk-client-javascript 3.8.0 → 3.10.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +7 -7
- package/sdk/application/Cart/CartApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +3 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +96 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +37 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +24 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +150 -29
- package/sdk/platform/Cart/CartPlatformModel.js +81 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +18 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformClient.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +66 -3
- package/sdk/platform/Order/OrderPlatformModel.js +42 -3
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicClient.js +4 -3
- package/sdk/public/Content/ContentPublicModel.d.ts +5 -0
- package/sdk/public/Content/ContentPublicModel.js +2 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +11 -3
- package/sdk/public/Content/ContentPublicValidator.js +7 -2
|
@@ -901,6 +901,7 @@ export = OrderPlatformModel;
|
|
|
901
901
|
* @property {string} [ordering_channel_logo]
|
|
902
902
|
* @property {Prices} [prices]
|
|
903
903
|
* @property {PriceAdjustmentCharge[]} [charges]
|
|
904
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
904
905
|
*/
|
|
905
906
|
/**
|
|
906
907
|
* @typedef Meta
|
|
@@ -1243,7 +1244,9 @@ export = OrderPlatformModel;
|
|
|
1243
1244
|
* @typedef PaymentMethod
|
|
1244
1245
|
* @property {string} collect_by - A string indicating the entity responsible
|
|
1245
1246
|
* for collecting the payment.
|
|
1246
|
-
* @property {string} mode - A string that specifies the mode of payment.
|
|
1247
|
+
* @property {string} mode - A string that specifies the mode of payment. Refer
|
|
1248
|
+
* to [API & references (in Nav bar) → Payment Modes] for a list of valid
|
|
1249
|
+
* payment methods.
|
|
1247
1250
|
* @property {string} refund_by - A string that indicates the entity responsible
|
|
1248
1251
|
* for processing refunds.
|
|
1249
1252
|
* @property {string} name - A string representing the name of the payment method.
|
|
@@ -2813,6 +2816,8 @@ export = OrderPlatformModel;
|
|
|
2813
2816
|
* used in the transaction.
|
|
2814
2817
|
* @property {number} [amount_to_be_collected] - Total amount to be collected in
|
|
2815
2818
|
* scenarios involving multiple payment methods.
|
|
2819
|
+
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
2820
|
+
* when the customer applies loyalty program points while placing the order.
|
|
2816
2821
|
*/
|
|
2817
2822
|
/**
|
|
2818
2823
|
* @typedef ChargeDistributionSchema
|
|
@@ -2895,6 +2900,8 @@ export = OrderPlatformModel;
|
|
|
2895
2900
|
* purchased by the customer, usable for future transactions.
|
|
2896
2901
|
* @property {number} [amount_to_be_collected] - Amount to be collected from the
|
|
2897
2902
|
* customer when multiple payment methods are utilized for a single order.
|
|
2903
|
+
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
2904
|
+
* when the customer applies loyalty program points while placing the order.
|
|
2898
2905
|
*/
|
|
2899
2906
|
/**
|
|
2900
2907
|
* @typedef Identifier
|
|
@@ -2986,6 +2993,8 @@ export = OrderPlatformModel;
|
|
|
2986
2993
|
* @property {boolean} added_to_fynd_cash - Indicates whether the amount has
|
|
2987
2994
|
* been added to Fynd cash for future use.
|
|
2988
2995
|
* @property {TaxComponent[]} [taxes] - Applied Tax Components
|
|
2996
|
+
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
2997
|
+
* when the customer applies loyalty program points while placing the order.
|
|
2989
2998
|
*/
|
|
2990
2999
|
/**
|
|
2991
3000
|
* @typedef GSTDetailsData
|
|
@@ -3539,6 +3548,16 @@ export = OrderPlatformModel;
|
|
|
3539
3548
|
* @property {Object} [links] - An object containing additional links relevant
|
|
3540
3549
|
* to the invoice, which may include related documents or resources.
|
|
3541
3550
|
*/
|
|
3551
|
+
/**
|
|
3552
|
+
* @typedef LoyaltyDiscountDetails
|
|
3553
|
+
* @property {number} [discount] - Discount amount applied by redeeming loyalty
|
|
3554
|
+
* points while placing the order. Represents the monetary value of loyalty
|
|
3555
|
+
* points redeemed.
|
|
3556
|
+
* @property {string} [ownership] - Indicates who bears the cost of the loyalty
|
|
3557
|
+
* discount, such as the seller or the marketplace.
|
|
3558
|
+
* @property {boolean} [is_applied] - Specifies whether the loyalty discount has
|
|
3559
|
+
* been applied to the order.
|
|
3560
|
+
*/
|
|
3542
3561
|
/**
|
|
3543
3562
|
* @typedef OrderDetailsData
|
|
3544
3563
|
* @property {string} [order_date] - Represents the date and time when the order
|
|
@@ -3568,6 +3587,7 @@ export = OrderPlatformModel;
|
|
|
3568
3587
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
3569
3588
|
* @property {string} [ordering_source] - To uniquely identify the source
|
|
3570
3589
|
* through which order has been placed (e.g, marketplace, gofynd).
|
|
3590
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
3571
3591
|
* @property {Object} [meta] - Meta data of the order contains additional,
|
|
3572
3592
|
* potentially dynamic information about the order.
|
|
3573
3593
|
*/
|
|
@@ -4367,6 +4387,7 @@ export = OrderPlatformModel;
|
|
|
4367
4387
|
* is created, including mobile applications, web interfaces, social media
|
|
4368
4388
|
* integrations, or external APIs.
|
|
4369
4389
|
* @property {CurrencySchema} [currency]
|
|
4390
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
4370
4391
|
*/
|
|
4371
4392
|
/**
|
|
4372
4393
|
* @typedef OrderDetailsResponseSchema
|
|
@@ -4435,6 +4456,7 @@ export = OrderPlatformModel;
|
|
|
4435
4456
|
* @property {CurrencyInfo} [currency_info]
|
|
4436
4457
|
* @property {Prices} [prices]
|
|
4437
4458
|
* @property {OrderingCurrencyPrices} [ordering_currency_prices]
|
|
4459
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
4438
4460
|
*/
|
|
4439
4461
|
/**
|
|
4440
4462
|
* @typedef OrderListingResponseSchema
|
|
@@ -5098,7 +5120,7 @@ export = OrderPlatformModel;
|
|
|
5098
5120
|
declare class OrderPlatformModel {
|
|
5099
5121
|
}
|
|
5100
5122
|
declare namespace OrderPlatformModel {
|
|
5101
|
-
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 };
|
|
5123
|
+
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, LoyaltyDiscountDetails, 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 };
|
|
5102
5124
|
}
|
|
5103
5125
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
5104
5126
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -6851,6 +6873,7 @@ type OrderDetails = {
|
|
|
6851
6873
|
ordering_channel_logo?: string;
|
|
6852
6874
|
prices?: Prices;
|
|
6853
6875
|
charges?: PriceAdjustmentCharge[];
|
|
6876
|
+
loyalty_discount_details?: LoyaltyDiscountDetails;
|
|
6854
6877
|
};
|
|
6855
6878
|
/** @returns {Meta} */
|
|
6856
6879
|
declare function Meta(): Meta;
|
|
@@ -7558,7 +7581,9 @@ type PaymentMethod = {
|
|
|
7558
7581
|
*/
|
|
7559
7582
|
collect_by: string;
|
|
7560
7583
|
/**
|
|
7561
|
-
* - A string that specifies the mode of payment.
|
|
7584
|
+
* - A string that specifies the mode of payment. Refer
|
|
7585
|
+
* to [API & references (in Nav bar) → Payment Modes] for a list of valid
|
|
7586
|
+
* payment methods.
|
|
7562
7587
|
*/
|
|
7563
7588
|
mode: string;
|
|
7564
7589
|
/**
|
|
@@ -10811,6 +10836,11 @@ type Prices = {
|
|
|
10811
10836
|
* scenarios involving multiple payment methods.
|
|
10812
10837
|
*/
|
|
10813
10838
|
amount_to_be_collected?: number;
|
|
10839
|
+
/**
|
|
10840
|
+
* - Amount reduced from the payable price
|
|
10841
|
+
* when the customer applies loyalty program points while placing the order.
|
|
10842
|
+
*/
|
|
10843
|
+
loyalty_discount?: number;
|
|
10814
10844
|
};
|
|
10815
10845
|
/** @returns {ChargeDistributionSchema} */
|
|
10816
10846
|
declare function ChargeDistributionSchema(): ChargeDistributionSchema;
|
|
@@ -10989,6 +11019,11 @@ type OrderingCurrencyPrices = {
|
|
|
10989
11019
|
* customer when multiple payment methods are utilized for a single order.
|
|
10990
11020
|
*/
|
|
10991
11021
|
amount_to_be_collected?: number;
|
|
11022
|
+
/**
|
|
11023
|
+
* - Amount reduced from the payable price
|
|
11024
|
+
* when the customer applies loyalty program points while placing the order.
|
|
11025
|
+
*/
|
|
11026
|
+
loyalty_discount?: number;
|
|
10992
11027
|
};
|
|
10993
11028
|
/** @returns {Identifier} */
|
|
10994
11029
|
declare function Identifier(): Identifier;
|
|
@@ -11194,6 +11229,11 @@ type FinancialBreakup = {
|
|
|
11194
11229
|
* - Applied Tax Components
|
|
11195
11230
|
*/
|
|
11196
11231
|
taxes?: TaxComponent[];
|
|
11232
|
+
/**
|
|
11233
|
+
* - Amount reduced from the payable price
|
|
11234
|
+
* when the customer applies loyalty program points while placing the order.
|
|
11235
|
+
*/
|
|
11236
|
+
loyalty_discount?: number;
|
|
11197
11237
|
};
|
|
11198
11238
|
/** @returns {GSTDetailsData} */
|
|
11199
11239
|
declare function GSTDetailsData(): GSTDetailsData;
|
|
@@ -12380,6 +12420,26 @@ type InvoiceInfo = {
|
|
|
12380
12420
|
*/
|
|
12381
12421
|
links?: any;
|
|
12382
12422
|
};
|
|
12423
|
+
/** @returns {LoyaltyDiscountDetails} */
|
|
12424
|
+
declare function LoyaltyDiscountDetails(): LoyaltyDiscountDetails;
|
|
12425
|
+
type LoyaltyDiscountDetails = {
|
|
12426
|
+
/**
|
|
12427
|
+
* - Discount amount applied by redeeming loyalty
|
|
12428
|
+
* points while placing the order. Represents the monetary value of loyalty
|
|
12429
|
+
* points redeemed.
|
|
12430
|
+
*/
|
|
12431
|
+
discount?: number;
|
|
12432
|
+
/**
|
|
12433
|
+
* - Indicates who bears the cost of the loyalty
|
|
12434
|
+
* discount, such as the seller or the marketplace.
|
|
12435
|
+
*/
|
|
12436
|
+
ownership?: string;
|
|
12437
|
+
/**
|
|
12438
|
+
* - Specifies whether the loyalty discount has
|
|
12439
|
+
* been applied to the order.
|
|
12440
|
+
*/
|
|
12441
|
+
is_applied?: boolean;
|
|
12442
|
+
};
|
|
12383
12443
|
/** @returns {OrderDetailsData} */
|
|
12384
12444
|
declare function OrderDetailsData(): OrderDetailsData;
|
|
12385
12445
|
type OrderDetailsData = {
|
|
@@ -12446,6 +12506,7 @@ type OrderDetailsData = {
|
|
|
12446
12506
|
* through which order has been placed (e.g, marketplace, gofynd).
|
|
12447
12507
|
*/
|
|
12448
12508
|
ordering_source?: string;
|
|
12509
|
+
loyalty_discount_details?: LoyaltyDiscountDetails;
|
|
12449
12510
|
/**
|
|
12450
12511
|
* - Meta data of the order contains additional,
|
|
12451
12512
|
* potentially dynamic information about the order.
|
|
@@ -14147,6 +14208,7 @@ type OrderData = {
|
|
|
14147
14208
|
*/
|
|
14148
14209
|
source?: string;
|
|
14149
14210
|
currency?: CurrencySchema;
|
|
14211
|
+
loyalty_discount_details?: LoyaltyDiscountDetails;
|
|
14150
14212
|
};
|
|
14151
14213
|
/** @returns {OrderDetailsResponseSchema} */
|
|
14152
14214
|
declare function OrderDetailsResponseSchema(): OrderDetailsResponseSchema;
|
|
@@ -14258,6 +14320,7 @@ type PlatformOrderItems = {
|
|
|
14258
14320
|
currency_info?: CurrencyInfo;
|
|
14259
14321
|
prices?: Prices;
|
|
14260
14322
|
ordering_currency_prices?: OrderingCurrencyPrices;
|
|
14323
|
+
loyalty_discount_details?: LoyaltyDiscountDetails;
|
|
14261
14324
|
};
|
|
14262
14325
|
/** @returns {OrderListingResponseSchema} */
|
|
14263
14326
|
declare function OrderListingResponseSchema(): OrderListingResponseSchema;
|
|
@@ -988,6 +988,7 @@ const Joi = require("joi");
|
|
|
988
988
|
* @property {string} [ordering_channel_logo]
|
|
989
989
|
* @property {Prices} [prices]
|
|
990
990
|
* @property {PriceAdjustmentCharge[]} [charges]
|
|
991
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
991
992
|
*/
|
|
992
993
|
|
|
993
994
|
/**
|
|
@@ -1353,7 +1354,9 @@ const Joi = require("joi");
|
|
|
1353
1354
|
* @typedef PaymentMethod
|
|
1354
1355
|
* @property {string} collect_by - A string indicating the entity responsible
|
|
1355
1356
|
* for collecting the payment.
|
|
1356
|
-
* @property {string} mode - A string that specifies the mode of payment.
|
|
1357
|
+
* @property {string} mode - A string that specifies the mode of payment. Refer
|
|
1358
|
+
* to [API & references (in Nav bar) → Payment Modes] for a list of valid
|
|
1359
|
+
* payment methods.
|
|
1357
1360
|
* @property {string} refund_by - A string that indicates the entity responsible
|
|
1358
1361
|
* for processing refunds.
|
|
1359
1362
|
* @property {string} name - A string representing the name of the payment method.
|
|
@@ -3059,6 +3062,8 @@ const Joi = require("joi");
|
|
|
3059
3062
|
* used in the transaction.
|
|
3060
3063
|
* @property {number} [amount_to_be_collected] - Total amount to be collected in
|
|
3061
3064
|
* scenarios involving multiple payment methods.
|
|
3065
|
+
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
3066
|
+
* when the customer applies loyalty program points while placing the order.
|
|
3062
3067
|
*/
|
|
3063
3068
|
|
|
3064
3069
|
/**
|
|
@@ -3147,6 +3152,8 @@ const Joi = require("joi");
|
|
|
3147
3152
|
* purchased by the customer, usable for future transactions.
|
|
3148
3153
|
* @property {number} [amount_to_be_collected] - Amount to be collected from the
|
|
3149
3154
|
* customer when multiple payment methods are utilized for a single order.
|
|
3155
|
+
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
3156
|
+
* when the customer applies loyalty program points while placing the order.
|
|
3150
3157
|
*/
|
|
3151
3158
|
|
|
3152
3159
|
/**
|
|
@@ -3241,6 +3248,8 @@ const Joi = require("joi");
|
|
|
3241
3248
|
* @property {boolean} added_to_fynd_cash - Indicates whether the amount has
|
|
3242
3249
|
* been added to Fynd cash for future use.
|
|
3243
3250
|
* @property {TaxComponent[]} [taxes] - Applied Tax Components
|
|
3251
|
+
* @property {number} [loyalty_discount] - Amount reduced from the payable price
|
|
3252
|
+
* when the customer applies loyalty program points while placing the order.
|
|
3244
3253
|
*/
|
|
3245
3254
|
|
|
3246
3255
|
/**
|
|
@@ -3820,6 +3829,17 @@ const Joi = require("joi");
|
|
|
3820
3829
|
* to the invoice, which may include related documents or resources.
|
|
3821
3830
|
*/
|
|
3822
3831
|
|
|
3832
|
+
/**
|
|
3833
|
+
* @typedef LoyaltyDiscountDetails
|
|
3834
|
+
* @property {number} [discount] - Discount amount applied by redeeming loyalty
|
|
3835
|
+
* points while placing the order. Represents the monetary value of loyalty
|
|
3836
|
+
* points redeemed.
|
|
3837
|
+
* @property {string} [ownership] - Indicates who bears the cost of the loyalty
|
|
3838
|
+
* discount, such as the seller or the marketplace.
|
|
3839
|
+
* @property {boolean} [is_applied] - Specifies whether the loyalty discount has
|
|
3840
|
+
* been applied to the order.
|
|
3841
|
+
*/
|
|
3842
|
+
|
|
3823
3843
|
/**
|
|
3824
3844
|
* @typedef OrderDetailsData
|
|
3825
3845
|
* @property {string} [order_date] - Represents the date and time when the order
|
|
@@ -3849,6 +3869,7 @@ const Joi = require("joi");
|
|
|
3849
3869
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
3850
3870
|
* @property {string} [ordering_source] - To uniquely identify the source
|
|
3851
3871
|
* through which order has been placed (e.g, marketplace, gofynd).
|
|
3872
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
3852
3873
|
* @property {Object} [meta] - Meta data of the order contains additional,
|
|
3853
3874
|
* potentially dynamic information about the order.
|
|
3854
3875
|
*/
|
|
@@ -4690,6 +4711,7 @@ const Joi = require("joi");
|
|
|
4690
4711
|
* is created, including mobile applications, web interfaces, social media
|
|
4691
4712
|
* integrations, or external APIs.
|
|
4692
4713
|
* @property {CurrencySchema} [currency]
|
|
4714
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
4693
4715
|
*/
|
|
4694
4716
|
|
|
4695
4717
|
/**
|
|
@@ -4765,6 +4787,7 @@ const Joi = require("joi");
|
|
|
4765
4787
|
* @property {CurrencyInfo} [currency_info]
|
|
4766
4788
|
* @property {Prices} [prices]
|
|
4767
4789
|
* @property {OrderingCurrencyPrices} [ordering_currency_prices]
|
|
4790
|
+
* @property {LoyaltyDiscountDetails} [loyalty_discount_details]
|
|
4768
4791
|
*/
|
|
4769
4792
|
|
|
4770
4793
|
/**
|
|
@@ -6430,6 +6453,7 @@ class OrderPlatformModel {
|
|
|
6430
6453
|
ordering_channel_logo: Joi.string().allow("").allow(null),
|
|
6431
6454
|
prices: OrderPlatformModel.Prices(),
|
|
6432
6455
|
charges: Joi.array().items(OrderPlatformModel.PriceAdjustmentCharge()),
|
|
6456
|
+
loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
|
|
6433
6457
|
});
|
|
6434
6458
|
}
|
|
6435
6459
|
|
|
@@ -8249,6 +8273,7 @@ class OrderPlatformModel {
|
|
|
8249
8273
|
fynd_credits: Joi.number().allow(null),
|
|
8250
8274
|
gift_price: Joi.number().allow(null),
|
|
8251
8275
|
amount_to_be_collected: Joi.number().allow(null),
|
|
8276
|
+
loyalty_discount: Joi.number(),
|
|
8252
8277
|
});
|
|
8253
8278
|
}
|
|
8254
8279
|
|
|
@@ -8320,6 +8345,7 @@ class OrderPlatformModel {
|
|
|
8320
8345
|
fynd_credits: Joi.number().allow(null),
|
|
8321
8346
|
gift_price: Joi.number().allow(null),
|
|
8322
8347
|
amount_to_be_collected: Joi.number().allow(null),
|
|
8348
|
+
loyalty_discount: Joi.number(),
|
|
8323
8349
|
});
|
|
8324
8350
|
}
|
|
8325
8351
|
|
|
@@ -8376,6 +8402,7 @@ class OrderPlatformModel {
|
|
|
8376
8402
|
total_units: Joi.number().required(),
|
|
8377
8403
|
added_to_fynd_cash: Joi.boolean().required(),
|
|
8378
8404
|
taxes: Joi.array().items(OrderPlatformModel.TaxComponent()),
|
|
8405
|
+
loyalty_discount: Joi.number(),
|
|
8379
8406
|
});
|
|
8380
8407
|
}
|
|
8381
8408
|
|
|
@@ -8520,7 +8547,7 @@ class OrderPlatformModel {
|
|
|
8520
8547
|
box_type: Joi.string().allow("").allow(null),
|
|
8521
8548
|
quantity: Joi.number().allow(null),
|
|
8522
8549
|
size_level_total_qty: Joi.number().allow(null),
|
|
8523
|
-
loyalty_discount: Joi.number()
|
|
8550
|
+
loyalty_discount: Joi.number(),
|
|
8524
8551
|
replacement_details: OrderPlatformModel.ReplacementDetails(),
|
|
8525
8552
|
channel_shipment_id: Joi.string().allow("").allow(null),
|
|
8526
8553
|
marketplace_invoice_id: Joi.string().allow("").allow(null),
|
|
@@ -8540,7 +8567,7 @@ class OrderPlatformModel {
|
|
|
8540
8567
|
affiliate_order_id: Joi.string().allow("").required(),
|
|
8541
8568
|
employee_discount: Joi.number().allow(null),
|
|
8542
8569
|
affiliate_bag_id: Joi.string().allow("").required(),
|
|
8543
|
-
loyalty_discount: Joi.number()
|
|
8570
|
+
loyalty_discount: Joi.number(),
|
|
8544
8571
|
});
|
|
8545
8572
|
}
|
|
8546
8573
|
|
|
@@ -8772,6 +8799,15 @@ class OrderPlatformModel {
|
|
|
8772
8799
|
});
|
|
8773
8800
|
}
|
|
8774
8801
|
|
|
8802
|
+
/** @returns {LoyaltyDiscountDetails} */
|
|
8803
|
+
static LoyaltyDiscountDetails() {
|
|
8804
|
+
return Joi.object({
|
|
8805
|
+
discount: Joi.number(),
|
|
8806
|
+
ownership: Joi.string().allow(""),
|
|
8807
|
+
is_applied: Joi.boolean(),
|
|
8808
|
+
});
|
|
8809
|
+
}
|
|
8810
|
+
|
|
8775
8811
|
/** @returns {OrderDetailsData} */
|
|
8776
8812
|
static OrderDetailsData() {
|
|
8777
8813
|
return Joi.object({
|
|
@@ -8789,6 +8825,7 @@ class OrderPlatformModel {
|
|
|
8789
8825
|
order_value: Joi.string().allow("").allow(null),
|
|
8790
8826
|
ordering_channel: Joi.string().allow("").allow(null),
|
|
8791
8827
|
ordering_source: Joi.string().allow(""),
|
|
8828
|
+
loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
|
|
8792
8829
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
8793
8830
|
});
|
|
8794
8831
|
}
|
|
@@ -9424,6 +9461,7 @@ class OrderPlatformModel {
|
|
|
9424
9461
|
affiliate_id: Joi.string().allow(""),
|
|
9425
9462
|
source: Joi.string().allow(""),
|
|
9426
9463
|
currency: OrderPlatformModel.CurrencySchema(),
|
|
9464
|
+
loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
|
|
9427
9465
|
});
|
|
9428
9466
|
}
|
|
9429
9467
|
|
|
@@ -9501,6 +9539,7 @@ class OrderPlatformModel {
|
|
|
9501
9539
|
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
9502
9540
|
prices: OrderPlatformModel.Prices(),
|
|
9503
9541
|
ordering_currency_prices: OrderPlatformModel.OrderingCurrencyPrices(),
|
|
9542
|
+
loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
|
|
9504
9543
|
});
|
|
9505
9544
|
}
|
|
9506
9545
|
|
|
@@ -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 }?:
|
|
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
|
-
/**
|
|
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():
|
|
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
|
-
/**
|
|
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} */
|