@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -19,7 +19,8 @@ declare class Catalog {
|
|
|
19
19
|
getHomeProducts: string;
|
|
20
20
|
getInStockLocations: string;
|
|
21
21
|
getLocationDetailsById: string;
|
|
22
|
-
|
|
22
|
+
getProductBundleItems: string;
|
|
23
|
+
getProductBundlesByChildSku: string;
|
|
23
24
|
getProductComparisonBySlugs: string;
|
|
24
25
|
getProductDetailBySlug: string;
|
|
25
26
|
getProductPriceBySlug: string;
|
|
@@ -29,10 +30,10 @@ declare class Catalog {
|
|
|
29
30
|
getProductStockForTimeByIds: string;
|
|
30
31
|
getProductVariantsBySlug: string;
|
|
31
32
|
getProducts: string;
|
|
32
|
-
getProductsServiceability: string;
|
|
33
33
|
getSearchResults: string;
|
|
34
34
|
getSimilarComparisonProductBySlug: string;
|
|
35
35
|
getStores: string;
|
|
36
|
+
listCountryCurrencyMappings: string;
|
|
36
37
|
unfollowById: string;
|
|
37
38
|
};
|
|
38
39
|
_urls: {};
|
|
@@ -40,30 +41,30 @@ declare class Catalog {
|
|
|
40
41
|
/**
|
|
41
42
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
43
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
43
|
-
* @returns {Promise<
|
|
44
|
+
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
44
45
|
* @name followById
|
|
45
46
|
* @summary: Create item, brand, product
|
|
46
|
-
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://
|
|
47
|
+
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/followById/).
|
|
47
48
|
*/
|
|
48
|
-
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
49
|
+
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
49
50
|
/**
|
|
50
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
52
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<
|
|
53
|
+
* @returns {Promise<BrandDetailResponseSchema>} - Success response
|
|
53
54
|
* @name getBrandDetailBySlug
|
|
54
55
|
* @summary: Get a brand
|
|
55
|
-
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
56
|
+
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrandDetailBySlug/).
|
|
56
57
|
*/
|
|
57
|
-
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
58
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BrandDetailResponseSchema>;
|
|
58
59
|
/**
|
|
59
60
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
60
61
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
|
-
* @returns {Promise<
|
|
62
|
+
* @returns {Promise<BrandListingResponseSchema>} - Success response
|
|
62
63
|
* @name getBrands
|
|
63
64
|
* @summary: List brands
|
|
64
|
-
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://
|
|
65
|
+
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrands/).
|
|
65
66
|
*/
|
|
66
|
-
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
67
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponseSchema>;
|
|
67
68
|
/**
|
|
68
69
|
* @param {Object} arg - Arg object.
|
|
69
70
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -71,50 +72,50 @@ declare class Catalog {
|
|
|
71
72
|
* of available departments below. Also, you can get available departments
|
|
72
73
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
73
74
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
74
|
-
* @returns {Paginator<
|
|
75
|
+
* @returns {Paginator<BrandListingResponseSchema>}
|
|
75
76
|
* @summary: List brands
|
|
76
77
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
77
78
|
*/
|
|
78
79
|
getBrandsPaginator({ department, pageSize }?: {
|
|
79
80
|
department?: string;
|
|
80
81
|
pageSize?: number;
|
|
81
|
-
}): Paginator<
|
|
82
|
+
}): Paginator<BrandListingResponseSchema>;
|
|
82
83
|
/**
|
|
83
84
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
85
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
85
|
-
* @returns {Promise<
|
|
86
|
+
* @returns {Promise<CategoryListingResponseSchema>} - Success response
|
|
86
87
|
* @name getCategories
|
|
87
88
|
* @summary: List product categories
|
|
88
|
-
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://
|
|
89
|
+
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategories/).
|
|
89
90
|
*/
|
|
90
|
-
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
91
|
+
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponseSchema>;
|
|
91
92
|
/**
|
|
92
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
93
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
94
|
-
* @returns {Promise<
|
|
95
|
+
* @returns {Promise<CategoryMetaResponseSchema>} - Success response
|
|
95
96
|
* @name getCategoryDetailBySlug
|
|
96
97
|
* @summary: Get category by slug
|
|
97
|
-
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
98
|
+
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
98
99
|
*/
|
|
99
|
-
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
100
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CategoryMetaResponseSchema>;
|
|
100
101
|
/**
|
|
101
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
103
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
103
|
-
* @returns {Promise<
|
|
104
|
+
* @returns {Promise<CollectionDetailResponseSchema>} - Success response
|
|
104
105
|
* @name getCollectionDetailBySlug
|
|
105
106
|
* @summary: Get a collection
|
|
106
|
-
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://
|
|
107
|
+
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
107
108
|
*/
|
|
108
|
-
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
109
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CollectionDetailResponseSchema>;
|
|
109
110
|
/**
|
|
110
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
111
112
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
112
|
-
* @returns {Promise<
|
|
113
|
+
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
113
114
|
* @name getCollectionItemsBySlug
|
|
114
115
|
* @summary: Lists items of collection
|
|
115
|
-
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://
|
|
116
|
+
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
116
117
|
*/
|
|
117
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
118
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductListingResponseSchema>;
|
|
118
119
|
/**
|
|
119
120
|
* @param {Object} arg - Arg object.
|
|
120
121
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -129,10 +130,12 @@ declare class Catalog {
|
|
|
129
130
|
* @param {boolean} [arg.filters] - True for fetching all filter parameters
|
|
130
131
|
* and False for disabling the filter parameters.
|
|
131
132
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
132
|
-
* should be sorted
|
|
133
|
-
*
|
|
133
|
+
* should be sorted. Supported values include latest, popular, price_asc,
|
|
134
|
+
* price_dsc, discount_asc, discount_dsc. Custom sort keys configured via
|
|
135
|
+
* listing configuration (e.g., best_selling) are also supported for
|
|
136
|
+
* cohort-based sorting.
|
|
134
137
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
135
|
-
* @returns {Paginator<
|
|
138
|
+
* @returns {Paginator<ProductListingResponseSchema>}
|
|
136
139
|
* @summary: Lists items of collection
|
|
137
140
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
138
141
|
*/
|
|
@@ -143,22 +146,22 @@ declare class Catalog {
|
|
|
143
146
|
filters?: boolean;
|
|
144
147
|
sortOn?: string;
|
|
145
148
|
pageSize?: number;
|
|
146
|
-
}): Paginator<
|
|
149
|
+
}): Paginator<ProductListingResponseSchema>;
|
|
147
150
|
/**
|
|
148
151
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
149
152
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
150
|
-
* @returns {Promise<
|
|
153
|
+
* @returns {Promise<GetCollectionListingResponseSchema>} - Success response
|
|
151
154
|
* @name getCollections
|
|
152
155
|
* @summary: List collections
|
|
153
|
-
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://
|
|
156
|
+
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollections/).
|
|
154
157
|
*/
|
|
155
|
-
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
158
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponseSchema>;
|
|
156
159
|
/**
|
|
157
160
|
* @param {Object} arg - Arg object.
|
|
158
161
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
159
162
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
160
163
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
161
|
-
* @returns {Paginator<
|
|
164
|
+
* @returns {Paginator<GetCollectionListingResponseSchema>}
|
|
162
165
|
* @summary: List collections
|
|
163
166
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
164
167
|
*/
|
|
@@ -166,95 +169,96 @@ declare class Catalog {
|
|
|
166
169
|
pageSize?: number;
|
|
167
170
|
tag?: string[];
|
|
168
171
|
q?: string;
|
|
169
|
-
}): Paginator<
|
|
172
|
+
}): Paginator<GetCollectionListingResponseSchema>;
|
|
170
173
|
/**
|
|
171
174
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
175
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
173
|
-
* @returns {Promise<
|
|
176
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponseSchema>} -
|
|
177
|
+
* Success response
|
|
174
178
|
* @name getComparedFrequentlyProductBySlug
|
|
175
179
|
* @summary: List frequent products
|
|
176
|
-
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://
|
|
180
|
+
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
177
181
|
*/
|
|
178
|
-
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
182
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductFrequentlyComparedSimilarResponseSchema>;
|
|
179
183
|
/**
|
|
180
184
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
185
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<
|
|
186
|
+
* @returns {Promise<DepartmentResponseSchema>} - Success response
|
|
183
187
|
* @name getDepartments
|
|
184
188
|
* @summary: List departments
|
|
185
|
-
* @description: List all departments associated with available products. - Check out [method documentation](https://
|
|
189
|
+
* @description: List all departments associated with available products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getDepartments/).
|
|
186
190
|
*/
|
|
187
|
-
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
191
|
+
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponseSchema>;
|
|
188
192
|
/**
|
|
189
193
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
190
194
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
191
|
-
* @returns {Promise<
|
|
195
|
+
* @returns {Promise<FollowIdsResponseSchema>} - Success response
|
|
192
196
|
* @name getFollowIds
|
|
193
197
|
* @summary: List Ids of followed item, brand, product
|
|
194
|
-
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://
|
|
198
|
+
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowIds/).
|
|
195
199
|
*/
|
|
196
|
-
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
200
|
+
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponseSchema>;
|
|
197
201
|
/**
|
|
198
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
199
203
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
200
|
-
* @returns {Promise<
|
|
204
|
+
* @returns {Promise<GetFollowListingResponseSchema>} - Success response
|
|
201
205
|
* @name getFollowedListing
|
|
202
206
|
* @summary: List followed products, brands
|
|
203
|
-
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://
|
|
207
|
+
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowedListing/).
|
|
204
208
|
*/
|
|
205
|
-
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
209
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFollowListingResponseSchema>;
|
|
206
210
|
/**
|
|
207
211
|
* @param {Object} arg - Arg object.
|
|
208
212
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
209
213
|
* products, brands, or collections.
|
|
210
214
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
211
|
-
* @returns {Paginator<
|
|
215
|
+
* @returns {Paginator<GetFollowListingResponseSchema>}
|
|
212
216
|
* @summary: List followed products, brands
|
|
213
217
|
* @description: Get a list of products or brands the user is following.
|
|
214
218
|
*/
|
|
215
219
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
216
220
|
collectionType: string;
|
|
217
221
|
pageSize?: number;
|
|
218
|
-
}): Paginator<
|
|
222
|
+
}): Paginator<GetFollowListingResponseSchema>;
|
|
219
223
|
/**
|
|
220
224
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
221
225
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
222
|
-
* @returns {Promise<
|
|
226
|
+
* @returns {Promise<FollowerCountResponseSchema>} - Success response
|
|
223
227
|
* @name getFollowerCountById
|
|
224
228
|
* @summary: Get follower count
|
|
225
|
-
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://
|
|
229
|
+
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowerCountById/).
|
|
226
230
|
*/
|
|
227
|
-
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
231
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowerCountResponseSchema>;
|
|
228
232
|
/**
|
|
229
233
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
230
234
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
231
|
-
* @returns {Promise<
|
|
235
|
+
* @returns {Promise<HomeListingResponseSchema>} - Success response
|
|
232
236
|
* @name getHomeProducts
|
|
233
237
|
* @summary: List homepage-featured products
|
|
234
|
-
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://
|
|
238
|
+
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getHomeProducts/).
|
|
235
239
|
*/
|
|
236
|
-
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
240
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponseSchema>;
|
|
237
241
|
/**
|
|
238
242
|
* @param {Object} arg - Arg object.
|
|
239
243
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
240
244
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
241
245
|
* either ascending or descending order.
|
|
242
246
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
243
|
-
* @returns {Paginator<
|
|
247
|
+
* @returns {Paginator<HomeListingResponseSchema>}
|
|
244
248
|
* @summary: List homepage-featured products
|
|
245
249
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
246
250
|
*/
|
|
247
251
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
248
252
|
sortOn?: string;
|
|
249
253
|
pageSize?: number;
|
|
250
|
-
}): Paginator<
|
|
254
|
+
}): Paginator<HomeListingResponseSchema>;
|
|
251
255
|
/**
|
|
252
256
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
253
257
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
254
258
|
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
255
259
|
* @name getInStockLocations
|
|
256
260
|
* @summary: List stores with inventory
|
|
257
|
-
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://
|
|
261
|
+
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getInStockLocations/).
|
|
258
262
|
*/
|
|
259
263
|
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationStoreListing>;
|
|
260
264
|
/**
|
|
@@ -286,54 +290,63 @@ declare class Catalog {
|
|
|
286
290
|
* @returns {Promise<StoreDetails>} - Success response
|
|
287
291
|
* @name getLocationDetailsById
|
|
288
292
|
* @summary: Get selling location
|
|
289
|
-
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://
|
|
293
|
+
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getLocationDetailsById/).
|
|
290
294
|
*/
|
|
291
295
|
getLocationDetailsById({ locationId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<StoreDetails>;
|
|
292
296
|
/**
|
|
293
297
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
294
298
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
295
|
-
* @returns {Promise<
|
|
296
|
-
* @name
|
|
297
|
-
* @summary:
|
|
298
|
-
* @description:
|
|
299
|
+
* @returns {Promise<ProductBundleItems>} - Success response
|
|
300
|
+
* @name getProductBundleItems
|
|
301
|
+
* @summary: Get children for a bundled product
|
|
302
|
+
* @description: Retrieve bundle children for a given bundled product slug with pricing, brand, media, and seller information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductBundleItems/).
|
|
299
303
|
*/
|
|
300
|
-
|
|
304
|
+
getProductBundleItems({ slug, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductBundleItems>;
|
|
301
305
|
/**
|
|
302
306
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
307
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
304
|
-
* @returns {Promise<
|
|
308
|
+
* @returns {Promise<ProductBundleItemsWithSlug>} - Success response
|
|
309
|
+
* @name getProductBundlesByChildSku
|
|
310
|
+
* @summary: Get bundled items for a specific product size
|
|
311
|
+
* @description: Retrieve bundled items for a given product slug and size with pricing, brand, media, and seller information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductBundlesByChildSku/).
|
|
312
|
+
*/
|
|
313
|
+
getProductBundlesByChildSku({ slug, size, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductBundleItemsWithSlug>;
|
|
314
|
+
/**
|
|
315
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
316
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
317
|
+
* @returns {Promise<ProductsComparisonResponseSchema>} - Success response
|
|
305
318
|
* @name getProductComparisonBySlugs
|
|
306
319
|
* @summary: List products for comparison
|
|
307
|
-
* @description: Get all the products that have the same category. - Check out [method documentation](https://
|
|
320
|
+
* @description: Get all the products that have the same category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
308
321
|
*/
|
|
309
|
-
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
322
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponseSchema>;
|
|
310
323
|
/**
|
|
311
324
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
312
325
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
313
326
|
* @returns {Promise<ProductDetail>} - Success response
|
|
314
327
|
* @name getProductDetailBySlug
|
|
315
328
|
* @summary: Get a product
|
|
316
|
-
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://
|
|
329
|
+
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductDetailBySlug/).
|
|
317
330
|
*/
|
|
318
331
|
getProductDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductDetail>;
|
|
319
332
|
/**
|
|
320
333
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
321
334
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
322
|
-
* @returns {Promise<
|
|
335
|
+
* @returns {Promise<ProductSizePriceResponseV4>} - Success response
|
|
323
336
|
* @name getProductPriceBySlug
|
|
324
337
|
* @summary: Get product price
|
|
325
|
-
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://
|
|
338
|
+
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
|
|
326
339
|
*/
|
|
327
|
-
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
340
|
+
getProductPriceBySlug({ slug, size, storeId, moq, fulfillmentOptionSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
|
|
328
341
|
/**
|
|
329
342
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
343
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
331
|
-
* @returns {Promise<
|
|
344
|
+
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
332
345
|
* @name getProductSellersBySlug
|
|
333
346
|
* @summary: List sellers
|
|
334
|
-
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://
|
|
347
|
+
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
335
348
|
*/
|
|
336
|
-
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
349
|
+
getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
337
350
|
/**
|
|
338
351
|
* @param {Object} arg - Arg object.
|
|
339
352
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -344,42 +357,45 @@ declare class Catalog {
|
|
|
344
357
|
* /service/application/catalog/v1.0/products/sizes.
|
|
345
358
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
346
359
|
* eg, fast-delivery, low-price, optimal.
|
|
360
|
+
* @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
|
|
361
|
+
* method, indicating whether an order is for home delivery or store pickup
|
|
347
362
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
348
|
-
* @returns {Paginator<
|
|
363
|
+
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
349
364
|
* @summary: List sellers
|
|
350
365
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
351
366
|
*/
|
|
352
|
-
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
|
|
367
|
+
getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, }?: {
|
|
353
368
|
slug: string;
|
|
354
369
|
size: string;
|
|
355
370
|
strategy?: string;
|
|
371
|
+
fulfillmentOptionSlug?: string;
|
|
356
372
|
pageSize?: number;
|
|
357
|
-
}): Paginator<
|
|
373
|
+
}): Paginator<ProductSizeSellersResponseV4>;
|
|
358
374
|
/**
|
|
359
375
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
360
376
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
361
377
|
* @returns {Promise<ProductSizes>} - Success response
|
|
362
378
|
* @name getProductSizesBySlug
|
|
363
379
|
* @summary: List sizes
|
|
364
|
-
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://
|
|
380
|
+
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSizesBySlug/).
|
|
365
381
|
*/
|
|
366
382
|
getProductSizesBySlug({ slug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizes>;
|
|
367
383
|
/**
|
|
368
384
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
369
385
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
370
|
-
* @returns {Promise<
|
|
386
|
+
* @returns {Promise<ProductStockStatusResponseSchema>} - Success response
|
|
371
387
|
* @name getProductStockByIds
|
|
372
388
|
* @summary: Get product stocks
|
|
373
|
-
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://
|
|
389
|
+
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockByIds/).
|
|
374
390
|
*/
|
|
375
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
391
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponseSchema>;
|
|
376
392
|
/**
|
|
377
393
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
378
394
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
379
395
|
* @returns {Promise<ProductStockPolling>} - Success response
|
|
380
396
|
* @name getProductStockForTimeByIds
|
|
381
397
|
* @summary: List future stock
|
|
382
|
-
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://
|
|
398
|
+
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
383
399
|
*/
|
|
384
400
|
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockPolling>;
|
|
385
401
|
/**
|
|
@@ -397,21 +413,21 @@ declare class Catalog {
|
|
|
397
413
|
/**
|
|
398
414
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
399
415
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
400
|
-
* @returns {Promise<
|
|
416
|
+
* @returns {Promise<ProductVariantsResponseSchema>} - Success response
|
|
401
417
|
* @name getProductVariantsBySlug
|
|
402
418
|
* @summary: List product variants
|
|
403
|
-
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://
|
|
419
|
+
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductVariantsBySlug/).
|
|
404
420
|
*/
|
|
405
|
-
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
421
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductVariantsResponseSchema>;
|
|
406
422
|
/**
|
|
407
423
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
408
424
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
409
|
-
* @returns {Promise<
|
|
425
|
+
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
410
426
|
* @name getProducts
|
|
411
427
|
* @summary: List products
|
|
412
|
-
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://
|
|
428
|
+
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProducts/).
|
|
413
429
|
*/
|
|
414
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
430
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponseSchema>;
|
|
415
431
|
/**
|
|
416
432
|
* @param {Object} arg - Arg object.
|
|
417
433
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -423,10 +439,12 @@ declare class Catalog {
|
|
|
423
439
|
* @param {boolean} [arg.filters] - True for fetching all filter parameters
|
|
424
440
|
* and False for disabling the filter parameters.
|
|
425
441
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
426
|
-
* should be sorted
|
|
427
|
-
*
|
|
442
|
+
* should be sorted. Supported values include latest, popular, price_asc,
|
|
443
|
+
* price_dsc, discount_asc, discount_dsc. Custom sort keys configured via
|
|
444
|
+
* listing configuration (e.g., best_selling) are also supported for
|
|
445
|
+
* cohort-based sorting.
|
|
428
446
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
429
|
-
* @returns {Paginator<
|
|
447
|
+
* @returns {Paginator<ProductListingResponseSchema>}
|
|
430
448
|
* @summary: List products
|
|
431
449
|
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
|
|
432
450
|
*/
|
|
@@ -436,43 +454,34 @@ declare class Catalog {
|
|
|
436
454
|
filters?: boolean;
|
|
437
455
|
sortOn?: string;
|
|
438
456
|
pageSize?: number;
|
|
439
|
-
}): Paginator<
|
|
440
|
-
/**
|
|
441
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
442
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
443
|
-
* @returns {Promise<ProductSizePriceServiceabilityResponse>} - Success response
|
|
444
|
-
* @name getProductsServiceability
|
|
445
|
-
* @summary: get size price for multiple products,For serviceability
|
|
446
|
-
* @description: Get size price for multiple products, For serviceability, with reduced size of response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductsServiceability/).
|
|
447
|
-
*/
|
|
448
|
-
getProductsServiceability({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductSizePriceServiceabilityResponse>;
|
|
457
|
+
}): Paginator<ProductListingResponseSchema>;
|
|
449
458
|
/**
|
|
450
459
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
460
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<
|
|
461
|
+
* @returns {Promise<AutoCompleteResponseSchema>} - Success response
|
|
453
462
|
* @name getSearchResults
|
|
454
463
|
* @summary: List product, brand, category
|
|
455
|
-
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://
|
|
464
|
+
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSearchResults/).
|
|
456
465
|
*/
|
|
457
|
-
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
466
|
+
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponseSchema>;
|
|
458
467
|
/**
|
|
459
468
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
460
469
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
461
|
-
* @returns {Promise<
|
|
470
|
+
* @returns {Promise<ProductCompareResponseSchema>} - Success response
|
|
462
471
|
* @name getSimilarComparisonProductBySlug
|
|
463
472
|
* @summary: List similar products
|
|
464
|
-
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://
|
|
473
|
+
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
465
474
|
*/
|
|
466
|
-
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
475
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductCompareResponseSchema>;
|
|
467
476
|
/**
|
|
468
477
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
469
478
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
470
|
-
* @returns {Promise<
|
|
479
|
+
* @returns {Promise<StoreListingResponseSchema>} - Success response
|
|
471
480
|
* @name getStores
|
|
472
481
|
* @summary: List available stores
|
|
473
|
-
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://
|
|
482
|
+
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getStores/).
|
|
474
483
|
*/
|
|
475
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
484
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponseSchema>;
|
|
476
485
|
/**
|
|
477
486
|
* @param {Object} arg - Arg object.
|
|
478
487
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -485,7 +494,7 @@ declare class Catalog {
|
|
|
485
494
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
486
495
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
487
496
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
488
|
-
* @returns {Paginator<
|
|
497
|
+
* @returns {Paginator<StoreListingResponseSchema>}
|
|
489
498
|
* @summary: List available stores
|
|
490
499
|
* @description: List all stores associated with the sales channel.
|
|
491
500
|
*/
|
|
@@ -497,15 +506,24 @@ declare class Catalog {
|
|
|
497
506
|
latitude?: number;
|
|
498
507
|
longitude?: number;
|
|
499
508
|
tags?: string;
|
|
500
|
-
}): Paginator<
|
|
509
|
+
}): Paginator<StoreListingResponseSchema>;
|
|
510
|
+
/**
|
|
511
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
512
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
513
|
+
* @returns {Promise<AvailableCountrySchema>} - Success response
|
|
514
|
+
* @name listCountryCurrencyMappings
|
|
515
|
+
* @summary: List country to currency mapping
|
|
516
|
+
* @description: List all country-to-currencies mappings configured during the Price Factory setup for given application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/listCountryCurrencyMappings/).
|
|
517
|
+
*/
|
|
518
|
+
listCountryCurrencyMappings({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AvailableCountrySchema>;
|
|
501
519
|
/**
|
|
502
520
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
503
521
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
504
|
-
* @returns {Promise<
|
|
522
|
+
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
505
523
|
* @name unfollowById
|
|
506
524
|
* @summary: Delete item, brand, product
|
|
507
|
-
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://
|
|
525
|
+
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/unfollowById/).
|
|
508
526
|
*/
|
|
509
|
-
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
527
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
510
528
|
}
|
|
511
529
|
import Paginator = require("../../common/Paginator");
|