@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.3
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +111 -1200
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
- package/sdk/application/Content/ContentApplicationClient.js +46 -990
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5046 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1979 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- 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/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -266,14 +266,25 @@ class Catalog {
|
|
|
266
266
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
267
267
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
268
268
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
270
|
-
* Success response
|
|
269
|
+
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponseSchema>}
|
|
270
|
+
* - Success response
|
|
271
|
+
*
|
|
271
272
|
* @name createCollection
|
|
272
273
|
* @summary: Create a collection
|
|
273
274
|
* @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
|
|
274
275
|
*/
|
|
275
276
|
async createCollection(
|
|
276
|
-
{
|
|
277
|
+
{
|
|
278
|
+
body,
|
|
279
|
+
q,
|
|
280
|
+
scheduleStatus,
|
|
281
|
+
type,
|
|
282
|
+
tags,
|
|
283
|
+
isActive,
|
|
284
|
+
pageNo,
|
|
285
|
+
pageSize,
|
|
286
|
+
requestHeaders,
|
|
287
|
+
} = { requestHeaders: {} },
|
|
277
288
|
{ responseHeaders } = { responseHeaders: false }
|
|
278
289
|
) {
|
|
279
290
|
const {
|
|
@@ -281,6 +292,13 @@ class Catalog {
|
|
|
281
292
|
} = CatalogPlatformApplicationValidator.createCollection().validate(
|
|
282
293
|
{
|
|
283
294
|
body,
|
|
295
|
+
q,
|
|
296
|
+
scheduleStatus,
|
|
297
|
+
type,
|
|
298
|
+
tags,
|
|
299
|
+
isActive,
|
|
300
|
+
pageNo,
|
|
301
|
+
pageSize,
|
|
284
302
|
},
|
|
285
303
|
{ abortEarly: false, allowUnknown: true }
|
|
286
304
|
);
|
|
@@ -294,6 +312,13 @@ class Catalog {
|
|
|
294
312
|
} = CatalogPlatformApplicationValidator.createCollection().validate(
|
|
295
313
|
{
|
|
296
314
|
body,
|
|
315
|
+
q,
|
|
316
|
+
scheduleStatus,
|
|
317
|
+
type,
|
|
318
|
+
tags,
|
|
319
|
+
isActive,
|
|
320
|
+
pageNo,
|
|
321
|
+
pageSize,
|
|
297
322
|
},
|
|
298
323
|
{ abortEarly: false, allowUnknown: false }
|
|
299
324
|
);
|
|
@@ -305,6 +330,13 @@ class Catalog {
|
|
|
305
330
|
}
|
|
306
331
|
|
|
307
332
|
const query_params = {};
|
|
333
|
+
query_params["q"] = q;
|
|
334
|
+
query_params["schedule_status"] = scheduleStatus;
|
|
335
|
+
query_params["type"] = type;
|
|
336
|
+
query_params["tags"] = tags;
|
|
337
|
+
query_params["is_active"] = isActive;
|
|
338
|
+
query_params["page_no"] = pageNo;
|
|
339
|
+
query_params["page_size"] = pageSize;
|
|
308
340
|
|
|
309
341
|
const response = await PlatformAPIClient.execute(
|
|
310
342
|
this.config,
|
|
@@ -323,10 +355,10 @@ class Catalog {
|
|
|
323
355
|
|
|
324
356
|
const {
|
|
325
357
|
error: res_error,
|
|
326
|
-
} = CatalogPlatformModel.
|
|
327
|
-
|
|
328
|
-
allowUnknown: true
|
|
329
|
-
|
|
358
|
+
} = CatalogPlatformModel.CollectionCreateResponseSchema().validate(
|
|
359
|
+
responseData,
|
|
360
|
+
{ abortEarly: false, allowUnknown: true }
|
|
361
|
+
);
|
|
330
362
|
|
|
331
363
|
if (res_error) {
|
|
332
364
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -514,7 +546,7 @@ class Catalog {
|
|
|
514
546
|
*
|
|
515
547
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
516
548
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
517
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
549
|
+
* @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>}
|
|
518
550
|
* - Success response
|
|
519
551
|
*
|
|
520
552
|
* @name createCustomAutocompleteRule
|
|
@@ -572,7 +604,7 @@ class Catalog {
|
|
|
572
604
|
|
|
573
605
|
const {
|
|
574
606
|
error: res_error,
|
|
575
|
-
} = CatalogPlatformModel.
|
|
607
|
+
} = CatalogPlatformModel.CreateAutocompleteWordsResponseSchema().validate(
|
|
576
608
|
responseData,
|
|
577
609
|
{ abortEarly: false, allowUnknown: true }
|
|
578
610
|
);
|
|
@@ -844,7 +876,7 @@ class Catalog {
|
|
|
844
876
|
*
|
|
845
877
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
846
878
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
847
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
879
|
+
* @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>}
|
|
848
880
|
* - Success response
|
|
849
881
|
*
|
|
850
882
|
* @name createSearchConfiguration
|
|
@@ -902,7 +934,7 @@ class Catalog {
|
|
|
902
934
|
|
|
903
935
|
const {
|
|
904
936
|
error: res_error,
|
|
905
|
-
} = CatalogPlatformModel.
|
|
937
|
+
} = CatalogPlatformModel.CreateSearchConfigurationResponseSchema().validate(
|
|
906
938
|
responseData,
|
|
907
939
|
{ abortEarly: false, allowUnknown: true }
|
|
908
940
|
);
|
|
@@ -927,7 +959,7 @@ class Catalog {
|
|
|
927
959
|
*
|
|
928
960
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
929
961
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
930
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
962
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
931
963
|
* @name deleteAppCategoryReturnConfiguration
|
|
932
964
|
* @summary: Delete product return configuration
|
|
933
965
|
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
@@ -983,7 +1015,7 @@ class Catalog {
|
|
|
983
1015
|
|
|
984
1016
|
const {
|
|
985
1017
|
error: res_error,
|
|
986
|
-
} = CatalogPlatformModel.
|
|
1018
|
+
} = CatalogPlatformModel.SuccessResponseSchema().validate(responseData, {
|
|
987
1019
|
abortEarly: false,
|
|
988
1020
|
allowUnknown: true,
|
|
989
1021
|
});
|
|
@@ -1008,7 +1040,7 @@ class Catalog {
|
|
|
1008
1040
|
*
|
|
1009
1041
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1010
1042
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1011
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1043
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
1012
1044
|
* @name deleteAutocompleteKeyword
|
|
1013
1045
|
* @summary: Delete autocomplete keyword
|
|
1014
1046
|
* @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
|
|
@@ -1064,7 +1096,7 @@ class Catalog {
|
|
|
1064
1096
|
|
|
1065
1097
|
const {
|
|
1066
1098
|
error: res_error,
|
|
1067
|
-
} = CatalogPlatformModel.
|
|
1099
|
+
} = CatalogPlatformModel.DeleteResponseSchema().validate(responseData, {
|
|
1068
1100
|
abortEarly: false,
|
|
1069
1101
|
allowUnknown: true,
|
|
1070
1102
|
});
|
|
@@ -1170,7 +1202,8 @@ class Catalog {
|
|
|
1170
1202
|
*
|
|
1171
1203
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1172
1204
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1173
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1205
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1206
|
+
* Success response
|
|
1174
1207
|
* @name deleteGroupConfiguration
|
|
1175
1208
|
* @summary: Delete group configuration
|
|
1176
1209
|
* @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
|
|
@@ -1228,10 +1261,10 @@ class Catalog {
|
|
|
1228
1261
|
|
|
1229
1262
|
const {
|
|
1230
1263
|
error: res_error,
|
|
1231
|
-
} = CatalogPlatformModel.
|
|
1232
|
-
|
|
1233
|
-
allowUnknown: true
|
|
1234
|
-
|
|
1264
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
1265
|
+
responseData,
|
|
1266
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1267
|
+
);
|
|
1235
1268
|
|
|
1236
1269
|
if (res_error) {
|
|
1237
1270
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1253,7 +1286,8 @@ class Catalog {
|
|
|
1253
1286
|
*
|
|
1254
1287
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1255
1288
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1256
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1289
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1290
|
+
* Success response
|
|
1257
1291
|
* @name deleteListingConfiguration
|
|
1258
1292
|
* @summary: Delete listing configuration
|
|
1259
1293
|
* @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
@@ -1311,10 +1345,10 @@ class Catalog {
|
|
|
1311
1345
|
|
|
1312
1346
|
const {
|
|
1313
1347
|
error: res_error,
|
|
1314
|
-
} = CatalogPlatformModel.
|
|
1315
|
-
|
|
1316
|
-
allowUnknown: true
|
|
1317
|
-
|
|
1348
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
1349
|
+
responseData,
|
|
1350
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1351
|
+
);
|
|
1318
1352
|
|
|
1319
1353
|
if (res_error) {
|
|
1320
1354
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1336,7 +1370,7 @@ class Catalog {
|
|
|
1336
1370
|
*
|
|
1337
1371
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1338
1372
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1339
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1373
|
+
* @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>}
|
|
1340
1374
|
* - Success response
|
|
1341
1375
|
*
|
|
1342
1376
|
* @name deleteSearchConfiguration
|
|
@@ -1390,7 +1424,7 @@ class Catalog {
|
|
|
1390
1424
|
|
|
1391
1425
|
const {
|
|
1392
1426
|
error: res_error,
|
|
1393
|
-
} = CatalogPlatformModel.
|
|
1427
|
+
} = CatalogPlatformModel.DeleteSearchConfigurationResponseSchema().validate(
|
|
1394
1428
|
responseData,
|
|
1395
1429
|
{ abortEarly: false, allowUnknown: true }
|
|
1396
1430
|
);
|
|
@@ -1415,7 +1449,7 @@ class Catalog {
|
|
|
1415
1449
|
*
|
|
1416
1450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1417
1451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1418
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1452
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
1419
1453
|
* @name deleteSearchKeywords
|
|
1420
1454
|
* @summary: Delete search keywords
|
|
1421
1455
|
* @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
|
|
@@ -1471,7 +1505,7 @@ class Catalog {
|
|
|
1471
1505
|
|
|
1472
1506
|
const {
|
|
1473
1507
|
error: res_error,
|
|
1474
|
-
} = CatalogPlatformModel.
|
|
1508
|
+
} = CatalogPlatformModel.DeleteResponseSchema().validate(responseData, {
|
|
1475
1509
|
abortEarly: false,
|
|
1476
1510
|
allowUnknown: true,
|
|
1477
1511
|
});
|
|
@@ -1496,8 +1530,9 @@ class Catalog {
|
|
|
1496
1530
|
*
|
|
1497
1531
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1498
1532
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1499
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1500
|
-
* Success response
|
|
1533
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
1534
|
+
* - Success response
|
|
1535
|
+
*
|
|
1501
1536
|
* @name getAllCollections
|
|
1502
1537
|
* @summary: List collections
|
|
1503
1538
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
|
|
@@ -1581,7 +1616,7 @@ class Catalog {
|
|
|
1581
1616
|
|
|
1582
1617
|
const {
|
|
1583
1618
|
error: res_error,
|
|
1584
|
-
} = CatalogPlatformModel.
|
|
1619
|
+
} = CatalogPlatformModel.GetCollectionListingResponseSchema().validate(
|
|
1585
1620
|
responseData,
|
|
1586
1621
|
{ abortEarly: false, allowUnknown: true }
|
|
1587
1622
|
);
|
|
@@ -1615,7 +1650,7 @@ class Catalog {
|
|
|
1615
1650
|
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
1616
1651
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1617
1652
|
* page. Default is 12.
|
|
1618
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
1653
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
1619
1654
|
* @summary: List collections
|
|
1620
1655
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
|
|
1621
1656
|
*/
|
|
@@ -1661,7 +1696,8 @@ class Catalog {
|
|
|
1661
1696
|
*
|
|
1662
1697
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1663
1698
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1664
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1699
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>} -
|
|
1700
|
+
* Success response
|
|
1665
1701
|
* @name getAllSearchKeyword
|
|
1666
1702
|
* @summary: List search keywords
|
|
1667
1703
|
* @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
|
|
@@ -1713,10 +1749,10 @@ class Catalog {
|
|
|
1713
1749
|
|
|
1714
1750
|
const {
|
|
1715
1751
|
error: res_error,
|
|
1716
|
-
} = CatalogPlatformModel.
|
|
1717
|
-
|
|
1718
|
-
allowUnknown: true
|
|
1719
|
-
|
|
1752
|
+
} = CatalogPlatformModel.GetSearchWordsResponseSchema().validate(
|
|
1753
|
+
responseData,
|
|
1754
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1755
|
+
);
|
|
1720
1756
|
|
|
1721
1757
|
if (res_error) {
|
|
1722
1758
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1738,7 +1774,7 @@ class Catalog {
|
|
|
1738
1774
|
*
|
|
1739
1775
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1740
1776
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1741
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1777
|
+
* @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>}
|
|
1742
1778
|
* - Success response
|
|
1743
1779
|
*
|
|
1744
1780
|
* @name getAppCategoryReturnConfig
|
|
@@ -1803,7 +1839,7 @@ class Catalog {
|
|
|
1803
1839
|
|
|
1804
1840
|
const {
|
|
1805
1841
|
error: res_error,
|
|
1806
|
-
} = CatalogPlatformModel.
|
|
1842
|
+
} = CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema().validate(
|
|
1807
1843
|
responseData,
|
|
1808
1844
|
{ abortEarly: false, allowUnknown: true }
|
|
1809
1845
|
);
|
|
@@ -1826,10 +1862,11 @@ class Catalog {
|
|
|
1826
1862
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
1827
1863
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1828
1864
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1829
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1865
|
+
* @returns {Promise<CatalogPlatformModel.InventoryStockResponseSchema>} -
|
|
1866
|
+
* Success response
|
|
1830
1867
|
* @name getAppInventory
|
|
1831
1868
|
* @summary: List sales channel inventory
|
|
1832
|
-
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products
|
|
1869
|
+
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
1833
1870
|
*/
|
|
1834
1871
|
async getAppInventory(
|
|
1835
1872
|
{
|
|
@@ -1930,10 +1967,10 @@ class Catalog {
|
|
|
1930
1967
|
|
|
1931
1968
|
const {
|
|
1932
1969
|
error: res_error,
|
|
1933
|
-
} = CatalogPlatformModel.
|
|
1934
|
-
|
|
1935
|
-
allowUnknown: true
|
|
1936
|
-
|
|
1970
|
+
} = CatalogPlatformModel.InventoryStockResponseSchema().validate(
|
|
1971
|
+
responseData,
|
|
1972
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1973
|
+
);
|
|
1937
1974
|
|
|
1938
1975
|
if (res_error) {
|
|
1939
1976
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1953,10 +1990,10 @@ class Catalog {
|
|
|
1953
1990
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
1954
1991
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1955
1992
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1956
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1993
|
+
* @returns {Promise<CatalogPlatformModel.LocationListSchema>} - Success response
|
|
1957
1994
|
* @name getAppLocations
|
|
1958
1995
|
* @summary: List sales channels
|
|
1959
|
-
* @description: Retrieve all stores associated with
|
|
1996
|
+
* @description: Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
|
|
1960
1997
|
*/
|
|
1961
1998
|
async getAppLocations(
|
|
1962
1999
|
{
|
|
@@ -2041,7 +2078,7 @@ class Catalog {
|
|
|
2041
2078
|
|
|
2042
2079
|
const {
|
|
2043
2080
|
error: res_error,
|
|
2044
|
-
} = CatalogPlatformModel.
|
|
2081
|
+
} = CatalogPlatformModel.LocationListSchema().validate(responseData, {
|
|
2045
2082
|
abortEarly: false,
|
|
2046
2083
|
allowUnknown: true,
|
|
2047
2084
|
});
|
|
@@ -2062,9 +2099,10 @@ class Catalog {
|
|
|
2062
2099
|
|
|
2063
2100
|
/**
|
|
2064
2101
|
* @param {Object} arg - Arg object.
|
|
2065
|
-
* @param {
|
|
2066
|
-
*
|
|
2067
|
-
*
|
|
2102
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
2103
|
+
* a particular seller account.
|
|
2104
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
2105
|
+
* identifier for a particular sale channel.
|
|
2068
2106
|
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
2069
2107
|
* basis of location type.
|
|
2070
2108
|
* @param {number[]} [arg.uid] - Helps to sort the location list on the
|
|
@@ -2076,9 +2114,9 @@ class Catalog {
|
|
|
2076
2114
|
* page. Default is 20.
|
|
2077
2115
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
2078
2116
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
2079
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2117
|
+
* @returns {Paginator<CatalogPlatformModel.LocationListSchema>}
|
|
2080
2118
|
* @summary: List sales channels
|
|
2081
|
-
* @description: Retrieve all stores associated with
|
|
2119
|
+
* @description: Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status.
|
|
2082
2120
|
*/
|
|
2083
2121
|
getAppLocationsPaginator({
|
|
2084
2122
|
companyId,
|
|
@@ -2122,7 +2160,8 @@ class Catalog {
|
|
|
2122
2160
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
2123
2161
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2124
2162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2125
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2163
|
+
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>} -
|
|
2164
|
+
* Success response
|
|
2126
2165
|
* @name getAppProduct
|
|
2127
2166
|
* @summary: Get sales channel product
|
|
2128
2167
|
* @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
|
|
@@ -2178,10 +2217,10 @@ class Catalog {
|
|
|
2178
2217
|
|
|
2179
2218
|
const {
|
|
2180
2219
|
error: res_error,
|
|
2181
|
-
} = CatalogPlatformModel.
|
|
2182
|
-
|
|
2183
|
-
allowUnknown: true
|
|
2184
|
-
|
|
2220
|
+
} = CatalogPlatformModel.OwnerAppItemResponseSchema().validate(
|
|
2221
|
+
responseData,
|
|
2222
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2223
|
+
);
|
|
2185
2224
|
|
|
2186
2225
|
if (res_error) {
|
|
2187
2226
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2201,8 +2240,9 @@ class Catalog {
|
|
|
2201
2240
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
2202
2241
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2203
2242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2204
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2205
|
-
* Success response
|
|
2243
|
+
* @returns {Promise<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
2244
|
+
* - Success response
|
|
2245
|
+
*
|
|
2206
2246
|
* @name getAppProducts
|
|
2207
2247
|
* @summary: List sales channel products
|
|
2208
2248
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
|
|
@@ -2290,7 +2330,7 @@ class Catalog {
|
|
|
2290
2330
|
|
|
2291
2331
|
const {
|
|
2292
2332
|
error: res_error,
|
|
2293
|
-
} = CatalogPlatformModel.
|
|
2333
|
+
} = CatalogPlatformModel.RawProductListingResponseSchema().validate(
|
|
2294
2334
|
responseData,
|
|
2295
2335
|
{ abortEarly: false, allowUnknown: true }
|
|
2296
2336
|
);
|
|
@@ -2311,7 +2351,7 @@ class Catalog {
|
|
|
2311
2351
|
|
|
2312
2352
|
/**
|
|
2313
2353
|
* @param {Object} arg - Arg object.
|
|
2314
|
-
* @param {
|
|
2354
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
2315
2355
|
* a particular seller account.
|
|
2316
2356
|
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
2317
2357
|
* identifier for a particular sale channel.
|
|
@@ -2325,7 +2365,7 @@ class Catalog {
|
|
|
2325
2365
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2326
2366
|
* page. Default is 10.
|
|
2327
2367
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
2328
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2368
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
2329
2369
|
* @summary: List sales channel products
|
|
2330
2370
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
|
|
2331
2371
|
*/
|
|
@@ -2373,9 +2413,10 @@ class Catalog {
|
|
|
2373
2413
|
*
|
|
2374
2414
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2375
2415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2376
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2416
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>} -
|
|
2417
|
+
* Success response
|
|
2377
2418
|
* @name getAppReturnConfiguration
|
|
2378
|
-
* @summary:
|
|
2419
|
+
* @summary: Get product-return configuration
|
|
2379
2420
|
* @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/).
|
|
2380
2421
|
*/
|
|
2381
2422
|
async getAppReturnConfiguration(
|
|
@@ -2425,134 +2466,7 @@ class Catalog {
|
|
|
2425
2466
|
|
|
2426
2467
|
const {
|
|
2427
2468
|
error: res_error,
|
|
2428
|
-
} = CatalogPlatformModel.
|
|
2429
|
-
abortEarly: false,
|
|
2430
|
-
allowUnknown: true,
|
|
2431
|
-
});
|
|
2432
|
-
|
|
2433
|
-
if (res_error) {
|
|
2434
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
2435
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
2436
|
-
} else {
|
|
2437
|
-
Logger({
|
|
2438
|
-
level: "WARN",
|
|
2439
|
-
message: `Response Validation Warnings for platform > Catalog > getAppReturnConfiguration \n ${res_error}`,
|
|
2440
|
-
});
|
|
2441
|
-
}
|
|
2442
|
-
}
|
|
2443
|
-
|
|
2444
|
-
return response;
|
|
2445
|
-
}
|
|
2446
|
-
|
|
2447
|
-
/**
|
|
2448
|
-
* @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
|
|
2449
|
-
* - Arg object
|
|
2450
|
-
*
|
|
2451
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2452
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2453
|
-
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
2454
|
-
* - Success response
|
|
2455
|
-
*
|
|
2456
|
-
* @name getAppicationProducts
|
|
2457
|
-
* @summary: List sales channel products
|
|
2458
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
|
|
2459
|
-
*/
|
|
2460
|
-
async getAppicationProducts(
|
|
2461
|
-
{
|
|
2462
|
-
q,
|
|
2463
|
-
f,
|
|
2464
|
-
c,
|
|
2465
|
-
filters,
|
|
2466
|
-
isDependent,
|
|
2467
|
-
sortOn,
|
|
2468
|
-
pageId,
|
|
2469
|
-
pageSize,
|
|
2470
|
-
pageNo,
|
|
2471
|
-
pageType,
|
|
2472
|
-
itemIds,
|
|
2473
|
-
requestHeaders,
|
|
2474
|
-
} = { requestHeaders: {} },
|
|
2475
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
2476
|
-
) {
|
|
2477
|
-
const {
|
|
2478
|
-
error,
|
|
2479
|
-
} = CatalogPlatformApplicationValidator.getAppicationProducts().validate(
|
|
2480
|
-
{
|
|
2481
|
-
q,
|
|
2482
|
-
f,
|
|
2483
|
-
c,
|
|
2484
|
-
filters,
|
|
2485
|
-
isDependent,
|
|
2486
|
-
sortOn,
|
|
2487
|
-
pageId,
|
|
2488
|
-
pageSize,
|
|
2489
|
-
pageNo,
|
|
2490
|
-
pageType,
|
|
2491
|
-
itemIds,
|
|
2492
|
-
},
|
|
2493
|
-
{ abortEarly: false, allowUnknown: true }
|
|
2494
|
-
);
|
|
2495
|
-
if (error) {
|
|
2496
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
2497
|
-
}
|
|
2498
|
-
|
|
2499
|
-
// Showing warrnings if extra unknown parameters are found
|
|
2500
|
-
const {
|
|
2501
|
-
error: warrning,
|
|
2502
|
-
} = CatalogPlatformApplicationValidator.getAppicationProducts().validate(
|
|
2503
|
-
{
|
|
2504
|
-
q,
|
|
2505
|
-
f,
|
|
2506
|
-
c,
|
|
2507
|
-
filters,
|
|
2508
|
-
isDependent,
|
|
2509
|
-
sortOn,
|
|
2510
|
-
pageId,
|
|
2511
|
-
pageSize,
|
|
2512
|
-
pageNo,
|
|
2513
|
-
pageType,
|
|
2514
|
-
itemIds,
|
|
2515
|
-
},
|
|
2516
|
-
{ abortEarly: false, allowUnknown: false }
|
|
2517
|
-
);
|
|
2518
|
-
if (warrning) {
|
|
2519
|
-
Logger({
|
|
2520
|
-
level: "WARN",
|
|
2521
|
-
message: `Parameter Validation warrnings for platform > Catalog > getAppicationProducts \n ${warrning}`,
|
|
2522
|
-
});
|
|
2523
|
-
}
|
|
2524
|
-
|
|
2525
|
-
const query_params = {};
|
|
2526
|
-
query_params["q"] = q;
|
|
2527
|
-
query_params["f"] = f;
|
|
2528
|
-
query_params["c"] = c;
|
|
2529
|
-
query_params["filters"] = filters;
|
|
2530
|
-
query_params["is_dependent"] = isDependent;
|
|
2531
|
-
query_params["sort_on"] = sortOn;
|
|
2532
|
-
query_params["page_id"] = pageId;
|
|
2533
|
-
query_params["page_size"] = pageSize;
|
|
2534
|
-
query_params["page_no"] = pageNo;
|
|
2535
|
-
query_params["page_type"] = pageType;
|
|
2536
|
-
query_params["item_ids"] = itemIds;
|
|
2537
|
-
|
|
2538
|
-
const response = await PlatformAPIClient.execute(
|
|
2539
|
-
this.config,
|
|
2540
|
-
"get",
|
|
2541
|
-
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/products`,
|
|
2542
|
-
query_params,
|
|
2543
|
-
undefined,
|
|
2544
|
-
requestHeaders,
|
|
2545
|
-
{ responseHeaders }
|
|
2546
|
-
);
|
|
2547
|
-
|
|
2548
|
-
let responseData = response;
|
|
2549
|
-
if (responseHeaders) {
|
|
2550
|
-
responseData = response[0];
|
|
2551
|
-
}
|
|
2552
|
-
|
|
2553
|
-
const {
|
|
2554
|
-
error: res_error,
|
|
2555
|
-
} = CatalogPlatformModel.ApplicationProductListingResponse().validate(
|
|
2469
|
+
} = CatalogPlatformModel.AppReturnConfigResponseSchema().validate(
|
|
2556
2470
|
responseData,
|
|
2557
2471
|
{ abortEarly: false, allowUnknown: true }
|
|
2558
2472
|
);
|
|
@@ -2563,7 +2477,7 @@ class Catalog {
|
|
|
2563
2477
|
} else {
|
|
2564
2478
|
Logger({
|
|
2565
2479
|
level: "WARN",
|
|
2566
|
-
message: `Response Validation Warnings for platform > Catalog >
|
|
2480
|
+
message: `Response Validation Warnings for platform > Catalog > getAppReturnConfiguration \n ${res_error}`,
|
|
2567
2481
|
});
|
|
2568
2482
|
}
|
|
2569
2483
|
}
|
|
@@ -2571,78 +2485,6 @@ class Catalog {
|
|
|
2571
2485
|
return response;
|
|
2572
2486
|
}
|
|
2573
2487
|
|
|
2574
|
-
/**
|
|
2575
|
-
* @param {Object} arg - Arg object.
|
|
2576
|
-
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
2577
|
-
* a particular seller account.
|
|
2578
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
2579
|
-
* identifier for a particular sale channel.
|
|
2580
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
2581
|
-
* complete name of a either a product, brand or category
|
|
2582
|
-
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
2583
|
-
* filtered from filter parameters will be passed in **f** parameter in
|
|
2584
|
-
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
2585
|
-
* @param {string} [arg.c] - The search filter parameters for collection
|
|
2586
|
-
* items. All the parameter filtered from filter parameters will be passed
|
|
2587
|
-
* in **c** parameter in this format.
|
|
2588
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
2589
|
-
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
2590
|
-
* filter details. This flag is used to fetch all filters
|
|
2591
|
-
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
2592
|
-
* the dependent products in the listing.
|
|
2593
|
-
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
2594
|
-
* The supported sort parameters are popularity, price, redemption and
|
|
2595
|
-
* discount in either ascending or descending order. See the supported
|
|
2596
|
-
* values below.
|
|
2597
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2598
|
-
* page. Default is 12.
|
|
2599
|
-
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
2600
|
-
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
2601
|
-
* @summary: List sales channel products
|
|
2602
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
2603
|
-
*/
|
|
2604
|
-
getAppicationProductsPaginator({
|
|
2605
|
-
companyId,
|
|
2606
|
-
applicationId,
|
|
2607
|
-
q,
|
|
2608
|
-
f,
|
|
2609
|
-
c,
|
|
2610
|
-
filters,
|
|
2611
|
-
isDependent,
|
|
2612
|
-
sortOn,
|
|
2613
|
-
pageSize,
|
|
2614
|
-
itemIds,
|
|
2615
|
-
} = {}) {
|
|
2616
|
-
const paginator = new Paginator();
|
|
2617
|
-
const callback = async () => {
|
|
2618
|
-
const pageId = paginator.nextId;
|
|
2619
|
-
const pageNo = paginator.pageNo;
|
|
2620
|
-
const pageType = "cursor";
|
|
2621
|
-
const data = await this.getAppicationProducts({
|
|
2622
|
-
companyId: companyId,
|
|
2623
|
-
applicationId: applicationId,
|
|
2624
|
-
q: q,
|
|
2625
|
-
f: f,
|
|
2626
|
-
c: c,
|
|
2627
|
-
filters: filters,
|
|
2628
|
-
isDependent: isDependent,
|
|
2629
|
-
sortOn: sortOn,
|
|
2630
|
-
pageId: pageId,
|
|
2631
|
-
pageSize: pageSize,
|
|
2632
|
-
pageNo: pageNo,
|
|
2633
|
-
pageType: pageType,
|
|
2634
|
-
itemIds: itemIds,
|
|
2635
|
-
});
|
|
2636
|
-
paginator.setPaginator({
|
|
2637
|
-
hasNext: data.page.has_next ? true : false,
|
|
2638
|
-
nextId: data.page.next_id,
|
|
2639
|
-
});
|
|
2640
|
-
return data;
|
|
2641
|
-
};
|
|
2642
|
-
paginator.setCallback(callback.bind(this));
|
|
2643
|
-
return paginator;
|
|
2644
|
-
}
|
|
2645
|
-
|
|
2646
2488
|
/**
|
|
2647
2489
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
2648
2490
|
* - Arg object
|
|
@@ -2780,7 +2622,8 @@ class Catalog {
|
|
|
2780
2622
|
*
|
|
2781
2623
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2782
2624
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2783
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2625
|
+
* @returns {Promise<CatalogPlatformModel.BrandListingResponseSchema>} -
|
|
2626
|
+
* Success response
|
|
2784
2627
|
* @name getApplicationBrands
|
|
2785
2628
|
* @summary: List brands
|
|
2786
2629
|
* @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
@@ -2851,10 +2694,10 @@ class Catalog {
|
|
|
2851
2694
|
|
|
2852
2695
|
const {
|
|
2853
2696
|
error: res_error,
|
|
2854
|
-
} = CatalogPlatformModel.
|
|
2855
|
-
|
|
2856
|
-
allowUnknown: true
|
|
2857
|
-
|
|
2697
|
+
} = CatalogPlatformModel.BrandListingResponseSchema().validate(
|
|
2698
|
+
responseData,
|
|
2699
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2700
|
+
);
|
|
2858
2701
|
|
|
2859
2702
|
if (res_error) {
|
|
2860
2703
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2886,7 +2729,7 @@ class Catalog {
|
|
|
2886
2729
|
* parameter to search brands by brand name.
|
|
2887
2730
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
2888
2731
|
* basis of uid list.
|
|
2889
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
2732
|
+
* @returns {Paginator<CatalogPlatformModel.BrandListingResponseSchema>}
|
|
2890
2733
|
* @summary: List brands
|
|
2891
2734
|
* @description: List all the brands.
|
|
2892
2735
|
*/
|
|
@@ -3069,7 +2912,7 @@ class Catalog {
|
|
|
3069
2912
|
*
|
|
3070
2913
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3071
2914
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3072
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
2915
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
3073
2916
|
* - Success response
|
|
3074
2917
|
*
|
|
3075
2918
|
* @name getApplicationDepartmentListing
|
|
@@ -3134,7 +2977,7 @@ class Catalog {
|
|
|
3134
2977
|
|
|
3135
2978
|
const {
|
|
3136
2979
|
error: res_error,
|
|
3137
|
-
} = CatalogPlatformModel.
|
|
2980
|
+
} = CatalogPlatformModel.ApplicationDepartmentListingResponseSchema().validate(
|
|
3138
2981
|
responseData,
|
|
3139
2982
|
{ abortEarly: false, allowUnknown: true }
|
|
3140
2983
|
);
|
|
@@ -3155,7 +2998,7 @@ class Catalog {
|
|
|
3155
2998
|
|
|
3156
2999
|
/**
|
|
3157
3000
|
* @param {Object} arg - Arg object.
|
|
3158
|
-
* @param {
|
|
3001
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
3159
3002
|
* a particular seller account.
|
|
3160
3003
|
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
3161
3004
|
* identifier for a particular sale channel.
|
|
@@ -3163,7 +3006,7 @@ class Catalog {
|
|
|
3163
3006
|
* page. Default is 12.
|
|
3164
3007
|
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
3165
3008
|
* filter results based on a keyword or specific value.
|
|
3166
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
3009
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
3167
3010
|
* @summary: List sales channel departments
|
|
3168
3011
|
* @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
|
|
3169
3012
|
*/
|
|
@@ -3196,26 +3039,119 @@ class Catalog {
|
|
|
3196
3039
|
}
|
|
3197
3040
|
|
|
3198
3041
|
/**
|
|
3199
|
-
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
3042
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
3043
|
+
* - Arg object
|
|
3044
|
+
*
|
|
3045
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3046
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3047
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>}
|
|
3048
|
+
* - Success response
|
|
3049
|
+
*
|
|
3050
|
+
* @name getApplicationFilterKeys
|
|
3051
|
+
* @summary: List filter keys
|
|
3052
|
+
* @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/).
|
|
3053
|
+
*/
|
|
3054
|
+
async getApplicationFilterKeys(
|
|
3055
|
+
{ c, requestHeaders } = { requestHeaders: {} },
|
|
3056
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3057
|
+
) {
|
|
3058
|
+
const {
|
|
3059
|
+
error,
|
|
3060
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterKeys().validate(
|
|
3061
|
+
{
|
|
3062
|
+
c,
|
|
3063
|
+
},
|
|
3064
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3065
|
+
);
|
|
3066
|
+
if (error) {
|
|
3067
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3068
|
+
}
|
|
3069
|
+
|
|
3070
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3071
|
+
const {
|
|
3072
|
+
error: warrning,
|
|
3073
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterKeys().validate(
|
|
3074
|
+
{
|
|
3075
|
+
c,
|
|
3076
|
+
},
|
|
3077
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3078
|
+
);
|
|
3079
|
+
if (warrning) {
|
|
3080
|
+
Logger({
|
|
3081
|
+
level: "WARN",
|
|
3082
|
+
message: `Parameter Validation warrnings for platform > Catalog > getApplicationFilterKeys \n ${warrning}`,
|
|
3083
|
+
});
|
|
3084
|
+
}
|
|
3085
|
+
|
|
3086
|
+
const query_params = {};
|
|
3087
|
+
query_params["c"] = c;
|
|
3088
|
+
|
|
3089
|
+
const response = await PlatformAPIClient.execute(
|
|
3090
|
+
this.config,
|
|
3091
|
+
"get",
|
|
3092
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/filter-options/keys`,
|
|
3093
|
+
query_params,
|
|
3094
|
+
undefined,
|
|
3095
|
+
requestHeaders,
|
|
3096
|
+
{ responseHeaders }
|
|
3097
|
+
);
|
|
3098
|
+
|
|
3099
|
+
let responseData = response;
|
|
3100
|
+
if (responseHeaders) {
|
|
3101
|
+
responseData = response[0];
|
|
3102
|
+
}
|
|
3103
|
+
|
|
3104
|
+
const {
|
|
3105
|
+
error: res_error,
|
|
3106
|
+
} = CatalogPlatformModel.GetQueryFiltersKeysResponseSchema().validate(
|
|
3107
|
+
responseData,
|
|
3108
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3109
|
+
);
|
|
3110
|
+
|
|
3111
|
+
if (res_error) {
|
|
3112
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3113
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3114
|
+
} else {
|
|
3115
|
+
Logger({
|
|
3116
|
+
level: "WARN",
|
|
3117
|
+
message: `Response Validation Warnings for platform > Catalog > getApplicationFilterKeys \n ${res_error}`,
|
|
3118
|
+
});
|
|
3119
|
+
}
|
|
3120
|
+
}
|
|
3121
|
+
|
|
3122
|
+
return response;
|
|
3123
|
+
}
|
|
3124
|
+
|
|
3125
|
+
/**
|
|
3126
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
|
|
3200
3127
|
* - Arg object
|
|
3201
3128
|
*
|
|
3202
3129
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3203
3130
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3204
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3205
|
-
* Success response
|
|
3206
|
-
*
|
|
3207
|
-
* @
|
|
3208
|
-
* @
|
|
3131
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>}
|
|
3132
|
+
* - Success response
|
|
3133
|
+
*
|
|
3134
|
+
* @name getApplicationFilterValues
|
|
3135
|
+
* @summary: List product filters
|
|
3136
|
+
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
3137
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
|
|
3209
3138
|
*/
|
|
3210
|
-
async
|
|
3211
|
-
{ c,
|
|
3139
|
+
async getApplicationFilterValues(
|
|
3140
|
+
{ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders } = {
|
|
3141
|
+
requestHeaders: {},
|
|
3142
|
+
},
|
|
3212
3143
|
{ responseHeaders } = { responseHeaders: false }
|
|
3213
3144
|
) {
|
|
3214
3145
|
const {
|
|
3215
3146
|
error,
|
|
3216
|
-
} = CatalogPlatformApplicationValidator.
|
|
3147
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterValues().validate(
|
|
3217
3148
|
{
|
|
3149
|
+
filterKey,
|
|
3218
3150
|
c,
|
|
3151
|
+
collectionId,
|
|
3152
|
+
pageNo,
|
|
3153
|
+
pageSize,
|
|
3154
|
+
q,
|
|
3219
3155
|
},
|
|
3220
3156
|
{ abortEarly: false, allowUnknown: true }
|
|
3221
3157
|
);
|
|
@@ -3226,26 +3162,35 @@ class Catalog {
|
|
|
3226
3162
|
// Showing warrnings if extra unknown parameters are found
|
|
3227
3163
|
const {
|
|
3228
3164
|
error: warrning,
|
|
3229
|
-
} = CatalogPlatformApplicationValidator.
|
|
3165
|
+
} = CatalogPlatformApplicationValidator.getApplicationFilterValues().validate(
|
|
3230
3166
|
{
|
|
3167
|
+
filterKey,
|
|
3231
3168
|
c,
|
|
3169
|
+
collectionId,
|
|
3170
|
+
pageNo,
|
|
3171
|
+
pageSize,
|
|
3172
|
+
q,
|
|
3232
3173
|
},
|
|
3233
3174
|
{ abortEarly: false, allowUnknown: false }
|
|
3234
3175
|
);
|
|
3235
3176
|
if (warrning) {
|
|
3236
3177
|
Logger({
|
|
3237
3178
|
level: "WARN",
|
|
3238
|
-
message: `Parameter Validation warrnings for platform > Catalog >
|
|
3179
|
+
message: `Parameter Validation warrnings for platform > Catalog > getApplicationFilterValues \n ${warrning}`,
|
|
3239
3180
|
});
|
|
3240
3181
|
}
|
|
3241
3182
|
|
|
3242
3183
|
const query_params = {};
|
|
3243
3184
|
query_params["c"] = c;
|
|
3185
|
+
query_params["collection_id"] = collectionId;
|
|
3186
|
+
query_params["page_no"] = pageNo;
|
|
3187
|
+
query_params["page_size"] = pageSize;
|
|
3188
|
+
query_params["q"] = q;
|
|
3244
3189
|
|
|
3245
3190
|
const response = await PlatformAPIClient.execute(
|
|
3246
3191
|
this.config,
|
|
3247
3192
|
"get",
|
|
3248
|
-
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/filter-options/
|
|
3193
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/filter-options/${filterKey}/values`,
|
|
3249
3194
|
query_params,
|
|
3250
3195
|
undefined,
|
|
3251
3196
|
requestHeaders,
|
|
@@ -3259,7 +3204,7 @@ class Catalog {
|
|
|
3259
3204
|
|
|
3260
3205
|
const {
|
|
3261
3206
|
error: res_error,
|
|
3262
|
-
} = CatalogPlatformModel.
|
|
3207
|
+
} = CatalogPlatformModel.GetQueryFiltersValuesResponseSchema().validate(
|
|
3263
3208
|
responseData,
|
|
3264
3209
|
{ abortEarly: false, allowUnknown: true }
|
|
3265
3210
|
);
|
|
@@ -3270,7 +3215,7 @@ class Catalog {
|
|
|
3270
3215
|
} else {
|
|
3271
3216
|
Logger({
|
|
3272
3217
|
level: "WARN",
|
|
3273
|
-
message: `Response Validation Warnings for platform > Catalog >
|
|
3218
|
+
message: `Response Validation Warnings for platform > Catalog > getApplicationFilterValues \n ${res_error}`,
|
|
3274
3219
|
});
|
|
3275
3220
|
}
|
|
3276
3221
|
}
|
|
@@ -3279,34 +3224,50 @@ class Catalog {
|
|
|
3279
3224
|
}
|
|
3280
3225
|
|
|
3281
3226
|
/**
|
|
3282
|
-
* @param {CatalogPlatformApplicationValidator.
|
|
3227
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
|
|
3283
3228
|
* - Arg object
|
|
3284
3229
|
*
|
|
3285
3230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3286
3231
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3287
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3288
|
-
* Success response
|
|
3289
|
-
*
|
|
3290
|
-
* @
|
|
3291
|
-
* @
|
|
3292
|
-
*
|
|
3232
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
3233
|
+
* - Success response
|
|
3234
|
+
*
|
|
3235
|
+
* @name getApplicationProducts
|
|
3236
|
+
* @summary: List sales channel products
|
|
3237
|
+
* @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/).
|
|
3293
3238
|
*/
|
|
3294
|
-
async
|
|
3295
|
-
{
|
|
3296
|
-
|
|
3297
|
-
|
|
3239
|
+
async getApplicationProducts(
|
|
3240
|
+
{
|
|
3241
|
+
q,
|
|
3242
|
+
f,
|
|
3243
|
+
c,
|
|
3244
|
+
filters,
|
|
3245
|
+
isDependent,
|
|
3246
|
+
sortOn,
|
|
3247
|
+
pageId,
|
|
3248
|
+
pageSize,
|
|
3249
|
+
pageNo,
|
|
3250
|
+
pageType,
|
|
3251
|
+
itemIds,
|
|
3252
|
+
requestHeaders,
|
|
3253
|
+
} = { requestHeaders: {} },
|
|
3298
3254
|
{ responseHeaders } = { responseHeaders: false }
|
|
3299
3255
|
) {
|
|
3300
3256
|
const {
|
|
3301
3257
|
error,
|
|
3302
|
-
} = CatalogPlatformApplicationValidator.
|
|
3258
|
+
} = CatalogPlatformApplicationValidator.getApplicationProducts().validate(
|
|
3303
3259
|
{
|
|
3304
|
-
|
|
3260
|
+
q,
|
|
3261
|
+
f,
|
|
3305
3262
|
c,
|
|
3306
|
-
|
|
3307
|
-
|
|
3263
|
+
filters,
|
|
3264
|
+
isDependent,
|
|
3265
|
+
sortOn,
|
|
3266
|
+
pageId,
|
|
3308
3267
|
pageSize,
|
|
3309
|
-
|
|
3268
|
+
pageNo,
|
|
3269
|
+
pageType,
|
|
3270
|
+
itemIds,
|
|
3310
3271
|
},
|
|
3311
3272
|
{ abortEarly: false, allowUnknown: true }
|
|
3312
3273
|
);
|
|
@@ -3317,35 +3278,46 @@ class Catalog {
|
|
|
3317
3278
|
// Showing warrnings if extra unknown parameters are found
|
|
3318
3279
|
const {
|
|
3319
3280
|
error: warrning,
|
|
3320
|
-
} = CatalogPlatformApplicationValidator.
|
|
3281
|
+
} = CatalogPlatformApplicationValidator.getApplicationProducts().validate(
|
|
3321
3282
|
{
|
|
3322
|
-
|
|
3283
|
+
q,
|
|
3284
|
+
f,
|
|
3323
3285
|
c,
|
|
3324
|
-
|
|
3325
|
-
|
|
3286
|
+
filters,
|
|
3287
|
+
isDependent,
|
|
3288
|
+
sortOn,
|
|
3289
|
+
pageId,
|
|
3326
3290
|
pageSize,
|
|
3327
|
-
|
|
3291
|
+
pageNo,
|
|
3292
|
+
pageType,
|
|
3293
|
+
itemIds,
|
|
3328
3294
|
},
|
|
3329
3295
|
{ abortEarly: false, allowUnknown: false }
|
|
3330
3296
|
);
|
|
3331
3297
|
if (warrning) {
|
|
3332
3298
|
Logger({
|
|
3333
3299
|
level: "WARN",
|
|
3334
|
-
message: `Parameter Validation warrnings for platform > Catalog >
|
|
3300
|
+
message: `Parameter Validation warrnings for platform > Catalog > getApplicationProducts \n ${warrning}`,
|
|
3335
3301
|
});
|
|
3336
3302
|
}
|
|
3337
3303
|
|
|
3338
3304
|
const query_params = {};
|
|
3305
|
+
query_params["q"] = q;
|
|
3306
|
+
query_params["f"] = f;
|
|
3339
3307
|
query_params["c"] = c;
|
|
3340
|
-
query_params["
|
|
3341
|
-
query_params["
|
|
3308
|
+
query_params["filters"] = filters;
|
|
3309
|
+
query_params["is_dependent"] = isDependent;
|
|
3310
|
+
query_params["sort_on"] = sortOn;
|
|
3311
|
+
query_params["page_id"] = pageId;
|
|
3342
3312
|
query_params["page_size"] = pageSize;
|
|
3343
|
-
query_params["
|
|
3313
|
+
query_params["page_no"] = pageNo;
|
|
3314
|
+
query_params["page_type"] = pageType;
|
|
3315
|
+
query_params["item_ids"] = itemIds;
|
|
3344
3316
|
|
|
3345
3317
|
const response = await PlatformAPIClient.execute(
|
|
3346
3318
|
this.config,
|
|
3347
3319
|
"get",
|
|
3348
|
-
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/
|
|
3320
|
+
`/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/products`,
|
|
3349
3321
|
query_params,
|
|
3350
3322
|
undefined,
|
|
3351
3323
|
requestHeaders,
|
|
@@ -3359,7 +3331,7 @@ class Catalog {
|
|
|
3359
3331
|
|
|
3360
3332
|
const {
|
|
3361
3333
|
error: res_error,
|
|
3362
|
-
} = CatalogPlatformModel.
|
|
3334
|
+
} = CatalogPlatformModel.ApplicationProductListingResponseSchema().validate(
|
|
3363
3335
|
responseData,
|
|
3364
3336
|
{ abortEarly: false, allowUnknown: true }
|
|
3365
3337
|
);
|
|
@@ -3370,7 +3342,7 @@ class Catalog {
|
|
|
3370
3342
|
} else {
|
|
3371
3343
|
Logger({
|
|
3372
3344
|
level: "WARN",
|
|
3373
|
-
message: `Response Validation Warnings for platform > Catalog >
|
|
3345
|
+
message: `Response Validation Warnings for platform > Catalog > getApplicationProducts \n ${res_error}`,
|
|
3374
3346
|
});
|
|
3375
3347
|
}
|
|
3376
3348
|
}
|
|
@@ -3378,14 +3350,87 @@ class Catalog {
|
|
|
3378
3350
|
return response;
|
|
3379
3351
|
}
|
|
3380
3352
|
|
|
3353
|
+
/**
|
|
3354
|
+
* @param {Object} arg - Arg object.
|
|
3355
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
3356
|
+
* a particular seller account.
|
|
3357
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
3358
|
+
* identifier for a particular sale channel.
|
|
3359
|
+
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
3360
|
+
* complete name of a either a product, brand or category
|
|
3361
|
+
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
3362
|
+
* filtered from filter parameters will be passed in **f** parameter in
|
|
3363
|
+
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
3364
|
+
* @param {string} [arg.c] - The search filter parameters for collection
|
|
3365
|
+
* items. All the parameter filtered from filter parameters will be passed
|
|
3366
|
+
* in **c** parameter in this format.
|
|
3367
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
3368
|
+
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
3369
|
+
* filter details. This flag is used to fetch all filters
|
|
3370
|
+
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
3371
|
+
* the dependent products in the listing.
|
|
3372
|
+
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
3373
|
+
* The supported sort parameters are popularity, price, redemption and
|
|
3374
|
+
* discount in either ascending or descending order. See the supported
|
|
3375
|
+
* values below.
|
|
3376
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
3377
|
+
* page. Default is 12.
|
|
3378
|
+
* @param {string[]} [arg.itemIds] - Item Ids of product
|
|
3379
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
3380
|
+
* @summary: List sales channel products
|
|
3381
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
3382
|
+
*/
|
|
3383
|
+
getApplicationProductsPaginator({
|
|
3384
|
+
companyId,
|
|
3385
|
+
applicationId,
|
|
3386
|
+
q,
|
|
3387
|
+
f,
|
|
3388
|
+
c,
|
|
3389
|
+
filters,
|
|
3390
|
+
isDependent,
|
|
3391
|
+
sortOn,
|
|
3392
|
+
pageSize,
|
|
3393
|
+
itemIds,
|
|
3394
|
+
} = {}) {
|
|
3395
|
+
const paginator = new Paginator();
|
|
3396
|
+
const callback = async () => {
|
|
3397
|
+
const pageId = paginator.nextId;
|
|
3398
|
+
const pageNo = paginator.pageNo;
|
|
3399
|
+
const pageType = "cursor";
|
|
3400
|
+
const data = await this.getApplicationProducts({
|
|
3401
|
+
companyId: companyId,
|
|
3402
|
+
applicationId: applicationId,
|
|
3403
|
+
q: q,
|
|
3404
|
+
f: f,
|
|
3405
|
+
c: c,
|
|
3406
|
+
filters: filters,
|
|
3407
|
+
isDependent: isDependent,
|
|
3408
|
+
sortOn: sortOn,
|
|
3409
|
+
pageId: pageId,
|
|
3410
|
+
pageSize: pageSize,
|
|
3411
|
+
pageNo: pageNo,
|
|
3412
|
+
pageType: pageType,
|
|
3413
|
+
itemIds: itemIds,
|
|
3414
|
+
});
|
|
3415
|
+
paginator.setPaginator({
|
|
3416
|
+
hasNext: data.page.has_next ? true : false,
|
|
3417
|
+
nextId: data.page.next_id,
|
|
3418
|
+
});
|
|
3419
|
+
return data;
|
|
3420
|
+
};
|
|
3421
|
+
paginator.setCallback(callback.bind(this));
|
|
3422
|
+
return paginator;
|
|
3423
|
+
}
|
|
3424
|
+
|
|
3381
3425
|
/**
|
|
3382
3426
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
3383
3427
|
* - Arg object
|
|
3384
3428
|
*
|
|
3385
3429
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3386
3430
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3387
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3388
|
-
* Success response
|
|
3431
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
3432
|
+
* - Success response
|
|
3433
|
+
*
|
|
3389
3434
|
* @name getAutocompleteConfig
|
|
3390
3435
|
* @summary: Get autocomplete configuration
|
|
3391
3436
|
* @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
|
|
@@ -3437,7 +3482,7 @@ class Catalog {
|
|
|
3437
3482
|
|
|
3438
3483
|
const {
|
|
3439
3484
|
error: res_error,
|
|
3440
|
-
} = CatalogPlatformModel.
|
|
3485
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponseSchema().validate(
|
|
3441
3486
|
responseData,
|
|
3442
3487
|
{ abortEarly: false, allowUnknown: true }
|
|
3443
3488
|
);
|
|
@@ -3462,8 +3507,9 @@ class Catalog {
|
|
|
3462
3507
|
*
|
|
3463
3508
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3464
3509
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3465
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3466
|
-
* Success response
|
|
3510
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
3511
|
+
* - Success response
|
|
3512
|
+
*
|
|
3467
3513
|
* @name getAutocompleteKeywordDetail
|
|
3468
3514
|
* @summary: Get autocomplete keyword
|
|
3469
3515
|
* @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
@@ -3519,7 +3565,7 @@ class Catalog {
|
|
|
3519
3565
|
|
|
3520
3566
|
const {
|
|
3521
3567
|
error: res_error,
|
|
3522
|
-
} = CatalogPlatformModel.
|
|
3568
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponseSchema().validate(
|
|
3523
3569
|
responseData,
|
|
3524
3570
|
{ abortEarly: false, allowUnknown: true }
|
|
3525
3571
|
);
|
|
@@ -3623,7 +3669,8 @@ class Catalog {
|
|
|
3623
3669
|
*
|
|
3624
3670
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3625
3671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3626
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3672
|
+
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponseSchema>} -
|
|
3673
|
+
* Success response
|
|
3627
3674
|
* @name getCatalogInsights
|
|
3628
3675
|
* @summary: Get catalog counts
|
|
3629
3676
|
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
|
|
@@ -3680,10 +3727,10 @@ class Catalog {
|
|
|
3680
3727
|
|
|
3681
3728
|
const {
|
|
3682
3729
|
error: res_error,
|
|
3683
|
-
} = CatalogPlatformModel.
|
|
3684
|
-
|
|
3685
|
-
allowUnknown: true
|
|
3686
|
-
|
|
3730
|
+
} = CatalogPlatformModel.CatalogInsightResponseSchema().validate(
|
|
3731
|
+
responseData,
|
|
3732
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3733
|
+
);
|
|
3687
3734
|
|
|
3688
3735
|
if (res_error) {
|
|
3689
3736
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3703,7 +3750,8 @@ class Catalog {
|
|
|
3703
3750
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
3704
3751
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3705
3752
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3706
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3753
|
+
* @returns {Promise<CatalogPlatformModel.CategoryListingResponseSchema>} -
|
|
3754
|
+
* Success response
|
|
3707
3755
|
* @name getCategories
|
|
3708
3756
|
* @summary: List categories
|
|
3709
3757
|
* @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
|
|
@@ -3760,10 +3808,10 @@ class Catalog {
|
|
|
3760
3808
|
|
|
3761
3809
|
const {
|
|
3762
3810
|
error: res_error,
|
|
3763
|
-
} = CatalogPlatformModel.
|
|
3764
|
-
|
|
3765
|
-
allowUnknown: true
|
|
3766
|
-
|
|
3811
|
+
} = CatalogPlatformModel.CategoryListingResponseSchema().validate(
|
|
3812
|
+
responseData,
|
|
3813
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3814
|
+
);
|
|
3767
3815
|
|
|
3768
3816
|
if (res_error) {
|
|
3769
3817
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3785,8 +3833,9 @@ class Catalog {
|
|
|
3785
3833
|
*
|
|
3786
3834
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3787
3835
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3788
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3789
|
-
* Success response
|
|
3836
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>}
|
|
3837
|
+
* - Success response
|
|
3838
|
+
*
|
|
3790
3839
|
* @name getCollectionDetail
|
|
3791
3840
|
* @summary: Get a collection
|
|
3792
3841
|
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
@@ -3842,7 +3891,7 @@ class Catalog {
|
|
|
3842
3891
|
|
|
3843
3892
|
const {
|
|
3844
3893
|
error: res_error,
|
|
3845
|
-
} = CatalogPlatformModel.
|
|
3894
|
+
} = CatalogPlatformModel.GetCollectionDetailResponseSchema().validate(
|
|
3846
3895
|
responseData,
|
|
3847
3896
|
{ abortEarly: false, allowUnknown: true }
|
|
3848
3897
|
);
|
|
@@ -3867,14 +3916,17 @@ class Catalog {
|
|
|
3867
3916
|
*
|
|
3868
3917
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3869
3918
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3870
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
3871
|
-
* Success response
|
|
3919
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>}
|
|
3920
|
+
* - Success response
|
|
3921
|
+
*
|
|
3872
3922
|
* @name getCollectionItems
|
|
3873
3923
|
* @summary: List items of collection
|
|
3874
3924
|
* @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
|
|
3875
3925
|
*/
|
|
3876
3926
|
async getCollectionItems(
|
|
3877
|
-
{ id, sortOn, pageId, pageSize, requestHeaders } = {
|
|
3927
|
+
{ id, sortOn, pageId, pageSize, pageNo, requestHeaders } = {
|
|
3928
|
+
requestHeaders: {},
|
|
3929
|
+
},
|
|
3878
3930
|
{ responseHeaders } = { responseHeaders: false }
|
|
3879
3931
|
) {
|
|
3880
3932
|
const {
|
|
@@ -3885,6 +3937,7 @@ class Catalog {
|
|
|
3885
3937
|
sortOn,
|
|
3886
3938
|
pageId,
|
|
3887
3939
|
pageSize,
|
|
3940
|
+
pageNo,
|
|
3888
3941
|
},
|
|
3889
3942
|
{ abortEarly: false, allowUnknown: true }
|
|
3890
3943
|
);
|
|
@@ -3901,6 +3954,7 @@ class Catalog {
|
|
|
3901
3954
|
sortOn,
|
|
3902
3955
|
pageId,
|
|
3903
3956
|
pageSize,
|
|
3957
|
+
pageNo,
|
|
3904
3958
|
},
|
|
3905
3959
|
{ abortEarly: false, allowUnknown: false }
|
|
3906
3960
|
);
|
|
@@ -3915,6 +3969,7 @@ class Catalog {
|
|
|
3915
3969
|
query_params["sort_on"] = sortOn;
|
|
3916
3970
|
query_params["page_id"] = pageId;
|
|
3917
3971
|
query_params["page_size"] = pageSize;
|
|
3972
|
+
query_params["page_no"] = pageNo;
|
|
3918
3973
|
|
|
3919
3974
|
const response = await PlatformAPIClient.execute(
|
|
3920
3975
|
this.config,
|
|
@@ -3933,7 +3988,7 @@ class Catalog {
|
|
|
3933
3988
|
|
|
3934
3989
|
const {
|
|
3935
3990
|
error: res_error,
|
|
3936
|
-
} = CatalogPlatformModel.
|
|
3991
|
+
} = CatalogPlatformModel.GetCollectionItemsResponseSchema().validate(
|
|
3937
3992
|
responseData,
|
|
3938
3993
|
{ abortEarly: false, allowUnknown: true }
|
|
3939
3994
|
);
|
|
@@ -4041,8 +4096,9 @@ class Catalog {
|
|
|
4041
4096
|
*
|
|
4042
4097
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4043
4098
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4044
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4045
|
-
* Success response
|
|
4099
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>}
|
|
4100
|
+
* - Success response
|
|
4101
|
+
*
|
|
4046
4102
|
* @name getConfigurationMetadata
|
|
4047
4103
|
* @summary: Get configuration metadata
|
|
4048
4104
|
* @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
@@ -4112,7 +4168,7 @@ class Catalog {
|
|
|
4112
4168
|
|
|
4113
4169
|
const {
|
|
4114
4170
|
error: res_error,
|
|
4115
|
-
} = CatalogPlatformModel.
|
|
4171
|
+
} = CatalogPlatformModel.GetConfigMetadataResponseSchema().validate(
|
|
4116
4172
|
responseData,
|
|
4117
4173
|
{ abortEarly: false, allowUnknown: true }
|
|
4118
4174
|
);
|
|
@@ -4213,7 +4269,8 @@ class Catalog {
|
|
|
4213
4269
|
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
4214
4270
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4215
4271
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4216
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4272
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentResponseSchema>} -
|
|
4273
|
+
* Success response
|
|
4217
4274
|
* @name getDepartments
|
|
4218
4275
|
* @summary: List departments
|
|
4219
4276
|
* @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
|
|
@@ -4265,7 +4322,7 @@ class Catalog {
|
|
|
4265
4322
|
|
|
4266
4323
|
const {
|
|
4267
4324
|
error: res_error,
|
|
4268
|
-
} = CatalogPlatformModel.
|
|
4325
|
+
} = CatalogPlatformModel.DepartmentResponseSchema().validate(responseData, {
|
|
4269
4326
|
abortEarly: false,
|
|
4270
4327
|
allowUnknown: true,
|
|
4271
4328
|
});
|
|
@@ -4290,7 +4347,7 @@ class Catalog {
|
|
|
4290
4347
|
*
|
|
4291
4348
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4292
4349
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4293
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4350
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
|
|
4294
4351
|
* - Success response
|
|
4295
4352
|
*
|
|
4296
4353
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
@@ -4303,7 +4360,6 @@ class Catalog {
|
|
|
4303
4360
|
sizeIdentifier,
|
|
4304
4361
|
pageNo,
|
|
4305
4362
|
pageSize,
|
|
4306
|
-
q,
|
|
4307
4363
|
locationIds,
|
|
4308
4364
|
requestHeaders,
|
|
4309
4365
|
} = { requestHeaders: {} },
|
|
@@ -4317,7 +4373,6 @@ class Catalog {
|
|
|
4317
4373
|
sizeIdentifier,
|
|
4318
4374
|
pageNo,
|
|
4319
4375
|
pageSize,
|
|
4320
|
-
q,
|
|
4321
4376
|
locationIds,
|
|
4322
4377
|
},
|
|
4323
4378
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -4335,7 +4390,6 @@ class Catalog {
|
|
|
4335
4390
|
sizeIdentifier,
|
|
4336
4391
|
pageNo,
|
|
4337
4392
|
pageSize,
|
|
4338
|
-
q,
|
|
4339
4393
|
locationIds,
|
|
4340
4394
|
},
|
|
4341
4395
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -4350,7 +4404,6 @@ class Catalog {
|
|
|
4350
4404
|
const query_params = {};
|
|
4351
4405
|
query_params["page_no"] = pageNo;
|
|
4352
4406
|
query_params["page_size"] = pageSize;
|
|
4353
|
-
query_params["q"] = q;
|
|
4354
4407
|
query_params["location_ids"] = locationIds;
|
|
4355
4408
|
|
|
4356
4409
|
const response = await PlatformAPIClient.execute(
|
|
@@ -4370,7 +4423,7 @@ class Catalog {
|
|
|
4370
4423
|
|
|
4371
4424
|
const {
|
|
4372
4425
|
error: res_error,
|
|
4373
|
-
} = CatalogPlatformModel.
|
|
4426
|
+
} = CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated().validate(
|
|
4374
4427
|
responseData,
|
|
4375
4428
|
{ abortEarly: false, allowUnknown: true }
|
|
4376
4429
|
);
|
|
@@ -4391,17 +4444,18 @@ class Catalog {
|
|
|
4391
4444
|
|
|
4392
4445
|
/**
|
|
4393
4446
|
* @param {Object} arg - Arg object.
|
|
4394
|
-
* @param {number} arg.companyId -
|
|
4395
|
-
*
|
|
4396
|
-
* @param {string} arg.applicationId -
|
|
4397
|
-
*
|
|
4398
|
-
* @param {
|
|
4399
|
-
*
|
|
4447
|
+
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
4448
|
+
* a particular seller account.
|
|
4449
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
4450
|
+
* identifier for a particular sale channel.
|
|
4451
|
+
* @param {number} arg.itemId - A `item_id` is a unique identifier for a
|
|
4452
|
+
* specific product.
|
|
4453
|
+
* @param {number} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
4454
|
+
* or Primary Identifier).
|
|
4400
4455
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
4401
4456
|
* page. Default is 12.
|
|
4402
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
4403
4457
|
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
4404
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
4458
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
|
|
4405
4459
|
* @summary: Get discounted inventory
|
|
4406
4460
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
4407
4461
|
*/
|
|
@@ -4411,7 +4465,6 @@ class Catalog {
|
|
|
4411
4465
|
itemId,
|
|
4412
4466
|
sizeIdentifier,
|
|
4413
4467
|
pageSize,
|
|
4414
|
-
q,
|
|
4415
4468
|
locationIds,
|
|
4416
4469
|
} = {}) {
|
|
4417
4470
|
const paginator = new Paginator();
|
|
@@ -4426,7 +4479,6 @@ class Catalog {
|
|
|
4426
4479
|
sizeIdentifier: sizeIdentifier,
|
|
4427
4480
|
pageNo: pageNo,
|
|
4428
4481
|
pageSize: pageSize,
|
|
4429
|
-
q: q,
|
|
4430
4482
|
locationIds: locationIds,
|
|
4431
4483
|
});
|
|
4432
4484
|
paginator.setPaginator({
|
|
@@ -4445,7 +4497,7 @@ class Catalog {
|
|
|
4445
4497
|
*
|
|
4446
4498
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4447
4499
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4448
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4500
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
4449
4501
|
* @name getGroupConfigurations
|
|
4450
4502
|
* @summary: Get group configurations
|
|
4451
4503
|
* @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
|
|
@@ -4515,7 +4567,7 @@ class Catalog {
|
|
|
4515
4567
|
|
|
4516
4568
|
const {
|
|
4517
4569
|
error: res_error,
|
|
4518
|
-
} = CatalogPlatformModel.
|
|
4570
|
+
} = CatalogPlatformModel.GetConfigResponseSchema().validate(responseData, {
|
|
4519
4571
|
abortEarly: false,
|
|
4520
4572
|
allowUnknown: true,
|
|
4521
4573
|
});
|
|
@@ -4540,7 +4592,7 @@ class Catalog {
|
|
|
4540
4592
|
*
|
|
4541
4593
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4542
4594
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4543
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4595
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
4544
4596
|
* @name getListingConfigurations
|
|
4545
4597
|
* @summary: Get listing configurations
|
|
4546
4598
|
* @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
|
|
@@ -4607,7 +4659,7 @@ class Catalog {
|
|
|
4607
4659
|
|
|
4608
4660
|
const {
|
|
4609
4661
|
error: res_error,
|
|
4610
|
-
} = CatalogPlatformModel.
|
|
4662
|
+
} = CatalogPlatformModel.GetConfigResponseSchema().validate(responseData, {
|
|
4611
4663
|
abortEarly: false,
|
|
4612
4664
|
allowUnknown: true,
|
|
4613
4665
|
});
|
|
@@ -4711,7 +4763,8 @@ class Catalog {
|
|
|
4711
4763
|
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
4712
4764
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4713
4765
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4714
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4766
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>} -
|
|
4767
|
+
* Success response
|
|
4715
4768
|
* @name getQueryFilters
|
|
4716
4769
|
* @summary: Get collection query filters
|
|
4717
4770
|
* @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
@@ -4763,10 +4816,10 @@ class Catalog {
|
|
|
4763
4816
|
|
|
4764
4817
|
const {
|
|
4765
4818
|
error: res_error,
|
|
4766
|
-
} = CatalogPlatformModel.
|
|
4767
|
-
|
|
4768
|
-
allowUnknown: true
|
|
4769
|
-
|
|
4819
|
+
} = CatalogPlatformModel.GetQueryFiltersResponseSchema().validate(
|
|
4820
|
+
responseData,
|
|
4821
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4822
|
+
);
|
|
4770
4823
|
|
|
4771
4824
|
if (res_error) {
|
|
4772
4825
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -4788,7 +4841,7 @@ class Catalog {
|
|
|
4788
4841
|
*
|
|
4789
4842
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4790
4843
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4791
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4844
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>}
|
|
4792
4845
|
* - Success response
|
|
4793
4846
|
*
|
|
4794
4847
|
* @name getSearchConfiguration
|
|
@@ -4842,7 +4895,7 @@ class Catalog {
|
|
|
4842
4895
|
|
|
4843
4896
|
const {
|
|
4844
4897
|
error: res_error,
|
|
4845
|
-
} = CatalogPlatformModel.
|
|
4898
|
+
} = CatalogPlatformModel.GetSearchConfigurationResponseSchema().validate(
|
|
4846
4899
|
responseData,
|
|
4847
4900
|
{ abortEarly: false, allowUnknown: true }
|
|
4848
4901
|
);
|
|
@@ -4867,8 +4920,9 @@ class Catalog {
|
|
|
4867
4920
|
*
|
|
4868
4921
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4869
4922
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4870
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
4871
|
-
* Success response
|
|
4923
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>}
|
|
4924
|
+
* - Success response
|
|
4925
|
+
*
|
|
4872
4926
|
* @name getSearchKeywords
|
|
4873
4927
|
* @summary: Get search keywords
|
|
4874
4928
|
* @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
|
|
@@ -4924,7 +4978,7 @@ class Catalog {
|
|
|
4924
4978
|
|
|
4925
4979
|
const {
|
|
4926
4980
|
error: res_error,
|
|
4927
|
-
} = CatalogPlatformModel.
|
|
4981
|
+
} = CatalogPlatformModel.GetSearchWordsDetailResponseSchema().validate(
|
|
4928
4982
|
responseData,
|
|
4929
4983
|
{ abortEarly: false, allowUnknown: true }
|
|
4930
4984
|
);
|
|
@@ -4949,7 +5003,8 @@ class Catalog {
|
|
|
4949
5003
|
*
|
|
4950
5004
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4951
5005
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4952
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5006
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
5007
|
+
* Success response
|
|
4953
5008
|
* @name updateAllowSingle
|
|
4954
5009
|
* @summary: Update 'Allow Single' setting
|
|
4955
5010
|
* @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
|
|
@@ -5005,10 +5060,10 @@ class Catalog {
|
|
|
5005
5060
|
|
|
5006
5061
|
const {
|
|
5007
5062
|
error: res_error,
|
|
5008
|
-
} = CatalogPlatformModel.
|
|
5009
|
-
|
|
5010
|
-
allowUnknown: true
|
|
5011
|
-
|
|
5063
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
5064
|
+
responseData,
|
|
5065
|
+
{ abortEarly: false, allowUnknown: true }
|
|
5066
|
+
);
|
|
5012
5067
|
|
|
5013
5068
|
if (res_error) {
|
|
5014
5069
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -5194,7 +5249,7 @@ class Catalog {
|
|
|
5194
5249
|
*
|
|
5195
5250
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5196
5251
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5197
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5252
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
5198
5253
|
* @name updateAppCategoryReturnConfiguration
|
|
5199
5254
|
* @summary: Update return Configuration
|
|
5200
5255
|
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
@@ -5250,7 +5305,7 @@ class Catalog {
|
|
|
5250
5305
|
|
|
5251
5306
|
const {
|
|
5252
5307
|
error: res_error,
|
|
5253
|
-
} = CatalogPlatformModel.
|
|
5308
|
+
} = CatalogPlatformModel.SuccessResponseSchema().validate(responseData, {
|
|
5254
5309
|
abortEarly: false,
|
|
5255
5310
|
allowUnknown: true,
|
|
5256
5311
|
});
|
|
@@ -5442,7 +5497,7 @@ class Catalog {
|
|
|
5442
5497
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
5443
5498
|
* @name updateAppProduct
|
|
5444
5499
|
* @summary: Update sales channel product
|
|
5445
|
-
* @description: Allows to update data associated to a item by its item_id for
|
|
5500
|
+
* @description: Allows to update data associated to a item by its item_id for a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
5446
5501
|
*/
|
|
5447
5502
|
async updateAppProduct(
|
|
5448
5503
|
{ itemId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5603,8 +5658,9 @@ class Catalog {
|
|
|
5603
5658
|
*
|
|
5604
5659
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5605
5660
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5606
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5607
|
-
* Success response
|
|
5661
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
5662
|
+
* - Success response
|
|
5663
|
+
*
|
|
5608
5664
|
* @name updateAutocompleteKeyword
|
|
5609
5665
|
* @summary: Update autocomplete keyword
|
|
5610
5666
|
* @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
|
|
@@ -5662,7 +5718,7 @@ class Catalog {
|
|
|
5662
5718
|
|
|
5663
5719
|
const {
|
|
5664
5720
|
error: res_error,
|
|
5665
|
-
} = CatalogPlatformModel.
|
|
5721
|
+
} = CatalogPlatformModel.GetAutocompleteWordsResponseSchema().validate(
|
|
5666
5722
|
responseData,
|
|
5667
5723
|
{ abortEarly: false, allowUnknown: true }
|
|
5668
5724
|
);
|
|
@@ -5768,7 +5824,8 @@ class Catalog {
|
|
|
5768
5824
|
*
|
|
5769
5825
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5770
5826
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5771
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
5827
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
5828
|
+
* Success response
|
|
5772
5829
|
* @name updateDefaultSort
|
|
5773
5830
|
* @summary: Update default sorting
|
|
5774
5831
|
* @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
|
|
@@ -5824,10 +5881,10 @@ class Catalog {
|
|
|
5824
5881
|
|
|
5825
5882
|
const {
|
|
5826
5883
|
error: res_error,
|
|
5827
|
-
} = CatalogPlatformModel.
|
|
5828
|
-
|
|
5829
|
-
allowUnknown: true
|
|
5830
|
-
|
|
5884
|
+
} = CatalogPlatformModel.ConfigSuccessResponseSchema().validate(
|
|
5885
|
+
responseData,
|
|
5886
|
+
{ abortEarly: false, allowUnknown: true }
|
|
5887
|
+
);
|
|
5831
5888
|
|
|
5832
5889
|
if (res_error) {
|
|
5833
5890
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -6019,7 +6076,7 @@ class Catalog {
|
|
|
6019
6076
|
*
|
|
6020
6077
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
6021
6078
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6022
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
6079
|
+
* @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>}
|
|
6023
6080
|
* - Success response
|
|
6024
6081
|
*
|
|
6025
6082
|
* @name updateSearchConfiguration
|
|
@@ -6077,7 +6134,7 @@ class Catalog {
|
|
|
6077
6134
|
|
|
6078
6135
|
const {
|
|
6079
6136
|
error: res_error,
|
|
6080
|
-
} = CatalogPlatformModel.
|
|
6137
|
+
} = CatalogPlatformModel.UpdateSearchConfigurationResponseSchema().validate(
|
|
6081
6138
|
responseData,
|
|
6082
6139
|
{ abortEarly: false, allowUnknown: true }
|
|
6083
6140
|
);
|