@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +53 -60
- package/sdk/application/Cart/CartApplicationClient.js +53 -130
- package/sdk/application/Cart/CartApplicationModel.d.ts +143 -489
- package/sdk/application/Cart/CartApplicationModel.js +159 -380
- package/sdk/application/Cart/CartApplicationValidator.d.ts +19 -38
- package/sdk/application/Cart/CartApplicationValidator.js +18 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +68 -88
- package/sdk/application/Catalog/CatalogApplicationClient.js +94 -114
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +142 -194
- package/sdk/application/Catalog/CatalogApplicationModel.js +133 -171
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -3
- package/sdk/application/Common/CommonApplicationClient.js +5 -6
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +57 -45
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +47 -35
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +33 -23
- package/sdk/application/Content/ContentApplicationClient.js +75 -54
- package/sdk/application/Content/ContentApplicationModel.d.ts +37 -93
- package/sdk/application/Content/ContentApplicationModel.js +32 -83
- package/sdk/application/Content/ContentApplicationValidator.d.ts +17 -23
- package/sdk/application/Content/ContentApplicationValidator.js +10 -15
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +13 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +25 -23
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +18 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -2
- package/sdk/application/Lead/LeadApplicationClient.js +3 -2
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +21 -189
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +173 -532
- package/sdk/application/Logistic/LogisticApplicationModel.js +139 -409
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +9 -54
- package/sdk/application/Logistic/LogisticApplicationValidator.js +8 -42
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -24
- package/sdk/application/Order/OrderApplicationClient.js +13 -96
- package/sdk/application/Order/OrderApplicationModel.d.ts +120 -436
- package/sdk/application/Order/OrderApplicationModel.js +81 -279
- package/sdk/application/Order/OrderApplicationValidator.d.ts +3 -17
- package/sdk/application/Order/OrderApplicationValidator.js +2 -15
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +99 -96
- package/sdk/application/Payment/PaymentApplicationClient.js +114 -111
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +289 -293
- package/sdk/application/Payment/PaymentApplicationModel.js +241 -243
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +22 -19
- 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 +6 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +17 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +22 -42
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +3 -16
- package/sdk/application/Theme/ThemeApplicationValidator.js +2 -9
- 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 +9 -11
- package/sdk/application/Webhook/WebhookApplicationModel.js +6 -8
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +0 -1
- package/sdk/application/index.js +0 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- 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 +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1304 -4979
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1922
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
- package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1751 -1501
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1224 -1393
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +124 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +94 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -83
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -25
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -16
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -178
- package/sdk/platform/Order/OrderPlatformClient.js +245 -597
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3071 -5449
- package/sdk/platform/Order/OrderPlatformModel.js +1656 -3501
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +190 -237
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -153
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
- package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +341 -602
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +284 -483
- 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 +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- 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 +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- 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/application/Finance/FinanceApplicationClient.d.ts +0 -36
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
- package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
- package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
|
@@ -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.SuccessResponseObject>} - 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.SuccessResponseObject().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.SuccessResponseObject>} - 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.SuccessResponseObject().validate(responseData, {
|
|
247
247
|
abortEarly: false,
|
|
248
248
|
allowUnknown: true,
|
|
249
249
|
});
|
|
@@ -266,9 +266,8 @@ 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
|
-
*
|
|
271
|
-
*
|
|
269
|
+
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponse>} -
|
|
270
|
+
* Success response
|
|
272
271
|
* @name createCollection
|
|
273
272
|
* @summary: Create a collection
|
|
274
273
|
* @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/).
|
|
@@ -324,10 +323,10 @@ class Catalog {
|
|
|
324
323
|
|
|
325
324
|
const {
|
|
326
325
|
error: res_error,
|
|
327
|
-
} = CatalogPlatformModel.
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
);
|
|
326
|
+
} = CatalogPlatformModel.CollectionCreateResponse().validate(responseData, {
|
|
327
|
+
abortEarly: false,
|
|
328
|
+
allowUnknown: true,
|
|
329
|
+
});
|
|
331
330
|
|
|
332
331
|
if (res_error) {
|
|
333
332
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -515,7 +514,7 @@ class Catalog {
|
|
|
515
514
|
*
|
|
516
515
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
517
516
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
518
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
517
|
+
* @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>}
|
|
519
518
|
* - Success response
|
|
520
519
|
*
|
|
521
520
|
* @name createCustomAutocompleteRule
|
|
@@ -573,7 +572,7 @@ class Catalog {
|
|
|
573
572
|
|
|
574
573
|
const {
|
|
575
574
|
error: res_error,
|
|
576
|
-
} = CatalogPlatformModel.
|
|
575
|
+
} = CatalogPlatformModel.CreateAutocompleteWordsResponse().validate(
|
|
577
576
|
responseData,
|
|
578
577
|
{ abortEarly: false, allowUnknown: true }
|
|
579
578
|
);
|
|
@@ -845,7 +844,7 @@ class Catalog {
|
|
|
845
844
|
*
|
|
846
845
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
847
846
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
848
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
847
|
+
* @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>}
|
|
849
848
|
* - Success response
|
|
850
849
|
*
|
|
851
850
|
* @name createSearchConfiguration
|
|
@@ -903,7 +902,7 @@ class Catalog {
|
|
|
903
902
|
|
|
904
903
|
const {
|
|
905
904
|
error: res_error,
|
|
906
|
-
} = CatalogPlatformModel.
|
|
905
|
+
} = CatalogPlatformModel.CreateSearchConfigurationResponse().validate(
|
|
907
906
|
responseData,
|
|
908
907
|
{ abortEarly: false, allowUnknown: true }
|
|
909
908
|
);
|
|
@@ -928,7 +927,7 @@ class Catalog {
|
|
|
928
927
|
*
|
|
929
928
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
930
929
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
931
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
930
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
932
931
|
* @name deleteAppCategoryReturnConfiguration
|
|
933
932
|
* @summary: Delete product return configuration
|
|
934
933
|
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
@@ -984,7 +983,7 @@ class Catalog {
|
|
|
984
983
|
|
|
985
984
|
const {
|
|
986
985
|
error: res_error,
|
|
987
|
-
} = CatalogPlatformModel.
|
|
986
|
+
} = CatalogPlatformModel.SuccessResponse().validate(responseData, {
|
|
988
987
|
abortEarly: false,
|
|
989
988
|
allowUnknown: true,
|
|
990
989
|
});
|
|
@@ -1009,7 +1008,7 @@ class Catalog {
|
|
|
1009
1008
|
*
|
|
1010
1009
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1011
1010
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1012
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1011
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
1013
1012
|
* @name deleteAutocompleteKeyword
|
|
1014
1013
|
* @summary: Delete autocomplete keyword
|
|
1015
1014
|
* @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/).
|
|
@@ -1065,7 +1064,7 @@ class Catalog {
|
|
|
1065
1064
|
|
|
1066
1065
|
const {
|
|
1067
1066
|
error: res_error,
|
|
1068
|
-
} = CatalogPlatformModel.
|
|
1067
|
+
} = CatalogPlatformModel.DeleteResponse().validate(responseData, {
|
|
1069
1068
|
abortEarly: false,
|
|
1070
1069
|
allowUnknown: true,
|
|
1071
1070
|
});
|
|
@@ -1171,8 +1170,7 @@ class Catalog {
|
|
|
1171
1170
|
*
|
|
1172
1171
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1173
1172
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1174
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1175
|
-
* Success response
|
|
1173
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1176
1174
|
* @name deleteGroupConfiguration
|
|
1177
1175
|
* @summary: Delete group configuration
|
|
1178
1176
|
* @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/).
|
|
@@ -1230,10 +1228,10 @@ class Catalog {
|
|
|
1230
1228
|
|
|
1231
1229
|
const {
|
|
1232
1230
|
error: res_error,
|
|
1233
|
-
} = CatalogPlatformModel.
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
);
|
|
1231
|
+
} = CatalogPlatformModel.ConfigSuccessResponse().validate(responseData, {
|
|
1232
|
+
abortEarly: false,
|
|
1233
|
+
allowUnknown: true,
|
|
1234
|
+
});
|
|
1237
1235
|
|
|
1238
1236
|
if (res_error) {
|
|
1239
1237
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1255,8 +1253,7 @@ class Catalog {
|
|
|
1255
1253
|
*
|
|
1256
1254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1257
1255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1258
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1259
|
-
* Success response
|
|
1256
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1260
1257
|
* @name deleteListingConfiguration
|
|
1261
1258
|
* @summary: Delete listing configuration
|
|
1262
1259
|
* @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/).
|
|
@@ -1314,10 +1311,10 @@ class Catalog {
|
|
|
1314
1311
|
|
|
1315
1312
|
const {
|
|
1316
1313
|
error: res_error,
|
|
1317
|
-
} = CatalogPlatformModel.
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
);
|
|
1314
|
+
} = CatalogPlatformModel.ConfigSuccessResponse().validate(responseData, {
|
|
1315
|
+
abortEarly: false,
|
|
1316
|
+
allowUnknown: true,
|
|
1317
|
+
});
|
|
1321
1318
|
|
|
1322
1319
|
if (res_error) {
|
|
1323
1320
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1339,7 +1336,7 @@ class Catalog {
|
|
|
1339
1336
|
*
|
|
1340
1337
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1341
1338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1342
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1339
|
+
* @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>}
|
|
1343
1340
|
* - Success response
|
|
1344
1341
|
*
|
|
1345
1342
|
* @name deleteSearchConfiguration
|
|
@@ -1393,7 +1390,7 @@ class Catalog {
|
|
|
1393
1390
|
|
|
1394
1391
|
const {
|
|
1395
1392
|
error: res_error,
|
|
1396
|
-
} = CatalogPlatformModel.
|
|
1393
|
+
} = CatalogPlatformModel.DeleteSearchConfigurationResponse().validate(
|
|
1397
1394
|
responseData,
|
|
1398
1395
|
{ abortEarly: false, allowUnknown: true }
|
|
1399
1396
|
);
|
|
@@ -1418,7 +1415,7 @@ class Catalog {
|
|
|
1418
1415
|
*
|
|
1419
1416
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1420
1417
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1421
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1418
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
1422
1419
|
* @name deleteSearchKeywords
|
|
1423
1420
|
* @summary: Delete search keywords
|
|
1424
1421
|
* @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/).
|
|
@@ -1474,7 +1471,7 @@ class Catalog {
|
|
|
1474
1471
|
|
|
1475
1472
|
const {
|
|
1476
1473
|
error: res_error,
|
|
1477
|
-
} = CatalogPlatformModel.
|
|
1474
|
+
} = CatalogPlatformModel.DeleteResponse().validate(responseData, {
|
|
1478
1475
|
abortEarly: false,
|
|
1479
1476
|
allowUnknown: true,
|
|
1480
1477
|
});
|
|
@@ -1499,9 +1496,8 @@ class Catalog {
|
|
|
1499
1496
|
*
|
|
1500
1497
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1501
1498
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1502
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1503
|
-
*
|
|
1504
|
-
*
|
|
1499
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
|
|
1500
|
+
* Success response
|
|
1505
1501
|
* @name getAllCollections
|
|
1506
1502
|
* @summary: List collections
|
|
1507
1503
|
* @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/).
|
|
@@ -1585,7 +1581,7 @@ class Catalog {
|
|
|
1585
1581
|
|
|
1586
1582
|
const {
|
|
1587
1583
|
error: res_error,
|
|
1588
|
-
} = CatalogPlatformModel.
|
|
1584
|
+
} = CatalogPlatformModel.GetCollectionListingResponse().validate(
|
|
1589
1585
|
responseData,
|
|
1590
1586
|
{ abortEarly: false, allowUnknown: true }
|
|
1591
1587
|
);
|
|
@@ -1619,7 +1615,7 @@ class Catalog {
|
|
|
1619
1615
|
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
1620
1616
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1621
1617
|
* page. Default is 12.
|
|
1622
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
1618
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponse>}
|
|
1623
1619
|
* @summary: List collections
|
|
1624
1620
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
|
|
1625
1621
|
*/
|
|
@@ -1665,8 +1661,7 @@ class Catalog {
|
|
|
1665
1661
|
*
|
|
1666
1662
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1667
1663
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1668
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1669
|
-
* Success response
|
|
1664
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
|
|
1670
1665
|
* @name getAllSearchKeyword
|
|
1671
1666
|
* @summary: List search keywords
|
|
1672
1667
|
* @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/).
|
|
@@ -1718,10 +1713,10 @@ class Catalog {
|
|
|
1718
1713
|
|
|
1719
1714
|
const {
|
|
1720
1715
|
error: res_error,
|
|
1721
|
-
} = CatalogPlatformModel.
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
);
|
|
1716
|
+
} = CatalogPlatformModel.GetSearchWordsResponse().validate(responseData, {
|
|
1717
|
+
abortEarly: false,
|
|
1718
|
+
allowUnknown: true,
|
|
1719
|
+
});
|
|
1725
1720
|
|
|
1726
1721
|
if (res_error) {
|
|
1727
1722
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1743,7 +1738,7 @@ class Catalog {
|
|
|
1743
1738
|
*
|
|
1744
1739
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1745
1740
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1746
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1741
|
+
* @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>}
|
|
1747
1742
|
* - Success response
|
|
1748
1743
|
*
|
|
1749
1744
|
* @name getAppCategoryReturnConfig
|
|
@@ -1808,7 +1803,7 @@ class Catalog {
|
|
|
1808
1803
|
|
|
1809
1804
|
const {
|
|
1810
1805
|
error: res_error,
|
|
1811
|
-
} = CatalogPlatformModel.
|
|
1806
|
+
} = CatalogPlatformModel.BaseAppCategoryReturnConfigResponse().validate(
|
|
1812
1807
|
responseData,
|
|
1813
1808
|
{ abortEarly: false, allowUnknown: true }
|
|
1814
1809
|
);
|
|
@@ -1831,8 +1826,7 @@ class Catalog {
|
|
|
1831
1826
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
1832
1827
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1833
1828
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1834
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1835
|
-
* Success response
|
|
1829
|
+
* @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
|
|
1836
1830
|
* @name getAppInventory
|
|
1837
1831
|
* @summary: List sales channel inventory
|
|
1838
1832
|
* @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/).
|
|
@@ -1936,10 +1930,10 @@ class Catalog {
|
|
|
1936
1930
|
|
|
1937
1931
|
const {
|
|
1938
1932
|
error: res_error,
|
|
1939
|
-
} = CatalogPlatformModel.
|
|
1940
|
-
|
|
1941
|
-
|
|
1942
|
-
);
|
|
1933
|
+
} = CatalogPlatformModel.InventoryStockResponse().validate(responseData, {
|
|
1934
|
+
abortEarly: false,
|
|
1935
|
+
allowUnknown: true,
|
|
1936
|
+
});
|
|
1943
1937
|
|
|
1944
1938
|
if (res_error) {
|
|
1945
1939
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1959,7 +1953,7 @@ class Catalog {
|
|
|
1959
1953
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
1960
1954
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1961
1955
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1962
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1956
|
+
* @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
|
|
1963
1957
|
* @name getAppLocations
|
|
1964
1958
|
* @summary: List sales channels
|
|
1965
1959
|
* @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/).
|
|
@@ -2047,7 +2041,7 @@ class Catalog {
|
|
|
2047
2041
|
|
|
2048
2042
|
const {
|
|
2049
2043
|
error: res_error,
|
|
2050
|
-
} = CatalogPlatformModel.
|
|
2044
|
+
} = CatalogPlatformModel.LocationListSerializer().validate(responseData, {
|
|
2051
2045
|
abortEarly: false,
|
|
2052
2046
|
allowUnknown: true,
|
|
2053
2047
|
});
|
|
@@ -2082,7 +2076,7 @@ class Catalog {
|
|
|
2082
2076
|
* page. Default is 20.
|
|
2083
2077
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
2084
2078
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
2085
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2079
|
+
* @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
|
|
2086
2080
|
* @summary: List sales channels
|
|
2087
2081
|
* @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)
|
|
2088
2082
|
*/
|
|
@@ -2128,8 +2122,7 @@ class Catalog {
|
|
|
2128
2122
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
2129
2123
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2130
2124
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2131
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2132
|
-
* Success response
|
|
2125
|
+
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
2133
2126
|
* @name getAppProduct
|
|
2134
2127
|
* @summary: Get sales channel product
|
|
2135
2128
|
* @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/).
|
|
@@ -2185,10 +2178,10 @@ class Catalog {
|
|
|
2185
2178
|
|
|
2186
2179
|
const {
|
|
2187
2180
|
error: res_error,
|
|
2188
|
-
} = CatalogPlatformModel.
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
);
|
|
2181
|
+
} = CatalogPlatformModel.OwnerAppItemResponse().validate(responseData, {
|
|
2182
|
+
abortEarly: false,
|
|
2183
|
+
allowUnknown: true,
|
|
2184
|
+
});
|
|
2192
2185
|
|
|
2193
2186
|
if (res_error) {
|
|
2194
2187
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2208,9 +2201,8 @@ class Catalog {
|
|
|
2208
2201
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
2209
2202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2210
2203
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2211
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2212
|
-
*
|
|
2213
|
-
*
|
|
2204
|
+
* @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
|
|
2205
|
+
* Success response
|
|
2214
2206
|
* @name getAppProducts
|
|
2215
2207
|
* @summary: List sales channel products
|
|
2216
2208
|
* @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/).
|
|
@@ -2298,7 +2290,7 @@ class Catalog {
|
|
|
2298
2290
|
|
|
2299
2291
|
const {
|
|
2300
2292
|
error: res_error,
|
|
2301
|
-
} = CatalogPlatformModel.
|
|
2293
|
+
} = CatalogPlatformModel.RawProductListingResponse().validate(
|
|
2302
2294
|
responseData,
|
|
2303
2295
|
{ abortEarly: false, allowUnknown: true }
|
|
2304
2296
|
);
|
|
@@ -2333,7 +2325,7 @@ class Catalog {
|
|
|
2333
2325
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2334
2326
|
* page. Default is 10.
|
|
2335
2327
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
2336
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2328
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
|
|
2337
2329
|
* @summary: List sales channel products
|
|
2338
2330
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
|
|
2339
2331
|
*/
|
|
@@ -2381,8 +2373,7 @@ class Catalog {
|
|
|
2381
2373
|
*
|
|
2382
2374
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2383
2375
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2384
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2385
|
-
* Success response
|
|
2376
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
|
|
2386
2377
|
* @name getAppReturnConfiguration
|
|
2387
2378
|
* @summary: get product-return configuration
|
|
2388
2379
|
* @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/).
|
|
@@ -2434,7 +2425,134 @@ class Catalog {
|
|
|
2434
2425
|
|
|
2435
2426
|
const {
|
|
2436
2427
|
error: res_error,
|
|
2437
|
-
} = CatalogPlatformModel.
|
|
2428
|
+
} = CatalogPlatformModel.AppReturnConfigResponse().validate(responseData, {
|
|
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(
|
|
2438
2556
|
responseData,
|
|
2439
2557
|
{ abortEarly: false, allowUnknown: true }
|
|
2440
2558
|
);
|
|
@@ -2445,7 +2563,7 @@ class Catalog {
|
|
|
2445
2563
|
} else {
|
|
2446
2564
|
Logger({
|
|
2447
2565
|
level: "WARN",
|
|
2448
|
-
message: `Response Validation Warnings for platform > Catalog >
|
|
2566
|
+
message: `Response Validation Warnings for platform > Catalog > getAppicationProducts \n ${res_error}`,
|
|
2449
2567
|
});
|
|
2450
2568
|
}
|
|
2451
2569
|
}
|
|
@@ -2453,6 +2571,78 @@ class Catalog {
|
|
|
2453
2571
|
return response;
|
|
2454
2572
|
}
|
|
2455
2573
|
|
|
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
|
+
|
|
2456
2646
|
/**
|
|
2457
2647
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
2458
2648
|
* - Arg object
|
|
@@ -2550,8 +2740,8 @@ class Catalog {
|
|
|
2550
2740
|
* identifier for a particular sale channel.
|
|
2551
2741
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2552
2742
|
* page. Default is 12.
|
|
2553
|
-
* @param {string} [arg.q] - Search query with brand name.Use this
|
|
2554
|
-
* to search brands by brand name.
|
|
2743
|
+
* @param {string} [arg.q] - Search query with brand name. Use this
|
|
2744
|
+
* parameter to search brands by brand name.
|
|
2555
2745
|
* @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
|
|
2556
2746
|
* @summary: List sales channel brands
|
|
2557
2747
|
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
|
|
@@ -2590,11 +2780,10 @@ class Catalog {
|
|
|
2590
2780
|
*
|
|
2591
2781
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2592
2782
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2593
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2594
|
-
* Success response
|
|
2783
|
+
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2595
2784
|
* @name getApplicationBrands
|
|
2596
2785
|
* @summary: List brands
|
|
2597
|
-
* @description: List all the brands
|
|
2786
|
+
* @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
2598
2787
|
*/
|
|
2599
2788
|
async getApplicationBrands(
|
|
2600
2789
|
{ department, pageNo, pageSize, q, brandId, requestHeaders } = {
|
|
@@ -2662,10 +2851,10 @@ class Catalog {
|
|
|
2662
2851
|
|
|
2663
2852
|
const {
|
|
2664
2853
|
error: res_error,
|
|
2665
|
-
} = CatalogPlatformModel.
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
);
|
|
2854
|
+
} = CatalogPlatformModel.BrandListingResponse().validate(responseData, {
|
|
2855
|
+
abortEarly: false,
|
|
2856
|
+
allowUnknown: true,
|
|
2857
|
+
});
|
|
2669
2858
|
|
|
2670
2859
|
if (res_error) {
|
|
2671
2860
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2690,16 +2879,16 @@ class Catalog {
|
|
|
2690
2879
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
2691
2880
|
* parameter to filter products by a particular department. See below the
|
|
2692
2881
|
* list of available departments. You can retrieve available departments
|
|
2693
|
-
* from the
|
|
2882
|
+
* from the "v1.0/departments/" API
|
|
2694
2883
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2695
2884
|
* page. Default is 12.
|
|
2696
|
-
* @param {string} [arg.q] - Search query with brand name.Use this
|
|
2697
|
-
* to search brands by brand name.
|
|
2885
|
+
* @param {string} [arg.q] - Search query with brand name. Use this
|
|
2886
|
+
* parameter to search brands by brand name.
|
|
2698
2887
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
2699
2888
|
* basis of uid list.
|
|
2700
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2889
|
+
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2701
2890
|
* @summary: List brands
|
|
2702
|
-
* @description: List all the brands
|
|
2891
|
+
* @description: List all the brands.
|
|
2703
2892
|
*/
|
|
2704
2893
|
getApplicationBrandsPaginator({
|
|
2705
2894
|
companyId,
|
|
@@ -2838,8 +3027,8 @@ class Catalog {
|
|
|
2838
3027
|
* identifier for a particular department.
|
|
2839
3028
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2840
3029
|
* page. Default is 12.
|
|
2841
|
-
* @param {string} [arg.q] -
|
|
2842
|
-
*
|
|
3030
|
+
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
3031
|
+
* filter results based on a keyword or specific value.
|
|
2843
3032
|
* @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
|
|
2844
3033
|
* @summary: List sales channel categories
|
|
2845
3034
|
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
|
|
@@ -2880,7 +3069,7 @@ class Catalog {
|
|
|
2880
3069
|
*
|
|
2881
3070
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2882
3071
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2883
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3072
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
2884
3073
|
* - Success response
|
|
2885
3074
|
*
|
|
2886
3075
|
* @name getApplicationDepartmentListing
|
|
@@ -2945,7 +3134,7 @@ class Catalog {
|
|
|
2945
3134
|
|
|
2946
3135
|
const {
|
|
2947
3136
|
error: res_error,
|
|
2948
|
-
} = CatalogPlatformModel.
|
|
3137
|
+
} = CatalogPlatformModel.ApplicationDepartmentListingResponse().validate(
|
|
2949
3138
|
responseData,
|
|
2950
3139
|
{ abortEarly: false, allowUnknown: true }
|
|
2951
3140
|
);
|
|
@@ -2972,9 +3161,9 @@ class Catalog {
|
|
|
2972
3161
|
* identifier for a particular sale channel.
|
|
2973
3162
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2974
3163
|
* page. Default is 12.
|
|
2975
|
-
* @param {string} [arg.q] -
|
|
2976
|
-
*
|
|
2977
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
3164
|
+
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
3165
|
+
* filter results based on a keyword or specific value.
|
|
3166
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
2978
3167
|
* @summary: List sales channel departments
|
|
2979
3168
|
* @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
|
|
2980
3169
|
*/
|
|
@@ -3012,9 +3201,8 @@ class Catalog {
|
|
|
3012
3201
|
*
|
|
3013
3202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3014
3203
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3015
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3016
|
-
*
|
|
3017
|
-
*
|
|
3204
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
|
|
3205
|
+
* Success response
|
|
3018
3206
|
* @name getApplicationFilterKeys
|
|
3019
3207
|
* @summary: List filter keys
|
|
3020
3208
|
* @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/).
|
|
@@ -3071,7 +3259,7 @@ class Catalog {
|
|
|
3071
3259
|
|
|
3072
3260
|
const {
|
|
3073
3261
|
error: res_error,
|
|
3074
|
-
} = CatalogPlatformModel.
|
|
3262
|
+
} = CatalogPlatformModel.GetQueryFiltersKeysResponse().validate(
|
|
3075
3263
|
responseData,
|
|
3076
3264
|
{ abortEarly: false, allowUnknown: true }
|
|
3077
3265
|
);
|
|
@@ -3096,9 +3284,8 @@ class Catalog {
|
|
|
3096
3284
|
*
|
|
3097
3285
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3098
3286
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3099
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3100
|
-
*
|
|
3101
|
-
*
|
|
3287
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
|
|
3288
|
+
* Success response
|
|
3102
3289
|
* @name getApplicationFilterValues
|
|
3103
3290
|
* @summary: List product filters
|
|
3104
3291
|
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
@@ -3172,7 +3359,7 @@ class Catalog {
|
|
|
3172
3359
|
|
|
3173
3360
|
const {
|
|
3174
3361
|
error: res_error,
|
|
3175
|
-
} = CatalogPlatformModel.
|
|
3362
|
+
} = CatalogPlatformModel.GetQueryFiltersValuesResponse().validate(
|
|
3176
3363
|
responseData,
|
|
3177
3364
|
{ abortEarly: false, allowUnknown: true }
|
|
3178
3365
|
);
|
|
@@ -3191,214 +3378,14 @@ class Catalog {
|
|
|
3191
3378
|
return response;
|
|
3192
3379
|
}
|
|
3193
3380
|
|
|
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
|
-
|
|
3393
3381
|
/**
|
|
3394
3382
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
3395
3383
|
* - Arg object
|
|
3396
3384
|
*
|
|
3397
3385
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3398
3386
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3399
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3400
|
-
*
|
|
3401
|
-
*
|
|
3387
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
3388
|
+
* Success response
|
|
3402
3389
|
* @name getAutocompleteConfig
|
|
3403
3390
|
* @summary: Get autocomplete configuration
|
|
3404
3391
|
* @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/).
|
|
@@ -3450,7 +3437,7 @@ class Catalog {
|
|
|
3450
3437
|
|
|
3451
3438
|
const {
|
|
3452
3439
|
error: res_error,
|
|
3453
|
-
} = CatalogPlatformModel.
|
|
3440
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponse().validate(
|
|
3454
3441
|
responseData,
|
|
3455
3442
|
{ abortEarly: false, allowUnknown: true }
|
|
3456
3443
|
);
|
|
@@ -3475,9 +3462,8 @@ class Catalog {
|
|
|
3475
3462
|
*
|
|
3476
3463
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3477
3464
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3478
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3479
|
-
*
|
|
3480
|
-
*
|
|
3465
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
3466
|
+
* Success response
|
|
3481
3467
|
* @name getAutocompleteKeywordDetail
|
|
3482
3468
|
* @summary: Get autocomplete keyword
|
|
3483
3469
|
* @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/).
|
|
@@ -3533,7 +3519,7 @@ class Catalog {
|
|
|
3533
3519
|
|
|
3534
3520
|
const {
|
|
3535
3521
|
error: res_error,
|
|
3536
|
-
} = CatalogPlatformModel.
|
|
3522
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponse().validate(
|
|
3537
3523
|
responseData,
|
|
3538
3524
|
{ abortEarly: false, allowUnknown: true }
|
|
3539
3525
|
);
|
|
@@ -3637,8 +3623,7 @@ class Catalog {
|
|
|
3637
3623
|
*
|
|
3638
3624
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3639
3625
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3640
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3641
|
-
* Success response
|
|
3626
|
+
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
3642
3627
|
* @name getCatalogInsights
|
|
3643
3628
|
* @summary: Get catalog counts
|
|
3644
3629
|
* @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/).
|
|
@@ -3695,10 +3680,10 @@ class Catalog {
|
|
|
3695
3680
|
|
|
3696
3681
|
const {
|
|
3697
3682
|
error: res_error,
|
|
3698
|
-
} = CatalogPlatformModel.
|
|
3699
|
-
|
|
3700
|
-
|
|
3701
|
-
);
|
|
3683
|
+
} = CatalogPlatformModel.CatalogInsightResponse().validate(responseData, {
|
|
3684
|
+
abortEarly: false,
|
|
3685
|
+
allowUnknown: true,
|
|
3686
|
+
});
|
|
3702
3687
|
|
|
3703
3688
|
if (res_error) {
|
|
3704
3689
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3718,8 +3703,7 @@ class Catalog {
|
|
|
3718
3703
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
3719
3704
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3720
3705
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3721
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3722
|
-
* Success response
|
|
3706
|
+
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
3723
3707
|
* @name getCategories
|
|
3724
3708
|
* @summary: List categories
|
|
3725
3709
|
* @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/).
|
|
@@ -3776,10 +3760,10 @@ class Catalog {
|
|
|
3776
3760
|
|
|
3777
3761
|
const {
|
|
3778
3762
|
error: res_error,
|
|
3779
|
-
} = CatalogPlatformModel.
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
);
|
|
3763
|
+
} = CatalogPlatformModel.CategoryListingResponse().validate(responseData, {
|
|
3764
|
+
abortEarly: false,
|
|
3765
|
+
allowUnknown: true,
|
|
3766
|
+
});
|
|
3783
3767
|
|
|
3784
3768
|
if (res_error) {
|
|
3785
3769
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3801,9 +3785,8 @@ class Catalog {
|
|
|
3801
3785
|
*
|
|
3802
3786
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3803
3787
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3804
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3805
|
-
*
|
|
3806
|
-
*
|
|
3788
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
|
|
3789
|
+
* Success response
|
|
3807
3790
|
* @name getCollectionDetail
|
|
3808
3791
|
* @summary: Get a collection
|
|
3809
3792
|
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
@@ -3859,7 +3842,7 @@ class Catalog {
|
|
|
3859
3842
|
|
|
3860
3843
|
const {
|
|
3861
3844
|
error: res_error,
|
|
3862
|
-
} = CatalogPlatformModel.
|
|
3845
|
+
} = CatalogPlatformModel.GetCollectionDetailResponse().validate(
|
|
3863
3846
|
responseData,
|
|
3864
3847
|
{ abortEarly: false, allowUnknown: true }
|
|
3865
3848
|
);
|
|
@@ -3884,9 +3867,8 @@ class Catalog {
|
|
|
3884
3867
|
*
|
|
3885
3868
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3886
3869
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3887
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3888
|
-
*
|
|
3889
|
-
*
|
|
3870
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponse>} -
|
|
3871
|
+
* Success response
|
|
3890
3872
|
* @name getCollectionItems
|
|
3891
3873
|
* @summary: List items of collection
|
|
3892
3874
|
* @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
|
|
@@ -3951,7 +3933,7 @@ class Catalog {
|
|
|
3951
3933
|
|
|
3952
3934
|
const {
|
|
3953
3935
|
error: res_error,
|
|
3954
|
-
} = CatalogPlatformModel.
|
|
3936
|
+
} = CatalogPlatformModel.GetCollectionItemsResponse().validate(
|
|
3955
3937
|
responseData,
|
|
3956
3938
|
{ abortEarly: false, allowUnknown: true }
|
|
3957
3939
|
);
|
|
@@ -4059,9 +4041,8 @@ class Catalog {
|
|
|
4059
4041
|
*
|
|
4060
4042
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4061
4043
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4062
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4063
|
-
*
|
|
4064
|
-
*
|
|
4044
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
4045
|
+
* Success response
|
|
4065
4046
|
* @name getConfigurationMetadata
|
|
4066
4047
|
* @summary: Get configuration metadata
|
|
4067
4048
|
* @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/).
|
|
@@ -4131,7 +4112,7 @@ class Catalog {
|
|
|
4131
4112
|
|
|
4132
4113
|
const {
|
|
4133
4114
|
error: res_error,
|
|
4134
|
-
} = CatalogPlatformModel.
|
|
4115
|
+
} = CatalogPlatformModel.GetConfigMetadataResponse().validate(
|
|
4135
4116
|
responseData,
|
|
4136
4117
|
{ abortEarly: false, allowUnknown: true }
|
|
4137
4118
|
);
|
|
@@ -4232,8 +4213,7 @@ class Catalog {
|
|
|
4232
4213
|
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
4233
4214
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4234
4215
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4235
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4236
|
-
* Success response
|
|
4216
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
4237
4217
|
* @name getDepartments
|
|
4238
4218
|
* @summary: List departments
|
|
4239
4219
|
* @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/).
|
|
@@ -4285,7 +4265,7 @@ class Catalog {
|
|
|
4285
4265
|
|
|
4286
4266
|
const {
|
|
4287
4267
|
error: res_error,
|
|
4288
|
-
} = CatalogPlatformModel.
|
|
4268
|
+
} = CatalogPlatformModel.DepartmentResponse().validate(responseData, {
|
|
4289
4269
|
abortEarly: false,
|
|
4290
4270
|
allowUnknown: true,
|
|
4291
4271
|
});
|
|
@@ -4465,7 +4445,7 @@ class Catalog {
|
|
|
4465
4445
|
*
|
|
4466
4446
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4467
4447
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4468
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4448
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
4469
4449
|
* @name getGroupConfigurations
|
|
4470
4450
|
* @summary: Get group configurations
|
|
4471
4451
|
* @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/).
|
|
@@ -4535,7 +4515,7 @@ class Catalog {
|
|
|
4535
4515
|
|
|
4536
4516
|
const {
|
|
4537
4517
|
error: res_error,
|
|
4538
|
-
} = CatalogPlatformModel.
|
|
4518
|
+
} = CatalogPlatformModel.GetConfigResponse().validate(responseData, {
|
|
4539
4519
|
abortEarly: false,
|
|
4540
4520
|
allowUnknown: true,
|
|
4541
4521
|
});
|
|
@@ -4560,7 +4540,7 @@ class Catalog {
|
|
|
4560
4540
|
*
|
|
4561
4541
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4562
4542
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4563
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4543
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
4564
4544
|
* @name getListingConfigurations
|
|
4565
4545
|
* @summary: Get listing configurations
|
|
4566
4546
|
* @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/).
|
|
@@ -4627,7 +4607,7 @@ class Catalog {
|
|
|
4627
4607
|
|
|
4628
4608
|
const {
|
|
4629
4609
|
error: res_error,
|
|
4630
|
-
} = CatalogPlatformModel.
|
|
4610
|
+
} = CatalogPlatformModel.GetConfigResponse().validate(responseData, {
|
|
4631
4611
|
abortEarly: false,
|
|
4632
4612
|
allowUnknown: true,
|
|
4633
4613
|
});
|
|
@@ -4731,8 +4711,7 @@ class Catalog {
|
|
|
4731
4711
|
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
4732
4712
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4733
4713
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4734
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4735
|
-
* Success response
|
|
4714
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
|
|
4736
4715
|
* @name getQueryFilters
|
|
4737
4716
|
* @summary: Get collection query filters
|
|
4738
4717
|
* @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/).
|
|
@@ -4784,10 +4763,10 @@ class Catalog {
|
|
|
4784
4763
|
|
|
4785
4764
|
const {
|
|
4786
4765
|
error: res_error,
|
|
4787
|
-
} = CatalogPlatformModel.
|
|
4788
|
-
|
|
4789
|
-
|
|
4790
|
-
);
|
|
4766
|
+
} = CatalogPlatformModel.GetQueryFiltersResponse().validate(responseData, {
|
|
4767
|
+
abortEarly: false,
|
|
4768
|
+
allowUnknown: true,
|
|
4769
|
+
});
|
|
4791
4770
|
|
|
4792
4771
|
if (res_error) {
|
|
4793
4772
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -4809,7 +4788,7 @@ class Catalog {
|
|
|
4809
4788
|
*
|
|
4810
4789
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4811
4790
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4812
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4791
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponse>}
|
|
4813
4792
|
* - Success response
|
|
4814
4793
|
*
|
|
4815
4794
|
* @name getSearchConfiguration
|
|
@@ -4863,7 +4842,7 @@ class Catalog {
|
|
|
4863
4842
|
|
|
4864
4843
|
const {
|
|
4865
4844
|
error: res_error,
|
|
4866
|
-
} = CatalogPlatformModel.
|
|
4845
|
+
} = CatalogPlatformModel.GetSearchConfigurationResponse().validate(
|
|
4867
4846
|
responseData,
|
|
4868
4847
|
{ abortEarly: false, allowUnknown: true }
|
|
4869
4848
|
);
|
|
@@ -4888,9 +4867,8 @@ class Catalog {
|
|
|
4888
4867
|
*
|
|
4889
4868
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4890
4869
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4891
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4892
|
-
*
|
|
4893
|
-
*
|
|
4870
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
4871
|
+
* Success response
|
|
4894
4872
|
* @name getSearchKeywords
|
|
4895
4873
|
* @summary: Get search keywords
|
|
4896
4874
|
* @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/).
|
|
@@ -4946,7 +4924,7 @@ class Catalog {
|
|
|
4946
4924
|
|
|
4947
4925
|
const {
|
|
4948
4926
|
error: res_error,
|
|
4949
|
-
} = CatalogPlatformModel.
|
|
4927
|
+
} = CatalogPlatformModel.GetSearchWordsDetailResponse().validate(
|
|
4950
4928
|
responseData,
|
|
4951
4929
|
{ abortEarly: false, allowUnknown: true }
|
|
4952
4930
|
);
|
|
@@ -4971,8 +4949,7 @@ class Catalog {
|
|
|
4971
4949
|
*
|
|
4972
4950
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4973
4951
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4974
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4975
|
-
* Success response
|
|
4952
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
4976
4953
|
* @name updateAllowSingle
|
|
4977
4954
|
* @summary: Update 'Allow Single' setting
|
|
4978
4955
|
* @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/).
|
|
@@ -5028,10 +5005,10 @@ class Catalog {
|
|
|
5028
5005
|
|
|
5029
5006
|
const {
|
|
5030
5007
|
error: res_error,
|
|
5031
|
-
} = CatalogPlatformModel.
|
|
5032
|
-
|
|
5033
|
-
|
|
5034
|
-
);
|
|
5008
|
+
} = CatalogPlatformModel.ConfigSuccessResponse().validate(responseData, {
|
|
5009
|
+
abortEarly: false,
|
|
5010
|
+
allowUnknown: true,
|
|
5011
|
+
});
|
|
5035
5012
|
|
|
5036
5013
|
if (res_error) {
|
|
5037
5014
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -5051,7 +5028,7 @@ class Catalog {
|
|
|
5051
5028
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
5052
5029
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5053
5030
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5054
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5031
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5055
5032
|
* @name updateAppBrand
|
|
5056
5033
|
* @summary: Update sales channel brand
|
|
5057
5034
|
* @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/).
|
|
@@ -5109,7 +5086,7 @@ class Catalog {
|
|
|
5109
5086
|
|
|
5110
5087
|
const {
|
|
5111
5088
|
error: res_error,
|
|
5112
|
-
} = CatalogPlatformModel.
|
|
5089
|
+
} = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
|
|
5113
5090
|
abortEarly: false,
|
|
5114
5091
|
allowUnknown: true,
|
|
5115
5092
|
});
|
|
@@ -5134,7 +5111,7 @@ class Catalog {
|
|
|
5134
5111
|
*
|
|
5135
5112
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5136
5113
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5137
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5114
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5138
5115
|
* @name updateAppCategory
|
|
5139
5116
|
* @summary: Update sales channel category
|
|
5140
5117
|
* @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
@@ -5192,7 +5169,7 @@ class Catalog {
|
|
|
5192
5169
|
|
|
5193
5170
|
const {
|
|
5194
5171
|
error: res_error,
|
|
5195
|
-
} = CatalogPlatformModel.
|
|
5172
|
+
} = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
|
|
5196
5173
|
abortEarly: false,
|
|
5197
5174
|
allowUnknown: true,
|
|
5198
5175
|
});
|
|
@@ -5217,7 +5194,7 @@ class Catalog {
|
|
|
5217
5194
|
*
|
|
5218
5195
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5219
5196
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5220
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5197
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
5221
5198
|
* @name updateAppCategoryReturnConfiguration
|
|
5222
5199
|
* @summary: Update return Configuration
|
|
5223
5200
|
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
@@ -5273,7 +5250,7 @@ class Catalog {
|
|
|
5273
5250
|
|
|
5274
5251
|
const {
|
|
5275
5252
|
error: res_error,
|
|
5276
|
-
} = CatalogPlatformModel.
|
|
5253
|
+
} = CatalogPlatformModel.SuccessResponse().validate(responseData, {
|
|
5277
5254
|
abortEarly: false,
|
|
5278
5255
|
allowUnknown: true,
|
|
5279
5256
|
});
|
|
@@ -5298,7 +5275,7 @@ class Catalog {
|
|
|
5298
5275
|
*
|
|
5299
5276
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5300
5277
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5301
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5278
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5302
5279
|
* @name updateAppDepartment
|
|
5303
5280
|
* @summary: Update sales channel department
|
|
5304
5281
|
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
@@ -5356,7 +5333,7 @@ class Catalog {
|
|
|
5356
5333
|
|
|
5357
5334
|
const {
|
|
5358
5335
|
error: res_error,
|
|
5359
|
-
} = CatalogPlatformModel.
|
|
5336
|
+
} = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
|
|
5360
5337
|
abortEarly: false,
|
|
5361
5338
|
allowUnknown: true,
|
|
5362
5339
|
});
|
|
@@ -5381,7 +5358,7 @@ class Catalog {
|
|
|
5381
5358
|
*
|
|
5382
5359
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5383
5360
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5384
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5361
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5385
5362
|
* @name updateAppLocation
|
|
5386
5363
|
* @summary: Update sales channel location
|
|
5387
5364
|
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
@@ -5439,7 +5416,7 @@ class Catalog {
|
|
|
5439
5416
|
|
|
5440
5417
|
const {
|
|
5441
5418
|
error: res_error,
|
|
5442
|
-
} = CatalogPlatformModel.
|
|
5419
|
+
} = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
|
|
5443
5420
|
abortEarly: false,
|
|
5444
5421
|
allowUnknown: true,
|
|
5445
5422
|
});
|
|
@@ -5462,7 +5439,7 @@ class Catalog {
|
|
|
5462
5439
|
* @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
|
|
5463
5440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5464
5441
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5465
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5442
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5466
5443
|
* @name updateAppProduct
|
|
5467
5444
|
* @summary: Update sales channel product
|
|
5468
5445
|
* @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/).
|
|
@@ -5520,7 +5497,7 @@ class Catalog {
|
|
|
5520
5497
|
|
|
5521
5498
|
const {
|
|
5522
5499
|
error: res_error,
|
|
5523
|
-
} = CatalogPlatformModel.
|
|
5500
|
+
} = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
|
|
5524
5501
|
abortEarly: false,
|
|
5525
5502
|
allowUnknown: true,
|
|
5526
5503
|
});
|
|
@@ -5545,7 +5522,7 @@ class Catalog {
|
|
|
5545
5522
|
*
|
|
5546
5523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5547
5524
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5548
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5525
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5549
5526
|
* @name updateAppReturnConfiguration
|
|
5550
5527
|
* @summary: Update product return configuration
|
|
5551
5528
|
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
@@ -5601,7 +5578,7 @@ class Catalog {
|
|
|
5601
5578
|
|
|
5602
5579
|
const {
|
|
5603
5580
|
error: res_error,
|
|
5604
|
-
} = CatalogPlatformModel.
|
|
5581
|
+
} = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
|
|
5605
5582
|
abortEarly: false,
|
|
5606
5583
|
allowUnknown: true,
|
|
5607
5584
|
});
|
|
@@ -5626,9 +5603,8 @@ class Catalog {
|
|
|
5626
5603
|
*
|
|
5627
5604
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5628
5605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5629
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5630
|
-
*
|
|
5631
|
-
*
|
|
5606
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
5607
|
+
* Success response
|
|
5632
5608
|
* @name updateAutocompleteKeyword
|
|
5633
5609
|
* @summary: Update autocomplete keyword
|
|
5634
5610
|
* @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/).
|
|
@@ -5686,7 +5662,7 @@ class Catalog {
|
|
|
5686
5662
|
|
|
5687
5663
|
const {
|
|
5688
5664
|
error: res_error,
|
|
5689
|
-
} = CatalogPlatformModel.
|
|
5665
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponse().validate(
|
|
5690
5666
|
responseData,
|
|
5691
5667
|
{ abortEarly: false, allowUnknown: true }
|
|
5692
5668
|
);
|
|
@@ -5792,8 +5768,7 @@ class Catalog {
|
|
|
5792
5768
|
*
|
|
5793
5769
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5794
5770
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5795
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5796
|
-
* Success response
|
|
5771
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
5797
5772
|
* @name updateDefaultSort
|
|
5798
5773
|
* @summary: Update default sorting
|
|
5799
5774
|
* @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/).
|
|
@@ -5849,10 +5824,10 @@ class Catalog {
|
|
|
5849
5824
|
|
|
5850
5825
|
const {
|
|
5851
5826
|
error: res_error,
|
|
5852
|
-
} = CatalogPlatformModel.
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
);
|
|
5827
|
+
} = CatalogPlatformModel.ConfigSuccessResponse().validate(responseData, {
|
|
5828
|
+
abortEarly: false,
|
|
5829
|
+
allowUnknown: true,
|
|
5830
|
+
});
|
|
5856
5831
|
|
|
5857
5832
|
if (res_error) {
|
|
5858
5833
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -6044,7 +6019,7 @@ class Catalog {
|
|
|
6044
6019
|
*
|
|
6045
6020
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
6046
6021
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6047
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
6022
|
+
* @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>}
|
|
6048
6023
|
* - Success response
|
|
6049
6024
|
*
|
|
6050
6025
|
* @name updateSearchConfiguration
|
|
@@ -6102,7 +6077,7 @@ class Catalog {
|
|
|
6102
6077
|
|
|
6103
6078
|
const {
|
|
6104
6079
|
error: res_error,
|
|
6105
|
-
} = CatalogPlatformModel.
|
|
6080
|
+
} = CatalogPlatformModel.UpdateSearchConfigurationResponse().validate(
|
|
6106
6081
|
responseData,
|
|
6107
6082
|
{ abortEarly: false, allowUnknown: true }
|
|
6108
6083
|
);
|