@gofynd/fdk-client-javascript 1.4.13 → 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 +1 -1
- 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 +93 -37
- package/sdk/application/Content/ContentApplicationModel.js +83 -32
- 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 +48 -17
- package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
- 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/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 +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- 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 +208 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
- package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
- 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 +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- 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 +178 -97
- package/sdk/platform/Order/OrderPlatformClient.js +589 -229
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
- package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
- package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
- 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 +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- 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
|
@@ -106,7 +106,7 @@ class Catalog {
|
|
|
106
106
|
*
|
|
107
107
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
108
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
109
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
110
110
|
* @name createAppCategoryReturnConfiguration
|
|
111
111
|
* @summary: Create return configuration
|
|
112
112
|
* @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
|
|
@@ -162,7 +162,7 @@ class Catalog {
|
|
|
162
162
|
|
|
163
163
|
const {
|
|
164
164
|
error: res_error,
|
|
165
|
-
} = CatalogPlatformModel.
|
|
165
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
166
166
|
abortEarly: false,
|
|
167
167
|
allowUnknown: true,
|
|
168
168
|
});
|
|
@@ -187,7 +187,7 @@ class Catalog {
|
|
|
187
187
|
*
|
|
188
188
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
189
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
190
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
191
191
|
* @name createAppReturnConfiguration
|
|
192
192
|
* @summary: Create product return configuration
|
|
193
193
|
* @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
|
|
@@ -243,7 +243,7 @@ class Catalog {
|
|
|
243
243
|
|
|
244
244
|
const {
|
|
245
245
|
error: res_error,
|
|
246
|
-
} = CatalogPlatformModel.
|
|
246
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
247
247
|
abortEarly: false,
|
|
248
248
|
allowUnknown: true,
|
|
249
249
|
});
|
|
@@ -266,8 +266,9 @@ class Catalog {
|
|
|
266
266
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
267
267
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
268
268
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
270
|
-
* Success response
|
|
269
|
+
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponseSchema>}
|
|
270
|
+
* - Success response
|
|
271
|
+
*
|
|
271
272
|
* @name createCollection
|
|
272
273
|
* @summary: Create a collection
|
|
273
274
|
* @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
|
|
@@ -323,10 +324,10 @@ class Catalog {
|
|
|
323
324
|
|
|
324
325
|
const {
|
|
325
326
|
error: res_error,
|
|
326
|
-
} = CatalogPlatformModel.
|
|
327
|
-
|
|
328
|
-
allowUnknown: true
|
|
329
|
-
|
|
327
|
+
} = CatalogPlatformModel.CollectionCreateResponseSchema().validate(
|
|
328
|
+
responseData,
|
|
329
|
+
{ abortEarly: false, allowUnknown: true }
|
|
330
|
+
);
|
|
330
331
|
|
|
331
332
|
if (res_error) {
|
|
332
333
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -514,7 +515,7 @@ class Catalog {
|
|
|
514
515
|
*
|
|
515
516
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
516
517
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
517
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
518
|
+
* @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>}
|
|
518
519
|
* - Success response
|
|
519
520
|
*
|
|
520
521
|
* @name createCustomAutocompleteRule
|
|
@@ -572,7 +573,7 @@ class Catalog {
|
|
|
572
573
|
|
|
573
574
|
const {
|
|
574
575
|
error: res_error,
|
|
575
|
-
} = CatalogPlatformModel.
|
|
576
|
+
} = CatalogPlatformModel.CreateAutocompleteWordsResponseSchema().validate(
|
|
576
577
|
responseData,
|
|
577
578
|
{ abortEarly: false, allowUnknown: true }
|
|
578
579
|
);
|
|
@@ -844,7 +845,7 @@ class Catalog {
|
|
|
844
845
|
*
|
|
845
846
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
846
847
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
847
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
848
|
+
* @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>}
|
|
848
849
|
* - Success response
|
|
849
850
|
*
|
|
850
851
|
* @name createSearchConfiguration
|
|
@@ -902,7 +903,7 @@ class Catalog {
|
|
|
902
903
|
|
|
903
904
|
const {
|
|
904
905
|
error: res_error,
|
|
905
|
-
} = CatalogPlatformModel.
|
|
906
|
+
} = CatalogPlatformModel.CreateSearchConfigurationResponseSchema().validate(
|
|
906
907
|
responseData,
|
|
907
908
|
{ abortEarly: false, allowUnknown: true }
|
|
908
909
|
);
|
|
@@ -927,7 +928,7 @@ class Catalog {
|
|
|
927
928
|
*
|
|
928
929
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
929
930
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
930
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
931
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
931
932
|
* @name deleteAppCategoryReturnConfiguration
|
|
932
933
|
* @summary: Delete product return configuration
|
|
933
934
|
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
@@ -983,7 +984,7 @@ class Catalog {
|
|
|
983
984
|
|
|
984
985
|
const {
|
|
985
986
|
error: res_error,
|
|
986
|
-
} = CatalogPlatformModel.
|
|
987
|
+
} = CatalogPlatformModel.SuccessResponseSchema().validate(responseData, {
|
|
987
988
|
abortEarly: false,
|
|
988
989
|
allowUnknown: true,
|
|
989
990
|
});
|
|
@@ -1008,7 +1009,7 @@ class Catalog {
|
|
|
1008
1009
|
*
|
|
1009
1010
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1010
1011
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1011
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1012
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
1012
1013
|
* @name deleteAutocompleteKeyword
|
|
1013
1014
|
* @summary: Delete autocomplete keyword
|
|
1014
1015
|
* @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
|
|
@@ -1064,7 +1065,7 @@ class Catalog {
|
|
|
1064
1065
|
|
|
1065
1066
|
const {
|
|
1066
1067
|
error: res_error,
|
|
1067
|
-
} = CatalogPlatformModel.
|
|
1068
|
+
} = CatalogPlatformModel.DeleteResponseSchema().validate(responseData, {
|
|
1068
1069
|
abortEarly: false,
|
|
1069
1070
|
allowUnknown: true,
|
|
1070
1071
|
});
|
|
@@ -1170,7 +1171,8 @@ class Catalog {
|
|
|
1170
1171
|
*
|
|
1171
1172
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1172
1173
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1173
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1174
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1175
|
+
* Success response
|
|
1174
1176
|
* @name deleteGroupConfiguration
|
|
1175
1177
|
* @summary: Delete group configuration
|
|
1176
1178
|
* @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
|
|
@@ -1228,10 +1230,10 @@ class Catalog {
|
|
|
1228
1230
|
|
|
1229
1231
|
const {
|
|
1230
1232
|
error: res_error,
|
|
1231
|
-
} = CatalogPlatformModel.
|
|
1232
|
-
|
|
1233
|
-
allowUnknown: true
|
|
1234
|
-
|
|
1233
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
1234
|
+
responseData,
|
|
1235
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1236
|
+
);
|
|
1235
1237
|
|
|
1236
1238
|
if (res_error) {
|
|
1237
1239
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1253,7 +1255,8 @@ class Catalog {
|
|
|
1253
1255
|
*
|
|
1254
1256
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1255
1257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1256
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1258
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1259
|
+
* Success response
|
|
1257
1260
|
* @name deleteListingConfiguration
|
|
1258
1261
|
* @summary: Delete listing configuration
|
|
1259
1262
|
* @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
@@ -1311,10 +1314,10 @@ class Catalog {
|
|
|
1311
1314
|
|
|
1312
1315
|
const {
|
|
1313
1316
|
error: res_error,
|
|
1314
|
-
} = CatalogPlatformModel.
|
|
1315
|
-
|
|
1316
|
-
allowUnknown: true
|
|
1317
|
-
|
|
1317
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
1318
|
+
responseData,
|
|
1319
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1320
|
+
);
|
|
1318
1321
|
|
|
1319
1322
|
if (res_error) {
|
|
1320
1323
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1336,7 +1339,7 @@ class Catalog {
|
|
|
1336
1339
|
*
|
|
1337
1340
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1338
1341
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1339
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1342
|
+
* @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>}
|
|
1340
1343
|
* - Success response
|
|
1341
1344
|
*
|
|
1342
1345
|
* @name deleteSearchConfiguration
|
|
@@ -1390,7 +1393,7 @@ class Catalog {
|
|
|
1390
1393
|
|
|
1391
1394
|
const {
|
|
1392
1395
|
error: res_error,
|
|
1393
|
-
} = CatalogPlatformModel.
|
|
1396
|
+
} = CatalogPlatformModel.DeleteSearchConfigurationResponseSchema().validate(
|
|
1394
1397
|
responseData,
|
|
1395
1398
|
{ abortEarly: false, allowUnknown: true }
|
|
1396
1399
|
);
|
|
@@ -1415,7 +1418,7 @@ class Catalog {
|
|
|
1415
1418
|
*
|
|
1416
1419
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1417
1420
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1418
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1421
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
1419
1422
|
* @name deleteSearchKeywords
|
|
1420
1423
|
* @summary: Delete search keywords
|
|
1421
1424
|
* @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
|
|
@@ -1471,7 +1474,7 @@ class Catalog {
|
|
|
1471
1474
|
|
|
1472
1475
|
const {
|
|
1473
1476
|
error: res_error,
|
|
1474
|
-
} = CatalogPlatformModel.
|
|
1477
|
+
} = CatalogPlatformModel.DeleteResponseSchema().validate(responseData, {
|
|
1475
1478
|
abortEarly: false,
|
|
1476
1479
|
allowUnknown: true,
|
|
1477
1480
|
});
|
|
@@ -1496,8 +1499,9 @@ class Catalog {
|
|
|
1496
1499
|
*
|
|
1497
1500
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1498
1501
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1499
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1500
|
-
* Success response
|
|
1502
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
1503
|
+
* - Success response
|
|
1504
|
+
*
|
|
1501
1505
|
* @name getAllCollections
|
|
1502
1506
|
* @summary: List collections
|
|
1503
1507
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
|
|
@@ -1581,7 +1585,7 @@ class Catalog {
|
|
|
1581
1585
|
|
|
1582
1586
|
const {
|
|
1583
1587
|
error: res_error,
|
|
1584
|
-
} = CatalogPlatformModel.
|
|
1588
|
+
} = CatalogPlatformModel.GetCollectionListingResponseSchema().validate(
|
|
1585
1589
|
responseData,
|
|
1586
1590
|
{ abortEarly: false, allowUnknown: true }
|
|
1587
1591
|
);
|
|
@@ -1615,7 +1619,7 @@ class Catalog {
|
|
|
1615
1619
|
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
1616
1620
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1617
1621
|
* page. Default is 12.
|
|
1618
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
1622
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
1619
1623
|
* @summary: List collections
|
|
1620
1624
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
|
|
1621
1625
|
*/
|
|
@@ -1661,7 +1665,8 @@ class Catalog {
|
|
|
1661
1665
|
*
|
|
1662
1666
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1663
1667
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1664
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1668
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>} -
|
|
1669
|
+
* Success response
|
|
1665
1670
|
* @name getAllSearchKeyword
|
|
1666
1671
|
* @summary: List search keywords
|
|
1667
1672
|
* @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
|
|
@@ -1713,10 +1718,10 @@ class Catalog {
|
|
|
1713
1718
|
|
|
1714
1719
|
const {
|
|
1715
1720
|
error: res_error,
|
|
1716
|
-
} = CatalogPlatformModel.
|
|
1717
|
-
|
|
1718
|
-
allowUnknown: true
|
|
1719
|
-
|
|
1721
|
+
} = CatalogPlatformModel.GetSearchWordsResponseSchema().validate(
|
|
1722
|
+
responseData,
|
|
1723
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1724
|
+
);
|
|
1720
1725
|
|
|
1721
1726
|
if (res_error) {
|
|
1722
1727
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1738,7 +1743,7 @@ class Catalog {
|
|
|
1738
1743
|
*
|
|
1739
1744
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1740
1745
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1741
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1746
|
+
* @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>}
|
|
1742
1747
|
* - Success response
|
|
1743
1748
|
*
|
|
1744
1749
|
* @name getAppCategoryReturnConfig
|
|
@@ -1803,7 +1808,7 @@ class Catalog {
|
|
|
1803
1808
|
|
|
1804
1809
|
const {
|
|
1805
1810
|
error: res_error,
|
|
1806
|
-
} = CatalogPlatformModel.
|
|
1811
|
+
} = CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema().validate(
|
|
1807
1812
|
responseData,
|
|
1808
1813
|
{ abortEarly: false, allowUnknown: true }
|
|
1809
1814
|
);
|
|
@@ -1826,7 +1831,8 @@ class Catalog {
|
|
|
1826
1831
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
1827
1832
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1828
1833
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1829
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1834
|
+
* @returns {Promise<CatalogPlatformModel.InventoryStockResponseSchema>} -
|
|
1835
|
+
* Success response
|
|
1830
1836
|
* @name getAppInventory
|
|
1831
1837
|
* @summary: List sales channel inventory
|
|
1832
1838
|
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
@@ -1930,10 +1936,10 @@ class Catalog {
|
|
|
1930
1936
|
|
|
1931
1937
|
const {
|
|
1932
1938
|
error: res_error,
|
|
1933
|
-
} = CatalogPlatformModel.
|
|
1934
|
-
|
|
1935
|
-
allowUnknown: true
|
|
1936
|
-
|
|
1939
|
+
} = CatalogPlatformModel.InventoryStockResponseSchema().validate(
|
|
1940
|
+
responseData,
|
|
1941
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1942
|
+
);
|
|
1937
1943
|
|
|
1938
1944
|
if (res_error) {
|
|
1939
1945
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1953,7 +1959,7 @@ class Catalog {
|
|
|
1953
1959
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
1954
1960
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1955
1961
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1956
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1962
|
+
* @returns {Promise<CatalogPlatformModel.LocationListSchema>} - Success response
|
|
1957
1963
|
* @name getAppLocations
|
|
1958
1964
|
* @summary: List sales channels
|
|
1959
1965
|
* @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
|
|
@@ -2041,7 +2047,7 @@ class Catalog {
|
|
|
2041
2047
|
|
|
2042
2048
|
const {
|
|
2043
2049
|
error: res_error,
|
|
2044
|
-
} = CatalogPlatformModel.
|
|
2050
|
+
} = CatalogPlatformModel.LocationListSchema().validate(responseData, {
|
|
2045
2051
|
abortEarly: false,
|
|
2046
2052
|
allowUnknown: true,
|
|
2047
2053
|
});
|
|
@@ -2076,7 +2082,7 @@ class Catalog {
|
|
|
2076
2082
|
* page. Default is 20.
|
|
2077
2083
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
2078
2084
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
2079
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2085
|
+
* @returns {Paginator<CatalogPlatformModel.LocationListSchema>}
|
|
2080
2086
|
* @summary: List sales channels
|
|
2081
2087
|
* @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified)
|
|
2082
2088
|
*/
|
|
@@ -2122,7 +2128,8 @@ class Catalog {
|
|
|
2122
2128
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
2123
2129
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2124
2130
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2125
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2131
|
+
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>} -
|
|
2132
|
+
* Success response
|
|
2126
2133
|
* @name getAppProduct
|
|
2127
2134
|
* @summary: Get sales channel product
|
|
2128
2135
|
* @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
|
|
@@ -2178,10 +2185,10 @@ class Catalog {
|
|
|
2178
2185
|
|
|
2179
2186
|
const {
|
|
2180
2187
|
error: res_error,
|
|
2181
|
-
} = CatalogPlatformModel.
|
|
2182
|
-
|
|
2183
|
-
allowUnknown: true
|
|
2184
|
-
|
|
2188
|
+
} = CatalogPlatformModel.OwnerAppItemResponseSchema().validate(
|
|
2189
|
+
responseData,
|
|
2190
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2191
|
+
);
|
|
2185
2192
|
|
|
2186
2193
|
if (res_error) {
|
|
2187
2194
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2201,8 +2208,9 @@ class Catalog {
|
|
|
2201
2208
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
2202
2209
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2203
2210
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2204
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2205
|
-
* Success response
|
|
2211
|
+
* @returns {Promise<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
2212
|
+
* - Success response
|
|
2213
|
+
*
|
|
2206
2214
|
* @name getAppProducts
|
|
2207
2215
|
* @summary: List sales channel products
|
|
2208
2216
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
|
|
@@ -2290,7 +2298,7 @@ class Catalog {
|
|
|
2290
2298
|
|
|
2291
2299
|
const {
|
|
2292
2300
|
error: res_error,
|
|
2293
|
-
} = CatalogPlatformModel.
|
|
2301
|
+
} = CatalogPlatformModel.RawProductListingResponseSchema().validate(
|
|
2294
2302
|
responseData,
|
|
2295
2303
|
{ abortEarly: false, allowUnknown: true }
|
|
2296
2304
|
);
|
|
@@ -2325,7 +2333,7 @@ class Catalog {
|
|
|
2325
2333
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2326
2334
|
* page. Default is 10.
|
|
2327
2335
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
2328
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2336
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
2329
2337
|
* @summary: List sales channel products
|
|
2330
2338
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
|
|
2331
2339
|
*/
|
|
@@ -2373,7 +2381,8 @@ class Catalog {
|
|
|
2373
2381
|
*
|
|
2374
2382
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2375
2383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2376
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2384
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>} -
|
|
2385
|
+
* Success response
|
|
2377
2386
|
* @name getAppReturnConfiguration
|
|
2378
2387
|
* @summary: get product-return configuration
|
|
2379
2388
|
* @description: Get Product Return configuration set at an sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
|
|
@@ -2425,134 +2434,7 @@ class Catalog {
|
|
|
2425
2434
|
|
|
2426
2435
|
const {
|
|
2427
2436
|
error: res_error,
|
|
2428
|
-
} = CatalogPlatformModel.
|
|
2429
|
-
abortEarly: false,
|
|
2430
|
-
allowUnknown: true,
|
|
2431
|
-
});
|
|
2432
|
-
|
|
2433
|
-
if (res_error) {
|
|
2434
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
2435
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
2436
|
-
} else {
|
|
2437
|
-
Logger({
|
|
2438
|
-
level: "WARN",
|
|
2439
|
-
message: `Response Validation Warnings for platform > Catalog > getAppReturnConfiguration \n ${res_error}`,
|
|
2440
|
-
});
|
|
2441
|
-
}
|
|
2442
|
-
}
|
|
2443
|
-
|
|
2444
|
-
return response;
|
|
2445
|
-
}
|
|
2446
|
-
|
|
2447
|
-
/**
|
|
2448
|
-
* @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
|
|
2449
|
-
* - Arg object
|
|
2450
|
-
*
|
|
2451
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2452
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2453
|
-
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
2454
|
-
* - Success response
|
|
2455
|
-
*
|
|
2456
|
-
* @name getAppicationProducts
|
|
2457
|
-
* @summary: List sales channel products
|
|
2458
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
|
|
2459
|
-
*/
|
|
2460
|
-
async getAppicationProducts(
|
|
2461
|
-
{
|
|
2462
|
-
q,
|
|
2463
|
-
f,
|
|
2464
|
-
c,
|
|
2465
|
-
filters,
|
|
2466
|
-
isDependent,
|
|
2467
|
-
sortOn,
|
|
2468
|
-
pageId,
|
|
2469
|
-
pageSize,
|
|
2470
|
-
pageNo,
|
|
2471
|
-
pageType,
|
|
2472
|
-
itemIds,
|
|
2473
|
-
requestHeaders,
|
|
2474
|
-
} = { requestHeaders: {} },
|
|
2475
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
2476
|
-
) {
|
|
2477
|
-
const {
|
|
2478
|
-
error,
|
|
2479
|
-
} = CatalogPlatformApplicationValidator.getAppicationProducts().validate(
|
|
2480
|
-
{
|
|
2481
|
-
q,
|
|
2482
|
-
f,
|
|
2483
|
-
c,
|
|
2484
|
-
filters,
|
|
2485
|
-
isDependent,
|
|
2486
|
-
sortOn,
|
|
2487
|
-
pageId,
|
|
2488
|
-
pageSize,
|
|
2489
|
-
pageNo,
|
|
2490
|
-
pageType,
|
|
2491
|
-
itemIds,
|
|
2492
|
-
},
|
|
2493
|
-
{ abortEarly: false, allowUnknown: true }
|
|
2494
|
-
);
|
|
2495
|
-
if (error) {
|
|
2496
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
2497
|
-
}
|
|
2498
|
-
|
|
2499
|
-
// Showing warrnings if extra unknown parameters are found
|
|
2500
|
-
const {
|
|
2501
|
-
error: warrning,
|
|
2502
|
-
} = CatalogPlatformApplicationValidator.getAppicationProducts().validate(
|
|
2503
|
-
{
|
|
2504
|
-
q,
|
|
2505
|
-
f,
|
|
2506
|
-
c,
|
|
2507
|
-
filters,
|
|
2508
|
-
isDependent,
|
|
2509
|
-
sortOn,
|
|
2510
|
-
pageId,
|
|
2511
|
-
pageSize,
|
|
2512
|
-
pageNo,
|
|
2513
|
-
pageType,
|
|
2514
|
-
itemIds,
|
|
2515
|
-
},
|
|
2516
|
-
{ abortEarly: false, allowUnknown: false }
|
|
2517
|
-
);
|
|
2518
|
-
if (warrning) {
|
|
2519
|
-
Logger({
|
|
2520
|
-
level: "WARN",
|
|
2521
|
-
message: `Parameter Validation warrnings for platform > Catalog > getAppicationProducts \n ${warrning}`,
|
|
2522
|
-
});
|
|
2523
|
-
}
|
|
2524
|
-
|
|
2525
|
-
const query_params = {};
|
|
2526
|
-
query_params["q"] = q;
|
|
2527
|
-
query_params["f"] = f;
|
|
2528
|
-
query_params["c"] = c;
|
|
2529
|
-
query_params["filters"] = filters;
|
|
2530
|
-
query_params["is_dependent"] = isDependent;
|
|
2531
|
-
query_params["sort_on"] = sortOn;
|
|
2532
|
-
query_params["page_id"] = pageId;
|
|
2533
|
-
query_params["page_size"] = pageSize;
|
|
2534
|
-
query_params["page_no"] = pageNo;
|
|
2535
|
-
query_params["page_type"] = pageType;
|
|
2536
|
-
query_params["item_ids"] = itemIds;
|
|
2537
|
-
|
|
2538
|
-
const response = await PlatformAPIClient.execute(
|
|
2539
|
-
this.config,
|
|
2540
|
-
"get",
|
|
2541
|
-
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/products`,
|
|
2542
|
-
query_params,
|
|
2543
|
-
undefined,
|
|
2544
|
-
requestHeaders,
|
|
2545
|
-
{ responseHeaders }
|
|
2546
|
-
);
|
|
2547
|
-
|
|
2548
|
-
let responseData = response;
|
|
2549
|
-
if (responseHeaders) {
|
|
2550
|
-
responseData = response[0];
|
|
2551
|
-
}
|
|
2552
|
-
|
|
2553
|
-
const {
|
|
2554
|
-
error: res_error,
|
|
2555
|
-
} = CatalogPlatformModel.ApplicationProductListingResponse().validate(
|
|
2437
|
+
} = CatalogPlatformModel.AppReturnConfigResponseSchema().validate(
|
|
2556
2438
|
responseData,
|
|
2557
2439
|
{ abortEarly: false, allowUnknown: true }
|
|
2558
2440
|
);
|
|
@@ -2563,7 +2445,7 @@ class Catalog {
|
|
|
2563
2445
|
} else {
|
|
2564
2446
|
Logger({
|
|
2565
2447
|
level: "WARN",
|
|
2566
|
-
message: `Response Validation Warnings for platform > Catalog >
|
|
2448
|
+
message: `Response Validation Warnings for platform > Catalog > getAppReturnConfiguration \n ${res_error}`,
|
|
2567
2449
|
});
|
|
2568
2450
|
}
|
|
2569
2451
|
}
|
|
@@ -2571,78 +2453,6 @@ class Catalog {
|
|
|
2571
2453
|
return response;
|
|
2572
2454
|
}
|
|
2573
2455
|
|
|
2574
|
-
/**
|
|
2575
|
-
* @param {Object} arg - Arg object.
|
|
2576
|
-
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
2577
|
-
* a particular seller account.
|
|
2578
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
2579
|
-
* identifier for a particular sale channel.
|
|
2580
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
2581
|
-
* complete name of a either a product, brand or category
|
|
2582
|
-
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
2583
|
-
* filtered from filter parameters will be passed in **f** parameter in
|
|
2584
|
-
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
2585
|
-
* @param {string} [arg.c] - The search filter parameters for collection
|
|
2586
|
-
* items. All the parameter filtered from filter parameters will be passed
|
|
2587
|
-
* in **c** parameter in this format.
|
|
2588
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
2589
|
-
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
2590
|
-
* filter details. This flag is used to fetch all filters
|
|
2591
|
-
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
2592
|
-
* the dependent products in the listing.
|
|
2593
|
-
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
2594
|
-
* The supported sort parameters are popularity, price, redemption and
|
|
2595
|
-
* discount in either ascending or descending order. See the supported
|
|
2596
|
-
* values below.
|
|
2597
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2598
|
-
* page. Default is 12.
|
|
2599
|
-
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
2600
|
-
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
2601
|
-
* @summary: List sales channel products
|
|
2602
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
2603
|
-
*/
|
|
2604
|
-
getAppicationProductsPaginator({
|
|
2605
|
-
companyId,
|
|
2606
|
-
applicationId,
|
|
2607
|
-
q,
|
|
2608
|
-
f,
|
|
2609
|
-
c,
|
|
2610
|
-
filters,
|
|
2611
|
-
isDependent,
|
|
2612
|
-
sortOn,
|
|
2613
|
-
pageSize,
|
|
2614
|
-
itemIds,
|
|
2615
|
-
} = {}) {
|
|
2616
|
-
const paginator = new Paginator();
|
|
2617
|
-
const callback = async () => {
|
|
2618
|
-
const pageId = paginator.nextId;
|
|
2619
|
-
const pageNo = paginator.pageNo;
|
|
2620
|
-
const pageType = "cursor";
|
|
2621
|
-
const data = await this.getAppicationProducts({
|
|
2622
|
-
companyId: companyId,
|
|
2623
|
-
applicationId: applicationId,
|
|
2624
|
-
q: q,
|
|
2625
|
-
f: f,
|
|
2626
|
-
c: c,
|
|
2627
|
-
filters: filters,
|
|
2628
|
-
isDependent: isDependent,
|
|
2629
|
-
sortOn: sortOn,
|
|
2630
|
-
pageId: pageId,
|
|
2631
|
-
pageSize: pageSize,
|
|
2632
|
-
pageNo: pageNo,
|
|
2633
|
-
pageType: pageType,
|
|
2634
|
-
itemIds: itemIds,
|
|
2635
|
-
});
|
|
2636
|
-
paginator.setPaginator({
|
|
2637
|
-
hasNext: data.page.has_next ? true : false,
|
|
2638
|
-
nextId: data.page.next_id,
|
|
2639
|
-
});
|
|
2640
|
-
return data;
|
|
2641
|
-
};
|
|
2642
|
-
paginator.setCallback(callback.bind(this));
|
|
2643
|
-
return paginator;
|
|
2644
|
-
}
|
|
2645
|
-
|
|
2646
2456
|
/**
|
|
2647
2457
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
2648
2458
|
* - Arg object
|
|
@@ -2740,8 +2550,8 @@ class Catalog {
|
|
|
2740
2550
|
* identifier for a particular sale channel.
|
|
2741
2551
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2742
2552
|
* page. Default is 12.
|
|
2743
|
-
* @param {string} [arg.q] - Search query with brand name.
|
|
2744
|
-
*
|
|
2553
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2554
|
+
* to search brands by brand name.
|
|
2745
2555
|
* @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
|
|
2746
2556
|
* @summary: List sales channel brands
|
|
2747
2557
|
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
|
|
@@ -2780,10 +2590,11 @@ class Catalog {
|
|
|
2780
2590
|
*
|
|
2781
2591
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2782
2592
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2783
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2593
|
+
* @returns {Promise<CatalogPlatformModel.BrandListingResponseSchema>} -
|
|
2594
|
+
* Success response
|
|
2784
2595
|
* @name getApplicationBrands
|
|
2785
2596
|
* @summary: List brands
|
|
2786
|
-
* @description: List all the brands
|
|
2597
|
+
* @description: List all the brands, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
2787
2598
|
*/
|
|
2788
2599
|
async getApplicationBrands(
|
|
2789
2600
|
{ department, pageNo, pageSize, q, brandId, requestHeaders } = {
|
|
@@ -2851,10 +2662,10 @@ class Catalog {
|
|
|
2851
2662
|
|
|
2852
2663
|
const {
|
|
2853
2664
|
error: res_error,
|
|
2854
|
-
} = CatalogPlatformModel.
|
|
2855
|
-
|
|
2856
|
-
allowUnknown: true
|
|
2857
|
-
|
|
2665
|
+
} = CatalogPlatformModel.BrandListingResponseSchema().validate(
|
|
2666
|
+
responseData,
|
|
2667
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2668
|
+
);
|
|
2858
2669
|
|
|
2859
2670
|
if (res_error) {
|
|
2860
2671
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2879,16 +2690,16 @@ class Catalog {
|
|
|
2879
2690
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
2880
2691
|
* parameter to filter products by a particular department. See below the
|
|
2881
2692
|
* list of available departments. You can retrieve available departments
|
|
2882
|
-
* from the
|
|
2693
|
+
* from the **v1.0/departments/** API
|
|
2883
2694
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2884
2695
|
* page. Default is 12.
|
|
2885
|
-
* @param {string} [arg.q] - Search query with brand name.
|
|
2886
|
-
*
|
|
2696
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2697
|
+
* to search brands by brand name.
|
|
2887
2698
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
2888
2699
|
* basis of uid list.
|
|
2889
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2700
|
+
* @returns {Paginator<CatalogPlatformModel.BrandListingResponseSchema>}
|
|
2890
2701
|
* @summary: List brands
|
|
2891
|
-
* @description: List all the brands
|
|
2702
|
+
* @description: List all the brands, and have search capabilities on brand uid, name etc
|
|
2892
2703
|
*/
|
|
2893
2704
|
getApplicationBrandsPaginator({
|
|
2894
2705
|
companyId,
|
|
@@ -3027,8 +2838,8 @@ class Catalog {
|
|
|
3027
2838
|
* identifier for a particular department.
|
|
3028
2839
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
3029
2840
|
* page. Default is 12.
|
|
3030
|
-
* @param {string} [arg.q] -
|
|
3031
|
-
*
|
|
2841
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2842
|
+
* to search brands by brand name.
|
|
3032
2843
|
* @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
|
|
3033
2844
|
* @summary: List sales channel categories
|
|
3034
2845
|
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
|
|
@@ -3069,7 +2880,7 @@ class Catalog {
|
|
|
3069
2880
|
*
|
|
3070
2881
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3071
2882
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3072
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2883
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
3073
2884
|
* - Success response
|
|
3074
2885
|
*
|
|
3075
2886
|
* @name getApplicationDepartmentListing
|
|
@@ -3134,7 +2945,7 @@ class Catalog {
|
|
|
3134
2945
|
|
|
3135
2946
|
const {
|
|
3136
2947
|
error: res_error,
|
|
3137
|
-
} = CatalogPlatformModel.
|
|
2948
|
+
} = CatalogPlatformModel.ApplicationDepartmentListingResponseSchema().validate(
|
|
3138
2949
|
responseData,
|
|
3139
2950
|
{ abortEarly: false, allowUnknown: true }
|
|
3140
2951
|
);
|
|
@@ -3161,9 +2972,9 @@ class Catalog {
|
|
|
3161
2972
|
* identifier for a particular sale channel.
|
|
3162
2973
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
3163
2974
|
* page. Default is 12.
|
|
3164
|
-
* @param {string} [arg.q] -
|
|
3165
|
-
*
|
|
3166
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2975
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2976
|
+
* to search department by name.
|
|
2977
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
3167
2978
|
* @summary: List sales channel departments
|
|
3168
2979
|
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
|
|
3169
2980
|
*/
|
|
@@ -3201,8 +3012,9 @@ class Catalog {
|
|
|
3201
3012
|
*
|
|
3202
3013
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3203
3014
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3204
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3205
|
-
* Success response
|
|
3015
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>}
|
|
3016
|
+
* - Success response
|
|
3017
|
+
*
|
|
3206
3018
|
* @name getApplicationFilterKeys
|
|
3207
3019
|
* @summary: List filter keys
|
|
3208
3020
|
* @description: Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
|
|
@@ -3259,7 +3071,7 @@ class Catalog {
|
|
|
3259
3071
|
|
|
3260
3072
|
const {
|
|
3261
3073
|
error: res_error,
|
|
3262
|
-
} = CatalogPlatformModel.
|
|
3074
|
+
} = CatalogPlatformModel.GetQueryFiltersKeysResponseSchema().validate(
|
|
3263
3075
|
responseData,
|
|
3264
3076
|
{ abortEarly: false, allowUnknown: true }
|
|
3265
3077
|
);
|
|
@@ -3284,8 +3096,9 @@ class Catalog {
|
|
|
3284
3096
|
*
|
|
3285
3097
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3286
3098
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3287
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3288
|
-
* Success response
|
|
3099
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>}
|
|
3100
|
+
* - Success response
|
|
3101
|
+
*
|
|
3289
3102
|
* @name getApplicationFilterValues
|
|
3290
3103
|
* @summary: List product filters
|
|
3291
3104
|
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
@@ -3359,7 +3172,7 @@ class Catalog {
|
|
|
3359
3172
|
|
|
3360
3173
|
const {
|
|
3361
3174
|
error: res_error,
|
|
3362
|
-
} = CatalogPlatformModel.
|
|
3175
|
+
} = CatalogPlatformModel.GetQueryFiltersValuesResponseSchema().validate(
|
|
3363
3176
|
responseData,
|
|
3364
3177
|
{ abortEarly: false, allowUnknown: true }
|
|
3365
3178
|
);
|
|
@@ -3378,14 +3191,214 @@ class Catalog {
|
|
|
3378
3191
|
return response;
|
|
3379
3192
|
}
|
|
3380
3193
|
|
|
3194
|
+
/**
|
|
3195
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
|
|
3196
|
+
* - Arg object
|
|
3197
|
+
*
|
|
3198
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3199
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3200
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
3201
|
+
* - Success response
|
|
3202
|
+
*
|
|
3203
|
+
* @name getApplicationProducts
|
|
3204
|
+
* @summary: List sales channel products
|
|
3205
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationProducts/).
|
|
3206
|
+
*/
|
|
3207
|
+
async getApplicationProducts(
|
|
3208
|
+
{
|
|
3209
|
+
q,
|
|
3210
|
+
f,
|
|
3211
|
+
c,
|
|
3212
|
+
filters,
|
|
3213
|
+
isDependent,
|
|
3214
|
+
sortOn,
|
|
3215
|
+
pageId,
|
|
3216
|
+
pageSize,
|
|
3217
|
+
pageNo,
|
|
3218
|
+
pageType,
|
|
3219
|
+
itemIds,
|
|
3220
|
+
requestHeaders,
|
|
3221
|
+
} = { requestHeaders: {} },
|
|
3222
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3223
|
+
) {
|
|
3224
|
+
const {
|
|
3225
|
+
error,
|
|
3226
|
+
} = CatalogPlatformApplicationValidator.getApplicationProducts().validate(
|
|
3227
|
+
{
|
|
3228
|
+
q,
|
|
3229
|
+
f,
|
|
3230
|
+
c,
|
|
3231
|
+
filters,
|
|
3232
|
+
isDependent,
|
|
3233
|
+
sortOn,
|
|
3234
|
+
pageId,
|
|
3235
|
+
pageSize,
|
|
3236
|
+
pageNo,
|
|
3237
|
+
pageType,
|
|
3238
|
+
itemIds,
|
|
3239
|
+
},
|
|
3240
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3241
|
+
);
|
|
3242
|
+
if (error) {
|
|
3243
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3244
|
+
}
|
|
3245
|
+
|
|
3246
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3247
|
+
const {
|
|
3248
|
+
error: warrning,
|
|
3249
|
+
} = CatalogPlatformApplicationValidator.getApplicationProducts().validate(
|
|
3250
|
+
{
|
|
3251
|
+
q,
|
|
3252
|
+
f,
|
|
3253
|
+
c,
|
|
3254
|
+
filters,
|
|
3255
|
+
isDependent,
|
|
3256
|
+
sortOn,
|
|
3257
|
+
pageId,
|
|
3258
|
+
pageSize,
|
|
3259
|
+
pageNo,
|
|
3260
|
+
pageType,
|
|
3261
|
+
itemIds,
|
|
3262
|
+
},
|
|
3263
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3264
|
+
);
|
|
3265
|
+
if (warrning) {
|
|
3266
|
+
Logger({
|
|
3267
|
+
level: "WARN",
|
|
3268
|
+
message: `Parameter Validation warrnings for platform > Catalog > getApplicationProducts \n ${warrning}`,
|
|
3269
|
+
});
|
|
3270
|
+
}
|
|
3271
|
+
|
|
3272
|
+
const query_params = {};
|
|
3273
|
+
query_params["q"] = q;
|
|
3274
|
+
query_params["f"] = f;
|
|
3275
|
+
query_params["c"] = c;
|
|
3276
|
+
query_params["filters"] = filters;
|
|
3277
|
+
query_params["is_dependent"] = isDependent;
|
|
3278
|
+
query_params["sort_on"] = sortOn;
|
|
3279
|
+
query_params["page_id"] = pageId;
|
|
3280
|
+
query_params["page_size"] = pageSize;
|
|
3281
|
+
query_params["page_no"] = pageNo;
|
|
3282
|
+
query_params["page_type"] = pageType;
|
|
3283
|
+
query_params["item_ids"] = itemIds;
|
|
3284
|
+
|
|
3285
|
+
const response = await PlatformAPIClient.execute(
|
|
3286
|
+
this.config,
|
|
3287
|
+
"get",
|
|
3288
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/products`,
|
|
3289
|
+
query_params,
|
|
3290
|
+
undefined,
|
|
3291
|
+
requestHeaders,
|
|
3292
|
+
{ responseHeaders }
|
|
3293
|
+
);
|
|
3294
|
+
|
|
3295
|
+
let responseData = response;
|
|
3296
|
+
if (responseHeaders) {
|
|
3297
|
+
responseData = response[0];
|
|
3298
|
+
}
|
|
3299
|
+
|
|
3300
|
+
const {
|
|
3301
|
+
error: res_error,
|
|
3302
|
+
} = CatalogPlatformModel.ApplicationProductListingResponseSchema().validate(
|
|
3303
|
+
responseData,
|
|
3304
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3305
|
+
);
|
|
3306
|
+
|
|
3307
|
+
if (res_error) {
|
|
3308
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3309
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3310
|
+
} else {
|
|
3311
|
+
Logger({
|
|
3312
|
+
level: "WARN",
|
|
3313
|
+
message: `Response Validation Warnings for platform > Catalog > getApplicationProducts \n ${res_error}`,
|
|
3314
|
+
});
|
|
3315
|
+
}
|
|
3316
|
+
}
|
|
3317
|
+
|
|
3318
|
+
return response;
|
|
3319
|
+
}
|
|
3320
|
+
|
|
3321
|
+
/**
|
|
3322
|
+
* @param {Object} arg - Arg object.
|
|
3323
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
3324
|
+
* a particular seller account.
|
|
3325
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
3326
|
+
* identifier for a particular sale channel.
|
|
3327
|
+
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
3328
|
+
* complete name of a either a product, brand or category
|
|
3329
|
+
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
3330
|
+
* filtered from filter parameters will be passed in **f** parameter in
|
|
3331
|
+
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
3332
|
+
* @param {string} [arg.c] - The search filter parameters for collection
|
|
3333
|
+
* items. All the parameter filtered from filter parameters will be passed
|
|
3334
|
+
* in **c** parameter in this format.
|
|
3335
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
3336
|
+
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
3337
|
+
* filter details. This flag is used to fetch all filters
|
|
3338
|
+
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
3339
|
+
* the dependent products in the listing.
|
|
3340
|
+
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
3341
|
+
* The supported sort parameters are popularity, price, redemption and
|
|
3342
|
+
* discount in either ascending or descending order. See the supported
|
|
3343
|
+
* values below.
|
|
3344
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
3345
|
+
* page. Default is 12.
|
|
3346
|
+
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
3347
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
3348
|
+
* @summary: List sales channel products
|
|
3349
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
3350
|
+
*/
|
|
3351
|
+
getApplicationProductsPaginator({
|
|
3352
|
+
companyId,
|
|
3353
|
+
applicationId,
|
|
3354
|
+
q,
|
|
3355
|
+
f,
|
|
3356
|
+
c,
|
|
3357
|
+
filters,
|
|
3358
|
+
isDependent,
|
|
3359
|
+
sortOn,
|
|
3360
|
+
pageSize,
|
|
3361
|
+
itemIds,
|
|
3362
|
+
} = {}) {
|
|
3363
|
+
const paginator = new Paginator();
|
|
3364
|
+
const callback = async () => {
|
|
3365
|
+
const pageId = paginator.nextId;
|
|
3366
|
+
const pageNo = paginator.pageNo;
|
|
3367
|
+
const pageType = "cursor";
|
|
3368
|
+
const data = await this.getApplicationProducts({
|
|
3369
|
+
companyId: companyId,
|
|
3370
|
+
applicationId: applicationId,
|
|
3371
|
+
q: q,
|
|
3372
|
+
f: f,
|
|
3373
|
+
c: c,
|
|
3374
|
+
filters: filters,
|
|
3375
|
+
isDependent: isDependent,
|
|
3376
|
+
sortOn: sortOn,
|
|
3377
|
+
pageId: pageId,
|
|
3378
|
+
pageSize: pageSize,
|
|
3379
|
+
pageNo: pageNo,
|
|
3380
|
+
pageType: pageType,
|
|
3381
|
+
itemIds: itemIds,
|
|
3382
|
+
});
|
|
3383
|
+
paginator.setPaginator({
|
|
3384
|
+
hasNext: data.page.has_next ? true : false,
|
|
3385
|
+
nextId: data.page.next_id,
|
|
3386
|
+
});
|
|
3387
|
+
return data;
|
|
3388
|
+
};
|
|
3389
|
+
paginator.setCallback(callback.bind(this));
|
|
3390
|
+
return paginator;
|
|
3391
|
+
}
|
|
3392
|
+
|
|
3381
3393
|
/**
|
|
3382
3394
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
3383
3395
|
* - Arg object
|
|
3384
3396
|
*
|
|
3385
3397
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3386
3398
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3387
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3388
|
-
* Success response
|
|
3399
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
3400
|
+
* - Success response
|
|
3401
|
+
*
|
|
3389
3402
|
* @name getAutocompleteConfig
|
|
3390
3403
|
* @summary: Get autocomplete configuration
|
|
3391
3404
|
* @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
|
|
@@ -3437,7 +3450,7 @@ class Catalog {
|
|
|
3437
3450
|
|
|
3438
3451
|
const {
|
|
3439
3452
|
error: res_error,
|
|
3440
|
-
} = CatalogPlatformModel.
|
|
3453
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponseSchema().validate(
|
|
3441
3454
|
responseData,
|
|
3442
3455
|
{ abortEarly: false, allowUnknown: true }
|
|
3443
3456
|
);
|
|
@@ -3462,8 +3475,9 @@ class Catalog {
|
|
|
3462
3475
|
*
|
|
3463
3476
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3464
3477
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3465
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3466
|
-
* Success response
|
|
3478
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
3479
|
+
* - Success response
|
|
3480
|
+
*
|
|
3467
3481
|
* @name getAutocompleteKeywordDetail
|
|
3468
3482
|
* @summary: Get autocomplete keyword
|
|
3469
3483
|
* @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
@@ -3519,7 +3533,7 @@ class Catalog {
|
|
|
3519
3533
|
|
|
3520
3534
|
const {
|
|
3521
3535
|
error: res_error,
|
|
3522
|
-
} = CatalogPlatformModel.
|
|
3536
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponseSchema().validate(
|
|
3523
3537
|
responseData,
|
|
3524
3538
|
{ abortEarly: false, allowUnknown: true }
|
|
3525
3539
|
);
|
|
@@ -3623,7 +3637,8 @@ class Catalog {
|
|
|
3623
3637
|
*
|
|
3624
3638
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3625
3639
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3626
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3640
|
+
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponseSchema>} -
|
|
3641
|
+
* Success response
|
|
3627
3642
|
* @name getCatalogInsights
|
|
3628
3643
|
* @summary: Get catalog counts
|
|
3629
3644
|
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
|
|
@@ -3680,10 +3695,10 @@ class Catalog {
|
|
|
3680
3695
|
|
|
3681
3696
|
const {
|
|
3682
3697
|
error: res_error,
|
|
3683
|
-
} = CatalogPlatformModel.
|
|
3684
|
-
|
|
3685
|
-
allowUnknown: true
|
|
3686
|
-
|
|
3698
|
+
} = CatalogPlatformModel.CatalogInsightResponseSchema().validate(
|
|
3699
|
+
responseData,
|
|
3700
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3701
|
+
);
|
|
3687
3702
|
|
|
3688
3703
|
if (res_error) {
|
|
3689
3704
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3703,7 +3718,8 @@ class Catalog {
|
|
|
3703
3718
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
3704
3719
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3705
3720
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3706
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3721
|
+
* @returns {Promise<CatalogPlatformModel.CategoryListingResponseSchema>} -
|
|
3722
|
+
* Success response
|
|
3707
3723
|
* @name getCategories
|
|
3708
3724
|
* @summary: List categories
|
|
3709
3725
|
* @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
|
|
@@ -3760,10 +3776,10 @@ class Catalog {
|
|
|
3760
3776
|
|
|
3761
3777
|
const {
|
|
3762
3778
|
error: res_error,
|
|
3763
|
-
} = CatalogPlatformModel.
|
|
3764
|
-
|
|
3765
|
-
allowUnknown: true
|
|
3766
|
-
|
|
3779
|
+
} = CatalogPlatformModel.CategoryListingResponseSchema().validate(
|
|
3780
|
+
responseData,
|
|
3781
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3782
|
+
);
|
|
3767
3783
|
|
|
3768
3784
|
if (res_error) {
|
|
3769
3785
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3785,8 +3801,9 @@ class Catalog {
|
|
|
3785
3801
|
*
|
|
3786
3802
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3787
3803
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3788
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3789
|
-
* Success response
|
|
3804
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>}
|
|
3805
|
+
* - Success response
|
|
3806
|
+
*
|
|
3790
3807
|
* @name getCollectionDetail
|
|
3791
3808
|
* @summary: Get a collection
|
|
3792
3809
|
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
@@ -3842,7 +3859,7 @@ class Catalog {
|
|
|
3842
3859
|
|
|
3843
3860
|
const {
|
|
3844
3861
|
error: res_error,
|
|
3845
|
-
} = CatalogPlatformModel.
|
|
3862
|
+
} = CatalogPlatformModel.GetCollectionDetailResponseSchema().validate(
|
|
3846
3863
|
responseData,
|
|
3847
3864
|
{ abortEarly: false, allowUnknown: true }
|
|
3848
3865
|
);
|
|
@@ -3867,8 +3884,9 @@ class Catalog {
|
|
|
3867
3884
|
*
|
|
3868
3885
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3869
3886
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3870
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3871
|
-
* Success response
|
|
3887
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>}
|
|
3888
|
+
* - Success response
|
|
3889
|
+
*
|
|
3872
3890
|
* @name getCollectionItems
|
|
3873
3891
|
* @summary: List items of collection
|
|
3874
3892
|
* @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
|
|
@@ -3933,7 +3951,7 @@ class Catalog {
|
|
|
3933
3951
|
|
|
3934
3952
|
const {
|
|
3935
3953
|
error: res_error,
|
|
3936
|
-
} = CatalogPlatformModel.
|
|
3954
|
+
} = CatalogPlatformModel.GetCollectionItemsResponseSchema().validate(
|
|
3937
3955
|
responseData,
|
|
3938
3956
|
{ abortEarly: false, allowUnknown: true }
|
|
3939
3957
|
);
|
|
@@ -4041,8 +4059,9 @@ class Catalog {
|
|
|
4041
4059
|
*
|
|
4042
4060
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4043
4061
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4044
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4045
|
-
* Success response
|
|
4062
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>}
|
|
4063
|
+
* - Success response
|
|
4064
|
+
*
|
|
4046
4065
|
* @name getConfigurationMetadata
|
|
4047
4066
|
* @summary: Get configuration metadata
|
|
4048
4067
|
* @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
@@ -4112,7 +4131,7 @@ class Catalog {
|
|
|
4112
4131
|
|
|
4113
4132
|
const {
|
|
4114
4133
|
error: res_error,
|
|
4115
|
-
} = CatalogPlatformModel.
|
|
4134
|
+
} = CatalogPlatformModel.GetConfigMetadataResponseSchema().validate(
|
|
4116
4135
|
responseData,
|
|
4117
4136
|
{ abortEarly: false, allowUnknown: true }
|
|
4118
4137
|
);
|
|
@@ -4213,7 +4232,8 @@ class Catalog {
|
|
|
4213
4232
|
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
4214
4233
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4215
4234
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4216
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4235
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentResponseSchema>} -
|
|
4236
|
+
* Success response
|
|
4217
4237
|
* @name getDepartments
|
|
4218
4238
|
* @summary: List departments
|
|
4219
4239
|
* @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
|
|
@@ -4265,7 +4285,7 @@ class Catalog {
|
|
|
4265
4285
|
|
|
4266
4286
|
const {
|
|
4267
4287
|
error: res_error,
|
|
4268
|
-
} = CatalogPlatformModel.
|
|
4288
|
+
} = CatalogPlatformModel.DepartmentResponseSchema().validate(responseData, {
|
|
4269
4289
|
abortEarly: false,
|
|
4270
4290
|
allowUnknown: true,
|
|
4271
4291
|
});
|
|
@@ -4445,7 +4465,7 @@ class Catalog {
|
|
|
4445
4465
|
*
|
|
4446
4466
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4447
4467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4448
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4468
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
4449
4469
|
* @name getGroupConfigurations
|
|
4450
4470
|
* @summary: Get group configurations
|
|
4451
4471
|
* @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
|
|
@@ -4515,7 +4535,7 @@ class Catalog {
|
|
|
4515
4535
|
|
|
4516
4536
|
const {
|
|
4517
4537
|
error: res_error,
|
|
4518
|
-
} = CatalogPlatformModel.
|
|
4538
|
+
} = CatalogPlatformModel.GetConfigResponseSchema().validate(responseData, {
|
|
4519
4539
|
abortEarly: false,
|
|
4520
4540
|
allowUnknown: true,
|
|
4521
4541
|
});
|
|
@@ -4540,7 +4560,7 @@ class Catalog {
|
|
|
4540
4560
|
*
|
|
4541
4561
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4542
4562
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4543
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4563
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
4544
4564
|
* @name getListingConfigurations
|
|
4545
4565
|
* @summary: Get listing configurations
|
|
4546
4566
|
* @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
|
|
@@ -4607,7 +4627,7 @@ class Catalog {
|
|
|
4607
4627
|
|
|
4608
4628
|
const {
|
|
4609
4629
|
error: res_error,
|
|
4610
|
-
} = CatalogPlatformModel.
|
|
4630
|
+
} = CatalogPlatformModel.GetConfigResponseSchema().validate(responseData, {
|
|
4611
4631
|
abortEarly: false,
|
|
4612
4632
|
allowUnknown: true,
|
|
4613
4633
|
});
|
|
@@ -4711,7 +4731,8 @@ class Catalog {
|
|
|
4711
4731
|
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
4712
4732
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4713
4733
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4714
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4734
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>} -
|
|
4735
|
+
* Success response
|
|
4715
4736
|
* @name getQueryFilters
|
|
4716
4737
|
* @summary: Get collection query filters
|
|
4717
4738
|
* @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
@@ -4763,10 +4784,10 @@ class Catalog {
|
|
|
4763
4784
|
|
|
4764
4785
|
const {
|
|
4765
4786
|
error: res_error,
|
|
4766
|
-
} = CatalogPlatformModel.
|
|
4767
|
-
|
|
4768
|
-
allowUnknown: true
|
|
4769
|
-
|
|
4787
|
+
} = CatalogPlatformModel.GetQueryFiltersResponseSchema().validate(
|
|
4788
|
+
responseData,
|
|
4789
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4790
|
+
);
|
|
4770
4791
|
|
|
4771
4792
|
if (res_error) {
|
|
4772
4793
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -4788,7 +4809,7 @@ class Catalog {
|
|
|
4788
4809
|
*
|
|
4789
4810
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4790
4811
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4791
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4812
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>}
|
|
4792
4813
|
* - Success response
|
|
4793
4814
|
*
|
|
4794
4815
|
* @name getSearchConfiguration
|
|
@@ -4842,7 +4863,7 @@ class Catalog {
|
|
|
4842
4863
|
|
|
4843
4864
|
const {
|
|
4844
4865
|
error: res_error,
|
|
4845
|
-
} = CatalogPlatformModel.
|
|
4866
|
+
} = CatalogPlatformModel.GetSearchConfigurationResponseSchema().validate(
|
|
4846
4867
|
responseData,
|
|
4847
4868
|
{ abortEarly: false, allowUnknown: true }
|
|
4848
4869
|
);
|
|
@@ -4867,8 +4888,9 @@ class Catalog {
|
|
|
4867
4888
|
*
|
|
4868
4889
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4869
4890
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4870
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4871
|
-
* Success response
|
|
4891
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>}
|
|
4892
|
+
* - Success response
|
|
4893
|
+
*
|
|
4872
4894
|
* @name getSearchKeywords
|
|
4873
4895
|
* @summary: Get search keywords
|
|
4874
4896
|
* @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
|
|
@@ -4924,7 +4946,7 @@ class Catalog {
|
|
|
4924
4946
|
|
|
4925
4947
|
const {
|
|
4926
4948
|
error: res_error,
|
|
4927
|
-
} = CatalogPlatformModel.
|
|
4949
|
+
} = CatalogPlatformModel.GetSearchWordsDetailResponseSchema().validate(
|
|
4928
4950
|
responseData,
|
|
4929
4951
|
{ abortEarly: false, allowUnknown: true }
|
|
4930
4952
|
);
|
|
@@ -4949,7 +4971,8 @@ class Catalog {
|
|
|
4949
4971
|
*
|
|
4950
4972
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4951
4973
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4952
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4974
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
4975
|
+
* Success response
|
|
4953
4976
|
* @name updateAllowSingle
|
|
4954
4977
|
* @summary: Update 'Allow Single' setting
|
|
4955
4978
|
* @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
|
|
@@ -5005,10 +5028,10 @@ class Catalog {
|
|
|
5005
5028
|
|
|
5006
5029
|
const {
|
|
5007
5030
|
error: res_error,
|
|
5008
|
-
} = CatalogPlatformModel.
|
|
5009
|
-
|
|
5010
|
-
allowUnknown: true
|
|
5011
|
-
|
|
5031
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
5032
|
+
responseData,
|
|
5033
|
+
{ abortEarly: false, allowUnknown: true }
|
|
5034
|
+
);
|
|
5012
5035
|
|
|
5013
5036
|
if (res_error) {
|
|
5014
5037
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -5028,7 +5051,7 @@ class Catalog {
|
|
|
5028
5051
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
5029
5052
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5030
5053
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5031
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5054
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5032
5055
|
* @name updateAppBrand
|
|
5033
5056
|
* @summary: Update sales channel brand
|
|
5034
5057
|
* @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
@@ -5086,7 +5109,7 @@ class Catalog {
|
|
|
5086
5109
|
|
|
5087
5110
|
const {
|
|
5088
5111
|
error: res_error,
|
|
5089
|
-
} = CatalogPlatformModel.
|
|
5112
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
5090
5113
|
abortEarly: false,
|
|
5091
5114
|
allowUnknown: true,
|
|
5092
5115
|
});
|
|
@@ -5111,7 +5134,7 @@ class Catalog {
|
|
|
5111
5134
|
*
|
|
5112
5135
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5113
5136
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5114
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5137
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5115
5138
|
* @name updateAppCategory
|
|
5116
5139
|
* @summary: Update sales channel category
|
|
5117
5140
|
* @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
@@ -5169,7 +5192,7 @@ class Catalog {
|
|
|
5169
5192
|
|
|
5170
5193
|
const {
|
|
5171
5194
|
error: res_error,
|
|
5172
|
-
} = CatalogPlatformModel.
|
|
5195
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
5173
5196
|
abortEarly: false,
|
|
5174
5197
|
allowUnknown: true,
|
|
5175
5198
|
});
|
|
@@ -5194,7 +5217,7 @@ class Catalog {
|
|
|
5194
5217
|
*
|
|
5195
5218
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5196
5219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5197
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5220
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
5198
5221
|
* @name updateAppCategoryReturnConfiguration
|
|
5199
5222
|
* @summary: Update return Configuration
|
|
5200
5223
|
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
@@ -5250,7 +5273,7 @@ class Catalog {
|
|
|
5250
5273
|
|
|
5251
5274
|
const {
|
|
5252
5275
|
error: res_error,
|
|
5253
|
-
} = CatalogPlatformModel.
|
|
5276
|
+
} = CatalogPlatformModel.SuccessResponseSchema().validate(responseData, {
|
|
5254
5277
|
abortEarly: false,
|
|
5255
5278
|
allowUnknown: true,
|
|
5256
5279
|
});
|
|
@@ -5275,7 +5298,7 @@ class Catalog {
|
|
|
5275
5298
|
*
|
|
5276
5299
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5277
5300
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5278
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5301
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5279
5302
|
* @name updateAppDepartment
|
|
5280
5303
|
* @summary: Update sales channel department
|
|
5281
5304
|
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
@@ -5333,7 +5356,7 @@ class Catalog {
|
|
|
5333
5356
|
|
|
5334
5357
|
const {
|
|
5335
5358
|
error: res_error,
|
|
5336
|
-
} = CatalogPlatformModel.
|
|
5359
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
5337
5360
|
abortEarly: false,
|
|
5338
5361
|
allowUnknown: true,
|
|
5339
5362
|
});
|
|
@@ -5358,7 +5381,7 @@ class Catalog {
|
|
|
5358
5381
|
*
|
|
5359
5382
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5360
5383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5361
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5384
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5362
5385
|
* @name updateAppLocation
|
|
5363
5386
|
* @summary: Update sales channel location
|
|
5364
5387
|
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
@@ -5416,7 +5439,7 @@ class Catalog {
|
|
|
5416
5439
|
|
|
5417
5440
|
const {
|
|
5418
5441
|
error: res_error,
|
|
5419
|
-
} = CatalogPlatformModel.
|
|
5442
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
5420
5443
|
abortEarly: false,
|
|
5421
5444
|
allowUnknown: true,
|
|
5422
5445
|
});
|
|
@@ -5439,7 +5462,7 @@ class Catalog {
|
|
|
5439
5462
|
* @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
|
|
5440
5463
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5441
5464
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5442
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5465
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5443
5466
|
* @name updateAppProduct
|
|
5444
5467
|
* @summary: Update sales channel product
|
|
5445
5468
|
* @description: Allows to update data associated to a item by its item_id for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
@@ -5497,7 +5520,7 @@ class Catalog {
|
|
|
5497
5520
|
|
|
5498
5521
|
const {
|
|
5499
5522
|
error: res_error,
|
|
5500
|
-
} = CatalogPlatformModel.
|
|
5523
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
5501
5524
|
abortEarly: false,
|
|
5502
5525
|
allowUnknown: true,
|
|
5503
5526
|
});
|
|
@@ -5522,7 +5545,7 @@ class Catalog {
|
|
|
5522
5545
|
*
|
|
5523
5546
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5524
5547
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5525
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5548
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5526
5549
|
* @name updateAppReturnConfiguration
|
|
5527
5550
|
* @summary: Update product return configuration
|
|
5528
5551
|
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
@@ -5578,7 +5601,7 @@ class Catalog {
|
|
|
5578
5601
|
|
|
5579
5602
|
const {
|
|
5580
5603
|
error: res_error,
|
|
5581
|
-
} = CatalogPlatformModel.
|
|
5604
|
+
} = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
|
|
5582
5605
|
abortEarly: false,
|
|
5583
5606
|
allowUnknown: true,
|
|
5584
5607
|
});
|
|
@@ -5603,8 +5626,9 @@ class Catalog {
|
|
|
5603
5626
|
*
|
|
5604
5627
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5605
5628
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5606
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5607
|
-
* Success response
|
|
5629
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
5630
|
+
* - Success response
|
|
5631
|
+
*
|
|
5608
5632
|
* @name updateAutocompleteKeyword
|
|
5609
5633
|
* @summary: Update autocomplete keyword
|
|
5610
5634
|
* @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
|
|
@@ -5662,7 +5686,7 @@ class Catalog {
|
|
|
5662
5686
|
|
|
5663
5687
|
const {
|
|
5664
5688
|
error: res_error,
|
|
5665
|
-
} = CatalogPlatformModel.
|
|
5689
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponseSchema().validate(
|
|
5666
5690
|
responseData,
|
|
5667
5691
|
{ abortEarly: false, allowUnknown: true }
|
|
5668
5692
|
);
|
|
@@ -5768,7 +5792,8 @@ class Catalog {
|
|
|
5768
5792
|
*
|
|
5769
5793
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5770
5794
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5771
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5795
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
5796
|
+
* Success response
|
|
5772
5797
|
* @name updateDefaultSort
|
|
5773
5798
|
* @summary: Update default sorting
|
|
5774
5799
|
* @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
|
|
@@ -5824,10 +5849,10 @@ class Catalog {
|
|
|
5824
5849
|
|
|
5825
5850
|
const {
|
|
5826
5851
|
error: res_error,
|
|
5827
|
-
} = CatalogPlatformModel.
|
|
5828
|
-
|
|
5829
|
-
allowUnknown: true
|
|
5830
|
-
|
|
5852
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
5853
|
+
responseData,
|
|
5854
|
+
{ abortEarly: false, allowUnknown: true }
|
|
5855
|
+
);
|
|
5831
5856
|
|
|
5832
5857
|
if (res_error) {
|
|
5833
5858
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -6019,7 +6044,7 @@ class Catalog {
|
|
|
6019
6044
|
*
|
|
6020
6045
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
6021
6046
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6022
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
6047
|
+
* @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>}
|
|
6023
6048
|
* - Success response
|
|
6024
6049
|
*
|
|
6025
6050
|
* @name updateSearchConfiguration
|
|
@@ -6077,7 +6102,7 @@ class Catalog {
|
|
|
6077
6102
|
|
|
6078
6103
|
const {
|
|
6079
6104
|
error: res_error,
|
|
6080
|
-
} = CatalogPlatformModel.
|
|
6105
|
+
} = CatalogPlatformModel.UpdateSearchConfigurationResponseSchema().validate(
|
|
6081
6106
|
responseData,
|
|
6082
6107
|
{ abortEarly: false, allowUnknown: true }
|
|
6083
6108
|
);
|