@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -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 +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
- package/sdk/platform/Order/OrderPlatformClient.js +41 -41
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -61,7 +61,7 @@ declare class Catalog {
|
|
|
61
61
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
62
62
|
* Success response
|
|
63
63
|
* @name createConfigurationByType
|
|
64
|
-
* @summary: Create configuration by type
|
|
64
|
+
* @summary: Create configuration by type
|
|
65
65
|
* @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
|
|
66
66
|
*/
|
|
67
67
|
createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
@@ -74,7 +74,7 @@ declare class Catalog {
|
|
|
74
74
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
75
75
|
* Success response
|
|
76
76
|
* @name createConfigurationProductListing
|
|
77
|
-
* @summary: Create configuration for product listing
|
|
77
|
+
* @summary: Create configuration for product listing
|
|
78
78
|
* @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
|
|
79
79
|
*/
|
|
80
80
|
createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
@@ -88,7 +88,7 @@ declare class Catalog {
|
|
|
88
88
|
* - Success response
|
|
89
89
|
*
|
|
90
90
|
* @name createCustomAutocompleteRule
|
|
91
|
-
* @summary: Create custom autocomplete rules
|
|
91
|
+
* @summary: Create custom autocomplete rules
|
|
92
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/).
|
|
93
93
|
*/
|
|
94
94
|
createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
|
|
@@ -100,7 +100,7 @@ declare class Catalog {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
102
102
|
* @name createCustomKeyword
|
|
103
|
-
* @summary: Create custom search keywords
|
|
103
|
+
* @summary: Create custom search keywords
|
|
104
104
|
* @description: Create a Custom Search Keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
|
|
105
105
|
*/
|
|
106
106
|
createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|
|
@@ -112,7 +112,7 @@ declare class Catalog {
|
|
|
112
112
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
113
113
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
114
114
|
* @name createGroupConfiguration
|
|
115
|
-
* @summary: Create group configuration
|
|
115
|
+
* @summary: Create group configuration
|
|
116
116
|
* @description: Create configuration for group configuration types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
|
|
117
117
|
*/
|
|
118
118
|
createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
@@ -124,7 +124,7 @@ declare class Catalog {
|
|
|
124
124
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
125
125
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
126
126
|
* @name createListingConfiguration
|
|
127
|
-
* @summary: Create listing configuration
|
|
127
|
+
* @summary: Create listing configuration
|
|
128
128
|
* @description: Add configuration for catalog listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
129
129
|
*/
|
|
130
130
|
createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
@@ -162,7 +162,7 @@ declare class Catalog {
|
|
|
162
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
163
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
164
164
|
* @name deleteAutocompleteKeyword
|
|
165
|
-
* @summary: Delete autocomplete keywords
|
|
165
|
+
* @summary: Delete autocomplete keywords
|
|
166
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/).
|
|
167
167
|
*/
|
|
168
168
|
deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
@@ -174,7 +174,7 @@ declare class Catalog {
|
|
|
174
174
|
* - Success response
|
|
175
175
|
*
|
|
176
176
|
* @name deleteCollection
|
|
177
|
-
* @summary: Delete a collection
|
|
177
|
+
* @summary: Delete a collection
|
|
178
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/).
|
|
179
179
|
*/
|
|
180
180
|
deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
|
|
@@ -186,7 +186,7 @@ declare class Catalog {
|
|
|
186
186
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
187
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
188
188
|
* @name deleteGroupConfiguration
|
|
189
|
-
* @summary: Delete group configuration
|
|
189
|
+
* @summary: Delete group configuration
|
|
190
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/).
|
|
191
191
|
*/
|
|
192
192
|
deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
@@ -198,7 +198,7 @@ declare class Catalog {
|
|
|
198
198
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
199
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
200
200
|
* @name deleteListingConfiguration
|
|
201
|
-
* @summary: Delete listing configuration
|
|
201
|
+
* @summary: Delete listing configuration
|
|
202
202
|
* @description: Remove a specific listing configuration from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
203
203
|
*/
|
|
204
204
|
deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
@@ -224,7 +224,7 @@ declare class Catalog {
|
|
|
224
224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
225
225
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
226
226
|
* @name deleteSearchKeywords
|
|
227
|
-
* @summary: Delete search keywords
|
|
227
|
+
* @summary: Delete search keywords
|
|
228
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/).
|
|
229
229
|
*/
|
|
230
230
|
deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
|
|
@@ -237,7 +237,7 @@ declare class Catalog {
|
|
|
237
237
|
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
|
|
238
238
|
* Success response
|
|
239
239
|
* @name getAllCollections
|
|
240
|
-
* @summary: Retrieve all collections
|
|
240
|
+
* @summary: Retrieve all collections
|
|
241
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/).
|
|
242
242
|
*/
|
|
243
243
|
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
|
|
@@ -257,7 +257,7 @@ declare class Catalog {
|
|
|
257
257
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
258
258
|
* page. Default is 12.
|
|
259
259
|
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponse>}
|
|
260
|
-
* @summary: Retrieve all collections
|
|
260
|
+
* @summary: Retrieve all collections
|
|
261
261
|
* @description: A Collection allows you to organize your products into hierarchical groups.
|
|
262
262
|
*/
|
|
263
263
|
getAllCollectionsPaginator({ companyId, applicationId, q, scheduleStatus, type, tags, isActive, pageSize, }?: {
|
|
@@ -278,7 +278,7 @@ declare class Catalog {
|
|
|
278
278
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
279
279
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
|
|
280
280
|
* @name getAllSearchKeyword
|
|
281
|
-
* @summary: Get all search keywords
|
|
281
|
+
* @summary: Get all search keywords
|
|
282
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/).
|
|
283
283
|
*/
|
|
284
284
|
getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
|
|
@@ -302,7 +302,7 @@ declare class Catalog {
|
|
|
302
302
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
303
303
|
* @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
|
|
304
304
|
* @name getAppInventory
|
|
305
|
-
* @summary: Get application inventory
|
|
305
|
+
* @summary: Get application inventory
|
|
306
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/).
|
|
307
307
|
*/
|
|
308
308
|
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
|
|
@@ -312,7 +312,7 @@ declare class Catalog {
|
|
|
312
312
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
313
313
|
* @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
|
|
314
314
|
* @name getAppLocations
|
|
315
|
-
* @summary: Get application locations
|
|
315
|
+
* @summary: Get application locations
|
|
316
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/).
|
|
317
317
|
*/
|
|
318
318
|
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
|
|
@@ -333,7 +333,7 @@ declare class Catalog {
|
|
|
333
333
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
334
334
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
335
335
|
* @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
|
|
336
|
-
* @summary: Get application locations
|
|
336
|
+
* @summary: Get application locations
|
|
337
337
|
* @description: Retrieve locations specific to the application. View all the locations asscoiated to a application.
|
|
338
338
|
*/
|
|
339
339
|
getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
|
|
@@ -353,7 +353,7 @@ declare class Catalog {
|
|
|
353
353
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
354
354
|
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
355
355
|
* @name getAppProduct
|
|
356
|
-
* @summary: Retrieve application product data
|
|
356
|
+
* @summary: Retrieve application product data
|
|
357
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/).
|
|
358
358
|
*/
|
|
359
359
|
getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
|
|
@@ -364,7 +364,7 @@ declare class Catalog {
|
|
|
364
364
|
* @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
|
|
365
365
|
* Success response
|
|
366
366
|
* @name getAppProducts
|
|
367
|
-
* @summary: Get application products
|
|
367
|
+
* @summary: Get application products
|
|
368
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/).
|
|
369
369
|
*/
|
|
370
370
|
getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponse>;
|
|
@@ -385,7 +385,7 @@ declare class Catalog {
|
|
|
385
385
|
* page. Default is 10.
|
|
386
386
|
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
387
387
|
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
|
|
388
|
-
* @summary: Get application products
|
|
388
|
+
* @summary: Get application products
|
|
389
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
390
|
*/
|
|
391
391
|
getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
|
|
@@ -421,7 +421,7 @@ declare class Catalog {
|
|
|
421
421
|
* - Success response
|
|
422
422
|
*
|
|
423
423
|
* @name getAppicationProducts
|
|
424
|
-
* @summary: Get application products
|
|
424
|
+
* @summary: Get application products
|
|
425
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/).
|
|
426
426
|
*/
|
|
427
427
|
getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
|
|
@@ -452,7 +452,7 @@ declare class Catalog {
|
|
|
452
452
|
* page. Default is 12.
|
|
453
453
|
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
454
454
|
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
455
|
-
* @summary: Get application products
|
|
455
|
+
* @summary: Get application products
|
|
456
456
|
* @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
|
|
457
457
|
*/
|
|
458
458
|
getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
|
|
@@ -475,7 +475,7 @@ declare class Catalog {
|
|
|
475
475
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
476
476
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
477
477
|
* @name getApplicationBrandListing
|
|
478
|
-
* @summary: Get application brand listing
|
|
478
|
+
* @summary: Get application brand listing
|
|
479
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/).
|
|
480
480
|
*/
|
|
481
481
|
getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
@@ -490,7 +490,7 @@ declare class Catalog {
|
|
|
490
490
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
491
491
|
* to search brands by brand name.
|
|
492
492
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
493
|
-
* @summary: Get application brand listing
|
|
493
|
+
* @summary: Get application brand listing
|
|
494
494
|
* @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold
|
|
495
495
|
*/
|
|
496
496
|
getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
@@ -507,7 +507,7 @@ declare class Catalog {
|
|
|
507
507
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
508
508
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
509
509
|
* @name getApplicationBrands
|
|
510
|
-
* @summary: Get application brands
|
|
510
|
+
* @summary: Get application brands
|
|
511
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/).
|
|
512
512
|
*/
|
|
513
513
|
getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
@@ -528,7 +528,7 @@ declare class Catalog {
|
|
|
528
528
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
529
529
|
* basis of uid list.
|
|
530
530
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
531
|
-
* @summary: Get application brands
|
|
531
|
+
* @summary: Get application brands
|
|
532
532
|
* @description: List all the brands. A brand is the name under which a product is being sold.
|
|
533
533
|
*/
|
|
534
534
|
getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
|
|
@@ -547,7 +547,7 @@ declare class Catalog {
|
|
|
547
547
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
548
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
549
549
|
* @name getApplicationCategoryListing
|
|
550
|
-
* @summary: Get application category listing
|
|
550
|
+
* @summary: Get application category listing
|
|
551
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/).
|
|
552
552
|
*/
|
|
553
553
|
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
|
|
@@ -564,7 +564,7 @@ declare class Catalog {
|
|
|
564
564
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
565
565
|
* to search brands by brand name.
|
|
566
566
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
567
|
-
* @summary: Get application category listing
|
|
567
|
+
* @summary: Get application category listing
|
|
568
568
|
* @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold.
|
|
569
569
|
*/
|
|
570
570
|
getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
|
|
@@ -584,7 +584,7 @@ declare class Catalog {
|
|
|
584
584
|
* - Success response
|
|
585
585
|
*
|
|
586
586
|
* @name getApplicationDepartmentListing
|
|
587
|
-
* @summary: Get application department listing
|
|
587
|
+
* @summary: Get application department listing
|
|
588
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/).
|
|
589
589
|
*/
|
|
590
590
|
getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
|
|
@@ -599,7 +599,7 @@ declare class Catalog {
|
|
|
599
599
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
600
600
|
* to search department by name.
|
|
601
601
|
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
602
|
-
* @summary: Get application department listing
|
|
602
|
+
* @summary: Get application department listing
|
|
603
603
|
* @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
604
604
|
*/
|
|
605
605
|
getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
@@ -617,7 +617,7 @@ declare class Catalog {
|
|
|
617
617
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
|
|
618
618
|
* Success response
|
|
619
619
|
* @name getApplicationFilterKeys
|
|
620
|
-
* @summary: Get filters keys of the filter options
|
|
620
|
+
* @summary: Get filters keys of the filter options
|
|
621
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
622
|
*/
|
|
623
623
|
getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>;
|
|
@@ -630,7 +630,7 @@ declare class Catalog {
|
|
|
630
630
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
|
|
631
631
|
* Success response
|
|
632
632
|
* @name getApplicationFilterValues
|
|
633
|
-
* @summary: Get values of the selected value for the filter options
|
|
633
|
+
* @summary: Get values of the selected value for the filter options
|
|
634
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
635
|
*/
|
|
636
636
|
getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>;
|
|
@@ -643,7 +643,7 @@ declare class Catalog {
|
|
|
643
643
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
644
644
|
* Success response
|
|
645
645
|
* @name getAutocompleteConfig
|
|
646
|
-
* @summary: Get autocomplete configuration
|
|
646
|
+
* @summary: Get autocomplete configuration
|
|
647
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/).
|
|
648
648
|
*/
|
|
649
649
|
getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
@@ -656,7 +656,7 @@ declare class Catalog {
|
|
|
656
656
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
657
657
|
* Success response
|
|
658
658
|
* @name getAutocompleteKeywordDetail
|
|
659
|
-
* @summary: Get autocomplete keyword details
|
|
659
|
+
* @summary: Get autocomplete keyword details
|
|
660
660
|
* @description: Retrieve detailed information about a specific autocomplete keyword. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
661
661
|
*/
|
|
662
662
|
getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
@@ -670,7 +670,7 @@ declare class Catalog {
|
|
|
670
670
|
* - Success response
|
|
671
671
|
*
|
|
672
672
|
* @name getCatalogConfiguration
|
|
673
|
-
* @summary: Retrieve catalog configuration
|
|
673
|
+
* @summary: Retrieve catalog configuration
|
|
674
674
|
* @description: Retrieve configuration meta details for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
|
|
675
675
|
*/
|
|
676
676
|
getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
|
|
@@ -682,7 +682,7 @@ declare class Catalog {
|
|
|
682
682
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
683
683
|
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
684
684
|
* @name getCatalogInsights
|
|
685
|
-
* @summary: Get catalog insights
|
|
685
|
+
* @summary: Get catalog insights
|
|
686
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/).
|
|
687
687
|
*/
|
|
688
688
|
getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
|
|
@@ -692,7 +692,7 @@ declare class Catalog {
|
|
|
692
692
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
693
693
|
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
694
694
|
* @name getCategories
|
|
695
|
-
* @summary: Get categories
|
|
695
|
+
* @summary: Get categories
|
|
696
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/).
|
|
697
697
|
*/
|
|
698
698
|
getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
|
|
@@ -705,7 +705,7 @@ declare class Catalog {
|
|
|
705
705
|
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
|
|
706
706
|
* Success response
|
|
707
707
|
* @name getCollectionDetail
|
|
708
|
-
* @summary: Get collection details
|
|
708
|
+
* @summary: Get collection details
|
|
709
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/).
|
|
710
710
|
*/
|
|
711
711
|
getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
|
|
@@ -732,7 +732,7 @@ declare class Catalog {
|
|
|
732
732
|
* - Success response
|
|
733
733
|
*
|
|
734
734
|
* @name getConfigurationByType
|
|
735
|
-
* @summary: Retrieve configuration by type
|
|
735
|
+
* @summary: Retrieve configuration by type
|
|
736
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/).
|
|
737
737
|
*/
|
|
738
738
|
getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
|
|
@@ -745,7 +745,7 @@ declare class Catalog {
|
|
|
745
745
|
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
746
746
|
* Success response
|
|
747
747
|
* @name getConfigurationMetadata
|
|
748
|
-
* @summary: Retrieve configuration metadata
|
|
748
|
+
* @summary: Retrieve configuration metadata
|
|
749
749
|
* @description: Retrieve the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
750
750
|
*/
|
|
751
751
|
getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
|
|
@@ -758,7 +758,7 @@ declare class Catalog {
|
|
|
758
758
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
759
759
|
* Success response
|
|
760
760
|
* @name getConfigurations
|
|
761
|
-
* @summary: Retrieve configurations
|
|
761
|
+
* @summary: Retrieve configurations
|
|
762
762
|
* @description: Retrieve a configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
763
763
|
*/
|
|
764
764
|
getConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
|
|
@@ -768,7 +768,7 @@ declare class Catalog {
|
|
|
768
768
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
769
769
|
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
770
770
|
* @name getDepartments
|
|
771
|
-
* @summary: Get departments
|
|
771
|
+
* @summary: Get departments
|
|
772
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/).
|
|
773
773
|
*/
|
|
774
774
|
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
|
|
@@ -782,7 +782,7 @@ declare class Catalog {
|
|
|
782
782
|
* - Success response
|
|
783
783
|
*
|
|
784
784
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
785
|
-
* @summary: Get discounted inventory by size identifier
|
|
785
|
+
* @summary: Get discounted inventory by size identifier
|
|
786
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/).
|
|
787
787
|
*/
|
|
788
788
|
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
@@ -799,7 +799,7 @@ declare class Catalog {
|
|
|
799
799
|
* @param {string} [arg.q] - Search with help of store code.
|
|
800
800
|
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
801
801
|
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
802
|
-
* @summary: Get discounted inventory by size identifier
|
|
802
|
+
* @summary: Get discounted inventory by size identifier
|
|
803
803
|
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
804
804
|
*/
|
|
805
805
|
getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
|
|
@@ -819,7 +819,7 @@ declare class Catalog {
|
|
|
819
819
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
820
820
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
821
821
|
* @name getGroupConfigurations
|
|
822
|
-
* @summary: Retrieve group configurations
|
|
822
|
+
* @summary: Retrieve group configurations
|
|
823
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/).
|
|
824
824
|
*/
|
|
825
825
|
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
|
|
@@ -831,7 +831,7 @@ declare class Catalog {
|
|
|
831
831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
832
832
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
833
833
|
* @name getListingConfigurations
|
|
834
|
-
* @summary: Retrieve listing configurations
|
|
834
|
+
* @summary: Retrieve listing configurations
|
|
835
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/).
|
|
836
836
|
*/
|
|
837
837
|
getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
|
|
@@ -843,7 +843,7 @@ declare class Catalog {
|
|
|
843
843
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
844
844
|
* @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
|
|
845
845
|
* @name getProductDetailBySlug
|
|
846
|
-
* @summary: Get product details by slug
|
|
846
|
+
* @summary: Get product details by slug
|
|
847
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/).
|
|
848
848
|
*/
|
|
849
849
|
getProductDetailBySlug({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDetail>;
|
|
@@ -853,7 +853,7 @@ declare class Catalog {
|
|
|
853
853
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
854
854
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
|
|
855
855
|
* @name getQueryFilters
|
|
856
|
-
* @summary: Retrieve query filters
|
|
856
|
+
* @summary: Retrieve query filters
|
|
857
857
|
* @description: Retrieve query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
858
858
|
*/
|
|
859
859
|
getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
|
|
@@ -880,7 +880,7 @@ declare class Catalog {
|
|
|
880
880
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
881
881
|
* Success response
|
|
882
882
|
* @name getSearchKeywords
|
|
883
|
-
* @summary: Retrieve search keywords
|
|
883
|
+
* @summary: Retrieve search keywords
|
|
884
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/).
|
|
885
885
|
*/
|
|
886
886
|
getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>;
|
|
@@ -892,7 +892,7 @@ declare class Catalog {
|
|
|
892
892
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
893
893
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
894
894
|
* @name updateAllowSingle
|
|
895
|
-
* @summary: Update 'Allow Single' setting
|
|
895
|
+
* @summary: Update 'Allow Single' setting
|
|
896
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/).
|
|
897
897
|
*/
|
|
898
898
|
updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
@@ -902,7 +902,7 @@ declare class Catalog {
|
|
|
902
902
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
903
903
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
904
904
|
* @name updateAppBrand
|
|
905
|
-
* @summary: Update application brand
|
|
905
|
+
* @summary: Update application brand
|
|
906
906
|
* @description: Modify data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
907
907
|
*/
|
|
908
908
|
updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
@@ -914,7 +914,7 @@ declare class Catalog {
|
|
|
914
914
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
915
915
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
916
916
|
* @name updateAppCategory
|
|
917
|
-
* @summary: Update application category
|
|
917
|
+
* @summary: Update application category
|
|
918
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/).
|
|
919
919
|
*/
|
|
920
920
|
updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
@@ -938,7 +938,7 @@ declare class Catalog {
|
|
|
938
938
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
939
939
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
940
940
|
* @name updateAppDepartment
|
|
941
|
-
* @summary: Update application department
|
|
941
|
+
* @summary: Update application department
|
|
942
942
|
* @description: Modify department data related to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
943
943
|
*/
|
|
944
944
|
updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
@@ -950,7 +950,7 @@ declare class Catalog {
|
|
|
950
950
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
951
951
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
952
952
|
* @name updateAppLocation
|
|
953
|
-
* @summary: Update application location
|
|
953
|
+
* @summary: Update application location
|
|
954
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/).
|
|
955
955
|
*/
|
|
956
956
|
updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
@@ -960,7 +960,7 @@ declare class Catalog {
|
|
|
960
960
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
961
961
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
962
962
|
* @name updateAppProduct
|
|
963
|
-
* @summary: Update application product data
|
|
963
|
+
* @summary: Update application product data
|
|
964
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/).
|
|
965
965
|
*/
|
|
966
966
|
updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
@@ -985,7 +985,7 @@ declare class Catalog {
|
|
|
985
985
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
986
986
|
* Success response
|
|
987
987
|
* @name updateAutocompleteKeyword
|
|
988
|
-
* @summary: Update autocomplete keywords
|
|
988
|
+
* @summary: Update autocomplete keywords
|
|
989
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/).
|
|
990
990
|
*/
|
|
991
991
|
updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
|
|
@@ -1007,7 +1007,7 @@ declare class Catalog {
|
|
|
1007
1007
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1008
1008
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1009
1009
|
* @name updateDefaultSort
|
|
1010
|
-
* @summary: Update default sorting
|
|
1010
|
+
* @summary: Update default sorting
|
|
1011
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/).
|
|
1012
1012
|
*/
|
|
1013
1013
|
updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
|
|
@@ -1019,7 +1019,7 @@ declare class Catalog {
|
|
|
1019
1019
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1020
1020
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
1021
1021
|
* @name updateGroupConfiguration
|
|
1022
|
-
* @summary: Update group configuration
|
|
1022
|
+
* @summary: Update group configuration
|
|
1023
1023
|
* @description: Modify the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
|
|
1024
1024
|
*/
|
|
1025
1025
|
updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
|
|
@@ -1031,7 +1031,7 @@ declare class Catalog {
|
|
|
1031
1031
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1032
1032
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
1033
1033
|
* @name updateListingConfiguration
|
|
1034
|
-
* @summary: Update listing configuration
|
|
1034
|
+
* @summary: Update listing configuration
|
|
1035
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/).
|
|
1036
1036
|
*/
|
|
1037
1037
|
updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
|
|
@@ -1057,7 +1057,7 @@ declare class Catalog {
|
|
|
1057
1057
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1058
1058
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
1059
1059
|
* @name updateSearchKeywords
|
|
1060
|
-
* @summary: Update search keywords
|
|
1060
|
+
* @summary: Update search keywords
|
|
1061
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/).
|
|
1062
1062
|
*/
|
|
1063
1063
|
updateSearchKeywords({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
|