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