@gofynd/fdk-client-javascript 3.17.0 → 3.17.2
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 +40 -0
- package/sdk/application/Cart/CartApplicationClient.js +176 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
- package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +11 -1
- package/sdk/application/Content/ContentApplicationClient.js +40 -2
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.js +2 -0
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
- package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +72 -10
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +634 -33
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +951 -1
- package/sdk/platform/Cart/CartPlatformModel.js +597 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +123 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +829 -39
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1023 -31
- package/sdk/platform/Catalog/CatalogPlatformModel.js +841 -26
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +7 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +3 -3
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -8
- package/sdk/platform/Content/ContentPlatformModel.js +11 -8
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -2
- package/sdk/platform/Order/OrderPlatformModel.js +9 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +356 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +229 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
|
@@ -365,6 +365,8 @@ export = CatalogPlatformValidator;
|
|
|
365
365
|
* @typedef GetTaxVersionDetailsParam
|
|
366
366
|
* @property {string} ruleId - The ID of the tax rule.
|
|
367
367
|
* @property {string} [versionStatus] - Filter by tax version status.
|
|
368
|
+
* @property {string} [q] - Case-insensitive search by region name (e.g., "raj",
|
|
369
|
+
* "New York") to find matching tax versions.
|
|
368
370
|
* @property {string} [limit] - The number of items to return per page for
|
|
369
371
|
* paginated past versions.
|
|
370
372
|
* @property {string} [page] - The page number for paginated past versions.
|
|
@@ -1395,6 +1397,11 @@ type GetTaxVersionDetailsParam = {
|
|
|
1395
1397
|
* - Filter by tax version status.
|
|
1396
1398
|
*/
|
|
1397
1399
|
versionStatus?: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* - Case-insensitive search by region name (e.g., "raj",
|
|
1402
|
+
* "New York") to find matching tax versions.
|
|
1403
|
+
*/
|
|
1404
|
+
q?: string;
|
|
1398
1405
|
/**
|
|
1399
1406
|
* - The number of items to return per page for
|
|
1400
1407
|
* paginated past versions.
|
|
@@ -429,6 +429,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
429
429
|
* @typedef GetTaxVersionDetailsParam
|
|
430
430
|
* @property {string} ruleId - The ID of the tax rule.
|
|
431
431
|
* @property {string} [versionStatus] - Filter by tax version status.
|
|
432
|
+
* @property {string} [q] - Case-insensitive search by region name (e.g., "raj",
|
|
433
|
+
* "New York") to find matching tax versions.
|
|
432
434
|
* @property {string} [limit] - The number of items to return per page for
|
|
433
435
|
* paginated past versions.
|
|
434
436
|
* @property {string} [page] - The page number for paginated past versions.
|
|
@@ -1124,6 +1126,7 @@ class CatalogPlatformValidator {
|
|
|
1124
1126
|
return Joi.object({
|
|
1125
1127
|
ruleId: Joi.string().allow("").required(),
|
|
1126
1128
|
versionStatus: Joi.string().allow(""),
|
|
1129
|
+
q: Joi.string().allow(""),
|
|
1127
1130
|
limit: Joi.string().allow(""),
|
|
1128
1131
|
page: Joi.string().allow(""),
|
|
1129
1132
|
}).required();
|
|
@@ -662,6 +662,8 @@ export = CommunicationPlatformModel;
|
|
|
662
662
|
* @property {SendOtpCommsReqData} [data]
|
|
663
663
|
* @property {SendOtpCommsReqSms} [sms]
|
|
664
664
|
* @property {SendOtpCommsReqEmail} [email]
|
|
665
|
+
* @property {Object} [additional_variables] - Additional data in key-value
|
|
666
|
+
* format where values can be of any type
|
|
665
667
|
*/
|
|
666
668
|
/**
|
|
667
669
|
* @typedef SendOtpCommsRes
|
|
@@ -1708,6 +1710,11 @@ type SendOtpCommsReq = {
|
|
|
1708
1710
|
data?: SendOtpCommsReqData;
|
|
1709
1711
|
sms?: SendOtpCommsReqSms;
|
|
1710
1712
|
email?: SendOtpCommsReqEmail;
|
|
1713
|
+
/**
|
|
1714
|
+
* - Additional data in key-value
|
|
1715
|
+
* format where values can be of any type
|
|
1716
|
+
*/
|
|
1717
|
+
additional_variables?: any;
|
|
1711
1718
|
};
|
|
1712
1719
|
/** @returns {SendOtpCommsRes} */
|
|
1713
1720
|
declare function SendOtpCommsRes(): SendOtpCommsRes;
|
|
@@ -757,6 +757,8 @@ const Joi = require("joi");
|
|
|
757
757
|
* @property {SendOtpCommsReqData} [data]
|
|
758
758
|
* @property {SendOtpCommsReqSms} [sms]
|
|
759
759
|
* @property {SendOtpCommsReqEmail} [email]
|
|
760
|
+
* @property {Object} [additional_variables] - Additional data in key-value
|
|
761
|
+
* format where values can be of any type
|
|
760
762
|
*/
|
|
761
763
|
|
|
762
764
|
/**
|
|
@@ -1992,6 +1994,7 @@ class CommunicationPlatformModel {
|
|
|
1992
1994
|
data: CommunicationPlatformModel.SendOtpCommsReqData(),
|
|
1993
1995
|
sms: CommunicationPlatformModel.SendOtpCommsReqSms(),
|
|
1994
1996
|
email: CommunicationPlatformModel.SendOtpCommsReqEmail(),
|
|
1997
|
+
additional_variables: Joi.object().pattern(/\S/, Joi.any()),
|
|
1995
1998
|
});
|
|
1996
1999
|
}
|
|
1997
2000
|
|
|
@@ -86,6 +86,14 @@ export = ConfigurationPlatformModel;
|
|
|
86
86
|
* @property {InventoryCategory} [category]
|
|
87
87
|
* @property {InventoryPrice} [price]
|
|
88
88
|
* @property {InventoryDiscount} [discount]
|
|
89
|
+
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
90
|
+
* enabled or not in an application.
|
|
91
|
+
* @property {boolean} [international] - Indicates whether internation price
|
|
92
|
+
* factory enabled or not in an application.
|
|
93
|
+
* @property {boolean} [strategy_change_pending] - Indicates whether price
|
|
94
|
+
* strategy change is pending or not in an application.
|
|
95
|
+
* @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known
|
|
96
|
+
* modifications to the sales channel feature configuration
|
|
89
97
|
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
90
98
|
* are allowed to show up on the website
|
|
91
99
|
* @property {boolean} [only_verified_products] - Show only verified products
|
|
@@ -917,8 +925,17 @@ export = ConfigurationPlatformModel;
|
|
|
917
925
|
* @property {QrFeature} [qr]
|
|
918
926
|
* @property {PcrFeature} [pcr]
|
|
919
927
|
* @property {OrderFeature} [order]
|
|
928
|
+
* @property {SecurityFeature} [security]
|
|
920
929
|
* @property {BuyboxFeature} [buybox]
|
|
921
930
|
* @property {DeliveryStrategy} [delivery_strategy]
|
|
931
|
+
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
932
|
+
* enabled or not in an application.
|
|
933
|
+
* @property {boolean} [international] - Indicates whether internation price
|
|
934
|
+
* factory enabled or not in an application.
|
|
935
|
+
* @property {boolean} [strategy_change_pending] - Indicates whether price
|
|
936
|
+
* strategy change is pending or not in an application.
|
|
937
|
+
* @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known
|
|
938
|
+
* modifications to the sales channel feature configuration
|
|
922
939
|
* @property {FulfillmentOption} [fulfillment_option]
|
|
923
940
|
* @property {string} [_id] - The unique identifier for the sales channel features
|
|
924
941
|
* @property {string} [app] - Application ID of the sales channel
|
|
@@ -1022,6 +1039,17 @@ export = ConfigurationPlatformModel;
|
|
|
1022
1039
|
* @property {boolean} [buy_again] - Allow buy again option for order. Default
|
|
1023
1040
|
* value is false.
|
|
1024
1041
|
*/
|
|
1042
|
+
/**
|
|
1043
|
+
* @typedef SecurityFeature
|
|
1044
|
+
* @property {AllowedDomain[]} [domains] - List of allowed domains for security
|
|
1045
|
+
* restrictions.
|
|
1046
|
+
*/
|
|
1047
|
+
/**
|
|
1048
|
+
* @typedef AllowedDomain
|
|
1049
|
+
* @property {string} host - The host URL for the allowed domain.
|
|
1050
|
+
* @property {string} [url_scheme] - The protocol/scheme to use for the domain.
|
|
1051
|
+
* Default is https.
|
|
1052
|
+
*/
|
|
1025
1053
|
/**
|
|
1026
1054
|
* @typedef AppFeatureRequestSchema
|
|
1027
1055
|
* @property {AppFeature} [feature]
|
|
@@ -1415,7 +1443,7 @@ export = ConfigurationPlatformModel;
|
|
|
1415
1443
|
declare class ConfigurationPlatformModel {
|
|
1416
1444
|
}
|
|
1417
1445
|
declare namespace ConfigurationPlatformModel {
|
|
1418
|
-
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1446
|
+
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, SecurityFeature, AllowedDomain, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1419
1447
|
}
|
|
1420
1448
|
/** @returns {CurrencyExchangeResponseV2} */
|
|
1421
1449
|
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
@@ -1585,6 +1613,26 @@ type AppInventoryConfig = {
|
|
|
1585
1613
|
category?: InventoryCategory;
|
|
1586
1614
|
price?: InventoryPrice;
|
|
1587
1615
|
discount?: InventoryDiscount;
|
|
1616
|
+
/**
|
|
1617
|
+
* - Indicates whether price strategy
|
|
1618
|
+
* enabled or not in an application.
|
|
1619
|
+
*/
|
|
1620
|
+
price_strategy?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* - Indicates whether internation price
|
|
1623
|
+
* factory enabled or not in an application.
|
|
1624
|
+
*/
|
|
1625
|
+
international?: boolean;
|
|
1626
|
+
/**
|
|
1627
|
+
* - Indicates whether price
|
|
1628
|
+
* strategy change is pending or not in an application.
|
|
1629
|
+
*/
|
|
1630
|
+
strategy_change_pending?: boolean;
|
|
1631
|
+
/**
|
|
1632
|
+
* - ISO 8601 timestamp of last known
|
|
1633
|
+
* modifications to the sales channel feature configuration
|
|
1634
|
+
*/
|
|
1635
|
+
strategy_modified_at?: string;
|
|
1588
1636
|
/**
|
|
1589
1637
|
* - Indicates whether out of stock products
|
|
1590
1638
|
* are allowed to show up on the website
|
|
@@ -3253,8 +3301,29 @@ type AppFeature = {
|
|
|
3253
3301
|
qr?: QrFeature;
|
|
3254
3302
|
pcr?: PcrFeature;
|
|
3255
3303
|
order?: OrderFeature;
|
|
3304
|
+
security?: SecurityFeature;
|
|
3256
3305
|
buybox?: BuyboxFeature;
|
|
3257
3306
|
delivery_strategy?: DeliveryStrategy;
|
|
3307
|
+
/**
|
|
3308
|
+
* - Indicates whether price strategy
|
|
3309
|
+
* enabled or not in an application.
|
|
3310
|
+
*/
|
|
3311
|
+
price_strategy?: string;
|
|
3312
|
+
/**
|
|
3313
|
+
* - Indicates whether internation price
|
|
3314
|
+
* factory enabled or not in an application.
|
|
3315
|
+
*/
|
|
3316
|
+
international?: boolean;
|
|
3317
|
+
/**
|
|
3318
|
+
* - Indicates whether price
|
|
3319
|
+
* strategy change is pending or not in an application.
|
|
3320
|
+
*/
|
|
3321
|
+
strategy_change_pending?: boolean;
|
|
3322
|
+
/**
|
|
3323
|
+
* - ISO 8601 timestamp of last known
|
|
3324
|
+
* modifications to the sales channel feature configuration
|
|
3325
|
+
*/
|
|
3326
|
+
strategy_modified_at?: string;
|
|
3258
3327
|
fulfillment_option?: FulfillmentOption;
|
|
3259
3328
|
/**
|
|
3260
3329
|
* - The unique identifier for the sales channel features
|
|
@@ -3456,6 +3525,28 @@ type OrderFeature = {
|
|
|
3456
3525
|
*/
|
|
3457
3526
|
buy_again?: boolean;
|
|
3458
3527
|
};
|
|
3528
|
+
/** @returns {SecurityFeature} */
|
|
3529
|
+
declare function SecurityFeature(): SecurityFeature;
|
|
3530
|
+
type SecurityFeature = {
|
|
3531
|
+
/**
|
|
3532
|
+
* - List of allowed domains for security
|
|
3533
|
+
* restrictions.
|
|
3534
|
+
*/
|
|
3535
|
+
domains?: AllowedDomain[];
|
|
3536
|
+
};
|
|
3537
|
+
/** @returns {AllowedDomain} */
|
|
3538
|
+
declare function AllowedDomain(): AllowedDomain;
|
|
3539
|
+
type AllowedDomain = {
|
|
3540
|
+
/**
|
|
3541
|
+
* - The host URL for the allowed domain.
|
|
3542
|
+
*/
|
|
3543
|
+
host: string;
|
|
3544
|
+
/**
|
|
3545
|
+
* - The protocol/scheme to use for the domain.
|
|
3546
|
+
* Default is https.
|
|
3547
|
+
*/
|
|
3548
|
+
url_scheme?: string;
|
|
3549
|
+
};
|
|
3459
3550
|
/** @returns {AppFeatureRequestSchema} */
|
|
3460
3551
|
declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
|
|
3461
3552
|
type AppFeatureRequestSchema = {
|
|
@@ -95,6 +95,14 @@ const Joi = require("joi");
|
|
|
95
95
|
* @property {InventoryCategory} [category]
|
|
96
96
|
* @property {InventoryPrice} [price]
|
|
97
97
|
* @property {InventoryDiscount} [discount]
|
|
98
|
+
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
99
|
+
* enabled or not in an application.
|
|
100
|
+
* @property {boolean} [international] - Indicates whether internation price
|
|
101
|
+
* factory enabled or not in an application.
|
|
102
|
+
* @property {boolean} [strategy_change_pending] - Indicates whether price
|
|
103
|
+
* strategy change is pending or not in an application.
|
|
104
|
+
* @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known
|
|
105
|
+
* modifications to the sales channel feature configuration
|
|
98
106
|
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
99
107
|
* are allowed to show up on the website
|
|
100
108
|
* @property {boolean} [only_verified_products] - Show only verified products
|
|
@@ -1040,8 +1048,17 @@ const Joi = require("joi");
|
|
|
1040
1048
|
* @property {QrFeature} [qr]
|
|
1041
1049
|
* @property {PcrFeature} [pcr]
|
|
1042
1050
|
* @property {OrderFeature} [order]
|
|
1051
|
+
* @property {SecurityFeature} [security]
|
|
1043
1052
|
* @property {BuyboxFeature} [buybox]
|
|
1044
1053
|
* @property {DeliveryStrategy} [delivery_strategy]
|
|
1054
|
+
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
1055
|
+
* enabled or not in an application.
|
|
1056
|
+
* @property {boolean} [international] - Indicates whether internation price
|
|
1057
|
+
* factory enabled or not in an application.
|
|
1058
|
+
* @property {boolean} [strategy_change_pending] - Indicates whether price
|
|
1059
|
+
* strategy change is pending or not in an application.
|
|
1060
|
+
* @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known
|
|
1061
|
+
* modifications to the sales channel feature configuration
|
|
1045
1062
|
* @property {FulfillmentOption} [fulfillment_option]
|
|
1046
1063
|
* @property {string} [_id] - The unique identifier for the sales channel features
|
|
1047
1064
|
* @property {string} [app] - Application ID of the sales channel
|
|
@@ -1160,6 +1177,19 @@ const Joi = require("joi");
|
|
|
1160
1177
|
* value is false.
|
|
1161
1178
|
*/
|
|
1162
1179
|
|
|
1180
|
+
/**
|
|
1181
|
+
* @typedef SecurityFeature
|
|
1182
|
+
* @property {AllowedDomain[]} [domains] - List of allowed domains for security
|
|
1183
|
+
* restrictions.
|
|
1184
|
+
*/
|
|
1185
|
+
|
|
1186
|
+
/**
|
|
1187
|
+
* @typedef AllowedDomain
|
|
1188
|
+
* @property {string} host - The host URL for the allowed domain.
|
|
1189
|
+
* @property {string} [url_scheme] - The protocol/scheme to use for the domain.
|
|
1190
|
+
* Default is https.
|
|
1191
|
+
*/
|
|
1192
|
+
|
|
1163
1193
|
/**
|
|
1164
1194
|
* @typedef AppFeatureRequestSchema
|
|
1165
1195
|
* @property {AppFeature} [feature]
|
|
@@ -1697,6 +1727,10 @@ class ConfigurationPlatformModel {
|
|
|
1697
1727
|
category: ConfigurationPlatformModel.InventoryCategory(),
|
|
1698
1728
|
price: ConfigurationPlatformModel.InventoryPrice(),
|
|
1699
1729
|
discount: ConfigurationPlatformModel.InventoryDiscount(),
|
|
1730
|
+
price_strategy: Joi.string().allow(""),
|
|
1731
|
+
international: Joi.boolean(),
|
|
1732
|
+
strategy_change_pending: Joi.boolean(),
|
|
1733
|
+
strategy_modified_at: Joi.string().allow(""),
|
|
1700
1734
|
out_of_stock: Joi.boolean(),
|
|
1701
1735
|
only_verified_products: Joi.boolean(),
|
|
1702
1736
|
franchise_enabled: Joi.boolean(),
|
|
@@ -2755,8 +2789,13 @@ class ConfigurationPlatformModel {
|
|
|
2755
2789
|
qr: ConfigurationPlatformModel.QrFeature(),
|
|
2756
2790
|
pcr: ConfigurationPlatformModel.PcrFeature(),
|
|
2757
2791
|
order: ConfigurationPlatformModel.OrderFeature(),
|
|
2792
|
+
security: ConfigurationPlatformModel.SecurityFeature(),
|
|
2758
2793
|
buybox: ConfigurationPlatformModel.BuyboxFeature(),
|
|
2759
2794
|
delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
|
|
2795
|
+
price_strategy: Joi.string().allow(""),
|
|
2796
|
+
international: Joi.boolean(),
|
|
2797
|
+
strategy_change_pending: Joi.boolean(),
|
|
2798
|
+
strategy_modified_at: Joi.string().allow(""),
|
|
2760
2799
|
fulfillment_option: ConfigurationPlatformModel.FulfillmentOption(),
|
|
2761
2800
|
_id: Joi.string().allow(""),
|
|
2762
2801
|
app: Joi.string().allow(""),
|
|
@@ -2883,6 +2922,21 @@ class ConfigurationPlatformModel {
|
|
|
2883
2922
|
});
|
|
2884
2923
|
}
|
|
2885
2924
|
|
|
2925
|
+
/** @returns {SecurityFeature} */
|
|
2926
|
+
static SecurityFeature() {
|
|
2927
|
+
return Joi.object({
|
|
2928
|
+
domains: Joi.array().items(ConfigurationPlatformModel.AllowedDomain()),
|
|
2929
|
+
});
|
|
2930
|
+
}
|
|
2931
|
+
|
|
2932
|
+
/** @returns {AllowedDomain} */
|
|
2933
|
+
static AllowedDomain() {
|
|
2934
|
+
return Joi.object({
|
|
2935
|
+
host: Joi.string().allow("").required(),
|
|
2936
|
+
url_scheme: Joi.string().allow(""),
|
|
2937
|
+
});
|
|
2938
|
+
}
|
|
2939
|
+
|
|
2886
2940
|
/** @returns {AppFeatureRequestSchema} */
|
|
2887
2941
|
static AppFeatureRequestSchema() {
|
|
2888
2942
|
return Joi.object({
|
|
@@ -269,8 +269,8 @@ export = ContentPlatformApplicationValidator;
|
|
|
269
269
|
/** @typedef GetDefaultNavigationsParam */
|
|
270
270
|
/**
|
|
271
271
|
* @typedef GetDefaultSEOMarkupSchemaParam
|
|
272
|
-
* @property {
|
|
273
|
-
* template was created
|
|
272
|
+
* @property {ContentPlatformModel.PageType} [pageType] - The type of page
|
|
273
|
+
* against which schema template was created
|
|
274
274
|
*/
|
|
275
275
|
/**
|
|
276
276
|
* @typedef GetFaqByIdOrSlugParam
|
|
@@ -1023,10 +1023,10 @@ type GetDataLoadersByServiceParam = {
|
|
|
1023
1023
|
};
|
|
1024
1024
|
type GetDefaultSEOMarkupSchemaParam = {
|
|
1025
1025
|
/**
|
|
1026
|
-
* - The type of page
|
|
1027
|
-
* template was created
|
|
1026
|
+
* - The type of page
|
|
1027
|
+
* against which schema template was created
|
|
1028
1028
|
*/
|
|
1029
|
-
pageType?:
|
|
1029
|
+
pageType?: ContentPlatformModel.PageType;
|
|
1030
1030
|
};
|
|
1031
1031
|
type GetFaqByIdOrSlugParam = {
|
|
1032
1032
|
/**
|
|
@@ -330,8 +330,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
330
330
|
|
|
331
331
|
/**
|
|
332
332
|
* @typedef GetDefaultSEOMarkupSchemaParam
|
|
333
|
-
* @property {
|
|
334
|
-
* template was created
|
|
333
|
+
* @property {ContentPlatformModel.PageType} [pageType] - The type of page
|
|
334
|
+
* against which schema template was created
|
|
335
335
|
*/
|
|
336
336
|
|
|
337
337
|
/**
|
|
@@ -1059,7 +1059,7 @@ class ContentPlatformApplicationValidator {
|
|
|
1059
1059
|
/** @returns {GetDefaultSEOMarkupSchemaParam} */
|
|
1060
1060
|
static getDefaultSEOMarkupSchema() {
|
|
1061
1061
|
return Joi.object({
|
|
1062
|
-
pageType:
|
|
1062
|
+
pageType: ContentPlatformModel.PageType(),
|
|
1063
1063
|
}).required();
|
|
1064
1064
|
}
|
|
1065
1065
|
|
|
@@ -86,7 +86,7 @@ export = ContentPlatformModel;
|
|
|
86
86
|
* @typedef SEOSchemaMarkupTemplate
|
|
87
87
|
* @property {string} [id]
|
|
88
88
|
* @property {string} [title]
|
|
89
|
-
* @property {
|
|
89
|
+
* @property {PageType} [page_type]
|
|
90
90
|
* @property {string} [schema]
|
|
91
91
|
* @property {string} [description]
|
|
92
92
|
* @property {boolean} [active]
|
|
@@ -98,7 +98,7 @@ export = ContentPlatformModel;
|
|
|
98
98
|
/**
|
|
99
99
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
100
100
|
* @property {string} [title]
|
|
101
|
-
* @property {
|
|
101
|
+
* @property {PageType} [page_type]
|
|
102
102
|
* @property {string} [schema]
|
|
103
103
|
* @property {string} [description]
|
|
104
104
|
* @property {Object} [target_json]
|
|
@@ -143,7 +143,7 @@ export = ContentPlatformModel;
|
|
|
143
143
|
*/
|
|
144
144
|
/**
|
|
145
145
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
146
|
-
* @property {
|
|
146
|
+
* @property {PageType} [page_type]
|
|
147
147
|
* @property {string} [schema]
|
|
148
148
|
* @property {Object} [target_json]
|
|
149
149
|
*/
|
|
@@ -1623,7 +1623,8 @@ export = ContentPlatformModel;
|
|
|
1623
1623
|
* | "order-status"
|
|
1624
1624
|
* | "locate-us"
|
|
1625
1625
|
* | "single-page-checkout"
|
|
1626
|
-
* | "request-reattempt"
|
|
1626
|
+
* | "request-reattempt"
|
|
1627
|
+
* | "files"} PageType
|
|
1627
1628
|
*/
|
|
1628
1629
|
declare class ContentPlatformModel {
|
|
1629
1630
|
}
|
|
@@ -1736,7 +1737,7 @@ declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
|
|
|
1736
1737
|
type SEOSchemaMarkupTemplate = {
|
|
1737
1738
|
id?: string;
|
|
1738
1739
|
title?: string;
|
|
1739
|
-
page_type?:
|
|
1740
|
+
page_type?: PageType;
|
|
1740
1741
|
schema?: string;
|
|
1741
1742
|
description?: string;
|
|
1742
1743
|
active?: boolean;
|
|
@@ -1749,7 +1750,7 @@ type SEOSchemaMarkupTemplate = {
|
|
|
1749
1750
|
declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
|
|
1750
1751
|
type SEOSchemaMarkupTemplateRequestBody = {
|
|
1751
1752
|
title?: string;
|
|
1752
|
-
page_type?:
|
|
1753
|
+
page_type?: PageType;
|
|
1753
1754
|
schema?: string;
|
|
1754
1755
|
description?: string;
|
|
1755
1756
|
target_json?: any;
|
|
@@ -1800,7 +1801,7 @@ type DefaultSchemaComponent = {
|
|
|
1800
1801
|
/** @returns {DefaultSEOSchemaMarkupTemplate} */
|
|
1801
1802
|
declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplate;
|
|
1802
1803
|
type DefaultSEOSchemaMarkupTemplate = {
|
|
1803
|
-
page_type?:
|
|
1804
|
+
page_type?: PageType;
|
|
1804
1805
|
schema?: string;
|
|
1805
1806
|
target_json?: any;
|
|
1806
1807
|
};
|
|
@@ -4649,4 +4650,4 @@ type GenerationEntityType = "title" | "description";
|
|
|
4649
4650
|
* @returns {PageType}
|
|
4650
4651
|
*/
|
|
4651
4652
|
declare function PageType(): PageType;
|
|
4652
|
-
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt";
|
|
4653
|
+
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
|
|
@@ -99,7 +99,7 @@ const Joi = require("joi");
|
|
|
99
99
|
* @typedef SEOSchemaMarkupTemplate
|
|
100
100
|
* @property {string} [id]
|
|
101
101
|
* @property {string} [title]
|
|
102
|
-
* @property {
|
|
102
|
+
* @property {PageType} [page_type]
|
|
103
103
|
* @property {string} [schema]
|
|
104
104
|
* @property {string} [description]
|
|
105
105
|
* @property {boolean} [active]
|
|
@@ -112,7 +112,7 @@ const Joi = require("joi");
|
|
|
112
112
|
/**
|
|
113
113
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
114
114
|
* @property {string} [title]
|
|
115
|
-
* @property {
|
|
115
|
+
* @property {PageType} [page_type]
|
|
116
116
|
* @property {string} [schema]
|
|
117
117
|
* @property {string} [description]
|
|
118
118
|
* @property {Object} [target_json]
|
|
@@ -163,7 +163,7 @@ const Joi = require("joi");
|
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
165
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
166
|
-
* @property {
|
|
166
|
+
* @property {PageType} [page_type]
|
|
167
167
|
* @property {string} [schema]
|
|
168
168
|
* @property {Object} [target_json]
|
|
169
169
|
*/
|
|
@@ -1825,7 +1825,8 @@ const Joi = require("joi");
|
|
|
1825
1825
|
* | "order-status"
|
|
1826
1826
|
* | "locate-us"
|
|
1827
1827
|
* | "single-page-checkout"
|
|
1828
|
-
* | "request-reattempt"
|
|
1828
|
+
* | "request-reattempt"
|
|
1829
|
+
* | "files"} PageType
|
|
1829
1830
|
*/
|
|
1830
1831
|
|
|
1831
1832
|
class ContentPlatformModel {
|
|
@@ -1953,7 +1954,7 @@ class ContentPlatformModel {
|
|
|
1953
1954
|
return Joi.object({
|
|
1954
1955
|
id: Joi.string().allow(""),
|
|
1955
1956
|
title: Joi.string().allow(""),
|
|
1956
|
-
page_type:
|
|
1957
|
+
page_type: ContentPlatformModel.PageType(),
|
|
1957
1958
|
schema: Joi.string().allow(""),
|
|
1958
1959
|
description: Joi.string().allow(""),
|
|
1959
1960
|
active: Joi.boolean(),
|
|
@@ -1968,7 +1969,7 @@ class ContentPlatformModel {
|
|
|
1968
1969
|
static SEOSchemaMarkupTemplateRequestBody() {
|
|
1969
1970
|
return Joi.object({
|
|
1970
1971
|
title: Joi.string().allow(""),
|
|
1971
|
-
page_type:
|
|
1972
|
+
page_type: ContentPlatformModel.PageType(),
|
|
1972
1973
|
schema: Joi.string().allow(""),
|
|
1973
1974
|
description: Joi.string().allow(""),
|
|
1974
1975
|
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
@@ -2033,7 +2034,7 @@ class ContentPlatformModel {
|
|
|
2033
2034
|
/** @returns {DefaultSEOSchemaMarkupTemplate} */
|
|
2034
2035
|
static DefaultSEOSchemaMarkupTemplate() {
|
|
2035
2036
|
return Joi.object({
|
|
2036
|
-
page_type:
|
|
2037
|
+
page_type: ContentPlatformModel.PageType(),
|
|
2037
2038
|
schema: Joi.string().allow(""),
|
|
2038
2039
|
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2039
2040
|
});
|
|
@@ -4064,7 +4065,9 @@ class ContentPlatformModel {
|
|
|
4064
4065
|
|
|
4065
4066
|
"single-page-checkout",
|
|
4066
4067
|
|
|
4067
|
-
"request-reattempt"
|
|
4068
|
+
"request-reattempt",
|
|
4069
|
+
|
|
4070
|
+
"files"
|
|
4068
4071
|
);
|
|
4069
4072
|
}
|
|
4070
4073
|
}
|
|
@@ -20,6 +20,8 @@ export = DiscountPlatformModel;
|
|
|
20
20
|
* @property {number[]} [brand_ids] - List of brand IDs associated with the discount.
|
|
21
21
|
* @property {number[]} [store_ids] - List of store IDs associated with the discount.
|
|
22
22
|
* @property {string[]} [zone_ids] - List of zone IDs associated with the discount.
|
|
23
|
+
* @property {string[]} [price_factory_ids] - List of price_factory IDs
|
|
24
|
+
* associated with the discount.
|
|
23
25
|
* @property {ValidityObject} validity
|
|
24
26
|
* @property {DiscountMeta} [discount_meta]
|
|
25
27
|
*/
|
|
@@ -48,6 +50,8 @@ export = DiscountPlatformModel;
|
|
|
48
50
|
* @property {number[]} [brand_ids] - List of brand IDs associated with the discount job.
|
|
49
51
|
* @property {number[]} [store_ids] - List of store IDs associated with the discount job.
|
|
50
52
|
* @property {string[]} [zone_ids] - List of zone IDs associated with the discount job.
|
|
53
|
+
* @property {string[]} [price_factory_ids] - List of price_factory IDs
|
|
54
|
+
* associated with the discount.
|
|
51
55
|
* @property {DiscountMeta} [discount_meta]
|
|
52
56
|
* @property {ValidityObject} validity
|
|
53
57
|
* @property {string} created_on - The date and time when the discount job was created.
|
|
@@ -129,6 +133,8 @@ export = DiscountPlatformModel;
|
|
|
129
133
|
* @property {string} [file_path] - Path to the disocunt file.
|
|
130
134
|
* @property {number[]} [brand_ids] - List of brand identifiers.
|
|
131
135
|
* @property {number[]} [store_ids] - List of store identifiers.
|
|
136
|
+
* @property {string[]} [price_factory_ids] - List of price_factory IDs
|
|
137
|
+
* associated with the discount.
|
|
132
138
|
* @property {ValidityObject} validity
|
|
133
139
|
* @property {Object} [meta] - Additional metadata for the disocunt.
|
|
134
140
|
*/
|
|
@@ -244,6 +250,11 @@ type CreateUpdateDiscount = {
|
|
|
244
250
|
* - List of zone IDs associated with the discount.
|
|
245
251
|
*/
|
|
246
252
|
zone_ids?: string[];
|
|
253
|
+
/**
|
|
254
|
+
* - List of price_factory IDs
|
|
255
|
+
* associated with the discount.
|
|
256
|
+
*/
|
|
257
|
+
price_factory_ids?: string[];
|
|
247
258
|
validity: ValidityObject;
|
|
248
259
|
discount_meta?: DiscountMeta;
|
|
249
260
|
};
|
|
@@ -322,6 +333,11 @@ type DiscountJob = {
|
|
|
322
333
|
* - List of zone IDs associated with the discount job.
|
|
323
334
|
*/
|
|
324
335
|
zone_ids?: string[];
|
|
336
|
+
/**
|
|
337
|
+
* - List of price_factory IDs
|
|
338
|
+
* associated with the discount.
|
|
339
|
+
*/
|
|
340
|
+
price_factory_ids?: string[];
|
|
325
341
|
discount_meta?: DiscountMeta;
|
|
326
342
|
validity: ValidityObject;
|
|
327
343
|
/**
|
|
@@ -559,6 +575,11 @@ type FileJobRequestSchema = {
|
|
|
559
575
|
* - List of store identifiers.
|
|
560
576
|
*/
|
|
561
577
|
store_ids?: number[];
|
|
578
|
+
/**
|
|
579
|
+
* - List of price_factory IDs
|
|
580
|
+
* associated with the discount.
|
|
581
|
+
*/
|
|
582
|
+
price_factory_ids?: string[];
|
|
562
583
|
validity: ValidityObject;
|
|
563
584
|
/**
|
|
564
585
|
* - Additional metadata for the disocunt.
|
|
@@ -22,6 +22,8 @@ const Joi = require("joi");
|
|
|
22
22
|
* @property {number[]} [brand_ids] - List of brand IDs associated with the discount.
|
|
23
23
|
* @property {number[]} [store_ids] - List of store IDs associated with the discount.
|
|
24
24
|
* @property {string[]} [zone_ids] - List of zone IDs associated with the discount.
|
|
25
|
+
* @property {string[]} [price_factory_ids] - List of price_factory IDs
|
|
26
|
+
* associated with the discount.
|
|
25
27
|
* @property {ValidityObject} validity
|
|
26
28
|
* @property {DiscountMeta} [discount_meta]
|
|
27
29
|
*/
|
|
@@ -52,6 +54,8 @@ const Joi = require("joi");
|
|
|
52
54
|
* @property {number[]} [brand_ids] - List of brand IDs associated with the discount job.
|
|
53
55
|
* @property {number[]} [store_ids] - List of store IDs associated with the discount job.
|
|
54
56
|
* @property {string[]} [zone_ids] - List of zone IDs associated with the discount job.
|
|
57
|
+
* @property {string[]} [price_factory_ids] - List of price_factory IDs
|
|
58
|
+
* associated with the discount.
|
|
55
59
|
* @property {DiscountMeta} [discount_meta]
|
|
56
60
|
* @property {ValidityObject} validity
|
|
57
61
|
* @property {string} created_on - The date and time when the discount job was created.
|
|
@@ -139,6 +143,8 @@ const Joi = require("joi");
|
|
|
139
143
|
* @property {string} [file_path] - Path to the disocunt file.
|
|
140
144
|
* @property {number[]} [brand_ids] - List of brand identifiers.
|
|
141
145
|
* @property {number[]} [store_ids] - List of store identifiers.
|
|
146
|
+
* @property {string[]} [price_factory_ids] - List of price_factory IDs
|
|
147
|
+
* associated with the discount.
|
|
142
148
|
* @property {ValidityObject} validity
|
|
143
149
|
* @property {Object} [meta] - Additional metadata for the disocunt.
|
|
144
150
|
*/
|
|
@@ -214,6 +220,7 @@ class DiscountPlatformModel {
|
|
|
214
220
|
brand_ids: Joi.array().items(Joi.number()),
|
|
215
221
|
store_ids: Joi.array().items(Joi.number()),
|
|
216
222
|
zone_ids: Joi.array().items(Joi.string().allow("")),
|
|
223
|
+
price_factory_ids: Joi.array().items(Joi.string().allow("")),
|
|
217
224
|
validity: DiscountPlatformModel.ValidityObject().required(),
|
|
218
225
|
discount_meta: DiscountPlatformModel.DiscountMeta(),
|
|
219
226
|
});
|
|
@@ -244,6 +251,7 @@ class DiscountPlatformModel {
|
|
|
244
251
|
brand_ids: Joi.array().items(Joi.number()),
|
|
245
252
|
store_ids: Joi.array().items(Joi.number()),
|
|
246
253
|
zone_ids: Joi.array().items(Joi.string().allow("")),
|
|
254
|
+
price_factory_ids: Joi.array().items(Joi.string().allow("")),
|
|
247
255
|
discount_meta: DiscountPlatformModel.DiscountMeta(),
|
|
248
256
|
validity: DiscountPlatformModel.ValidityObject().required(),
|
|
249
257
|
created_on: Joi.string().allow("").required(),
|
|
@@ -344,6 +352,7 @@ class DiscountPlatformModel {
|
|
|
344
352
|
file_path: Joi.string().allow(""),
|
|
345
353
|
brand_ids: Joi.array().items(Joi.number()),
|
|
346
354
|
store_ids: Joi.array().items(Joi.number()),
|
|
355
|
+
price_factory_ids: Joi.array().items(Joi.string().allow("")),
|
|
347
356
|
validity: DiscountPlatformModel.ValidityObject().required(),
|
|
348
357
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
349
358
|
});
|
|
@@ -85,7 +85,7 @@ declare class Order {
|
|
|
85
85
|
* @returns {Promise<Object>} - Success response
|
|
86
86
|
* @name createOrder
|
|
87
87
|
* @summary: Create Order
|
|
88
|
-
* @description: Creates an order in the OMS.
|
|
88
|
+
* @description: Creates an order in the OMS. Use the (<a href='https://docs.fynd.com/partners/commerce/sdk/latest/platform/application/serviceability#createShipments'>createShipments API</a>) to determine shipments before creating an order. Click <a href='https://docs.fynd.com/partners/commerce/miscellaneous/createOrder-useCases'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
|
|
89
89
|
*/
|
|
90
90
|
createOrder({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<any>;
|
|
91
91
|
/**
|
|
@@ -866,7 +866,7 @@ declare class Order {
|
|
|
866
866
|
*
|
|
867
867
|
* @name updateShipmentStatus
|
|
868
868
|
* @summary: Update a shipment's status
|
|
869
|
-
* @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the
|
|
869
|
+
* @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
|
|
870
870
|
*/
|
|
871
871
|
updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
|
|
872
872
|
/**
|