@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1
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/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
- package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -39,30 +39,30 @@ declare class Catalog {
|
|
|
39
39
|
/**
|
|
40
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
41
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
|
-
* @returns {Promise<
|
|
42
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
43
43
|
* @name followById
|
|
44
|
-
* @summary:
|
|
44
|
+
* @summary: Follows an item by ID.
|
|
45
45
|
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
46
46
|
*/
|
|
47
|
-
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
47
|
+
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowPostResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
50
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
|
-
* @returns {Promise<
|
|
51
|
+
* @returns {Promise<BrandDetailResponse>} - Success response
|
|
52
52
|
* @name getBrandDetailBySlug
|
|
53
|
-
* @summary:
|
|
53
|
+
* @summary: Retrieves detailed brand info by slug.
|
|
54
54
|
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrandDetailBySlug/).
|
|
55
55
|
*/
|
|
56
|
-
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
56
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandDetailResponse>;
|
|
57
57
|
/**
|
|
58
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
59
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
60
|
-
* @returns {Promise<
|
|
60
|
+
* @returns {Promise<BrandListingResponse>} - Success response
|
|
61
61
|
* @name getBrands
|
|
62
|
-
* @summary:
|
|
62
|
+
* @summary: Fetches all available brands.
|
|
63
63
|
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
64
64
|
*/
|
|
65
|
-
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
65
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponse>;
|
|
66
66
|
/**
|
|
67
67
|
* @param {Object} arg - Arg object.
|
|
68
68
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -70,50 +70,50 @@ declare class Catalog {
|
|
|
70
70
|
* of available departments below. Also, you can get available departments
|
|
71
71
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
72
72
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
73
|
-
* @returns {Paginator<
|
|
74
|
-
* @summary:
|
|
73
|
+
* @returns {Paginator<BrandListingResponse>}
|
|
74
|
+
* @summary: Fetches all available brands.
|
|
75
75
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
76
76
|
*/
|
|
77
77
|
getBrandsPaginator({ department, pageSize }?: {
|
|
78
78
|
department?: string;
|
|
79
79
|
pageSize?: number;
|
|
80
|
-
}): Paginator<
|
|
80
|
+
}): Paginator<BrandListingResponse>;
|
|
81
81
|
/**
|
|
82
82
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
83
83
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
84
|
-
* @returns {Promise<
|
|
84
|
+
* @returns {Promise<CategoryListingResponse>} - Success response
|
|
85
85
|
* @name getCategories
|
|
86
|
-
* @summary:
|
|
86
|
+
* @summary: Lists all product categories.
|
|
87
87
|
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
88
88
|
*/
|
|
89
|
-
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
89
|
+
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponse>;
|
|
90
90
|
/**
|
|
91
91
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
92
92
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
93
|
-
* @returns {Promise<
|
|
93
|
+
* @returns {Promise<CategoryMetaResponse>} - Success response
|
|
94
94
|
* @name getCategoryDetailBySlug
|
|
95
|
-
* @summary:
|
|
95
|
+
* @summary: Retrieves category details by slug.
|
|
96
96
|
* @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://partners.fynd.com/help/docs/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
97
97
|
*/
|
|
98
|
-
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
98
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryMetaResponse>;
|
|
99
99
|
/**
|
|
100
100
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
101
101
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
102
|
-
* @returns {Promise<
|
|
102
|
+
* @returns {Promise<CollectionDetailResponse>} - Success response
|
|
103
103
|
* @name getCollectionDetailBySlug
|
|
104
|
-
* @summary:
|
|
104
|
+
* @summary: Retrieves collection details by slug.
|
|
105
105
|
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
106
106
|
*/
|
|
107
|
-
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
107
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CollectionDetailResponse>;
|
|
108
108
|
/**
|
|
109
109
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
110
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
111
|
-
* @returns {Promise<
|
|
111
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
112
112
|
* @name getCollectionItemsBySlug
|
|
113
|
-
* @summary: Lists items
|
|
113
|
+
* @summary: Lists items in a collection by slug.
|
|
114
114
|
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
115
115
|
*/
|
|
116
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
116
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponse>;
|
|
117
117
|
/**
|
|
118
118
|
* @param {Object} arg - Arg object.
|
|
119
119
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -131,8 +131,8 @@ declare class Catalog {
|
|
|
131
131
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
132
132
|
* either ascending or descending order. See the supported values below.
|
|
133
133
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
134
|
-
* @returns {Paginator<
|
|
135
|
-
* @summary: Lists items
|
|
134
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
135
|
+
* @summary: Lists items in a collection by slug.
|
|
136
136
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
137
137
|
*/
|
|
138
138
|
getCollectionItemsBySlugPaginator({ slug, f, q, filters, sortOn, pageSize, }?: {
|
|
@@ -142,118 +142,117 @@ declare class Catalog {
|
|
|
142
142
|
filters?: boolean;
|
|
143
143
|
sortOn?: string;
|
|
144
144
|
pageSize?: number;
|
|
145
|
-
}): Paginator<
|
|
145
|
+
}): Paginator<ProductListingResponse>;
|
|
146
146
|
/**
|
|
147
147
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
148
148
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
149
|
-
* @returns {Promise<
|
|
149
|
+
* @returns {Promise<GetCollectionListingResponse>} - Success response
|
|
150
150
|
* @name getCollections
|
|
151
|
-
* @summary:
|
|
151
|
+
* @summary: Fetches all available collections.
|
|
152
152
|
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
153
153
|
*/
|
|
154
|
-
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
154
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponse>;
|
|
155
155
|
/**
|
|
156
156
|
* @param {Object} arg - Arg object.
|
|
157
157
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
158
158
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
159
159
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
160
|
-
* @returns {Paginator<
|
|
161
|
-
* @summary:
|
|
160
|
+
* @returns {Paginator<GetCollectionListingResponse>}
|
|
161
|
+
* @summary: Fetches all available collections.
|
|
162
162
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
163
163
|
*/
|
|
164
164
|
getCollectionsPaginator({ pageSize, tag, q }?: {
|
|
165
165
|
pageSize?: number;
|
|
166
166
|
tag?: string[];
|
|
167
167
|
q?: string;
|
|
168
|
-
}): Paginator<
|
|
168
|
+
}): Paginator<GetCollectionListingResponse>;
|
|
169
169
|
/**
|
|
170
170
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
171
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
172
|
-
* @returns {Promise<
|
|
173
|
-
* Success response
|
|
172
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
|
|
174
173
|
* @name getComparedFrequentlyProductBySlug
|
|
175
|
-
* @summary:
|
|
174
|
+
* @summary: Retrieves products frequently compared with a given product.
|
|
176
175
|
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
177
176
|
*/
|
|
178
|
-
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
177
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductFrequentlyComparedSimilarResponse>;
|
|
179
178
|
/**
|
|
180
179
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
180
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<
|
|
181
|
+
* @returns {Promise<DepartmentResponse>} - Success response
|
|
183
182
|
* @name getDepartments
|
|
184
|
-
* @summary:
|
|
183
|
+
* @summary: Lists all departments.
|
|
185
184
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
186
185
|
*/
|
|
187
|
-
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
186
|
+
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponse>;
|
|
188
187
|
/**
|
|
189
188
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
190
189
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
191
|
-
* @returns {Promise<
|
|
190
|
+
* @returns {Promise<FollowIdsResponse>} - Success response
|
|
192
191
|
* @name getFollowIds
|
|
193
|
-
* @summary:
|
|
192
|
+
* @summary: Fetches IDs of followed items.
|
|
194
193
|
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
195
194
|
*/
|
|
196
|
-
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
195
|
+
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponse>;
|
|
197
196
|
/**
|
|
198
197
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
199
198
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
200
|
-
* @returns {Promise<
|
|
199
|
+
* @returns {Promise<GetFollowListingResponse>} - Success response
|
|
201
200
|
* @name getFollowedListing
|
|
202
|
-
* @summary:
|
|
201
|
+
* @summary: Retrieves user's followed listings.
|
|
203
202
|
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
204
203
|
*/
|
|
205
|
-
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
204
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetFollowListingResponse>;
|
|
206
205
|
/**
|
|
207
206
|
* @param {Object} arg - Arg object.
|
|
208
207
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
209
208
|
* products, brands, or collections.
|
|
210
209
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
211
|
-
* @returns {Paginator<
|
|
212
|
-
* @summary:
|
|
210
|
+
* @returns {Paginator<GetFollowListingResponse>}
|
|
211
|
+
* @summary: Retrieves user's followed listings.
|
|
213
212
|
* @description: Get a list of products or brands the user is following.
|
|
214
213
|
*/
|
|
215
214
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
216
215
|
collectionType: string;
|
|
217
216
|
pageSize?: number;
|
|
218
|
-
}): Paginator<
|
|
217
|
+
}): Paginator<GetFollowListingResponse>;
|
|
219
218
|
/**
|
|
220
219
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
221
220
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
222
|
-
* @returns {Promise<
|
|
221
|
+
* @returns {Promise<FollowerCountResponse>} - Success response
|
|
223
222
|
* @name getFollowerCountById
|
|
224
|
-
* @summary:
|
|
223
|
+
* @summary: Retrieves follower count for an item.
|
|
225
224
|
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
|
|
226
225
|
*/
|
|
227
|
-
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
226
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowerCountResponse>;
|
|
228
227
|
/**
|
|
229
228
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
230
229
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
231
|
-
* @returns {Promise<
|
|
230
|
+
* @returns {Promise<HomeListingResponse>} - Success response
|
|
232
231
|
* @name getHomeProducts
|
|
233
|
-
* @summary:
|
|
232
|
+
* @summary: Fetches homepage-featured products.
|
|
234
233
|
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getHomeProducts/).
|
|
235
234
|
*/
|
|
236
|
-
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
235
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponse>;
|
|
237
236
|
/**
|
|
238
237
|
* @param {Object} arg - Arg object.
|
|
239
238
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
240
239
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
241
240
|
* either ascending or descending order.
|
|
242
241
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
243
|
-
* @returns {Paginator<
|
|
244
|
-
* @summary:
|
|
242
|
+
* @returns {Paginator<HomeListingResponse>}
|
|
243
|
+
* @summary: Fetches homepage-featured products.
|
|
245
244
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
246
245
|
*/
|
|
247
246
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
248
247
|
sortOn?: string;
|
|
249
248
|
pageSize?: number;
|
|
250
|
-
}): Paginator<
|
|
249
|
+
}): Paginator<HomeListingResponse>;
|
|
251
250
|
/**
|
|
252
251
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
253
252
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
254
253
|
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
255
254
|
* @name getInStockLocations
|
|
256
|
-
* @summary:
|
|
255
|
+
* @summary: Get store meta information.
|
|
257
256
|
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
258
257
|
*/
|
|
259
258
|
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationStoreListing>;
|
|
@@ -269,7 +268,7 @@ declare class Catalog {
|
|
|
269
268
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
270
269
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
271
270
|
* @returns {Paginator<ApplicationStoreListing>}
|
|
272
|
-
* @summary:
|
|
271
|
+
* @summary: Get store meta information.
|
|
273
272
|
* @description: List stores where specified products are currently in stock.
|
|
274
273
|
*/
|
|
275
274
|
getInStockLocationsPaginator({ pageSize, q, city, range, latitude, longitude, }?: {
|
|
@@ -285,7 +284,7 @@ declare class Catalog {
|
|
|
285
284
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
286
285
|
* @returns {Promise<StoreDetails>} - Success response
|
|
287
286
|
* @name getLocationDetailsById
|
|
288
|
-
* @summary: Get
|
|
287
|
+
* @summary: Get store meta information.
|
|
289
288
|
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
290
289
|
*/
|
|
291
290
|
getLocationDetailsById({ locationId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreDetails>;
|
|
@@ -294,46 +293,46 @@ declare class Catalog {
|
|
|
294
293
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
295
294
|
* @returns {Promise<ProductBundle>} - Success response
|
|
296
295
|
* @name getProductBundlesBySlug
|
|
297
|
-
* @summary:
|
|
296
|
+
* @summary: Fetches product bundles by slug.
|
|
298
297
|
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
299
298
|
*/
|
|
300
|
-
getProductBundlesBySlug({ slug, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductBundle>;
|
|
299
|
+
getProductBundlesBySlug({ slug, id, size, sellerId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductBundle>;
|
|
301
300
|
/**
|
|
302
301
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
302
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
304
|
-
* @returns {Promise<
|
|
303
|
+
* @returns {Promise<ProductsComparisonResponse>} - Success response
|
|
305
304
|
* @name getProductComparisonBySlugs
|
|
306
|
-
* @summary:
|
|
305
|
+
* @summary: Compares multiple products by slugs.
|
|
307
306
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
308
307
|
*/
|
|
309
|
-
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
308
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponse>;
|
|
310
309
|
/**
|
|
311
310
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
312
311
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
313
312
|
* @returns {Promise<ProductDetail>} - Success response
|
|
314
313
|
* @name getProductDetailBySlug
|
|
315
|
-
* @summary:
|
|
314
|
+
* @summary: Fetches detailed product information by slug.
|
|
316
315
|
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
317
316
|
*/
|
|
318
317
|
getProductDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductDetail>;
|
|
319
318
|
/**
|
|
320
319
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
321
320
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
322
|
-
* @returns {Promise<
|
|
321
|
+
* @returns {Promise<ProductSizePriceResponseV1>} - Success response
|
|
323
322
|
* @name getProductPriceBySlug
|
|
324
|
-
* @summary:
|
|
323
|
+
* @summary: get size price for multiple products
|
|
325
324
|
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
|
|
326
325
|
*/
|
|
327
|
-
getProductPriceBySlug({
|
|
326
|
+
getProductPriceBySlug({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductSizePriceResponseV1>;
|
|
328
327
|
/**
|
|
329
328
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
329
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
331
|
-
* @returns {Promise<
|
|
330
|
+
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
332
331
|
* @name getProductSellersBySlug
|
|
333
|
-
* @summary:
|
|
332
|
+
* @summary: Get the sellers of a product size at a PIN Code
|
|
334
333
|
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
335
334
|
*/
|
|
336
|
-
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
335
|
+
getProductSellersBySlug({ slug, size, pincode, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductSizeSellersResponseV4>;
|
|
337
336
|
/**
|
|
338
337
|
* @param {Object} arg - Arg object.
|
|
339
338
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -342,43 +341,46 @@ declare class Catalog {
|
|
|
342
341
|
* @param {string} arg.size - A string indicating the size of the product,
|
|
343
342
|
* e.g. S, M, XL. You can get slug value from the endpoint
|
|
344
343
|
* /service/application/catalog/v1.0/products/sizes.
|
|
344
|
+
* @param {string} [arg.pincode] - The 6-digit PIN Code of the area near
|
|
345
|
+
* which the selling locations should be searched, e.g. 400059
|
|
345
346
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
346
347
|
* eg, fast-delivery, low-price, optimal.
|
|
347
348
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
348
|
-
* @returns {Paginator<
|
|
349
|
-
* @summary:
|
|
349
|
+
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
350
|
+
* @summary: Get the sellers of a product size at a PIN Code
|
|
350
351
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
351
352
|
*/
|
|
352
|
-
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
|
|
353
|
+
getProductSellersBySlugPaginator({ slug, size, pincode, strategy, pageSize, }?: {
|
|
353
354
|
slug: string;
|
|
354
355
|
size: string;
|
|
356
|
+
pincode?: string;
|
|
355
357
|
strategy?: string;
|
|
356
358
|
pageSize?: number;
|
|
357
|
-
}): Paginator<
|
|
359
|
+
}): Paginator<ProductSizeSellersResponseV4>;
|
|
358
360
|
/**
|
|
359
361
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
360
362
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
361
363
|
* @returns {Promise<ProductSizes>} - Success response
|
|
362
364
|
* @name getProductSizesBySlug
|
|
363
|
-
* @summary:
|
|
365
|
+
* @summary: Retrieves available sizes for a product by slug.
|
|
364
366
|
* @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://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
|
|
365
367
|
*/
|
|
366
368
|
getProductSizesBySlug({ slug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductSizes>;
|
|
367
369
|
/**
|
|
368
370
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
369
371
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
370
|
-
* @returns {Promise<
|
|
372
|
+
* @returns {Promise<ProductStockStatusResponse>} - Success response
|
|
371
373
|
* @name getProductStockByIds
|
|
372
|
-
* @summary:
|
|
374
|
+
* @summary: Checks product stock by IDs.
|
|
373
375
|
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
374
376
|
*/
|
|
375
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
377
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponse>;
|
|
376
378
|
/**
|
|
377
379
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
378
380
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
379
381
|
* @returns {Promise<ProductStockPolling>} - Success response
|
|
380
382
|
* @name getProductStockForTimeByIds
|
|
381
|
-
* @summary:
|
|
383
|
+
* @summary: Fetches future stock data for products.
|
|
382
384
|
* @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://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
383
385
|
*/
|
|
384
386
|
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockPolling>;
|
|
@@ -387,7 +389,7 @@ declare class Catalog {
|
|
|
387
389
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
388
390
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
389
391
|
* @returns {Paginator<ProductStockPolling>}
|
|
390
|
-
* @summary:
|
|
392
|
+
* @summary: Fetches future stock data for products.
|
|
391
393
|
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time.
|
|
392
394
|
*/
|
|
393
395
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
|
|
@@ -397,21 +399,21 @@ declare class Catalog {
|
|
|
397
399
|
/**
|
|
398
400
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
399
401
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
400
|
-
* @returns {Promise<
|
|
402
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
401
403
|
* @name getProductVariantsBySlug
|
|
402
|
-
* @summary:
|
|
404
|
+
* @summary: Retrieves product variants by slug.
|
|
403
405
|
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
|
|
404
406
|
*/
|
|
405
|
-
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
407
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductVariantsResponse>;
|
|
406
408
|
/**
|
|
407
409
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
408
410
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
409
|
-
* @returns {Promise<
|
|
411
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
410
412
|
* @name getProducts
|
|
411
|
-
* @summary:
|
|
413
|
+
* @summary: Lists all products.
|
|
412
414
|
* @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://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
413
415
|
*/
|
|
414
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
416
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponse>;
|
|
415
417
|
/**
|
|
416
418
|
* @param {Object} arg - Arg object.
|
|
417
419
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -426,8 +428,8 @@ declare class Catalog {
|
|
|
426
428
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
427
429
|
* either ascending or descending order. See the supported values below.
|
|
428
430
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
429
|
-
* @returns {Paginator<
|
|
430
|
-
* @summary:
|
|
431
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
432
|
+
* @summary: Lists all products.
|
|
431
433
|
* @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
434
|
*/
|
|
433
435
|
getProductsPaginator({ q, f, filters, sortOn, pageSize }?: {
|
|
@@ -436,34 +438,34 @@ declare class Catalog {
|
|
|
436
438
|
filters?: boolean;
|
|
437
439
|
sortOn?: string;
|
|
438
440
|
pageSize?: number;
|
|
439
|
-
}): Paginator<
|
|
441
|
+
}): Paginator<ProductListingResponse>;
|
|
440
442
|
/**
|
|
441
443
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
442
444
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
443
|
-
* @returns {Promise<
|
|
445
|
+
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
444
446
|
* @name getSearchResults
|
|
445
|
-
* @summary:
|
|
447
|
+
* @summary: Retrieves search result listings.
|
|
446
448
|
* @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://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
447
449
|
*/
|
|
448
|
-
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
450
|
+
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponse>;
|
|
449
451
|
/**
|
|
450
452
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
453
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<
|
|
454
|
+
* @returns {Promise<ProductCompareResponse>} - Success response
|
|
453
455
|
* @name getSimilarComparisonProductBySlug
|
|
454
|
-
* @summary:
|
|
456
|
+
* @summary: Fetches similar products for comparison.
|
|
455
457
|
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
456
458
|
*/
|
|
457
|
-
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
459
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductCompareResponse>;
|
|
458
460
|
/**
|
|
459
461
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
460
462
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
461
|
-
* @returns {Promise<
|
|
463
|
+
* @returns {Promise<StoreListingResponse>} - Success response
|
|
462
464
|
* @name getStores
|
|
463
|
-
* @summary:
|
|
465
|
+
* @summary: Get store meta information.
|
|
464
466
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
465
467
|
*/
|
|
466
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude,
|
|
468
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponse>;
|
|
467
469
|
/**
|
|
468
470
|
* @param {Object} arg - Arg object.
|
|
469
471
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -475,28 +477,26 @@ declare class Catalog {
|
|
|
475
477
|
* wants to retrieve the nearest stores, e.g. 72.8691788.
|
|
476
478
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
477
479
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
478
|
-
* @
|
|
479
|
-
* @
|
|
480
|
-
* @summary: List available stores
|
|
480
|
+
* @returns {Paginator<StoreListingResponse>}
|
|
481
|
+
* @summary: Get store meta information.
|
|
481
482
|
* @description: List all stores associated with the sales channel.
|
|
482
483
|
*/
|
|
483
|
-
getStoresPaginator({ pageSize, q, city, range, latitude, longitude
|
|
484
|
+
getStoresPaginator({ pageSize, q, city, range, latitude, longitude }?: {
|
|
484
485
|
pageSize?: number;
|
|
485
486
|
q?: string;
|
|
486
487
|
city?: string;
|
|
487
488
|
range?: number;
|
|
488
489
|
latitude?: number;
|
|
489
490
|
longitude?: number;
|
|
490
|
-
|
|
491
|
-
}): Paginator<StoreListingResponseSchema>;
|
|
491
|
+
}): Paginator<StoreListingResponse>;
|
|
492
492
|
/**
|
|
493
493
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
494
494
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
495
|
-
* @returns {Promise<
|
|
495
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
496
496
|
* @name unfollowById
|
|
497
|
-
* @summary:
|
|
497
|
+
* @summary: Unfollows an item by ID.
|
|
498
498
|
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
499
499
|
*/
|
|
500
|
-
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
500
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowPostResponse>;
|
|
501
501
|
}
|
|
502
502
|
import Paginator = require("../../common/Paginator");
|