@gofynd/fdk-client-javascript 1.4.12 → 1.4.14
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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
- package/sdk/application/Cart/CartApplicationClient.js +130 -53
- package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
- package/sdk/application/Cart/CartApplicationModel.js +380 -159
- package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
- package/sdk/application/Cart/CartApplicationValidator.js +34 -18
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
- package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
- package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
- package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
- package/sdk/application/Common/CommonApplicationClient.js +6 -5
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
- package/sdk/application/Content/ContentApplicationClient.js +54 -75
- package/sdk/application/Content/ContentApplicationModel.d.ts +96 -39
- package/sdk/application/Content/ContentApplicationModel.js +88 -34
- package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
- package/sdk/application/Content/ContentApplicationValidator.js +15 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
- package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
- package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
- package/sdk/application/Lead/LeadApplicationClient.js +2 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
- package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
- package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
- package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
- package/sdk/application/Order/OrderApplicationClient.js +96 -13
- package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
- package/sdk/application/Order/OrderApplicationModel.js +278 -73
- package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
- package/sdk/application/Order/OrderApplicationValidator.js +15 -2
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
- package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
- package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
- package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +51 -19
- package/sdk/application/Theme/ThemeApplicationModel.js +47 -24
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
- package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
- package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +1 -0
- package/sdk/application/index.js +2 -0
- package/sdk/common/Clickstream.js +12 -0
- package/sdk/common/Constant.d.ts +5 -0
- package/sdk/common/Constant.js +5 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +99 -39
- package/sdk/partner/Theme/ThemePartnerModel.js +95 -38
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- 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 +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
- package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +192 -164
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +371 -343
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +99 -99
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +54 -54
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +139 -116
- package/sdk/platform/Catalog/CatalogPlatformClient.js +191 -168
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1374 -749
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1241 -830
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1244 -397
- package/sdk/platform/Content/ContentPlatformModel.js +526 -392
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +138 -101
- package/sdk/platform/Order/OrderPlatformClient.js +267 -203
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4497 -877
- package/sdk/platform/Order/OrderPlatformModel.js +2336 -812
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +147 -50
- package/sdk/platform/Order/OrderPlatformValidator.js +75 -46
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
- package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +40 -13
- package/sdk/platform/Theme/ThemePlatformModel.js +38 -17
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +791 -5
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -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 +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- 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
|
@@ -40,32 +40,35 @@ declare class Catalog {
|
|
|
40
40
|
* @param {CatalogApplicationValidator.FollowByIdParam} arg - Arg object.
|
|
41
41
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
43
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
43
|
+
* @returns {Promise<CatalogApplicationModel.FollowPostResponseSchema>} -
|
|
44
|
+
* Success response
|
|
44
45
|
* @name followById
|
|
45
46
|
* @summary: Create item, brand, product
|
|
46
47
|
* @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/).
|
|
47
48
|
*/
|
|
48
|
-
followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
49
|
+
followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponseSchema>;
|
|
49
50
|
/**
|
|
50
51
|
* @param {CatalogApplicationValidator.GetBrandDetailBySlugParam} arg - Arg object.
|
|
51
52
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
54
|
+
* @returns {Promise<CatalogApplicationModel.BrandDetailResponseSchema>} -
|
|
55
|
+
* Success response
|
|
54
56
|
* @name getBrandDetailBySlug
|
|
55
57
|
* @summary: Get a brand
|
|
56
58
|
* @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/).
|
|
57
59
|
*/
|
|
58
|
-
getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
60
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandDetailResponseSchema>;
|
|
59
61
|
/**
|
|
60
62
|
* @param {CatalogApplicationValidator.GetBrandsParam} arg - Arg object.
|
|
61
63
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
64
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
63
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
65
|
+
* @returns {Promise<CatalogApplicationModel.BrandListingResponseSchema>} -
|
|
66
|
+
* Success response
|
|
64
67
|
* @name getBrands
|
|
65
68
|
* @summary: List brands
|
|
66
69
|
* @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/).
|
|
67
70
|
*/
|
|
68
|
-
getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
71
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandListingResponseSchema>;
|
|
69
72
|
/**
|
|
70
73
|
* @param {Object} arg - Arg object.
|
|
71
74
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -73,60 +76,64 @@ declare class Catalog {
|
|
|
73
76
|
* of available departments below. Also, you can get available departments
|
|
74
77
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
75
78
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
76
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
79
|
+
* @returns {Paginator<CatalogApplicationModel.BrandListingResponseSchema>}
|
|
77
80
|
* @summary: List brands
|
|
78
81
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
79
82
|
*/
|
|
80
83
|
getBrandsPaginator({ department, pageSize }?: {
|
|
81
84
|
department?: string;
|
|
82
85
|
pageSize?: number;
|
|
83
|
-
}): Paginator<CatalogApplicationModel.
|
|
86
|
+
}): Paginator<CatalogApplicationModel.BrandListingResponseSchema>;
|
|
84
87
|
/**
|
|
85
88
|
* @param {CatalogApplicationValidator.GetCategoriesParam} arg - Arg object.
|
|
86
89
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
87
90
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
89
|
-
* Success response
|
|
91
|
+
* @returns {Promise<CatalogApplicationModel.CategoryListingResponseSchema>}
|
|
92
|
+
* - Success response
|
|
93
|
+
*
|
|
90
94
|
* @name getCategories
|
|
91
95
|
* @summary: List product categories
|
|
92
96
|
* @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/).
|
|
93
97
|
*/
|
|
94
|
-
getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
98
|
+
getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryListingResponseSchema>;
|
|
95
99
|
/**
|
|
96
100
|
* @param {CatalogApplicationValidator.GetCategoryDetailBySlugParam} arg - Arg object.
|
|
97
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
98
102
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
103
|
+
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponseSchema>} -
|
|
104
|
+
* Success response
|
|
100
105
|
* @name getCategoryDetailBySlug
|
|
101
106
|
* @summary: Get category by slug
|
|
102
107
|
* @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/).
|
|
103
108
|
*/
|
|
104
|
-
getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
109
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryMetaResponseSchema>;
|
|
105
110
|
/**
|
|
106
111
|
* @param {CatalogApplicationValidator.GetCollectionDetailBySlugParam} arg
|
|
107
112
|
* - Arg object.
|
|
108
113
|
*
|
|
109
114
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
115
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
111
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
112
|
-
* Success response
|
|
116
|
+
* @returns {Promise<CatalogApplicationModel.CollectionDetailResponseSchema>}
|
|
117
|
+
* - Success response
|
|
118
|
+
*
|
|
113
119
|
* @name getCollectionDetailBySlug
|
|
114
120
|
* @summary: Get a collection
|
|
115
121
|
* @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/).
|
|
116
122
|
*/
|
|
117
|
-
getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
123
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CollectionDetailResponseSchema>;
|
|
118
124
|
/**
|
|
119
125
|
* @param {CatalogApplicationValidator.GetCollectionItemsBySlugParam} arg -
|
|
120
126
|
* Arg object.
|
|
121
127
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
128
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
124
|
-
* Success response
|
|
129
|
+
* @returns {Promise<CatalogApplicationModel.ProductListingResponseSchema>}
|
|
130
|
+
* - Success response
|
|
131
|
+
*
|
|
125
132
|
* @name getCollectionItemsBySlug
|
|
126
133
|
* @summary: Lists items of collection
|
|
127
134
|
* @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/).
|
|
128
135
|
*/
|
|
129
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
136
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponseSchema>;
|
|
130
137
|
/**
|
|
131
138
|
* @param {Object} arg - Arg object.
|
|
132
139
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -144,7 +151,7 @@ declare class Catalog {
|
|
|
144
151
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
145
152
|
* either ascending or descending order. See the supported values below.
|
|
146
153
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
147
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
154
|
+
* @returns {Paginator<CatalogApplicationModel.ProductListingResponseSchema>}
|
|
148
155
|
* @summary: Lists items of collection
|
|
149
156
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
150
157
|
*/
|
|
@@ -155,25 +162,25 @@ declare class Catalog {
|
|
|
155
162
|
filters?: boolean;
|
|
156
163
|
sortOn?: string;
|
|
157
164
|
pageSize?: number;
|
|
158
|
-
}): Paginator<CatalogApplicationModel.
|
|
165
|
+
}): Paginator<CatalogApplicationModel.ProductListingResponseSchema>;
|
|
159
166
|
/**
|
|
160
167
|
* @param {CatalogApplicationValidator.GetCollectionsParam} arg - Arg object.
|
|
161
168
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
169
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
170
|
+
* @returns {Promise<CatalogApplicationModel.GetCollectionListingResponseSchema>}
|
|
164
171
|
* - Success response
|
|
165
172
|
*
|
|
166
173
|
* @name getCollections
|
|
167
174
|
* @summary: List collections
|
|
168
175
|
* @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/).
|
|
169
176
|
*/
|
|
170
|
-
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
177
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponseSchema>;
|
|
171
178
|
/**
|
|
172
179
|
* @param {Object} arg - Arg object.
|
|
173
180
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
174
181
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
175
182
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
176
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
183
|
+
* @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponseSchema>}
|
|
177
184
|
* @summary: List collections
|
|
178
185
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
179
186
|
*/
|
|
@@ -181,100 +188,105 @@ declare class Catalog {
|
|
|
181
188
|
pageSize?: number;
|
|
182
189
|
tag?: string[];
|
|
183
190
|
q?: string;
|
|
184
|
-
}): Paginator<CatalogApplicationModel.
|
|
191
|
+
}): Paginator<CatalogApplicationModel.GetCollectionListingResponseSchema>;
|
|
185
192
|
/**
|
|
186
193
|
* @param {CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam} arg
|
|
187
194
|
* - Arg object.
|
|
188
195
|
*
|
|
189
196
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
190
197
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
191
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
198
|
+
* @returns {Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponseSchema>}
|
|
192
199
|
* - Success response
|
|
193
200
|
*
|
|
194
201
|
* @name getComparedFrequentlyProductBySlug
|
|
195
202
|
* @summary: List frequent products
|
|
196
203
|
* @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/).
|
|
197
204
|
*/
|
|
198
|
-
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
205
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponseSchema>;
|
|
199
206
|
/**
|
|
200
207
|
* @param {CatalogApplicationValidator.GetDepartmentsParam} arg - Arg object.
|
|
201
208
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
209
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
210
|
+
* @returns {Promise<CatalogApplicationModel.DepartmentResponseSchema>} -
|
|
211
|
+
* Success response
|
|
204
212
|
* @name getDepartments
|
|
205
213
|
* @summary: List departments
|
|
206
214
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
207
215
|
*/
|
|
208
|
-
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
216
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogApplicationModel.DepartmentResponseSchema>;
|
|
209
217
|
/**
|
|
210
218
|
* @param {CatalogApplicationValidator.GetFollowIdsParam} arg - Arg object.
|
|
211
219
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
212
220
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
221
|
+
* @returns {Promise<CatalogApplicationModel.FollowIdsResponseSchema>} -
|
|
222
|
+
* Success response
|
|
214
223
|
* @name getFollowIds
|
|
215
224
|
* @summary: List Ids of followed item, brand, product
|
|
216
225
|
* @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/).
|
|
217
226
|
*/
|
|
218
|
-
getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
227
|
+
getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowIdsResponseSchema>;
|
|
219
228
|
/**
|
|
220
229
|
* @param {CatalogApplicationValidator.GetFollowedListingParam} arg - Arg object.
|
|
221
230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
222
231
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
223
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
224
|
-
* Success response
|
|
232
|
+
* @returns {Promise<CatalogApplicationModel.GetFollowListingResponseSchema>}
|
|
233
|
+
* - Success response
|
|
234
|
+
*
|
|
225
235
|
* @name getFollowedListing
|
|
226
236
|
* @summary: List followed products, brands
|
|
227
237
|
* @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/).
|
|
228
238
|
*/
|
|
229
|
-
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
239
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponseSchema>;
|
|
230
240
|
/**
|
|
231
241
|
* @param {Object} arg - Arg object.
|
|
232
242
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
233
243
|
* products, brands, or collections.
|
|
234
244
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
235
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
245
|
+
* @returns {Paginator<CatalogApplicationModel.GetFollowListingResponseSchema>}
|
|
236
246
|
* @summary: List followed products, brands
|
|
237
247
|
* @description: Get a list of products or brands the user is following.
|
|
238
248
|
*/
|
|
239
249
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
240
250
|
collectionType: string;
|
|
241
251
|
pageSize?: number;
|
|
242
|
-
}): Paginator<CatalogApplicationModel.
|
|
252
|
+
}): Paginator<CatalogApplicationModel.GetFollowListingResponseSchema>;
|
|
243
253
|
/**
|
|
244
254
|
* @param {CatalogApplicationValidator.GetFollowerCountByIdParam} arg - Arg object.
|
|
245
255
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
246
256
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
247
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
248
|
-
* Success response
|
|
257
|
+
* @returns {Promise<CatalogApplicationModel.FollowerCountResponseSchema>}
|
|
258
|
+
* - Success response
|
|
259
|
+
*
|
|
249
260
|
* @name getFollowerCountById
|
|
250
261
|
* @summary: Get follower count
|
|
251
262
|
* @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/).
|
|
252
263
|
*/
|
|
253
|
-
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
264
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowerCountResponseSchema>;
|
|
254
265
|
/**
|
|
255
266
|
* @param {CatalogApplicationValidator.GetHomeProductsParam} arg - Arg object.
|
|
256
267
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
268
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
258
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
269
|
+
* @returns {Promise<CatalogApplicationModel.HomeListingResponseSchema>} -
|
|
270
|
+
* Success response
|
|
259
271
|
* @name getHomeProducts
|
|
260
272
|
* @summary: List homepage-featured products
|
|
261
273
|
* @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/).
|
|
262
274
|
*/
|
|
263
|
-
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetHomeProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
275
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetHomeProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.HomeListingResponseSchema>;
|
|
264
276
|
/**
|
|
265
277
|
* @param {Object} arg - Arg object.
|
|
266
278
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
267
279
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
268
280
|
* either ascending or descending order.
|
|
269
281
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
270
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
282
|
+
* @returns {Paginator<CatalogApplicationModel.HomeListingResponseSchema>}
|
|
271
283
|
* @summary: List homepage-featured products
|
|
272
284
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
273
285
|
*/
|
|
274
286
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
275
287
|
sortOn?: string;
|
|
276
288
|
pageSize?: number;
|
|
277
|
-
}): Paginator<CatalogApplicationModel.
|
|
289
|
+
}): Paginator<CatalogApplicationModel.HomeListingResponseSchema>;
|
|
278
290
|
/**
|
|
279
291
|
* @param {CatalogApplicationValidator.GetInStockLocationsParam} arg - Arg object.
|
|
280
292
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -335,13 +347,14 @@ declare class Catalog {
|
|
|
335
347
|
*
|
|
336
348
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
349
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
338
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
339
|
-
* Success response
|
|
350
|
+
* @returns {Promise<CatalogApplicationModel.ProductsComparisonResponseSchema>}
|
|
351
|
+
* - Success response
|
|
352
|
+
*
|
|
340
353
|
* @name getProductComparisonBySlugs
|
|
341
354
|
* @summary: List products for comparison
|
|
342
355
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
343
356
|
*/
|
|
344
|
-
getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
357
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductsComparisonResponseSchema>;
|
|
345
358
|
/**
|
|
346
359
|
* @param {CatalogApplicationValidator.GetProductDetailBySlugParam} arg - Arg object.
|
|
347
360
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -410,13 +423,14 @@ declare class Catalog {
|
|
|
410
423
|
* @param {CatalogApplicationValidator.GetProductStockByIdsParam} arg - Arg object.
|
|
411
424
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
412
425
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
413
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
414
|
-
* Success response
|
|
426
|
+
* @returns {Promise<CatalogApplicationModel.ProductStockStatusResponseSchema>}
|
|
427
|
+
* - Success response
|
|
428
|
+
*
|
|
415
429
|
* @name getProductStockByIds
|
|
416
430
|
* @summary: Get product stocks
|
|
417
431
|
* @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/).
|
|
418
432
|
*/
|
|
419
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
433
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockStatusResponseSchema>;
|
|
420
434
|
/**
|
|
421
435
|
* @param {CatalogApplicationValidator.GetProductStockForTimeByIdsParam} arg
|
|
422
436
|
* - Arg object.
|
|
@@ -446,24 +460,26 @@ declare class Catalog {
|
|
|
446
460
|
* Arg object.
|
|
447
461
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
448
462
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
449
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
450
|
-
* Success response
|
|
463
|
+
* @returns {Promise<CatalogApplicationModel.ProductVariantsResponseSchema>}
|
|
464
|
+
* - Success response
|
|
465
|
+
*
|
|
451
466
|
* @name getProductVariantsBySlug
|
|
452
467
|
* @summary: List product variants
|
|
453
468
|
* @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/).
|
|
454
469
|
*/
|
|
455
|
-
getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
470
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponseSchema>;
|
|
456
471
|
/**
|
|
457
472
|
* @param {CatalogApplicationValidator.GetProductsParam} arg - Arg object.
|
|
458
473
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
474
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
460
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
461
|
-
* Success response
|
|
475
|
+
* @returns {Promise<CatalogApplicationModel.ProductListingResponseSchema>}
|
|
476
|
+
* - Success response
|
|
477
|
+
*
|
|
462
478
|
* @name getProducts
|
|
463
479
|
* @summary: List products
|
|
464
480
|
* @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/).
|
|
465
481
|
*/
|
|
466
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
482
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponseSchema>;
|
|
467
483
|
/**
|
|
468
484
|
* @param {Object} arg - Arg object.
|
|
469
485
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -478,7 +494,7 @@ declare class Catalog {
|
|
|
478
494
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
479
495
|
* either ascending or descending order. See the supported values below.
|
|
480
496
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
481
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
497
|
+
* @returns {Paginator<CatalogApplicationModel.ProductListingResponseSchema>}
|
|
482
498
|
* @summary: List products
|
|
483
499
|
* @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.
|
|
484
500
|
*/
|
|
@@ -488,40 +504,43 @@ declare class Catalog {
|
|
|
488
504
|
filters?: boolean;
|
|
489
505
|
sortOn?: string;
|
|
490
506
|
pageSize?: number;
|
|
491
|
-
}): Paginator<CatalogApplicationModel.
|
|
507
|
+
}): Paginator<CatalogApplicationModel.ProductListingResponseSchema>;
|
|
492
508
|
/**
|
|
493
509
|
* @param {CatalogApplicationValidator.GetSearchResultsParam} arg - Arg object.
|
|
494
510
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
511
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
496
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
512
|
+
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponseSchema>} -
|
|
513
|
+
* Success response
|
|
497
514
|
* @name getSearchResults
|
|
498
515
|
* @summary: List product, brand, category
|
|
499
516
|
* @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/).
|
|
500
517
|
*/
|
|
501
|
-
getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
518
|
+
getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.AutoCompleteResponseSchema>;
|
|
502
519
|
/**
|
|
503
520
|
* @param {CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam} arg
|
|
504
521
|
* - Arg object.
|
|
505
522
|
*
|
|
506
523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
507
524
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
508
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
509
|
-
* Success response
|
|
525
|
+
* @returns {Promise<CatalogApplicationModel.ProductCompareResponseSchema>}
|
|
526
|
+
* - Success response
|
|
527
|
+
*
|
|
510
528
|
* @name getSimilarComparisonProductBySlug
|
|
511
529
|
* @summary: List similar products
|
|
512
530
|
* @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/).
|
|
513
531
|
*/
|
|
514
|
-
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
532
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductCompareResponseSchema>;
|
|
515
533
|
/**
|
|
516
534
|
* @param {CatalogApplicationValidator.GetStoresParam} arg - Arg object.
|
|
517
535
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
518
536
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
519
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
537
|
+
* @returns {Promise<CatalogApplicationModel.StoreListingResponseSchema>} -
|
|
538
|
+
* Success response
|
|
520
539
|
* @name getStores
|
|
521
540
|
* @summary: List available stores
|
|
522
541
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
523
542
|
*/
|
|
524
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
543
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponseSchema>;
|
|
525
544
|
/**
|
|
526
545
|
* @param {Object} arg - Arg object.
|
|
527
546
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -534,7 +553,7 @@ declare class Catalog {
|
|
|
534
553
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
535
554
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
536
555
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
537
|
-
* @returns {Paginator<CatalogApplicationModel.
|
|
556
|
+
* @returns {Paginator<CatalogApplicationModel.StoreListingResponseSchema>}
|
|
538
557
|
* @summary: List available stores
|
|
539
558
|
* @description: List all stores associated with the sales channel.
|
|
540
559
|
*/
|
|
@@ -546,17 +565,18 @@ declare class Catalog {
|
|
|
546
565
|
latitude?: number;
|
|
547
566
|
longitude?: number;
|
|
548
567
|
tags?: string;
|
|
549
|
-
}): Paginator<CatalogApplicationModel.
|
|
568
|
+
}): Paginator<CatalogApplicationModel.StoreListingResponseSchema>;
|
|
550
569
|
/**
|
|
551
570
|
* @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
|
|
552
571
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
553
572
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
554
|
-
* @returns {Promise<CatalogApplicationModel.
|
|
573
|
+
* @returns {Promise<CatalogApplicationModel.FollowPostResponseSchema>} -
|
|
574
|
+
* Success response
|
|
555
575
|
* @name unfollowById
|
|
556
576
|
* @summary: Delete item, brand, product
|
|
557
577
|
* @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/).
|
|
558
578
|
*/
|
|
559
|
-
unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.
|
|
579
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponseSchema>;
|
|
560
580
|
}
|
|
561
581
|
import CatalogApplicationValidator = require("./CatalogApplicationValidator");
|
|
562
582
|
import CatalogApplicationModel = require("./CatalogApplicationModel");
|