@gofynd/fdk-client-javascript 1.4.13 → 1.4.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
- package/sdk/application/Cart/CartApplicationClient.js +130 -53
- package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
- package/sdk/application/Cart/CartApplicationModel.js +380 -159
- package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
- package/sdk/application/Cart/CartApplicationValidator.js +34 -18
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
- package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
- package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
- package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
- package/sdk/application/Common/CommonApplicationClient.js +6 -5
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
- package/sdk/application/Content/ContentApplicationClient.js +54 -75
- package/sdk/application/Content/ContentApplicationModel.d.ts +93 -37
- package/sdk/application/Content/ContentApplicationModel.js +83 -32
- package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
- package/sdk/application/Content/ContentApplicationValidator.js +15 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
- package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
- package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
- package/sdk/application/Lead/LeadApplicationClient.js +2 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
- package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
- package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
- package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
- package/sdk/application/Order/OrderApplicationClient.js +96 -13
- package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
- package/sdk/application/Order/OrderApplicationModel.js +278 -73
- package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
- package/sdk/application/Order/OrderApplicationValidator.js +15 -2
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
- package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
- package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
- package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +48 -17
- package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
- package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
- package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +1 -0
- package/sdk/application/index.js +2 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
- package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +208 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
- package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +178 -97
- package/sdk/platform/Order/OrderPlatformClient.js +589 -229
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
- package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
- package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
- package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +791 -5
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -23,35 +23,36 @@ declare class Catalog {
|
|
|
23
23
|
*
|
|
24
24
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
25
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
26
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
27
27
|
* @name createAppCategoryReturnConfiguration
|
|
28
28
|
* @summary: Create return configuration
|
|
29
29
|
* @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
|
|
30
30
|
*/
|
|
31
|
-
createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
31
|
+
createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
32
32
|
/**
|
|
33
33
|
* @param {CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam} arg
|
|
34
34
|
* - Arg object
|
|
35
35
|
*
|
|
36
36
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
37
37
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
38
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
38
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
39
39
|
* @name createAppReturnConfiguration
|
|
40
40
|
* @summary: Create product return configuration
|
|
41
41
|
* @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
|
|
42
42
|
*/
|
|
43
|
-
createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
43
|
+
createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
44
44
|
/**
|
|
45
45
|
* @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
|
|
46
46
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
47
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
49
|
-
* Success response
|
|
48
|
+
* @returns {Promise<CatalogPlatformModel.CollectionCreateResponseSchema>}
|
|
49
|
+
* - Success response
|
|
50
|
+
*
|
|
50
51
|
* @name createCollection
|
|
51
52
|
* @summary: Create a collection
|
|
52
53
|
* @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/).
|
|
53
54
|
*/
|
|
54
|
-
createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
55
|
+
createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponseSchema>;
|
|
55
56
|
/**
|
|
56
57
|
* @param {CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam} arg
|
|
57
58
|
* - Arg object
|
|
@@ -84,14 +85,14 @@ declare class Catalog {
|
|
|
84
85
|
*
|
|
85
86
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
86
87
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
87
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
88
|
+
* @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>}
|
|
88
89
|
* - Success response
|
|
89
90
|
*
|
|
90
91
|
* @name createCustomAutocompleteRule
|
|
91
92
|
* @summary: Create autocomplete configurations
|
|
92
93
|
* @description: Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
|
|
93
94
|
*/
|
|
94
|
-
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
95
|
+
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>;
|
|
95
96
|
/**
|
|
96
97
|
* @param {CatalogPlatformApplicationValidator.CreateCustomKeywordParam} arg
|
|
97
98
|
* - Arg object
|
|
@@ -134,38 +135,38 @@ declare class Catalog {
|
|
|
134
135
|
*
|
|
135
136
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
136
137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
137
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
138
|
+
* @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>}
|
|
138
139
|
* - Success response
|
|
139
140
|
*
|
|
140
141
|
* @name createSearchConfiguration
|
|
141
142
|
* @summary: Create search configuration
|
|
142
143
|
* @description: Create search configuration for the catalog for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
|
|
143
144
|
*/
|
|
144
|
-
createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
145
|
+
createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>;
|
|
145
146
|
/**
|
|
146
147
|
* @param {CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam} arg
|
|
147
148
|
* - Arg object
|
|
148
149
|
*
|
|
149
150
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
150
151
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
151
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
152
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
152
153
|
* @name deleteAppCategoryReturnConfiguration
|
|
153
154
|
* @summary: Delete product return configuration
|
|
154
155
|
* @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
|
|
155
156
|
*/
|
|
156
|
-
deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
157
|
+
deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
157
158
|
/**
|
|
158
159
|
* @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
|
|
159
160
|
* - Arg object
|
|
160
161
|
*
|
|
161
162
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
163
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
164
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
164
165
|
* @name deleteAutocompleteKeyword
|
|
165
166
|
* @summary: Delete autocomplete keyword
|
|
166
167
|
* @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/).
|
|
167
168
|
*/
|
|
168
|
-
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
169
|
+
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
|
|
169
170
|
/**
|
|
170
171
|
* @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
|
|
171
172
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -184,63 +185,66 @@ declare class Catalog {
|
|
|
184
185
|
*
|
|
185
186
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
187
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
188
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
189
|
+
* Success response
|
|
188
190
|
* @name deleteGroupConfiguration
|
|
189
191
|
* @summary: Delete group configuration
|
|
190
192
|
* @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/).
|
|
191
193
|
*/
|
|
192
|
-
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
194
|
+
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
193
195
|
/**
|
|
194
196
|
* @param {CatalogPlatformApplicationValidator.DeleteListingConfigurationParam} arg
|
|
195
197
|
* - Arg object
|
|
196
198
|
*
|
|
197
199
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
198
200
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
201
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
202
|
+
* Success response
|
|
200
203
|
* @name deleteListingConfiguration
|
|
201
204
|
* @summary: Delete listing configuration
|
|
202
205
|
* @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/).
|
|
203
206
|
*/
|
|
204
|
-
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
207
|
+
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
205
208
|
/**
|
|
206
209
|
* @param {CatalogPlatformApplicationValidator.DeleteSearchConfigurationParam} arg
|
|
207
210
|
* - Arg object
|
|
208
211
|
*
|
|
209
212
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
210
213
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
211
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
214
|
+
* @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>}
|
|
212
215
|
* - Success response
|
|
213
216
|
*
|
|
214
217
|
* @name deleteSearchConfiguration
|
|
215
218
|
* @summary: Delete search configuration
|
|
216
219
|
* @description: Delete Search Configuration for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
|
|
217
220
|
*/
|
|
218
|
-
deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
221
|
+
deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>;
|
|
219
222
|
/**
|
|
220
223
|
* @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
|
|
221
224
|
* - Arg object
|
|
222
225
|
*
|
|
223
226
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
224
227
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
225
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
228
|
+
* @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
|
|
226
229
|
* @name deleteSearchKeywords
|
|
227
230
|
* @summary: Delete search keywords
|
|
228
231
|
* @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/).
|
|
229
232
|
*/
|
|
230
|
-
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
233
|
+
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
|
|
231
234
|
/**
|
|
232
235
|
* @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
|
|
233
236
|
* - Arg object
|
|
234
237
|
*
|
|
235
238
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
236
239
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
237
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
238
|
-
* Success response
|
|
240
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
241
|
+
* - Success response
|
|
242
|
+
*
|
|
239
243
|
* @name getAllCollections
|
|
240
244
|
* @summary: List collections
|
|
241
245
|
* @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/).
|
|
242
246
|
*/
|
|
243
|
-
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
247
|
+
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>;
|
|
244
248
|
/**
|
|
245
249
|
* @param {Object} arg - Arg object.
|
|
246
250
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -256,7 +260,7 @@ declare class Catalog {
|
|
|
256
260
|
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
257
261
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
258
262
|
* page. Default is 12.
|
|
259
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
263
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>}
|
|
260
264
|
* @summary: List collections
|
|
261
265
|
* @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
|
|
262
266
|
*/
|
|
@@ -269,53 +273,55 @@ declare class Catalog {
|
|
|
269
273
|
tags?: string[];
|
|
270
274
|
isActive?: boolean;
|
|
271
275
|
pageSize?: number;
|
|
272
|
-
}): Paginator<CatalogPlatformModel.
|
|
276
|
+
}): Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>;
|
|
273
277
|
/**
|
|
274
278
|
* @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
|
|
275
279
|
* - Arg object
|
|
276
280
|
*
|
|
277
281
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
278
282
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
279
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
283
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>} -
|
|
284
|
+
* Success response
|
|
280
285
|
* @name getAllSearchKeyword
|
|
281
286
|
* @summary: List search keywords
|
|
282
287
|
* @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/).
|
|
283
288
|
*/
|
|
284
|
-
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
289
|
+
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>;
|
|
285
290
|
/**
|
|
286
291
|
* @param {CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam} arg
|
|
287
292
|
* - Arg object
|
|
288
293
|
*
|
|
289
294
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
290
295
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
291
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
296
|
+
* @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>}
|
|
292
297
|
* - Success response
|
|
293
298
|
*
|
|
294
299
|
* @name getAppCategoryReturnConfig
|
|
295
300
|
* @summary: Get category return configuration
|
|
296
301
|
* @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
|
|
297
302
|
*/
|
|
298
|
-
getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
303
|
+
getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>;
|
|
299
304
|
/**
|
|
300
305
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
301
306
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
302
307
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
303
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
308
|
+
* @returns {Promise<CatalogPlatformModel.InventoryStockResponseSchema>} -
|
|
309
|
+
* Success response
|
|
304
310
|
* @name getAppInventory
|
|
305
311
|
* @summary: List sales channel inventory
|
|
306
312
|
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
307
313
|
*/
|
|
308
|
-
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
314
|
+
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponseSchema>;
|
|
309
315
|
/**
|
|
310
316
|
* @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
|
|
311
317
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
312
318
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
313
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
319
|
+
* @returns {Promise<CatalogPlatformModel.LocationListSchema>} - Success response
|
|
314
320
|
* @name getAppLocations
|
|
315
321
|
* @summary: List sales channels
|
|
316
322
|
* @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
|
|
317
323
|
*/
|
|
318
|
-
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
324
|
+
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSchema>;
|
|
319
325
|
/**
|
|
320
326
|
* @param {Object} arg - Arg object.
|
|
321
327
|
* @param {string} arg.companyId - Id of the company whose locations are to fetched
|
|
@@ -332,7 +338,7 @@ declare class Catalog {
|
|
|
332
338
|
* page. Default is 20.
|
|
333
339
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
334
340
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
335
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
341
|
+
* @returns {Paginator<CatalogPlatformModel.LocationListSchema>}
|
|
336
342
|
* @summary: List sales channels
|
|
337
343
|
* @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified)
|
|
338
344
|
*/
|
|
@@ -346,28 +352,30 @@ declare class Catalog {
|
|
|
346
352
|
pageSize?: number;
|
|
347
353
|
tags?: string[];
|
|
348
354
|
storeTypes?: string[];
|
|
349
|
-
}): Paginator<CatalogPlatformModel.
|
|
355
|
+
}): Paginator<CatalogPlatformModel.LocationListSchema>;
|
|
350
356
|
/**
|
|
351
357
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
352
358
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
353
359
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
354
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
360
|
+
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>} -
|
|
361
|
+
* Success response
|
|
355
362
|
* @name getAppProduct
|
|
356
363
|
* @summary: Get sales channel product
|
|
357
364
|
* @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/).
|
|
358
365
|
*/
|
|
359
|
-
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
366
|
+
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>;
|
|
360
367
|
/**
|
|
361
368
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
362
369
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
363
370
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
364
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
365
|
-
* Success response
|
|
371
|
+
* @returns {Promise<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
372
|
+
* - Success response
|
|
373
|
+
*
|
|
366
374
|
* @name getAppProducts
|
|
367
375
|
* @summary: List sales channel products
|
|
368
376
|
* @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/).
|
|
369
377
|
*/
|
|
370
|
-
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
378
|
+
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponseSchema>;
|
|
371
379
|
/**
|
|
372
380
|
* @param {Object} arg - Arg object.
|
|
373
381
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -384,7 +392,7 @@ declare class Catalog {
|
|
|
384
392
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
385
393
|
* page. Default is 10.
|
|
386
394
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
387
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
395
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponseSchema>}
|
|
388
396
|
* @summary: List sales channel products
|
|
389
397
|
* @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
|
|
390
398
|
*/
|
|
@@ -398,75 +406,20 @@ declare class Catalog {
|
|
|
398
406
|
itemIds?: number[];
|
|
399
407
|
pageSize?: number;
|
|
400
408
|
q?: string;
|
|
401
|
-
}): Paginator<CatalogPlatformModel.
|
|
409
|
+
}): Paginator<CatalogPlatformModel.RawProductListingResponseSchema>;
|
|
402
410
|
/**
|
|
403
411
|
* @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
|
|
404
412
|
* - Arg object
|
|
405
413
|
*
|
|
406
414
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
407
415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
408
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
416
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>} -
|
|
417
|
+
* Success response
|
|
409
418
|
* @name getAppReturnConfiguration
|
|
410
419
|
* @summary: get product-return configuration
|
|
411
420
|
* @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/).
|
|
412
421
|
*/
|
|
413
|
-
getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
414
|
-
/**
|
|
415
|
-
* @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
|
|
416
|
-
* - Arg object
|
|
417
|
-
*
|
|
418
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
419
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
420
|
-
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
421
|
-
* - Success response
|
|
422
|
-
*
|
|
423
|
-
* @name getAppicationProducts
|
|
424
|
-
* @summary: List sales channel products
|
|
425
|
-
* @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/).
|
|
426
|
-
*/
|
|
427
|
-
getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
428
|
-
/**
|
|
429
|
-
* @param {Object} arg - Arg object.
|
|
430
|
-
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
431
|
-
* a particular seller account.
|
|
432
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
433
|
-
* identifier for a particular sale channel.
|
|
434
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
435
|
-
* complete name of a either a product, brand or category
|
|
436
|
-
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
437
|
-
* filtered from filter parameters will be passed in **f** parameter in
|
|
438
|
-
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
439
|
-
* @param {string} [arg.c] - The search filter parameters for collection
|
|
440
|
-
* items. All the parameter filtered from filter parameters will be passed
|
|
441
|
-
* in **c** parameter in this format.
|
|
442
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
443
|
-
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
444
|
-
* filter details. This flag is used to fetch all filters
|
|
445
|
-
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
446
|
-
* the dependent products in the listing.
|
|
447
|
-
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
448
|
-
* The supported sort parameters are popularity, price, redemption and
|
|
449
|
-
* discount in either ascending or descending order. See the supported
|
|
450
|
-
* values below.
|
|
451
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
452
|
-
* page. Default is 12.
|
|
453
|
-
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
454
|
-
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
455
|
-
* @summary: List sales channel products
|
|
456
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
457
|
-
*/
|
|
458
|
-
getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
|
|
459
|
-
companyId: string;
|
|
460
|
-
applicationId: string;
|
|
461
|
-
q?: string;
|
|
462
|
-
f?: string;
|
|
463
|
-
c?: string;
|
|
464
|
-
filters?: boolean;
|
|
465
|
-
isDependent?: boolean;
|
|
466
|
-
sortOn?: string;
|
|
467
|
-
pageSize?: number;
|
|
468
|
-
itemIds?: number[];
|
|
469
|
-
}): Paginator<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
422
|
+
getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>;
|
|
470
423
|
/**
|
|
471
424
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
472
425
|
* - Arg object
|
|
@@ -488,8 +441,8 @@ declare class Catalog {
|
|
|
488
441
|
* identifier for a particular sale channel.
|
|
489
442
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
490
443
|
* page. Default is 12.
|
|
491
|
-
* @param {string} [arg.q] - Search query with brand name.
|
|
492
|
-
*
|
|
444
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
445
|
+
* to search brands by brand name.
|
|
493
446
|
* @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
|
|
494
447
|
* @summary: List sales channel brands
|
|
495
448
|
* @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
|
|
@@ -506,12 +459,13 @@ declare class Catalog {
|
|
|
506
459
|
*
|
|
507
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
508
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
509
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
462
|
+
* @returns {Promise<CatalogPlatformModel.BrandListingResponseSchema>} -
|
|
463
|
+
* Success response
|
|
510
464
|
* @name getApplicationBrands
|
|
511
465
|
* @summary: List brands
|
|
512
|
-
* @description: List all the brands
|
|
466
|
+
* @description: List all the brands, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
513
467
|
*/
|
|
514
|
-
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
468
|
+
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponseSchema>;
|
|
515
469
|
/**
|
|
516
470
|
* @param {Object} arg - Arg object.
|
|
517
471
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -521,16 +475,16 @@ declare class Catalog {
|
|
|
521
475
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
522
476
|
* parameter to filter products by a particular department. See below the
|
|
523
477
|
* list of available departments. You can retrieve available departments
|
|
524
|
-
* from the
|
|
478
|
+
* from the **v1.0/departments/** API
|
|
525
479
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
526
480
|
* page. Default is 12.
|
|
527
|
-
* @param {string} [arg.q] - Search query with brand name.
|
|
528
|
-
*
|
|
481
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
482
|
+
* to search brands by brand name.
|
|
529
483
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
530
484
|
* basis of uid list.
|
|
531
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
485
|
+
* @returns {Paginator<CatalogPlatformModel.BrandListingResponseSchema>}
|
|
532
486
|
* @summary: List brands
|
|
533
|
-
* @description: List all the brands
|
|
487
|
+
* @description: List all the brands, and have search capabilities on brand uid, name etc
|
|
534
488
|
*/
|
|
535
489
|
getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
|
|
536
490
|
companyId: string;
|
|
@@ -539,7 +493,7 @@ declare class Catalog {
|
|
|
539
493
|
pageSize?: number;
|
|
540
494
|
q?: string;
|
|
541
495
|
brandId?: number[];
|
|
542
|
-
}): Paginator<CatalogPlatformModel.
|
|
496
|
+
}): Paginator<CatalogPlatformModel.BrandListingResponseSchema>;
|
|
543
497
|
/**
|
|
544
498
|
* @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
|
|
545
499
|
* - Arg object
|
|
@@ -564,8 +518,8 @@ declare class Catalog {
|
|
|
564
518
|
* identifier for a particular department.
|
|
565
519
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
566
520
|
* page. Default is 12.
|
|
567
|
-
* @param {string} [arg.q] -
|
|
568
|
-
*
|
|
521
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
522
|
+
* to search brands by brand name.
|
|
569
523
|
* @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
|
|
570
524
|
* @summary: List sales channel categories
|
|
571
525
|
* @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
|
|
@@ -583,14 +537,14 @@ declare class Catalog {
|
|
|
583
537
|
*
|
|
584
538
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
585
539
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
586
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
540
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
587
541
|
* - Success response
|
|
588
542
|
*
|
|
589
543
|
* @name getApplicationDepartmentListing
|
|
590
544
|
* @summary: List sales channel departments
|
|
591
545
|
* @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
|
|
592
546
|
*/
|
|
593
|
-
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
547
|
+
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
|
|
594
548
|
/**
|
|
595
549
|
* @param {Object} arg - Arg object.
|
|
596
550
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -599,9 +553,9 @@ declare class Catalog {
|
|
|
599
553
|
* identifier for a particular sale channel.
|
|
600
554
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
601
555
|
* page. Default is 12.
|
|
602
|
-
* @param {string} [arg.q] -
|
|
603
|
-
*
|
|
604
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
556
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
557
|
+
* to search department by name.
|
|
558
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
|
|
605
559
|
* @summary: List sales channel departments
|
|
606
560
|
* @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
|
|
607
561
|
*/
|
|
@@ -610,60 +564,120 @@ declare class Catalog {
|
|
|
610
564
|
applicationId: string;
|
|
611
565
|
pageSize?: number;
|
|
612
566
|
q?: string;
|
|
613
|
-
}): Paginator<CatalogPlatformModel.
|
|
567
|
+
}): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
|
|
614
568
|
/**
|
|
615
569
|
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
616
570
|
* - Arg object
|
|
617
571
|
*
|
|
618
572
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
619
573
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
620
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
621
|
-
* Success response
|
|
574
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>}
|
|
575
|
+
* - Success response
|
|
576
|
+
*
|
|
622
577
|
* @name getApplicationFilterKeys
|
|
623
578
|
* @summary: List filter keys
|
|
624
579
|
* @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/).
|
|
625
580
|
*/
|
|
626
|
-
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
581
|
+
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>;
|
|
627
582
|
/**
|
|
628
583
|
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
|
|
629
584
|
* - Arg object
|
|
630
585
|
*
|
|
631
586
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
632
587
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
633
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
634
|
-
* Success response
|
|
588
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>}
|
|
589
|
+
* - Success response
|
|
590
|
+
*
|
|
635
591
|
* @name getApplicationFilterValues
|
|
636
592
|
* @summary: List product filters
|
|
637
593
|
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
638
594
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
|
|
639
595
|
*/
|
|
640
|
-
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
596
|
+
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>;
|
|
597
|
+
/**
|
|
598
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
|
|
599
|
+
* - Arg object
|
|
600
|
+
*
|
|
601
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
602
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
603
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
604
|
+
* - Success response
|
|
605
|
+
*
|
|
606
|
+
* @name getApplicationProducts
|
|
607
|
+
* @summary: List sales channel products
|
|
608
|
+
* @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/).
|
|
609
|
+
*/
|
|
610
|
+
getApplicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetApplicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
|
|
611
|
+
/**
|
|
612
|
+
* @param {Object} arg - Arg object.
|
|
613
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
614
|
+
* a particular seller account.
|
|
615
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
616
|
+
* identifier for a particular sale channel.
|
|
617
|
+
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
618
|
+
* complete name of a either a product, brand or category
|
|
619
|
+
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
620
|
+
* filtered from filter parameters will be passed in **f** parameter in
|
|
621
|
+
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
622
|
+
* @param {string} [arg.c] - The search filter parameters for collection
|
|
623
|
+
* items. All the parameter filtered from filter parameters will be passed
|
|
624
|
+
* in **c** parameter in this format.
|
|
625
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
626
|
+
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
627
|
+
* filter details. This flag is used to fetch all filters
|
|
628
|
+
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
629
|
+
* the dependent products in the listing.
|
|
630
|
+
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
631
|
+
* The supported sort parameters are popularity, price, redemption and
|
|
632
|
+
* discount in either ascending or descending order. See the supported
|
|
633
|
+
* values below.
|
|
634
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
635
|
+
* page. Default is 12.
|
|
636
|
+
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
637
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
638
|
+
* @summary: List sales channel products
|
|
639
|
+
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
640
|
+
*/
|
|
641
|
+
getApplicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
|
|
642
|
+
companyId: string;
|
|
643
|
+
applicationId: string;
|
|
644
|
+
q?: string;
|
|
645
|
+
f?: string;
|
|
646
|
+
c?: string;
|
|
647
|
+
filters?: boolean;
|
|
648
|
+
isDependent?: boolean;
|
|
649
|
+
sortOn?: string;
|
|
650
|
+
pageSize?: number;
|
|
651
|
+
itemIds?: number[];
|
|
652
|
+
}): Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
|
|
641
653
|
/**
|
|
642
654
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
643
655
|
* - Arg object
|
|
644
656
|
*
|
|
645
657
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
646
658
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
647
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
648
|
-
* Success response
|
|
659
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
660
|
+
* - Success response
|
|
661
|
+
*
|
|
649
662
|
* @name getAutocompleteConfig
|
|
650
663
|
* @summary: Get autocomplete configuration
|
|
651
664
|
* @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/).
|
|
652
665
|
*/
|
|
653
|
-
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
666
|
+
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
|
|
654
667
|
/**
|
|
655
668
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
|
|
656
669
|
* - Arg object
|
|
657
670
|
*
|
|
658
671
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
659
672
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
661
|
-
* Success response
|
|
673
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
674
|
+
* - Success response
|
|
675
|
+
*
|
|
662
676
|
* @name getAutocompleteKeywordDetail
|
|
663
677
|
* @summary: Get autocomplete keyword
|
|
664
678
|
* @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/).
|
|
665
679
|
*/
|
|
666
|
-
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
680
|
+
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
|
|
667
681
|
/**
|
|
668
682
|
* @param {CatalogPlatformApplicationValidator.GetCatalogConfigurationParam} arg
|
|
669
683
|
* - Arg object
|
|
@@ -684,48 +698,52 @@ declare class Catalog {
|
|
|
684
698
|
*
|
|
685
699
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
686
700
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
687
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
701
|
+
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponseSchema>} -
|
|
702
|
+
* Success response
|
|
688
703
|
* @name getCatalogInsights
|
|
689
704
|
* @summary: Get catalog counts
|
|
690
705
|
* @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/).
|
|
691
706
|
*/
|
|
692
|
-
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
707
|
+
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponseSchema>;
|
|
693
708
|
/**
|
|
694
709
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
695
710
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
696
711
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
697
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
712
|
+
* @returns {Promise<CatalogPlatformModel.CategoryListingResponseSchema>} -
|
|
713
|
+
* Success response
|
|
698
714
|
* @name getCategories
|
|
699
715
|
* @summary: List categories
|
|
700
716
|
* @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/).
|
|
701
717
|
*/
|
|
702
|
-
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
718
|
+
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponseSchema>;
|
|
703
719
|
/**
|
|
704
720
|
* @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
|
|
705
721
|
* - Arg object
|
|
706
722
|
*
|
|
707
723
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
708
724
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
709
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
710
|
-
* Success response
|
|
725
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>}
|
|
726
|
+
* - Success response
|
|
727
|
+
*
|
|
711
728
|
* @name getCollectionDetail
|
|
712
729
|
* @summary: Get a collection
|
|
713
730
|
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
714
731
|
*/
|
|
715
|
-
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
732
|
+
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>;
|
|
716
733
|
/**
|
|
717
734
|
* @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
|
|
718
735
|
* - Arg object
|
|
719
736
|
*
|
|
720
737
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
721
738
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
722
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
723
|
-
* Success response
|
|
739
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>}
|
|
740
|
+
* - Success response
|
|
741
|
+
*
|
|
724
742
|
* @name getCollectionItems
|
|
725
743
|
* @summary: List items of collection
|
|
726
744
|
* @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
|
|
727
745
|
*/
|
|
728
|
-
getCollectionItems({ id, sortOn, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
746
|
+
getCollectionItems({ id, sortOn, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>;
|
|
729
747
|
/**
|
|
730
748
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
|
|
731
749
|
* - Arg object
|
|
@@ -746,13 +764,14 @@ declare class Catalog {
|
|
|
746
764
|
*
|
|
747
765
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
748
766
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
749
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
750
|
-
* Success response
|
|
767
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>}
|
|
768
|
+
* - Success response
|
|
769
|
+
*
|
|
751
770
|
* @name getConfigurationMetadata
|
|
752
771
|
* @summary: Get configuration metadata
|
|
753
772
|
* @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/).
|
|
754
773
|
*/
|
|
755
|
-
getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
774
|
+
getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>;
|
|
756
775
|
/**
|
|
757
776
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
|
|
758
777
|
* - Arg object
|
|
@@ -770,12 +789,13 @@ declare class Catalog {
|
|
|
770
789
|
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
771
790
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
772
791
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
773
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
792
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentResponseSchema>} -
|
|
793
|
+
* Success response
|
|
774
794
|
* @name getDepartments
|
|
775
795
|
* @summary: List departments
|
|
776
796
|
* @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/).
|
|
777
797
|
*/
|
|
778
|
-
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
798
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponseSchema>;
|
|
779
799
|
/**
|
|
780
800
|
* @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
|
|
781
801
|
* - Arg object
|
|
@@ -821,24 +841,24 @@ declare class Catalog {
|
|
|
821
841
|
*
|
|
822
842
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
823
843
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
824
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
844
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
825
845
|
* @name getGroupConfigurations
|
|
826
846
|
* @summary: Get group configurations
|
|
827
847
|
* @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/).
|
|
828
848
|
*/
|
|
829
|
-
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
849
|
+
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
|
|
830
850
|
/**
|
|
831
851
|
* @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
|
|
832
852
|
* - Arg object
|
|
833
853
|
*
|
|
834
854
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
835
855
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
836
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
856
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
|
|
837
857
|
* @name getListingConfigurations
|
|
838
858
|
* @summary: Get listing configurations
|
|
839
859
|
* @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/).
|
|
840
860
|
*/
|
|
841
|
-
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
861
|
+
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
|
|
842
862
|
/**
|
|
843
863
|
* @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
|
|
844
864
|
* - Arg object
|
|
@@ -855,144 +875,148 @@ declare class Catalog {
|
|
|
855
875
|
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
856
876
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
857
877
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
858
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
878
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>} -
|
|
879
|
+
* Success response
|
|
859
880
|
* @name getQueryFilters
|
|
860
881
|
* @summary: Get collection query filters
|
|
861
882
|
* @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/).
|
|
862
883
|
*/
|
|
863
|
-
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
884
|
+
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>;
|
|
864
885
|
/**
|
|
865
886
|
* @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
|
|
866
887
|
* - Arg object
|
|
867
888
|
*
|
|
868
889
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
869
890
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
870
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
891
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>}
|
|
871
892
|
* - Success response
|
|
872
893
|
*
|
|
873
894
|
* @name getSearchConfiguration
|
|
874
895
|
* @summary: Get Search configuration
|
|
875
896
|
* @description: Get search configuration for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
|
|
876
897
|
*/
|
|
877
|
-
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
898
|
+
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>;
|
|
878
899
|
/**
|
|
879
900
|
* @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
|
|
880
901
|
* - Arg object
|
|
881
902
|
*
|
|
882
903
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
883
904
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
884
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
885
|
-
* Success response
|
|
905
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>}
|
|
906
|
+
* - Success response
|
|
907
|
+
*
|
|
886
908
|
* @name getSearchKeywords
|
|
887
909
|
* @summary: Get search keywords
|
|
888
910
|
* @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/).
|
|
889
911
|
*/
|
|
890
|
-
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
912
|
+
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>;
|
|
891
913
|
/**
|
|
892
914
|
* @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
|
|
893
915
|
* - Arg object
|
|
894
916
|
*
|
|
895
917
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
896
918
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
897
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
919
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
920
|
+
* Success response
|
|
898
921
|
* @name updateAllowSingle
|
|
899
922
|
* @summary: Update 'Allow Single' setting
|
|
900
923
|
* @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/).
|
|
901
924
|
*/
|
|
902
|
-
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
925
|
+
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
903
926
|
/**
|
|
904
927
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
905
928
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
906
929
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
907
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
930
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
908
931
|
* @name updateAppBrand
|
|
909
932
|
* @summary: Update sales channel brand
|
|
910
933
|
* @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
911
934
|
*/
|
|
912
|
-
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
935
|
+
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
913
936
|
/**
|
|
914
937
|
* @param {CatalogPlatformApplicationValidator.UpdateAppCategoryParam} arg
|
|
915
938
|
* - Arg object
|
|
916
939
|
*
|
|
917
940
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
918
941
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
919
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
942
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
920
943
|
* @name updateAppCategory
|
|
921
944
|
* @summary: Update sales channel category
|
|
922
945
|
* @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
923
946
|
*/
|
|
924
|
-
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
947
|
+
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
925
948
|
/**
|
|
926
949
|
* @param {CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam} arg
|
|
927
950
|
* - Arg object
|
|
928
951
|
*
|
|
929
952
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
930
953
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
931
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
954
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
932
955
|
* @name updateAppCategoryReturnConfiguration
|
|
933
956
|
* @summary: Update return Configuration
|
|
934
957
|
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
935
958
|
*/
|
|
936
|
-
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
959
|
+
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
937
960
|
/**
|
|
938
961
|
* @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
|
|
939
962
|
* - Arg object
|
|
940
963
|
*
|
|
941
964
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
942
965
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
943
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
966
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
944
967
|
* @name updateAppDepartment
|
|
945
968
|
* @summary: Update sales channel department
|
|
946
969
|
* @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
947
970
|
*/
|
|
948
|
-
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
971
|
+
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
949
972
|
/**
|
|
950
973
|
* @param {CatalogPlatformApplicationValidator.UpdateAppLocationParam} arg
|
|
951
974
|
* - Arg object
|
|
952
975
|
*
|
|
953
976
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
954
977
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
955
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
978
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
956
979
|
* @name updateAppLocation
|
|
957
980
|
* @summary: Update sales channel location
|
|
958
981
|
* @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
959
982
|
*/
|
|
960
|
-
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
983
|
+
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
961
984
|
/**
|
|
962
985
|
* @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
|
|
963
986
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
964
987
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
965
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
988
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
966
989
|
* @name updateAppProduct
|
|
967
990
|
* @summary: Update sales channel product
|
|
968
991
|
* @description: Allows to update data associated to a item by its item_id for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
969
992
|
*/
|
|
970
|
-
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
993
|
+
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
971
994
|
/**
|
|
972
995
|
* @param {CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam} arg
|
|
973
996
|
* - Arg object
|
|
974
997
|
*
|
|
975
998
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
976
999
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
977
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1000
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
978
1001
|
* @name updateAppReturnConfiguration
|
|
979
1002
|
* @summary: Update product return configuration
|
|
980
1003
|
* @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
|
|
981
1004
|
*/
|
|
982
|
-
updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1005
|
+
updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
983
1006
|
/**
|
|
984
1007
|
* @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
|
|
985
1008
|
* - Arg object
|
|
986
1009
|
*
|
|
987
1010
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
988
1011
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
989
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
990
|
-
* Success response
|
|
1012
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
|
|
1013
|
+
* - Success response
|
|
1014
|
+
*
|
|
991
1015
|
* @name updateAutocompleteKeyword
|
|
992
1016
|
* @summary: Update autocomplete keyword
|
|
993
1017
|
* @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/).
|
|
994
1018
|
*/
|
|
995
|
-
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1019
|
+
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
|
|
996
1020
|
/**
|
|
997
1021
|
* @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
|
|
998
1022
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1009,12 +1033,13 @@ declare class Catalog {
|
|
|
1009
1033
|
*
|
|
1010
1034
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1011
1035
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1012
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1036
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
|
|
1037
|
+
* Success response
|
|
1013
1038
|
* @name updateDefaultSort
|
|
1014
1039
|
* @summary: Update default sorting
|
|
1015
1040
|
* @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/).
|
|
1016
1041
|
*/
|
|
1017
|
-
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1042
|
+
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
|
|
1018
1043
|
/**
|
|
1019
1044
|
* @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
|
|
1020
1045
|
* - Arg object
|
|
@@ -1045,14 +1070,14 @@ declare class Catalog {
|
|
|
1045
1070
|
*
|
|
1046
1071
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1047
1072
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1048
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1073
|
+
* @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>}
|
|
1049
1074
|
* - Success response
|
|
1050
1075
|
*
|
|
1051
1076
|
* @name updateSearchConfiguration
|
|
1052
1077
|
* @summary: Update search configuration
|
|
1053
1078
|
* @description: Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
|
|
1054
1079
|
*/
|
|
1055
|
-
updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1080
|
+
updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>;
|
|
1056
1081
|
/**
|
|
1057
1082
|
* @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
|
|
1058
1083
|
* - Arg object
|