@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-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/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +29 -1
- package/sdk/application/Order/OrderApplicationModel.js +34 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +524 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +335 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +66 -66
- package/sdk/application/User/UserApplicationClient.js +68 -71
- package/sdk/application/User/UserApplicationModel.d.ts +32 -27
- package/sdk/application/User/UserApplicationModel.js +22 -32
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +221 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +460 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +72 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +46 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +38 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +47 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
- package/sdk/platform/Content/ContentPlatformModel.js +20 -0
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +23 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -48
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +12 -48
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +15 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +42 -1
- package/sdk/platform/Order/OrderPlatformModel.js +44 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +10 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +11 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.js +29 -16
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +81 -11
- package/sdk/platform/User/UserPlatformModel.js +80 -10
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -9,12 +9,14 @@ declare class Catalog {
|
|
|
9
9
|
*
|
|
10
10
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
12
|
+
* @returns {Promise<CatalogPlatformModel.CommonResponseSchemaCollection>}
|
|
13
|
+
* - Success response
|
|
14
|
+
*
|
|
13
15
|
* @name addCollectionItems
|
|
14
16
|
* @summary: Add items to a collection
|
|
15
17
|
* @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
|
|
16
18
|
*/
|
|
17
|
-
addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
19
|
+
addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
|
|
18
20
|
/**
|
|
19
21
|
* @param {CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam} arg
|
|
20
22
|
* - Arg object
|
|
@@ -47,7 +49,7 @@ declare class Catalog {
|
|
|
47
49
|
* Success response
|
|
48
50
|
* @name createCollection
|
|
49
51
|
* @summary: Add a Collection
|
|
50
|
-
* @description: Create a collection
|
|
52
|
+
* @description: Create a collection to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
|
|
51
53
|
*/
|
|
52
54
|
createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponse>;
|
|
53
55
|
/**
|
|
@@ -59,7 +61,7 @@ declare class Catalog {
|
|
|
59
61
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
60
62
|
* Success response
|
|
61
63
|
* @name createConfigurationByType
|
|
62
|
-
* @summary:
|
|
64
|
+
* @summary: Create configuration by type.
|
|
63
65
|
* @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
|
|
64
66
|
*/
|
|
65
67
|
createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
@@ -72,7 +74,7 @@ declare class Catalog {
|
|
|
72
74
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
73
75
|
* Success response
|
|
74
76
|
* @name createConfigurationProductListing
|
|
75
|
-
* @summary:
|
|
77
|
+
* @summary: Create configuration for product listing.
|
|
76
78
|
* @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
|
|
77
79
|
*/
|
|
78
80
|
createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
@@ -86,8 +88,8 @@ declare class Catalog {
|
|
|
86
88
|
* - Success response
|
|
87
89
|
*
|
|
88
90
|
* @name createCustomAutocompleteRule
|
|
89
|
-
* @summary:
|
|
90
|
-
* @description:
|
|
91
|
+
* @summary: Create custom autocomplete rules.
|
|
92
|
+
* @description: Generate and add custom autocomplete rules to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
|
|
91
93
|
*/
|
|
92
94
|
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
|
|
93
95
|
/**
|
|
@@ -98,8 +100,8 @@ declare class Catalog {
|
|
|
98
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
101
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
100
102
|
* @name createCustomKeyword
|
|
101
|
-
* @summary:
|
|
102
|
-
* @description: Create a Custom Search Keywords.
|
|
103
|
+
* @summary: Create custom search keywords.
|
|
104
|
+
* @description: Create a Custom Search Keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
|
|
103
105
|
*/
|
|
104
106
|
createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|
|
105
107
|
/**
|
|
@@ -110,8 +112,8 @@ declare class Catalog {
|
|
|
110
112
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
111
113
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
112
114
|
* @name createGroupConfiguration
|
|
113
|
-
* @summary: Create configuration
|
|
114
|
-
* @description: Create configuration for
|
|
115
|
+
* @summary: Create group configuration.
|
|
116
|
+
* @description: Create configuration for group configuration types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
|
|
115
117
|
*/
|
|
116
118
|
createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
117
119
|
/**
|
|
@@ -122,8 +124,8 @@ declare class Catalog {
|
|
|
122
124
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
125
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
124
126
|
* @name createListingConfiguration
|
|
125
|
-
* @summary:
|
|
126
|
-
* @description: Add configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
127
|
+
* @summary: Create listing configuration.
|
|
128
|
+
* @description: Add configuration for catalog listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
127
129
|
*/
|
|
128
130
|
createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
129
131
|
/**
|
|
@@ -136,8 +138,8 @@ declare class Catalog {
|
|
|
136
138
|
* - Success response
|
|
137
139
|
*
|
|
138
140
|
* @name createSearchConfiguration
|
|
139
|
-
* @summary:
|
|
140
|
-
* @description:
|
|
141
|
+
* @summary: Create search configuration
|
|
142
|
+
* @description: Create search configuration for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
|
|
141
143
|
*/
|
|
142
144
|
createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>;
|
|
143
145
|
/**
|
|
@@ -160,7 +162,7 @@ declare class Catalog {
|
|
|
160
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
161
163
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
162
164
|
* @name deleteAutocompleteKeyword
|
|
163
|
-
* @summary: Delete
|
|
165
|
+
* @summary: Delete autocomplete keywords.
|
|
164
166
|
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
|
|
165
167
|
*/
|
|
166
168
|
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
@@ -172,7 +174,7 @@ declare class Catalog {
|
|
|
172
174
|
* - Success response
|
|
173
175
|
*
|
|
174
176
|
* @name deleteCollection
|
|
175
|
-
* @summary: Delete a
|
|
177
|
+
* @summary: Delete a collection.
|
|
176
178
|
* @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteCollection/).
|
|
177
179
|
*/
|
|
178
180
|
deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
|
|
@@ -184,7 +186,7 @@ declare class Catalog {
|
|
|
184
186
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
187
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
186
188
|
* @name deleteGroupConfiguration
|
|
187
|
-
* @summary: Delete configuration
|
|
189
|
+
* @summary: Delete group configuration.
|
|
188
190
|
* @description: Delete configuration of the product config type of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
|
|
189
191
|
*/
|
|
190
192
|
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
@@ -196,8 +198,8 @@ declare class Catalog {
|
|
|
196
198
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
197
199
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
198
200
|
* @name deleteListingConfiguration
|
|
199
|
-
* @summary: Delete configuration
|
|
200
|
-
* @description:
|
|
201
|
+
* @summary: Delete listing configuration.
|
|
202
|
+
* @description: Remove a specific listing configuration from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
201
203
|
*/
|
|
202
204
|
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
203
205
|
/**
|
|
@@ -210,8 +212,8 @@ declare class Catalog {
|
|
|
210
212
|
* - Success response
|
|
211
213
|
*
|
|
212
214
|
* @name deleteSearchConfiguration
|
|
213
|
-
* @summary: Delete
|
|
214
|
-
* @description:
|
|
215
|
+
* @summary: Delete Search Configuration
|
|
216
|
+
* @description: Delete search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
|
|
215
217
|
*/
|
|
216
218
|
deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>;
|
|
217
219
|
/**
|
|
@@ -222,7 +224,7 @@ declare class Catalog {
|
|
|
222
224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
223
225
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
224
226
|
* @name deleteSearchKeywords
|
|
225
|
-
* @summary: Delete
|
|
227
|
+
* @summary: Delete search keywords.
|
|
226
228
|
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
|
|
227
229
|
*/
|
|
228
230
|
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
@@ -235,10 +237,39 @@ declare class Catalog {
|
|
|
235
237
|
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
|
|
236
238
|
* Success response
|
|
237
239
|
* @name getAllCollections
|
|
238
|
-
* @summary:
|
|
239
|
-
* @description: A Collection allows you to organize your products into hierarchical groups.
|
|
240
|
+
* @summary: Retrieve all collections.
|
|
241
|
+
* @description: A Collection allows you to organize your products into hierarchical groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
|
|
240
242
|
*/
|
|
241
243
|
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
|
|
244
|
+
/**
|
|
245
|
+
* @param {Object} arg - Arg object.
|
|
246
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
247
|
+
* a particular seller account.
|
|
248
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
249
|
+
* identifier for a particular sale channel.
|
|
250
|
+
* @param {string} [arg.q] - Get collection list filtered by q string,
|
|
251
|
+
* @param {string} [arg.scheduleStatus] - Get collection list filtered by
|
|
252
|
+
* scheduled status,
|
|
253
|
+
* @param {string} [arg.type] - Type of the collections
|
|
254
|
+
* @param {string[]} [arg.tags] - Each response will contain next_id param,
|
|
255
|
+
* which should be sent back to make pagination work.
|
|
256
|
+
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
257
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
258
|
+
* page. Default is 12.
|
|
259
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponse>}
|
|
260
|
+
* @summary: Retrieve all collections.
|
|
261
|
+
* @description: A Collection allows you to organize your products into hierarchical groups.
|
|
262
|
+
*/
|
|
263
|
+
getAllCollectionsPaginator({ companyId, applicationId, q, scheduleStatus, type, tags, isActive, pageSize, }?: {
|
|
264
|
+
companyId: string;
|
|
265
|
+
applicationId: string;
|
|
266
|
+
q?: string;
|
|
267
|
+
scheduleStatus?: string;
|
|
268
|
+
type?: string;
|
|
269
|
+
tags?: string[];
|
|
270
|
+
isActive?: boolean;
|
|
271
|
+
pageSize?: number;
|
|
272
|
+
}): Paginator<CatalogPlatformModel.GetCollectionListingResponse>;
|
|
242
273
|
/**
|
|
243
274
|
* @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
|
|
244
275
|
* - Arg object
|
|
@@ -247,7 +278,7 @@ declare class Catalog {
|
|
|
247
278
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
248
279
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
|
|
249
280
|
* @name getAllSearchKeyword
|
|
250
|
-
* @summary:
|
|
281
|
+
* @summary: Get all search keywords.
|
|
251
282
|
* @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
|
|
252
283
|
*/
|
|
253
284
|
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
|
|
@@ -271,8 +302,8 @@ declare class Catalog {
|
|
|
271
302
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
272
303
|
* @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
|
|
273
304
|
* @name getAppInventory
|
|
274
|
-
* @summary: Get
|
|
275
|
-
* @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id
|
|
305
|
+
* @summary: Get application inventory.
|
|
306
|
+
* @description: Retrieve inventory data related to the application. Retrieve the available Inventory of the products. Use this API 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/).
|
|
276
307
|
*/
|
|
277
308
|
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
|
|
278
309
|
/**
|
|
@@ -281,8 +312,8 @@ declare class Catalog {
|
|
|
281
312
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
282
313
|
* @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
|
|
283
314
|
* @name getAppLocations
|
|
284
|
-
* @summary: Get
|
|
285
|
-
* @description:
|
|
315
|
+
* @summary: Get application locations.
|
|
316
|
+
* @description: Retrieve locations specific to the application. View all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
|
|
286
317
|
*/
|
|
287
318
|
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
|
|
288
319
|
/**
|
|
@@ -302,8 +333,8 @@ declare class Catalog {
|
|
|
302
333
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
303
334
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
304
335
|
* @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
|
|
305
|
-
* @summary: Get
|
|
306
|
-
* @description:
|
|
336
|
+
* @summary: Get application locations.
|
|
337
|
+
* @description: Retrieve locations specific to the application. View all the locations asscoiated to a application.
|
|
307
338
|
*/
|
|
308
339
|
getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
|
|
309
340
|
companyId: string;
|
|
@@ -322,7 +353,7 @@ declare class Catalog {
|
|
|
322
353
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
323
354
|
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
324
355
|
* @name getAppProduct
|
|
325
|
-
* @summary:
|
|
356
|
+
* @summary: Retrieve application product data.
|
|
326
357
|
* @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
|
|
327
358
|
*/
|
|
328
359
|
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
|
|
@@ -333,10 +364,41 @@ declare class Catalog {
|
|
|
333
364
|
* @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
|
|
334
365
|
* Success response
|
|
335
366
|
* @name getAppProducts
|
|
336
|
-
* @summary: Get
|
|
337
|
-
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
|
|
367
|
+
* @summary: Get application products.
|
|
368
|
+
* @description: Retrieve products specific to the application. Products are the core resource of an application. Products can be associated by categories, collections, brands and more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
|
|
338
369
|
*/
|
|
339
370
|
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponse>;
|
|
371
|
+
/**
|
|
372
|
+
* @param {Object} arg - Arg object.
|
|
373
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
374
|
+
* a particular seller account.
|
|
375
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
376
|
+
* identifier for a particular sale channel.
|
|
377
|
+
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
378
|
+
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
379
|
+
* Category Ids
|
|
380
|
+
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
381
|
+
* Department Ids
|
|
382
|
+
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
383
|
+
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
384
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
385
|
+
* page. Default is 10.
|
|
386
|
+
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
387
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
|
|
388
|
+
* @summary: Get application products.
|
|
389
|
+
* @description: Retrieve products specific to the application. Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
|
|
390
|
+
*/
|
|
391
|
+
getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
|
|
392
|
+
companyId: string;
|
|
393
|
+
applicationId: string;
|
|
394
|
+
brandIds?: number[];
|
|
395
|
+
categoryIds?: number[];
|
|
396
|
+
departmentIds?: number[];
|
|
397
|
+
tags?: string[];
|
|
398
|
+
itemIds?: number[];
|
|
399
|
+
pageSize?: number;
|
|
400
|
+
q?: string;
|
|
401
|
+
}): Paginator<CatalogPlatformModel.RawProductListingResponse>;
|
|
340
402
|
/**
|
|
341
403
|
* @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
|
|
342
404
|
* - Arg object
|
|
@@ -359,8 +421,8 @@ declare class Catalog {
|
|
|
359
421
|
* - Success response
|
|
360
422
|
*
|
|
361
423
|
* @name getAppicationProducts
|
|
362
|
-
* @summary:
|
|
363
|
-
* @description: List all the products associated with a brand, collection or category in a requested sort order.
|
|
424
|
+
* @summary: Get application products.
|
|
425
|
+
* @description: Retrieve products associated with the application. 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/).
|
|
364
426
|
*/
|
|
365
427
|
getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
366
428
|
/**
|
|
@@ -390,8 +452,8 @@ declare class Catalog {
|
|
|
390
452
|
* page. Default is 12.
|
|
391
453
|
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
392
454
|
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
393
|
-
* @summary:
|
|
394
|
-
* @description: List all the products associated with a brand, collection or category in a requested sort order.
|
|
455
|
+
* @summary: Get application products.
|
|
456
|
+
* @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
|
|
395
457
|
*/
|
|
396
458
|
getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
|
|
397
459
|
companyId: string;
|
|
@@ -413,8 +475,8 @@ declare class Catalog {
|
|
|
413
475
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
414
476
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
415
477
|
* @name getApplicationBrandListing
|
|
416
|
-
* @summary:
|
|
417
|
-
* @description:
|
|
478
|
+
* @summary: Get application brand listing.
|
|
479
|
+
* @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
|
|
418
480
|
*/
|
|
419
481
|
getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
420
482
|
/**
|
|
@@ -428,8 +490,8 @@ declare class Catalog {
|
|
|
428
490
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
429
491
|
* to search brands by brand name.
|
|
430
492
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
431
|
-
* @summary:
|
|
432
|
-
* @description:
|
|
493
|
+
* @summary: Get application brand listing.
|
|
494
|
+
* @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold
|
|
433
495
|
*/
|
|
434
496
|
getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
435
497
|
companyId: string;
|
|
@@ -445,8 +507,8 @@ declare class Catalog {
|
|
|
445
507
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
446
508
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
447
509
|
* @name getApplicationBrands
|
|
448
|
-
* @summary:
|
|
449
|
-
* @description: A brand is the name under which a product is being sold.
|
|
510
|
+
* @summary: Get application brands.
|
|
511
|
+
* @description: List all the brands. A brand is the name under which a product is being sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
|
|
450
512
|
*/
|
|
451
513
|
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
452
514
|
/**
|
|
@@ -466,8 +528,8 @@ declare class Catalog {
|
|
|
466
528
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
467
529
|
* basis of uid list.
|
|
468
530
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
469
|
-
* @summary:
|
|
470
|
-
* @description: A brand is the name under which a product is being sold.
|
|
531
|
+
* @summary: Get application brands.
|
|
532
|
+
* @description: List all the brands. A brand is the name under which a product is being sold.
|
|
471
533
|
*/
|
|
472
534
|
getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
|
|
473
535
|
companyId: string;
|
|
@@ -485,8 +547,8 @@ declare class Catalog {
|
|
|
485
547
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
486
548
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
487
549
|
* @name getApplicationCategoryListing
|
|
488
|
-
* @summary:
|
|
489
|
-
* @description: A brand is the name under which a product is being sold.
|
|
550
|
+
* @summary: Get application category listing.
|
|
551
|
+
* @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
|
|
490
552
|
*/
|
|
491
553
|
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
492
554
|
/**
|
|
@@ -502,8 +564,8 @@ declare class Catalog {
|
|
|
502
564
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
503
565
|
* to search brands by brand name.
|
|
504
566
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
505
|
-
* @summary:
|
|
506
|
-
* @description: A brand is the name under which a product is being sold.
|
|
567
|
+
* @summary: Get application category listing.
|
|
568
|
+
* @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold.
|
|
507
569
|
*/
|
|
508
570
|
getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
|
|
509
571
|
companyId: string;
|
|
@@ -522,8 +584,8 @@ declare class Catalog {
|
|
|
522
584
|
* - Success response
|
|
523
585
|
*
|
|
524
586
|
* @name getApplicationDepartmentListing
|
|
525
|
-
* @summary:
|
|
526
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
587
|
+
* @summary: Get application department listing.
|
|
588
|
+
* @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
|
|
527
589
|
*/
|
|
528
590
|
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
529
591
|
/**
|
|
@@ -537,8 +599,8 @@ declare class Catalog {
|
|
|
537
599
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
538
600
|
* to search department by name.
|
|
539
601
|
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
540
|
-
* @summary:
|
|
541
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
602
|
+
* @summary: Get application department listing.
|
|
603
|
+
* @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
542
604
|
*/
|
|
543
605
|
getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
544
606
|
companyId: string;
|
|
@@ -546,6 +608,32 @@ declare class Catalog {
|
|
|
546
608
|
pageSize?: number;
|
|
547
609
|
q?: string;
|
|
548
610
|
}): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
611
|
+
/**
|
|
612
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
|
|
613
|
+
* - Arg object
|
|
614
|
+
*
|
|
615
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
616
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
617
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
|
|
618
|
+
* Success response
|
|
619
|
+
* @name getApplicationFilterKeys
|
|
620
|
+
* @summary: Get filters keys of the filter options.
|
|
621
|
+
* @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
|
|
622
|
+
*/
|
|
623
|
+
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>;
|
|
624
|
+
/**
|
|
625
|
+
* @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
|
|
626
|
+
* - Arg object
|
|
627
|
+
*
|
|
628
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
629
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
630
|
+
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
|
|
631
|
+
* Success response
|
|
632
|
+
* @name getApplicationFilterValues
|
|
633
|
+
* @summary: Get values of the selected value for the filter options.
|
|
634
|
+
* @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
|
|
635
|
+
*/
|
|
636
|
+
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>;
|
|
549
637
|
/**
|
|
550
638
|
* @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
|
|
551
639
|
* - Arg object
|
|
@@ -555,7 +643,7 @@ declare class Catalog {
|
|
|
555
643
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
556
644
|
* Success response
|
|
557
645
|
* @name getAutocompleteConfig
|
|
558
|
-
* @summary:
|
|
646
|
+
* @summary: Get autocomplete configuration.
|
|
559
647
|
* @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
|
|
560
648
|
*/
|
|
561
649
|
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
@@ -568,8 +656,8 @@ declare class Catalog {
|
|
|
568
656
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
569
657
|
* Success response
|
|
570
658
|
* @name getAutocompleteKeywordDetail
|
|
571
|
-
* @summary: Get
|
|
572
|
-
* @description:
|
|
659
|
+
* @summary: Get autocomplete keyword details.
|
|
660
|
+
* @description: Retrieve detailed information about a specific autocomplete keyword. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
573
661
|
*/
|
|
574
662
|
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
575
663
|
/**
|
|
@@ -582,8 +670,8 @@ declare class Catalog {
|
|
|
582
670
|
* - Success response
|
|
583
671
|
*
|
|
584
672
|
* @name getCatalogConfiguration
|
|
585
|
-
* @summary:
|
|
586
|
-
* @description: configuration meta
|
|
673
|
+
* @summary: Retrieve catalog configuration.
|
|
674
|
+
* @description: Retrieve configuration meta details for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
|
|
587
675
|
*/
|
|
588
676
|
getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
|
|
589
677
|
/**
|
|
@@ -594,8 +682,8 @@ declare class Catalog {
|
|
|
594
682
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
595
683
|
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
596
684
|
* @name getCatalogInsights
|
|
597
|
-
* @summary:
|
|
598
|
-
* @description:
|
|
685
|
+
* @summary: Get catalog insights.
|
|
686
|
+
* @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
|
|
599
687
|
*/
|
|
600
688
|
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
|
|
601
689
|
/**
|
|
@@ -604,8 +692,8 @@ declare class Catalog {
|
|
|
604
692
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
605
693
|
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
606
694
|
* @name getCategories
|
|
607
|
-
* @summary:
|
|
608
|
-
* @description:
|
|
695
|
+
* @summary: Get categories.
|
|
696
|
+
* @description: Retrieve a list of categories. Optionally pass filter the brands by the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
|
|
609
697
|
*/
|
|
610
698
|
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
|
|
611
699
|
/**
|
|
@@ -617,8 +705,8 @@ declare class Catalog {
|
|
|
617
705
|
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
|
|
618
706
|
* Success response
|
|
619
707
|
* @name getCollectionDetail
|
|
620
|
-
* @summary: Get
|
|
621
|
-
* @description: Get the details of a collection by its
|
|
708
|
+
* @summary: Get collection details.
|
|
709
|
+
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
622
710
|
*/
|
|
623
711
|
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
|
|
624
712
|
/**
|
|
@@ -644,8 +732,8 @@ declare class Catalog {
|
|
|
644
732
|
* - Success response
|
|
645
733
|
*
|
|
646
734
|
* @name getConfigurationByType
|
|
647
|
-
* @summary:
|
|
648
|
-
* @description:
|
|
735
|
+
* @summary: Retrieve configuration by type.
|
|
736
|
+
* @description: Retrieve configuration details based on a specific type in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
|
|
649
737
|
*/
|
|
650
738
|
getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
651
739
|
/**
|
|
@@ -657,8 +745,8 @@ declare class Catalog {
|
|
|
657
745
|
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
658
746
|
* Success response
|
|
659
747
|
* @name getConfigurationMetadata
|
|
660
|
-
* @summary:
|
|
661
|
-
* @description:
|
|
748
|
+
* @summary: Retrieve configuration metadata.
|
|
749
|
+
* @description: Retrieve the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
662
750
|
*/
|
|
663
751
|
getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
|
|
664
752
|
/**
|
|
@@ -670,8 +758,8 @@ declare class Catalog {
|
|
|
670
758
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
671
759
|
* Success response
|
|
672
760
|
* @name getConfigurations
|
|
673
|
-
* @summary:
|
|
674
|
-
* @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
761
|
+
* @summary: Retrieve configurations.
|
|
762
|
+
* @description: Retrieve a configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
675
763
|
*/
|
|
676
764
|
getConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
677
765
|
/**
|
|
@@ -680,8 +768,8 @@ declare class Catalog {
|
|
|
680
768
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
681
769
|
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
682
770
|
* @name getDepartments
|
|
683
|
-
* @summary:
|
|
684
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
771
|
+
* @summary: Get departments.
|
|
772
|
+
* @description: Retrieve a list of departments. Departments are a way to categorise similar products. A product can lie in multiple departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
|
|
685
773
|
*/
|
|
686
774
|
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
|
|
687
775
|
/**
|
|
@@ -694,10 +782,35 @@ declare class Catalog {
|
|
|
694
782
|
* - Success response
|
|
695
783
|
*
|
|
696
784
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
697
|
-
* @summary: Get
|
|
698
|
-
* @description:
|
|
785
|
+
* @summary: Get discounted inventory by size identifier.
|
|
786
|
+
* @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/).
|
|
699
787
|
*/
|
|
700
788
|
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
789
|
+
/**
|
|
790
|
+
* @param {Object} arg - Arg object.
|
|
791
|
+
* @param {number} arg.companyId - Id of the company associated to product
|
|
792
|
+
* that is to be viewed.
|
|
793
|
+
* @param {string} arg.applicationId - Uniquer Application ID.
|
|
794
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
795
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
796
|
+
* or Primary Identifier) of which inventory is to get.
|
|
797
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
798
|
+
* page. Default is 12.
|
|
799
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
800
|
+
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
801
|
+
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
802
|
+
* @summary: Get discounted inventory by size identifier.
|
|
803
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
804
|
+
*/
|
|
805
|
+
getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
|
|
806
|
+
companyId: number;
|
|
807
|
+
applicationId: string;
|
|
808
|
+
itemId: number;
|
|
809
|
+
sizeIdentifier: string;
|
|
810
|
+
pageSize?: number;
|
|
811
|
+
q?: string;
|
|
812
|
+
locationIds?: number[];
|
|
813
|
+
}): Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
701
814
|
/**
|
|
702
815
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
703
816
|
* - Arg object
|
|
@@ -706,8 +819,8 @@ declare class Catalog {
|
|
|
706
819
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
707
820
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
708
821
|
* @name getGroupConfigurations
|
|
709
|
-
* @summary:
|
|
710
|
-
* @description:
|
|
822
|
+
* @summary: Retrieve group configurations.
|
|
823
|
+
* @description: Retrieve the details of the application configured configurations of group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
|
|
711
824
|
*/
|
|
712
825
|
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
|
|
713
826
|
/**
|
|
@@ -718,8 +831,8 @@ declare class Catalog {
|
|
|
718
831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
719
832
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
720
833
|
* @name getListingConfigurations
|
|
721
|
-
* @summary:
|
|
722
|
-
* @description:
|
|
834
|
+
* @summary: Retrieve listing configurations.
|
|
835
|
+
* @description: Retrieve the details of the application configured configurations of listing config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
|
|
723
836
|
*/
|
|
724
837
|
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
|
|
725
838
|
/**
|
|
@@ -730,8 +843,8 @@ declare class Catalog {
|
|
|
730
843
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
731
844
|
* @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
|
|
732
845
|
* @name getProductDetailBySlug
|
|
733
|
-
* @summary: Get
|
|
734
|
-
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
|
|
846
|
+
* @summary: Get product details by slug.
|
|
847
|
+
* @description: Retrieve detailed product information using a product slug. Products are the core resource of an application. Products can be associated by categories, collections, brands and more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
|
|
735
848
|
*/
|
|
736
849
|
getProductDetailBySlug({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDetail>;
|
|
737
850
|
/**
|
|
@@ -740,8 +853,8 @@ declare class Catalog {
|
|
|
740
853
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
741
854
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
|
|
742
855
|
* @name getQueryFilters
|
|
743
|
-
* @summary:
|
|
744
|
-
* @description:
|
|
856
|
+
* @summary: Retrieve query filters.
|
|
857
|
+
* @description: Retrieve query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
745
858
|
*/
|
|
746
859
|
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
|
|
747
860
|
/**
|
|
@@ -754,8 +867,8 @@ declare class Catalog {
|
|
|
754
867
|
* - Success response
|
|
755
868
|
*
|
|
756
869
|
* @name getSearchConfiguration
|
|
757
|
-
* @summary:
|
|
758
|
-
* @description:
|
|
870
|
+
* @summary: Get Search Configuration
|
|
871
|
+
* @description: Get search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
|
|
759
872
|
*/
|
|
760
873
|
getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponse>;
|
|
761
874
|
/**
|
|
@@ -767,8 +880,8 @@ declare class Catalog {
|
|
|
767
880
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
768
881
|
* Success response
|
|
769
882
|
* @name getSearchKeywords
|
|
770
|
-
* @summary:
|
|
771
|
-
* @description:
|
|
883
|
+
* @summary: Retrieve search keywords.
|
|
884
|
+
* @description: Retrieve a list of search keywords from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
|
|
772
885
|
*/
|
|
773
886
|
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>;
|
|
774
887
|
/**
|
|
@@ -779,8 +892,8 @@ declare class Catalog {
|
|
|
779
892
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
780
893
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
781
894
|
* @name updateAllowSingle
|
|
782
|
-
* @summary: Update
|
|
783
|
-
* @description:
|
|
895
|
+
* @summary: Update 'Allow Single' setting.
|
|
896
|
+
* @description: Modify allow single flag for filters of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
|
|
784
897
|
*/
|
|
785
898
|
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
786
899
|
/**
|
|
@@ -789,8 +902,8 @@ declare class Catalog {
|
|
|
789
902
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
790
903
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
791
904
|
* @name updateAppBrand
|
|
792
|
-
* @summary: Update
|
|
793
|
-
* @description:
|
|
905
|
+
* @summary: Update application brand.
|
|
906
|
+
* @description: Modify data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
794
907
|
*/
|
|
795
908
|
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
796
909
|
/**
|
|
@@ -801,8 +914,8 @@ declare class Catalog {
|
|
|
801
914
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
802
915
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
803
916
|
* @name updateAppCategory
|
|
804
|
-
* @summary: Update
|
|
805
|
-
* @description:
|
|
917
|
+
* @summary: Update application category.
|
|
918
|
+
* @description: Modify category data related to the application. Helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
|
|
806
919
|
*/
|
|
807
920
|
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
808
921
|
/**
|
|
@@ -825,8 +938,8 @@ declare class Catalog {
|
|
|
825
938
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
826
939
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
827
940
|
* @name updateAppDepartment
|
|
828
|
-
* @summary: Update
|
|
829
|
-
* @description:
|
|
941
|
+
* @summary: Update application department.
|
|
942
|
+
* @description: Modify department data related to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
830
943
|
*/
|
|
831
944
|
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
832
945
|
/**
|
|
@@ -837,8 +950,8 @@ declare class Catalog {
|
|
|
837
950
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
838
951
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
839
952
|
* @name updateAppLocation
|
|
840
|
-
* @summary: Update
|
|
841
|
-
* @description:
|
|
953
|
+
* @summary: Update application location.
|
|
954
|
+
* @description: Modify location data related to the application. Helps to update data associated to a item custom meta - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
|
|
842
955
|
*/
|
|
843
956
|
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
844
957
|
/**
|
|
@@ -847,8 +960,8 @@ declare class Catalog {
|
|
|
847
960
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
848
961
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
849
962
|
* @name updateAppProduct
|
|
850
|
-
* @summary: Update
|
|
851
|
-
* @description:
|
|
963
|
+
* @summary: Update application product data.
|
|
964
|
+
* @description: Allows to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
|
|
852
965
|
*/
|
|
853
966
|
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
854
967
|
/**
|
|
@@ -872,7 +985,7 @@ declare class Catalog {
|
|
|
872
985
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
873
986
|
* Success response
|
|
874
987
|
* @name updateAutocompleteKeyword
|
|
875
|
-
* @summary:
|
|
988
|
+
* @summary: Update autocomplete keywords.
|
|
876
989
|
* @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
|
|
877
990
|
*/
|
|
878
991
|
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
@@ -894,8 +1007,8 @@ declare class Catalog {
|
|
|
894
1007
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
895
1008
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
896
1009
|
* @name updateDefaultSort
|
|
897
|
-
* @summary: Update
|
|
898
|
-
* @description:
|
|
1010
|
+
* @summary: Update default sorting.
|
|
1011
|
+
* @description: Modify the default sort key configuration for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
|
|
899
1012
|
*/
|
|
900
1013
|
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
901
1014
|
/**
|
|
@@ -906,8 +1019,8 @@ declare class Catalog {
|
|
|
906
1019
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
907
1020
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
908
1021
|
* @name updateGroupConfiguration
|
|
909
|
-
* @summary: Update
|
|
910
|
-
* @description:
|
|
1022
|
+
* @summary: Update group configuration.
|
|
1023
|
+
* @description: Modify the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
|
|
911
1024
|
*/
|
|
912
1025
|
updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
913
1026
|
/**
|
|
@@ -918,8 +1031,8 @@ declare class Catalog {
|
|
|
918
1031
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
919
1032
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
920
1033
|
* @name updateListingConfiguration
|
|
921
|
-
* @summary: Update configuration
|
|
922
|
-
* @description:
|
|
1034
|
+
* @summary: Update listing configuration.
|
|
1035
|
+
* @description: Modify the details and settings of an existing listing configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
|
|
923
1036
|
*/
|
|
924
1037
|
updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
925
1038
|
/**
|
|
@@ -944,7 +1057,7 @@ declare class Catalog {
|
|
|
944
1057
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
945
1058
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
946
1059
|
* @name updateSearchKeywords
|
|
947
|
-
* @summary: Update
|
|
1060
|
+
* @summary: Update search keywords.
|
|
948
1061
|
* @description: Update Search Keyword by its id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
|
|
949
1062
|
*/
|
|
950
1063
|
updateSearchKeywords({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|