@gofynd/fdk-client-javascript 1.4.16-beta.2 → 1.4.16-beta.4
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 +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -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 +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- 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 +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- 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 +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -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 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- 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 +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -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 +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -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 +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- 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 +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- 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 +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- 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 +6 -810
- 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 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -45,14 +45,13 @@ declare class Catalog {
|
|
|
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,
|
|
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,61 +269,58 @@ 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
|
-
* @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
|
|
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
|
-
* @description: Retrieve all stores associated with
|
|
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
|
-
* @param {
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
* identifier for a particular sale channel.
|
|
321
|
+
* @param {string} arg.companyId - Id of the company whose locations are to fetched
|
|
322
|
+
* @param {string} arg.applicationId - Id of the application whose locations
|
|
323
|
+
* are to fetched
|
|
331
324
|
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
332
325
|
* basis of location type.
|
|
333
326
|
* @param {number[]} [arg.uid] - Helps to sort the location list on the
|
|
@@ -339,12 +332,12 @@ declare class Catalog {
|
|
|
339
332
|
* page. Default is 20.
|
|
340
333
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
341
334
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
342
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
335
|
+
* @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
|
|
343
336
|
* @summary: List sales channels
|
|
344
|
-
* @description: Retrieve all stores associated with
|
|
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)
|
|
345
338
|
*/
|
|
346
339
|
getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
|
|
347
|
-
companyId:
|
|
340
|
+
companyId: string;
|
|
348
341
|
applicationId: string;
|
|
349
342
|
storeType?: string;
|
|
350
343
|
uid?: number[];
|
|
@@ -353,33 +346,31 @@ declare class Catalog {
|
|
|
353
346
|
pageSize?: number;
|
|
354
347
|
tags?: string[];
|
|
355
348
|
storeTypes?: string[];
|
|
356
|
-
}): Paginator<CatalogPlatformModel.
|
|
349
|
+
}): Paginator<CatalogPlatformModel.LocationListSerializer>;
|
|
357
350
|
/**
|
|
358
351
|
* @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
|
|
359
352
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
360
353
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
361
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
362
|
-
* Success response
|
|
354
|
+
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
363
355
|
* @name getAppProduct
|
|
364
356
|
* @summary: Get sales channel product
|
|
365
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/).
|
|
366
358
|
*/
|
|
367
|
-
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
359
|
+
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
|
|
368
360
|
/**
|
|
369
361
|
* @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
|
|
370
362
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
371
363
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
372
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
373
|
-
*
|
|
374
|
-
*
|
|
364
|
+
* @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
|
|
365
|
+
* Success response
|
|
375
366
|
* @name getAppProducts
|
|
376
367
|
* @summary: List sales channel products
|
|
377
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/).
|
|
378
369
|
*/
|
|
379
|
-
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>;
|
|
380
371
|
/**
|
|
381
372
|
* @param {Object} arg - Arg object.
|
|
382
|
-
* @param {
|
|
373
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
383
374
|
* a particular seller account.
|
|
384
375
|
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
385
376
|
* identifier for a particular sale channel.
|
|
@@ -393,12 +384,12 @@ declare class Catalog {
|
|
|
393
384
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
394
385
|
* page. Default is 10.
|
|
395
386
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
396
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
387
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
|
|
397
388
|
* @summary: List sales channel products
|
|
398
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
|
|
399
390
|
*/
|
|
400
391
|
getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
|
|
401
|
-
companyId:
|
|
392
|
+
companyId: string;
|
|
402
393
|
applicationId: string;
|
|
403
394
|
brandIds?: number[];
|
|
404
395
|
categoryIds?: number[];
|
|
@@ -407,20 +398,75 @@ declare class Catalog {
|
|
|
407
398
|
itemIds?: number[];
|
|
408
399
|
pageSize?: number;
|
|
409
400
|
q?: string;
|
|
410
|
-
}): Paginator<CatalogPlatformModel.
|
|
401
|
+
}): Paginator<CatalogPlatformModel.RawProductListingResponse>;
|
|
411
402
|
/**
|
|
412
403
|
* @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
|
|
413
404
|
* - Arg object
|
|
414
405
|
*
|
|
415
406
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
416
407
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
417
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
418
|
-
* Success response
|
|
408
|
+
* @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
|
|
419
409
|
* @name getAppReturnConfiguration
|
|
420
|
-
* @summary:
|
|
410
|
+
* @summary: get product-return configuration
|
|
421
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/).
|
|
422
412
|
*/
|
|
423
|
-
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>;
|
|
424
470
|
/**
|
|
425
471
|
* @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
|
|
426
472
|
* - Arg object
|
|
@@ -460,13 +506,12 @@ declare class Catalog {
|
|
|
460
506
|
*
|
|
461
507
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
462
508
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
463
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
464
|
-
* Success response
|
|
509
|
+
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
465
510
|
* @name getApplicationBrands
|
|
466
511
|
* @summary: List brands
|
|
467
512
|
* @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
468
513
|
*/
|
|
469
|
-
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>;
|
|
470
515
|
/**
|
|
471
516
|
* @param {Object} arg - Arg object.
|
|
472
517
|
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
@@ -483,7 +528,7 @@ declare class Catalog {
|
|
|
483
528
|
* parameter to search brands by brand name.
|
|
484
529
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
485
530
|
* basis of uid list.
|
|
486
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
531
|
+
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
487
532
|
* @summary: List brands
|
|
488
533
|
* @description: List all the brands.
|
|
489
534
|
*/
|
|
@@ -494,7 +539,7 @@ declare class Catalog {
|
|
|
494
539
|
pageSize?: number;
|
|
495
540
|
q?: string;
|
|
496
541
|
brandId?: number[];
|
|
497
|
-
}): Paginator<CatalogPlatformModel.
|
|
542
|
+
}): Paginator<CatalogPlatformModel.BrandListingResponse>;
|
|
498
543
|
/**
|
|
499
544
|
* @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
|
|
500
545
|
* - Arg object
|
|
@@ -538,17 +583,17 @@ declare class Catalog {
|
|
|
538
583
|
*
|
|
539
584
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
540
585
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
541
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
586
|
+
* @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
542
587
|
* - Success response
|
|
543
588
|
*
|
|
544
589
|
* @name getApplicationDepartmentListing
|
|
545
590
|
* @summary: List sales channel departments
|
|
546
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/).
|
|
547
592
|
*/
|
|
548
|
-
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
593
|
+
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
549
594
|
/**
|
|
550
595
|
* @param {Object} arg - Arg object.
|
|
551
|
-
* @param {
|
|
596
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
552
597
|
* a particular seller account.
|
|
553
598
|
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
554
599
|
* identifier for a particular sale channel.
|
|
@@ -556,129 +601,69 @@ declare class Catalog {
|
|
|
556
601
|
* page. Default is 12.
|
|
557
602
|
* @param {string} [arg.q] - A search query string. Use this parameter to
|
|
558
603
|
* filter results based on a keyword or specific value.
|
|
559
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
604
|
+
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
560
605
|
* @summary: List sales channel departments
|
|
561
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
|
|
562
607
|
*/
|
|
563
608
|
getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
564
|
-
companyId:
|
|
609
|
+
companyId: string;
|
|
565
610
|
applicationId: string;
|
|
566
611
|
pageSize?: number;
|
|
567
612
|
q?: string;
|
|
568
|
-
}): Paginator<CatalogPlatformModel.
|
|
613
|
+
}): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
569
614
|
/**
|
|
570
615
|
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
571
616
|
* - Arg object
|
|
572
617
|
*
|
|
573
618
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
574
619
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
575
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
576
|
-
*
|
|
577
|
-
*
|
|
620
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
|
|
621
|
+
* Success response
|
|
578
622
|
* @name getApplicationFilterKeys
|
|
579
623
|
* @summary: List filter keys
|
|
580
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/).
|
|
581
625
|
*/
|
|
582
|
-
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
626
|
+
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>;
|
|
583
627
|
/**
|
|
584
628
|
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
|
|
585
629
|
* - Arg object
|
|
586
630
|
*
|
|
587
631
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
588
632
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
589
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
590
|
-
*
|
|
591
|
-
*
|
|
633
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
|
|
634
|
+
* Success response
|
|
592
635
|
* @name getApplicationFilterValues
|
|
593
636
|
* @summary: List product filters
|
|
594
637
|
* @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
|
|
595
638
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
|
|
596
639
|
*/
|
|
597
|
-
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
598
|
-
/**
|
|
599
|
-
* @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
|
|
600
|
-
* - Arg object
|
|
601
|
-
*
|
|
602
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
603
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
|
-
* @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
605
|
-
* - Success response
|
|
606
|
-
*
|
|
607
|
-
* @name getApplicationProducts
|
|
608
|
-
* @summary: List sales channel products
|
|
609
|
-
* @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/).
|
|
610
|
-
*/
|
|
611
|
-
getApplicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetApplicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
|
|
612
|
-
/**
|
|
613
|
-
* @param {Object} arg - Arg object.
|
|
614
|
-
* @param {number} arg.companyId - A `company_id` is a unique identifier for
|
|
615
|
-
* a particular seller account.
|
|
616
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
617
|
-
* identifier for a particular sale channel.
|
|
618
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
619
|
-
* complete name of a either a product, brand or category
|
|
620
|
-
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
621
|
-
* filtered from filter parameters will be passed in **f** parameter in
|
|
622
|
-
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
623
|
-
* @param {string} [arg.c] - The search filter parameters for collection
|
|
624
|
-
* items. All the parameter filtered from filter parameters will be passed
|
|
625
|
-
* in **c** parameter in this format.
|
|
626
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
627
|
-
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
628
|
-
* filter details. This flag is used to fetch all filters
|
|
629
|
-
* @param {boolean} [arg.isDependent] - This query parameter is used to get
|
|
630
|
-
* the dependent products in the listing.
|
|
631
|
-
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
632
|
-
* The supported sort parameters are popularity, price, redemption and
|
|
633
|
-
* discount in either ascending or descending order. See the supported
|
|
634
|
-
* values below.
|
|
635
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
636
|
-
* page. Default is 12.
|
|
637
|
-
* @param {string[]} [arg.itemIds] - Item Ids of product
|
|
638
|
-
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
|
|
639
|
-
* @summary: List sales channel products
|
|
640
|
-
* @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
|
|
641
|
-
*/
|
|
642
|
-
getApplicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
|
|
643
|
-
companyId: number;
|
|
644
|
-
applicationId: string;
|
|
645
|
-
q?: string;
|
|
646
|
-
f?: string;
|
|
647
|
-
c?: string;
|
|
648
|
-
filters?: boolean;
|
|
649
|
-
isDependent?: boolean;
|
|
650
|
-
sortOn?: string;
|
|
651
|
-
pageSize?: number;
|
|
652
|
-
itemIds?: string[];
|
|
653
|
-
}): Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
|
|
640
|
+
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>;
|
|
654
641
|
/**
|
|
655
642
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
656
643
|
* - Arg object
|
|
657
644
|
*
|
|
658
645
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
659
646
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
661
|
-
*
|
|
662
|
-
*
|
|
647
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
648
|
+
* Success response
|
|
663
649
|
* @name getAutocompleteConfig
|
|
664
650
|
* @summary: Get autocomplete configuration
|
|
665
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/).
|
|
666
652
|
*/
|
|
667
|
-
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
653
|
+
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
668
654
|
/**
|
|
669
655
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
|
|
670
656
|
* - Arg object
|
|
671
657
|
*
|
|
672
658
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
673
659
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
674
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
675
|
-
*
|
|
676
|
-
*
|
|
660
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
661
|
+
* Success response
|
|
677
662
|
* @name getAutocompleteKeywordDetail
|
|
678
663
|
* @summary: Get autocomplete keyword
|
|
679
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/).
|
|
680
665
|
*/
|
|
681
|
-
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
666
|
+
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
682
667
|
/**
|
|
683
668
|
* @param {CatalogPlatformApplicationValidator.GetCatalogConfigurationParam} arg
|
|
684
669
|
* - Arg object
|
|
@@ -699,52 +684,48 @@ declare class Catalog {
|
|
|
699
684
|
*
|
|
700
685
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
701
686
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
702
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
703
|
-
* Success response
|
|
687
|
+
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
704
688
|
* @name getCatalogInsights
|
|
705
689
|
* @summary: Get catalog counts
|
|
706
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/).
|
|
707
691
|
*/
|
|
708
|
-
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
692
|
+
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
|
|
709
693
|
/**
|
|
710
694
|
* @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
|
|
711
695
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
712
696
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
713
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
714
|
-
* Success response
|
|
697
|
+
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
715
698
|
* @name getCategories
|
|
716
699
|
* @summary: List categories
|
|
717
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/).
|
|
718
701
|
*/
|
|
719
|
-
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
702
|
+
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
|
|
720
703
|
/**
|
|
721
704
|
* @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
|
|
722
705
|
* - Arg object
|
|
723
706
|
*
|
|
724
707
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
725
708
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
726
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
727
|
-
*
|
|
728
|
-
*
|
|
709
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
|
|
710
|
+
* Success response
|
|
729
711
|
* @name getCollectionDetail
|
|
730
712
|
* @summary: Get a collection
|
|
731
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/).
|
|
732
714
|
*/
|
|
733
|
-
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
715
|
+
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
|
|
734
716
|
/**
|
|
735
717
|
* @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
|
|
736
718
|
* - Arg object
|
|
737
719
|
*
|
|
738
720
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
739
721
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
740
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
741
|
-
*
|
|
742
|
-
*
|
|
722
|
+
* @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponse>} -
|
|
723
|
+
* Success response
|
|
743
724
|
* @name getCollectionItems
|
|
744
725
|
* @summary: List items of collection
|
|
745
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/).
|
|
746
727
|
*/
|
|
747
|
-
getCollectionItems({ id, sortOn, pageId, pageSize,
|
|
728
|
+
getCollectionItems({ id, sortOn, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponse>;
|
|
748
729
|
/**
|
|
749
730
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
|
|
750
731
|
* - Arg object
|
|
@@ -765,14 +746,13 @@ declare class Catalog {
|
|
|
765
746
|
*
|
|
766
747
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
767
748
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
768
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
769
|
-
*
|
|
770
|
-
*
|
|
749
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
750
|
+
* Success response
|
|
771
751
|
* @name getConfigurationMetadata
|
|
772
752
|
* @summary: Get configuration metadata
|
|
773
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/).
|
|
774
754
|
*/
|
|
775
|
-
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>;
|
|
776
756
|
/**
|
|
777
757
|
* @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
|
|
778
758
|
* - Arg object
|
|
@@ -790,76 +770,75 @@ declare class Catalog {
|
|
|
790
770
|
* @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
|
|
791
771
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
792
772
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
793
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
794
|
-
* Success response
|
|
773
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
795
774
|
* @name getDepartments
|
|
796
775
|
* @summary: List departments
|
|
797
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/).
|
|
798
777
|
*/
|
|
799
|
-
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
778
|
+
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
|
|
800
779
|
/**
|
|
801
780
|
* @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
|
|
802
781
|
* - Arg object
|
|
803
782
|
*
|
|
804
783
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
805
784
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
806
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
785
|
+
* @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
807
786
|
* - Success response
|
|
808
787
|
*
|
|
809
788
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
810
789
|
* @summary: Get discounted inventory
|
|
811
790
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDiscountedInventoryBySizeIdentifier/).
|
|
812
791
|
*/
|
|
813
|
-
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
792
|
+
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
814
793
|
/**
|
|
815
794
|
* @param {Object} arg - Arg object.
|
|
816
|
-
* @param {number} arg.companyId -
|
|
817
|
-
*
|
|
818
|
-
* @param {string} arg.applicationId -
|
|
819
|
-
*
|
|
820
|
-
* @param {
|
|
821
|
-
*
|
|
822
|
-
* @param {number} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
823
|
-
* or Primary Identifier).
|
|
795
|
+
* @param {number} arg.companyId - Id of the company associated to product
|
|
796
|
+
* that is to be viewed.
|
|
797
|
+
* @param {string} arg.applicationId - Uniquer Application ID.
|
|
798
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
799
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
800
|
+
* or Primary Identifier) of which inventory is to get.
|
|
824
801
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
825
802
|
* page. Default is 12.
|
|
803
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
826
804
|
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
827
|
-
* @returns {Paginator<CatalogPlatformModel.
|
|
805
|
+
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
828
806
|
* @summary: Get discounted inventory
|
|
829
807
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
830
808
|
*/
|
|
831
|
-
getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, locationIds, }?: {
|
|
809
|
+
getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
|
|
832
810
|
companyId: number;
|
|
833
811
|
applicationId: string;
|
|
834
812
|
itemId: number;
|
|
835
|
-
sizeIdentifier:
|
|
813
|
+
sizeIdentifier: string;
|
|
836
814
|
pageSize?: number;
|
|
815
|
+
q?: string;
|
|
837
816
|
locationIds?: number[];
|
|
838
|
-
}): Paginator<CatalogPlatformModel.
|
|
817
|
+
}): Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
839
818
|
/**
|
|
840
819
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
841
820
|
* - Arg object
|
|
842
821
|
*
|
|
843
822
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
844
823
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
845
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
824
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
846
825
|
* @name getGroupConfigurations
|
|
847
826
|
* @summary: Get group configurations
|
|
848
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/).
|
|
849
828
|
*/
|
|
850
|
-
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>;
|
|
851
830
|
/**
|
|
852
831
|
* @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
|
|
853
832
|
* - Arg object
|
|
854
833
|
*
|
|
855
834
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
856
835
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
857
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
836
|
+
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
858
837
|
* @name getListingConfigurations
|
|
859
838
|
* @summary: Get listing configurations
|
|
860
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/).
|
|
861
840
|
*/
|
|
862
|
-
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>;
|
|
863
842
|
/**
|
|
864
843
|
* @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
|
|
865
844
|
* - Arg object
|
|
@@ -876,54 +855,51 @@ declare class Catalog {
|
|
|
876
855
|
* @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
|
|
877
856
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
878
857
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
879
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
880
|
-
* Success response
|
|
858
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
|
|
881
859
|
* @name getQueryFilters
|
|
882
860
|
* @summary: Get collection query filters
|
|
883
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/).
|
|
884
862
|
*/
|
|
885
|
-
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
863
|
+
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
|
|
886
864
|
/**
|
|
887
865
|
* @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
|
|
888
866
|
* - Arg object
|
|
889
867
|
*
|
|
890
868
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
891
869
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
892
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
870
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponse>}
|
|
893
871
|
* - Success response
|
|
894
872
|
*
|
|
895
873
|
* @name getSearchConfiguration
|
|
896
874
|
* @summary: Get Search configuration
|
|
897
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/).
|
|
898
876
|
*/
|
|
899
|
-
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
877
|
+
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponse>;
|
|
900
878
|
/**
|
|
901
879
|
* @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
|
|
902
880
|
* - Arg object
|
|
903
881
|
*
|
|
904
882
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
905
883
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
906
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
907
|
-
*
|
|
908
|
-
*
|
|
884
|
+
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
885
|
+
* Success response
|
|
909
886
|
* @name getSearchKeywords
|
|
910
887
|
* @summary: Get search keywords
|
|
911
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/).
|
|
912
889
|
*/
|
|
913
|
-
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
890
|
+
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>;
|
|
914
891
|
/**
|
|
915
892
|
* @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
|
|
916
893
|
* - Arg object
|
|
917
894
|
*
|
|
918
895
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
919
896
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
920
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
921
|
-
* Success response
|
|
897
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
922
898
|
* @name updateAllowSingle
|
|
923
899
|
* @summary: Update 'Allow Single' setting
|
|
924
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/).
|
|
925
901
|
*/
|
|
926
|
-
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
902
|
+
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
927
903
|
/**
|
|
928
904
|
* @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
|
|
929
905
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -952,12 +928,12 @@ declare class Catalog {
|
|
|
952
928
|
*
|
|
953
929
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
954
930
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
955
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
931
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
956
932
|
* @name updateAppCategoryReturnConfiguration
|
|
957
933
|
* @summary: Update return Configuration
|
|
958
934
|
* @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
|
|
959
935
|
*/
|
|
960
|
-
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
936
|
+
updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
961
937
|
/**
|
|
962
938
|
* @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
|
|
963
939
|
* - Arg object
|
|
@@ -989,7 +965,7 @@ declare class Catalog {
|
|
|
989
965
|
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
990
966
|
* @name updateAppProduct
|
|
991
967
|
* @summary: Update sales channel product
|
|
992
|
-
* @description: Allows to update data associated to a item by its item_id for
|
|
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/).
|
|
993
969
|
*/
|
|
994
970
|
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
995
971
|
/**
|
|
@@ -1010,14 +986,13 @@ declare class Catalog {
|
|
|
1010
986
|
*
|
|
1011
987
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1012
988
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1013
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1014
|
-
*
|
|
1015
|
-
*
|
|
989
|
+
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
990
|
+
* Success response
|
|
1016
991
|
* @name updateAutocompleteKeyword
|
|
1017
992
|
* @summary: Update autocomplete keyword
|
|
1018
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/).
|
|
1019
994
|
*/
|
|
1020
|
-
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
995
|
+
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
1021
996
|
/**
|
|
1022
997
|
* @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
|
|
1023
998
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1034,13 +1009,12 @@ declare class Catalog {
|
|
|
1034
1009
|
*
|
|
1035
1010
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1036
1011
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1037
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1038
|
-
* Success response
|
|
1012
|
+
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1039
1013
|
* @name updateDefaultSort
|
|
1040
1014
|
* @summary: Update default sorting
|
|
1041
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/).
|
|
1042
1016
|
*/
|
|
1043
|
-
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1017
|
+
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
1044
1018
|
/**
|
|
1045
1019
|
* @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
|
|
1046
1020
|
* - Arg object
|
|
@@ -1071,14 +1045,14 @@ declare class Catalog {
|
|
|
1071
1045
|
*
|
|
1072
1046
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1073
1047
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1074
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1048
|
+
* @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>}
|
|
1075
1049
|
* - Success response
|
|
1076
1050
|
*
|
|
1077
1051
|
* @name updateSearchConfiguration
|
|
1078
1052
|
* @summary: Update search configuration
|
|
1079
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/).
|
|
1080
1054
|
*/
|
|
1081
|
-
updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1055
|
+
updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>;
|
|
1082
1056
|
/**
|
|
1083
1057
|
* @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
|
|
1084
1058
|
* - Arg object
|