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