@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- 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/Lead/LeadApplicationModel.js +1 -1
- 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 +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -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 +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -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/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- 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 +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -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 +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -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/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 +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- 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/Lead/LeadPlatformModel.js +1 -1
- 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 +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- 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/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 +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- 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 +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- 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
|
@@ -21,7 +21,9 @@ class Catalog {
|
|
|
21
21
|
*
|
|
22
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
24
|
+
* @returns {Promise<CatalogPlatformModel.CommonResponseSchemaCollection>}
|
|
25
|
+
* - Success response
|
|
26
|
+
*
|
|
25
27
|
* @name addCollectionItems
|
|
26
28
|
* @summary: Add items to a collection
|
|
27
29
|
* @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/).
|
|
@@ -65,7 +67,7 @@ class Catalog {
|
|
|
65
67
|
const response = await PlatformAPIClient.execute(
|
|
66
68
|
this.config,
|
|
67
69
|
"post",
|
|
68
|
-
`/service/platform/catalog/
|
|
70
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/application/${this.applicationId}/collections/${id}/items/`,
|
|
69
71
|
query_params,
|
|
70
72
|
body,
|
|
71
73
|
requestHeaders,
|
|
@@ -79,10 +81,10 @@ class Catalog {
|
|
|
79
81
|
|
|
80
82
|
const {
|
|
81
83
|
error: res_error,
|
|
82
|
-
} = CatalogPlatformModel.
|
|
83
|
-
|
|
84
|
-
allowUnknown: true
|
|
85
|
-
|
|
84
|
+
} = CatalogPlatformModel.CommonResponseSchemaCollection().validate(
|
|
85
|
+
responseData,
|
|
86
|
+
{ abortEarly: false, allowUnknown: true }
|
|
87
|
+
);
|
|
86
88
|
|
|
87
89
|
if (res_error) {
|
|
88
90
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -268,7 +270,7 @@ class Catalog {
|
|
|
268
270
|
* Success response
|
|
269
271
|
* @name createCollection
|
|
270
272
|
* @summary: Add a Collection
|
|
271
|
-
* @description: Create a collection
|
|
273
|
+
* @description: Create a collection to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
|
|
272
274
|
*/
|
|
273
275
|
async createCollection(
|
|
274
276
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -349,7 +351,7 @@ class Catalog {
|
|
|
349
351
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
350
352
|
* Success response
|
|
351
353
|
* @name createConfigurationByType
|
|
352
|
-
* @summary:
|
|
354
|
+
* @summary: Create configuration by type.
|
|
353
355
|
* @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
|
|
354
356
|
*/
|
|
355
357
|
async createConfigurationByType(
|
|
@@ -433,7 +435,7 @@ class Catalog {
|
|
|
433
435
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
434
436
|
* Success response
|
|
435
437
|
* @name createConfigurationProductListing
|
|
436
|
-
* @summary:
|
|
438
|
+
* @summary: Create configuration for product listing.
|
|
437
439
|
* @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
|
|
438
440
|
*/
|
|
439
441
|
async createConfigurationProductListing(
|
|
@@ -516,8 +518,8 @@ class Catalog {
|
|
|
516
518
|
* - Success response
|
|
517
519
|
*
|
|
518
520
|
* @name createCustomAutocompleteRule
|
|
519
|
-
* @summary:
|
|
520
|
-
* @description:
|
|
521
|
+
* @summary: Create custom autocomplete rules.
|
|
522
|
+
* @description: Generate and add custom autocomplete rules to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
|
|
521
523
|
*/
|
|
522
524
|
async createCustomAutocompleteRule(
|
|
523
525
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -597,8 +599,8 @@ class Catalog {
|
|
|
597
599
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
598
600
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
599
601
|
* @name createCustomKeyword
|
|
600
|
-
* @summary:
|
|
601
|
-
* @description: Create a Custom Search Keywords.
|
|
602
|
+
* @summary: Create custom search keywords.
|
|
603
|
+
* @description: Create a Custom Search Keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
|
|
602
604
|
*/
|
|
603
605
|
async createCustomKeyword(
|
|
604
606
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -678,8 +680,8 @@ class Catalog {
|
|
|
678
680
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
679
681
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
680
682
|
* @name createGroupConfiguration
|
|
681
|
-
* @summary: Create configuration
|
|
682
|
-
* @description: Create configuration for
|
|
683
|
+
* @summary: Create group configuration.
|
|
684
|
+
* @description: Create configuration for group configuration types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
|
|
683
685
|
*/
|
|
684
686
|
async createGroupConfiguration(
|
|
685
687
|
{ configType, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -761,8 +763,8 @@ class Catalog {
|
|
|
761
763
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
762
764
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
763
765
|
* @name createListingConfiguration
|
|
764
|
-
* @summary:
|
|
765
|
-
* @description: Add configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
766
|
+
* @summary: Create listing configuration.
|
|
767
|
+
* @description: Add configuration for catalog listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
|
|
766
768
|
*/
|
|
767
769
|
async createListingConfiguration(
|
|
768
770
|
{ configType, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -846,8 +848,8 @@ class Catalog {
|
|
|
846
848
|
* - Success response
|
|
847
849
|
*
|
|
848
850
|
* @name createSearchConfiguration
|
|
849
|
-
* @summary:
|
|
850
|
-
* @description:
|
|
851
|
+
* @summary: Create search configuration
|
|
852
|
+
* @description: Create search configuration for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
|
|
851
853
|
*/
|
|
852
854
|
async createSearchConfiguration(
|
|
853
855
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1008,7 +1010,7 @@ class Catalog {
|
|
|
1008
1010
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1009
1011
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
1010
1012
|
* @name deleteAutocompleteKeyword
|
|
1011
|
-
* @summary: Delete
|
|
1013
|
+
* @summary: Delete autocomplete keywords.
|
|
1012
1014
|
* @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/).
|
|
1013
1015
|
*/
|
|
1014
1016
|
async deleteAutocompleteKeyword(
|
|
@@ -1089,7 +1091,7 @@ class Catalog {
|
|
|
1089
1091
|
* - Success response
|
|
1090
1092
|
*
|
|
1091
1093
|
* @name deleteCollection
|
|
1092
|
-
* @summary: Delete a
|
|
1094
|
+
* @summary: Delete a collection.
|
|
1093
1095
|
* @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/).
|
|
1094
1096
|
*/
|
|
1095
1097
|
async deleteCollection(
|
|
@@ -1170,7 +1172,7 @@ class Catalog {
|
|
|
1170
1172
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1171
1173
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1172
1174
|
* @name deleteGroupConfiguration
|
|
1173
|
-
* @summary: Delete configuration
|
|
1175
|
+
* @summary: Delete group configuration.
|
|
1174
1176
|
* @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/).
|
|
1175
1177
|
*/
|
|
1176
1178
|
async deleteGroupConfiguration(
|
|
@@ -1253,8 +1255,8 @@ class Catalog {
|
|
|
1253
1255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1254
1256
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
1255
1257
|
* @name deleteListingConfiguration
|
|
1256
|
-
* @summary: Delete configuration
|
|
1257
|
-
* @description:
|
|
1258
|
+
* @summary: Delete listing configuration.
|
|
1259
|
+
* @description: Remove a specific listing configuration from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
|
|
1258
1260
|
*/
|
|
1259
1261
|
async deleteListingConfiguration(
|
|
1260
1262
|
{ configType, configId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1338,8 +1340,8 @@ class Catalog {
|
|
|
1338
1340
|
* - Success response
|
|
1339
1341
|
*
|
|
1340
1342
|
* @name deleteSearchConfiguration
|
|
1341
|
-
* @summary: Delete
|
|
1342
|
-
* @description:
|
|
1343
|
+
* @summary: Delete Search Configuration
|
|
1344
|
+
* @description: Delete search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
|
|
1343
1345
|
*/
|
|
1344
1346
|
async deleteSearchConfiguration(
|
|
1345
1347
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1415,7 +1417,7 @@ class Catalog {
|
|
|
1415
1417
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1416
1418
|
* @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
|
|
1417
1419
|
* @name deleteSearchKeywords
|
|
1418
|
-
* @summary: Delete
|
|
1420
|
+
* @summary: Delete search keywords.
|
|
1419
1421
|
* @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/).
|
|
1420
1422
|
*/
|
|
1421
1423
|
async deleteSearchKeywords(
|
|
@@ -1497,8 +1499,8 @@ class Catalog {
|
|
|
1497
1499
|
* @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
|
|
1498
1500
|
* Success response
|
|
1499
1501
|
* @name getAllCollections
|
|
1500
|
-
* @summary:
|
|
1501
|
-
* @description: A Collection allows you to organize your products into hierarchical groups.
|
|
1502
|
+
* @summary: Retrieve all collections.
|
|
1503
|
+
* @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/).
|
|
1502
1504
|
*/
|
|
1503
1505
|
async getAllCollections(
|
|
1504
1506
|
{
|
|
@@ -1598,6 +1600,61 @@ class Catalog {
|
|
|
1598
1600
|
return response;
|
|
1599
1601
|
}
|
|
1600
1602
|
|
|
1603
|
+
/**
|
|
1604
|
+
* @param {Object} arg - Arg object.
|
|
1605
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
1606
|
+
* a particular seller account.
|
|
1607
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
1608
|
+
* identifier for a particular sale channel.
|
|
1609
|
+
* @param {string} [arg.q] - Get collection list filtered by q string,
|
|
1610
|
+
* @param {string} [arg.scheduleStatus] - Get collection list filtered by
|
|
1611
|
+
* scheduled status,
|
|
1612
|
+
* @param {string} [arg.type] - Type of the collections
|
|
1613
|
+
* @param {string[]} [arg.tags] - Each response will contain next_id param,
|
|
1614
|
+
* which should be sent back to make pagination work.
|
|
1615
|
+
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
1616
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1617
|
+
* page. Default is 12.
|
|
1618
|
+
* @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponse>}
|
|
1619
|
+
* @summary: Retrieve all collections.
|
|
1620
|
+
* @description: A Collection allows you to organize your products into hierarchical groups.
|
|
1621
|
+
*/
|
|
1622
|
+
getAllCollectionsPaginator({
|
|
1623
|
+
companyId,
|
|
1624
|
+
applicationId,
|
|
1625
|
+
q,
|
|
1626
|
+
scheduleStatus,
|
|
1627
|
+
type,
|
|
1628
|
+
tags,
|
|
1629
|
+
isActive,
|
|
1630
|
+
pageSize,
|
|
1631
|
+
} = {}) {
|
|
1632
|
+
const paginator = new Paginator();
|
|
1633
|
+
const callback = async () => {
|
|
1634
|
+
const pageId = paginator.nextId;
|
|
1635
|
+
const pageNo = paginator.pageNo;
|
|
1636
|
+
const pageType = "number";
|
|
1637
|
+
const data = await this.getAllCollections({
|
|
1638
|
+
companyId: companyId,
|
|
1639
|
+
applicationId: applicationId,
|
|
1640
|
+
q: q,
|
|
1641
|
+
scheduleStatus: scheduleStatus,
|
|
1642
|
+
type: type,
|
|
1643
|
+
tags: tags,
|
|
1644
|
+
isActive: isActive,
|
|
1645
|
+
pageNo: pageNo,
|
|
1646
|
+
pageSize: pageSize,
|
|
1647
|
+
});
|
|
1648
|
+
paginator.setPaginator({
|
|
1649
|
+
hasNext: data.page.has_next ? true : false,
|
|
1650
|
+
nextId: data.page.next_id,
|
|
1651
|
+
});
|
|
1652
|
+
return data;
|
|
1653
|
+
};
|
|
1654
|
+
paginator.setCallback(callback.bind(this));
|
|
1655
|
+
return paginator;
|
|
1656
|
+
}
|
|
1657
|
+
|
|
1601
1658
|
/**
|
|
1602
1659
|
* @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
|
|
1603
1660
|
* - Arg object
|
|
@@ -1606,7 +1663,7 @@ class Catalog {
|
|
|
1606
1663
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1607
1664
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
|
|
1608
1665
|
* @name getAllSearchKeyword
|
|
1609
|
-
* @summary:
|
|
1666
|
+
* @summary: Get all search keywords.
|
|
1610
1667
|
* @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/).
|
|
1611
1668
|
*/
|
|
1612
1669
|
async getAllSearchKeyword(
|
|
@@ -1760,8 +1817,8 @@ class Catalog {
|
|
|
1760
1817
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1761
1818
|
* @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
|
|
1762
1819
|
* @name getAppInventory
|
|
1763
|
-
* @summary: Get
|
|
1764
|
-
* @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
|
|
1820
|
+
* @summary: Get application inventory.
|
|
1821
|
+
* @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/).
|
|
1765
1822
|
*/
|
|
1766
1823
|
async getAppInventory(
|
|
1767
1824
|
{
|
|
@@ -1867,8 +1924,8 @@ class Catalog {
|
|
|
1867
1924
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1868
1925
|
* @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
|
|
1869
1926
|
* @name getAppLocations
|
|
1870
|
-
* @summary: Get
|
|
1871
|
-
* @description:
|
|
1927
|
+
* @summary: Get application locations.
|
|
1928
|
+
* @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/).
|
|
1872
1929
|
*/
|
|
1873
1930
|
async getAppLocations(
|
|
1874
1931
|
{
|
|
@@ -1989,8 +2046,8 @@ class Catalog {
|
|
|
1989
2046
|
* @param {string[]} [arg.tags] - Get locations filtered by tags.
|
|
1990
2047
|
* @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
|
|
1991
2048
|
* @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
|
|
1992
|
-
* @summary: Get
|
|
1993
|
-
* @description:
|
|
2049
|
+
* @summary: Get application locations.
|
|
2050
|
+
* @description: Retrieve locations specific to the application. View all the locations asscoiated to a application.
|
|
1994
2051
|
*/
|
|
1995
2052
|
getAppLocationsPaginator({
|
|
1996
2053
|
companyId,
|
|
@@ -2036,7 +2093,7 @@ class Catalog {
|
|
|
2036
2093
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2037
2094
|
* @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
|
|
2038
2095
|
* @name getAppProduct
|
|
2039
|
-
* @summary:
|
|
2096
|
+
* @summary: Retrieve application product data.
|
|
2040
2097
|
* @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/).
|
|
2041
2098
|
*/
|
|
2042
2099
|
async getAppProduct(
|
|
@@ -2116,8 +2173,8 @@ class Catalog {
|
|
|
2116
2173
|
* @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
|
|
2117
2174
|
* Success response
|
|
2118
2175
|
* @name getAppProducts
|
|
2119
|
-
* @summary: Get
|
|
2120
|
-
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
|
|
2176
|
+
* @summary: Get application products.
|
|
2177
|
+
* @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/).
|
|
2121
2178
|
*/
|
|
2122
2179
|
async getAppProducts(
|
|
2123
2180
|
{
|
|
@@ -2221,6 +2278,64 @@ class Catalog {
|
|
|
2221
2278
|
return response;
|
|
2222
2279
|
}
|
|
2223
2280
|
|
|
2281
|
+
/**
|
|
2282
|
+
* @param {Object} arg - Arg object.
|
|
2283
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
2284
|
+
* a particular seller account.
|
|
2285
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
2286
|
+
* identifier for a particular sale channel.
|
|
2287
|
+
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
2288
|
+
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
2289
|
+
* Category Ids
|
|
2290
|
+
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
2291
|
+
* Department Ids
|
|
2292
|
+
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
2293
|
+
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
2294
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
2295
|
+
* page. Default is 10.
|
|
2296
|
+
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
2297
|
+
* @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
|
|
2298
|
+
* @summary: Get application products.
|
|
2299
|
+
* @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.
|
|
2300
|
+
*/
|
|
2301
|
+
getAppProductsPaginator({
|
|
2302
|
+
companyId,
|
|
2303
|
+
applicationId,
|
|
2304
|
+
brandIds,
|
|
2305
|
+
categoryIds,
|
|
2306
|
+
departmentIds,
|
|
2307
|
+
tags,
|
|
2308
|
+
itemIds,
|
|
2309
|
+
pageSize,
|
|
2310
|
+
q,
|
|
2311
|
+
} = {}) {
|
|
2312
|
+
const paginator = new Paginator();
|
|
2313
|
+
const callback = async () => {
|
|
2314
|
+
const pageId = paginator.nextId;
|
|
2315
|
+
const pageNo = paginator.pageNo;
|
|
2316
|
+
const pageType = "number";
|
|
2317
|
+
const data = await this.getAppProducts({
|
|
2318
|
+
companyId: companyId,
|
|
2319
|
+
applicationId: applicationId,
|
|
2320
|
+
brandIds: brandIds,
|
|
2321
|
+
categoryIds: categoryIds,
|
|
2322
|
+
departmentIds: departmentIds,
|
|
2323
|
+
tags: tags,
|
|
2324
|
+
itemIds: itemIds,
|
|
2325
|
+
pageNo: pageNo,
|
|
2326
|
+
pageSize: pageSize,
|
|
2327
|
+
q: q,
|
|
2328
|
+
});
|
|
2329
|
+
paginator.setPaginator({
|
|
2330
|
+
hasNext: data.page.has_next ? true : false,
|
|
2331
|
+
nextId: data.page.next_id,
|
|
2332
|
+
});
|
|
2333
|
+
return data;
|
|
2334
|
+
};
|
|
2335
|
+
paginator.setCallback(callback.bind(this));
|
|
2336
|
+
return paginator;
|
|
2337
|
+
}
|
|
2338
|
+
|
|
2224
2339
|
/**
|
|
2225
2340
|
* @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
|
|
2226
2341
|
* - Arg object
|
|
@@ -2308,8 +2423,8 @@ class Catalog {
|
|
|
2308
2423
|
* - Success response
|
|
2309
2424
|
*
|
|
2310
2425
|
* @name getAppicationProducts
|
|
2311
|
-
* @summary:
|
|
2312
|
-
* @description: List all the products associated with a brand, collection or category in a requested sort order.
|
|
2426
|
+
* @summary: Get application products.
|
|
2427
|
+
* @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/).
|
|
2313
2428
|
*/
|
|
2314
2429
|
async getAppicationProducts(
|
|
2315
2430
|
{
|
|
@@ -2452,8 +2567,8 @@ class Catalog {
|
|
|
2452
2567
|
* page. Default is 12.
|
|
2453
2568
|
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
2454
2569
|
* @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
|
|
2455
|
-
* @summary:
|
|
2456
|
-
* @description: List all the products associated with a brand, collection or category in a requested sort order.
|
|
2570
|
+
* @summary: Get application products.
|
|
2571
|
+
* @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
|
|
2457
2572
|
*/
|
|
2458
2573
|
getAppicationProductsPaginator({
|
|
2459
2574
|
companyId,
|
|
@@ -2505,8 +2620,8 @@ class Catalog {
|
|
|
2505
2620
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2506
2621
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2507
2622
|
* @name getApplicationBrandListing
|
|
2508
|
-
* @summary:
|
|
2509
|
-
* @description:
|
|
2623
|
+
* @summary: Get application brand listing.
|
|
2624
|
+
* @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/).
|
|
2510
2625
|
*/
|
|
2511
2626
|
async getApplicationBrandListing(
|
|
2512
2627
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2596,8 +2711,8 @@ class Catalog {
|
|
|
2596
2711
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2597
2712
|
* to search brands by brand name.
|
|
2598
2713
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2599
|
-
* @summary:
|
|
2600
|
-
* @description:
|
|
2714
|
+
* @summary: Get application brand listing.
|
|
2715
|
+
* @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold
|
|
2601
2716
|
*/
|
|
2602
2717
|
getApplicationBrandListingPaginator({
|
|
2603
2718
|
companyId,
|
|
@@ -2635,8 +2750,8 @@ class Catalog {
|
|
|
2635
2750
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2636
2751
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2637
2752
|
* @name getApplicationBrands
|
|
2638
|
-
* @summary:
|
|
2639
|
-
* @description: A brand is the name under which a product is being sold.
|
|
2753
|
+
* @summary: Get application brands.
|
|
2754
|
+
* @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/).
|
|
2640
2755
|
*/
|
|
2641
2756
|
async getApplicationBrands(
|
|
2642
2757
|
{ department, pageNo, pageSize, q, brandId, requestHeaders } = {
|
|
@@ -2740,8 +2855,8 @@ class Catalog {
|
|
|
2740
2855
|
* @param {number[]} [arg.brandId] - Helps to sort the brands list on the
|
|
2741
2856
|
* basis of uid list.
|
|
2742
2857
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2743
|
-
* @summary:
|
|
2744
|
-
* @description: A brand is the name under which a product is being sold.
|
|
2858
|
+
* @summary: Get application brands.
|
|
2859
|
+
* @description: List all the brands. A brand is the name under which a product is being sold.
|
|
2745
2860
|
*/
|
|
2746
2861
|
getApplicationBrandsPaginator({
|
|
2747
2862
|
companyId,
|
|
@@ -2783,8 +2898,8 @@ class Catalog {
|
|
|
2783
2898
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2784
2899
|
* @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
|
|
2785
2900
|
* @name getApplicationCategoryListing
|
|
2786
|
-
* @summary:
|
|
2787
|
-
* @description: A brand is the name under which a product is being sold.
|
|
2901
|
+
* @summary: Get application category listing.
|
|
2902
|
+
* @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/).
|
|
2788
2903
|
*/
|
|
2789
2904
|
async getApplicationCategoryListing(
|
|
2790
2905
|
{ departmentId, pageNo, pageSize, q, requestHeaders } = {
|
|
@@ -2881,8 +2996,8 @@ class Catalog {
|
|
|
2881
2996
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
2882
2997
|
* to search brands by brand name.
|
|
2883
2998
|
* @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
|
|
2884
|
-
* @summary:
|
|
2885
|
-
* @description: A brand is the name under which a product is being sold.
|
|
2999
|
+
* @summary: Get application category listing.
|
|
3000
|
+
* @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold.
|
|
2886
3001
|
*/
|
|
2887
3002
|
getApplicationCategoryListingPaginator({
|
|
2888
3003
|
companyId,
|
|
@@ -2924,8 +3039,8 @@ class Catalog {
|
|
|
2924
3039
|
* - Success response
|
|
2925
3040
|
*
|
|
2926
3041
|
* @name getApplicationDepartmentListing
|
|
2927
|
-
* @summary:
|
|
2928
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
3042
|
+
* @summary: Get application department listing.
|
|
3043
|
+
* @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/).
|
|
2929
3044
|
*/
|
|
2930
3045
|
async getApplicationDepartmentListing(
|
|
2931
3046
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3015,8 +3130,8 @@ class Catalog {
|
|
|
3015
3130
|
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
3016
3131
|
* to search department by name.
|
|
3017
3132
|
* @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
|
|
3018
|
-
* @summary:
|
|
3019
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
3133
|
+
* @summary: Get application department listing.
|
|
3134
|
+
* @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
3020
3135
|
*/
|
|
3021
3136
|
getApplicationDepartmentListingPaginator({
|
|
3022
3137
|
companyId,
|
|
@@ -3237,7 +3352,7 @@ class Catalog {
|
|
|
3237
3352
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
3238
3353
|
* Success response
|
|
3239
3354
|
* @name getAutocompleteConfig
|
|
3240
|
-
* @summary:
|
|
3355
|
+
* @summary: Get autocomplete configuration.
|
|
3241
3356
|
* @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/).
|
|
3242
3357
|
*/
|
|
3243
3358
|
async getAutocompleteConfig(
|
|
@@ -3315,8 +3430,8 @@ class Catalog {
|
|
|
3315
3430
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
3316
3431
|
* Success response
|
|
3317
3432
|
* @name getAutocompleteKeywordDetail
|
|
3318
|
-
* @summary: Get
|
|
3319
|
-
* @description:
|
|
3433
|
+
* @summary: Get autocomplete keyword details.
|
|
3434
|
+
* @description: Retrieve detailed information about a specific autocomplete keyword. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
|
|
3320
3435
|
*/
|
|
3321
3436
|
async getAutocompleteKeywordDetail(
|
|
3322
3437
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3398,8 +3513,8 @@ class Catalog {
|
|
|
3398
3513
|
* - Success response
|
|
3399
3514
|
*
|
|
3400
3515
|
* @name getCatalogConfiguration
|
|
3401
|
-
* @summary:
|
|
3402
|
-
* @description: configuration meta
|
|
3516
|
+
* @summary: Retrieve catalog configuration.
|
|
3517
|
+
* @description: Retrieve configuration meta details for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
|
|
3403
3518
|
*/
|
|
3404
3519
|
async getCatalogConfiguration(
|
|
3405
3520
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3475,8 +3590,8 @@ class Catalog {
|
|
|
3475
3590
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3476
3591
|
* @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
|
|
3477
3592
|
* @name getCatalogInsights
|
|
3478
|
-
* @summary:
|
|
3479
|
-
* @description:
|
|
3593
|
+
* @summary: Get catalog insights.
|
|
3594
|
+
* @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/).
|
|
3480
3595
|
*/
|
|
3481
3596
|
async getCatalogInsights(
|
|
3482
3597
|
{ brand, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3555,8 +3670,8 @@ class Catalog {
|
|
|
3555
3670
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3556
3671
|
* @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
|
|
3557
3672
|
* @name getCategories
|
|
3558
|
-
* @summary:
|
|
3559
|
-
* @description:
|
|
3673
|
+
* @summary: Get categories.
|
|
3674
|
+
* @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/).
|
|
3560
3675
|
*/
|
|
3561
3676
|
async getCategories(
|
|
3562
3677
|
{ department, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3638,8 +3753,8 @@ class Catalog {
|
|
|
3638
3753
|
* @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
|
|
3639
3754
|
* Success response
|
|
3640
3755
|
* @name getCollectionDetail
|
|
3641
|
-
* @summary: Get
|
|
3642
|
-
* @description: Get the details of a collection by its
|
|
3756
|
+
* @summary: Get collection details.
|
|
3757
|
+
* @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
|
|
3643
3758
|
*/
|
|
3644
3759
|
async getCollectionDetail(
|
|
3645
3760
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3769,7 +3884,7 @@ class Catalog {
|
|
|
3769
3884
|
const response = await PlatformAPIClient.execute(
|
|
3770
3885
|
this.config,
|
|
3771
3886
|
"get",
|
|
3772
|
-
`/service/platform/catalog/
|
|
3887
|
+
`/service/platform/catalog/v2.0/company/${this.config.companyId}/application/${this.applicationId}/collections/${id}/items/`,
|
|
3773
3888
|
query_params,
|
|
3774
3889
|
undefined,
|
|
3775
3890
|
requestHeaders,
|
|
@@ -3812,8 +3927,8 @@ class Catalog {
|
|
|
3812
3927
|
* - Success response
|
|
3813
3928
|
*
|
|
3814
3929
|
* @name getConfigurationByType
|
|
3815
|
-
* @summary:
|
|
3816
|
-
* @description:
|
|
3930
|
+
* @summary: Retrieve configuration by type.
|
|
3931
|
+
* @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/).
|
|
3817
3932
|
*/
|
|
3818
3933
|
async getConfigurationByType(
|
|
3819
3934
|
{ type, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3894,8 +4009,8 @@ class Catalog {
|
|
|
3894
4009
|
* @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
|
|
3895
4010
|
* Success response
|
|
3896
4011
|
* @name getConfigurationMetadata
|
|
3897
|
-
* @summary:
|
|
3898
|
-
* @description:
|
|
4012
|
+
* @summary: Retrieve configuration metadata.
|
|
4013
|
+
* @description: Retrieve the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
|
|
3899
4014
|
*/
|
|
3900
4015
|
async getConfigurationMetadata(
|
|
3901
4016
|
{ configType, templateSlug, pageNo, pageSize, q, requestHeaders } = {
|
|
@@ -3990,8 +4105,8 @@ class Catalog {
|
|
|
3990
4105
|
* @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
|
|
3991
4106
|
* Success response
|
|
3992
4107
|
* @name getConfigurations
|
|
3993
|
-
* @summary:
|
|
3994
|
-
* @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
4108
|
+
* @summary: Retrieve configurations.
|
|
4109
|
+
* @description: Retrieve a configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
|
|
3995
4110
|
*/
|
|
3996
4111
|
async getConfigurations(
|
|
3997
4112
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4065,8 +4180,8 @@ class Catalog {
|
|
|
4065
4180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4066
4181
|
* @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
|
|
4067
4182
|
* @name getDepartments
|
|
4068
|
-
* @summary:
|
|
4069
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments.
|
|
4183
|
+
* @summary: Get departments.
|
|
4184
|
+
* @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/).
|
|
4070
4185
|
*/
|
|
4071
4186
|
async getDepartments(
|
|
4072
4187
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4144,8 +4259,8 @@ class Catalog {
|
|
|
4144
4259
|
* - Success response
|
|
4145
4260
|
*
|
|
4146
4261
|
* @name getDiscountedInventoryBySizeIdentifier
|
|
4147
|
-
* @summary: Get
|
|
4148
|
-
* @description:
|
|
4262
|
+
* @summary: Get discounted inventory by size identifier.
|
|
4263
|
+
* @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/).
|
|
4149
4264
|
*/
|
|
4150
4265
|
async getDiscountedInventoryBySizeIdentifier(
|
|
4151
4266
|
{
|
|
@@ -4239,6 +4354,56 @@ class Catalog {
|
|
|
4239
4354
|
return response;
|
|
4240
4355
|
}
|
|
4241
4356
|
|
|
4357
|
+
/**
|
|
4358
|
+
* @param {Object} arg - Arg object.
|
|
4359
|
+
* @param {number} arg.companyId - Id of the company associated to product
|
|
4360
|
+
* that is to be viewed.
|
|
4361
|
+
* @param {string} arg.applicationId - Uniquer Application ID.
|
|
4362
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
4363
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
4364
|
+
* or Primary Identifier) of which inventory is to get.
|
|
4365
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
4366
|
+
* page. Default is 12.
|
|
4367
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
4368
|
+
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
4369
|
+
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
4370
|
+
* @summary: Get discounted inventory by size identifier.
|
|
4371
|
+
* @description: Allows to retrieve Inventory data for particular company grouped by size and store.
|
|
4372
|
+
*/
|
|
4373
|
+
getDiscountedInventoryBySizeIdentifierPaginator({
|
|
4374
|
+
companyId,
|
|
4375
|
+
applicationId,
|
|
4376
|
+
itemId,
|
|
4377
|
+
sizeIdentifier,
|
|
4378
|
+
pageSize,
|
|
4379
|
+
q,
|
|
4380
|
+
locationIds,
|
|
4381
|
+
} = {}) {
|
|
4382
|
+
const paginator = new Paginator();
|
|
4383
|
+
const callback = async () => {
|
|
4384
|
+
const pageId = paginator.nextId;
|
|
4385
|
+
const pageNo = paginator.pageNo;
|
|
4386
|
+
const pageType = "number";
|
|
4387
|
+
const data = await this.getDiscountedInventoryBySizeIdentifier({
|
|
4388
|
+
companyId: companyId,
|
|
4389
|
+
applicationId: applicationId,
|
|
4390
|
+
itemId: itemId,
|
|
4391
|
+
sizeIdentifier: sizeIdentifier,
|
|
4392
|
+
pageNo: pageNo,
|
|
4393
|
+
pageSize: pageSize,
|
|
4394
|
+
q: q,
|
|
4395
|
+
locationIds: locationIds,
|
|
4396
|
+
});
|
|
4397
|
+
paginator.setPaginator({
|
|
4398
|
+
hasNext: data.page.has_next ? true : false,
|
|
4399
|
+
nextId: data.page.next_id,
|
|
4400
|
+
});
|
|
4401
|
+
return data;
|
|
4402
|
+
};
|
|
4403
|
+
paginator.setCallback(callback.bind(this));
|
|
4404
|
+
return paginator;
|
|
4405
|
+
}
|
|
4406
|
+
|
|
4242
4407
|
/**
|
|
4243
4408
|
* @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
|
|
4244
4409
|
* - Arg object
|
|
@@ -4247,8 +4412,8 @@ class Catalog {
|
|
|
4247
4412
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4248
4413
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
4249
4414
|
* @name getGroupConfigurations
|
|
4250
|
-
* @summary:
|
|
4251
|
-
* @description:
|
|
4415
|
+
* @summary: Retrieve group configurations.
|
|
4416
|
+
* @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/).
|
|
4252
4417
|
*/
|
|
4253
4418
|
async getGroupConfigurations(
|
|
4254
4419
|
{ configType, pageNo, pageSize, search, templateSlug, requestHeaders } = {
|
|
@@ -4342,8 +4507,8 @@ class Catalog {
|
|
|
4342
4507
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4343
4508
|
* @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
|
|
4344
4509
|
* @name getListingConfigurations
|
|
4345
|
-
* @summary:
|
|
4346
|
-
* @description:
|
|
4510
|
+
* @summary: Retrieve listing configurations.
|
|
4511
|
+
* @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/).
|
|
4347
4512
|
*/
|
|
4348
4513
|
async getListingConfigurations(
|
|
4349
4514
|
{ configType, pageNo, pageSize, search, requestHeaders } = {
|
|
@@ -4434,8 +4599,8 @@ class Catalog {
|
|
|
4434
4599
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4435
4600
|
* @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
|
|
4436
4601
|
* @name getProductDetailBySlug
|
|
4437
|
-
* @summary: Get
|
|
4438
|
-
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
|
|
4602
|
+
* @summary: Get product details by slug.
|
|
4603
|
+
* @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/).
|
|
4439
4604
|
*/
|
|
4440
4605
|
async getProductDetailBySlug(
|
|
4441
4606
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4513,8 +4678,8 @@ class Catalog {
|
|
|
4513
4678
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4514
4679
|
* @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
|
|
4515
4680
|
* @name getQueryFilters
|
|
4516
|
-
* @summary:
|
|
4517
|
-
* @description:
|
|
4681
|
+
* @summary: Retrieve query filters.
|
|
4682
|
+
* @description: Retrieve query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
|
|
4518
4683
|
*/
|
|
4519
4684
|
async getQueryFilters(
|
|
4520
4685
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4592,8 +4757,8 @@ class Catalog {
|
|
|
4592
4757
|
* - Success response
|
|
4593
4758
|
*
|
|
4594
4759
|
* @name getSearchConfiguration
|
|
4595
|
-
* @summary:
|
|
4596
|
-
* @description:
|
|
4760
|
+
* @summary: Get Search Configuration
|
|
4761
|
+
* @description: Get search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
|
|
4597
4762
|
*/
|
|
4598
4763
|
async getSearchConfiguration(
|
|
4599
4764
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4670,8 +4835,8 @@ class Catalog {
|
|
|
4670
4835
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
|
|
4671
4836
|
* Success response
|
|
4672
4837
|
* @name getSearchKeywords
|
|
4673
|
-
* @summary:
|
|
4674
|
-
* @description:
|
|
4838
|
+
* @summary: Retrieve search keywords.
|
|
4839
|
+
* @description: Retrieve a list of search keywords from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
|
|
4675
4840
|
*/
|
|
4676
4841
|
async getSearchKeywords(
|
|
4677
4842
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4751,8 +4916,8 @@ class Catalog {
|
|
|
4751
4916
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4752
4917
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
4753
4918
|
* @name updateAllowSingle
|
|
4754
|
-
* @summary: Update
|
|
4755
|
-
* @description:
|
|
4919
|
+
* @summary: Update 'Allow Single' setting.
|
|
4920
|
+
* @description: Modify allow single flag for filters of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
|
|
4756
4921
|
*/
|
|
4757
4922
|
async updateAllowSingle(
|
|
4758
4923
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4830,8 +4995,8 @@ class Catalog {
|
|
|
4830
4995
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4831
4996
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
4832
4997
|
* @name updateAppBrand
|
|
4833
|
-
* @summary: Update
|
|
4834
|
-
* @description:
|
|
4998
|
+
* @summary: Update application brand.
|
|
4999
|
+
* @description: Modify data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
|
|
4835
5000
|
*/
|
|
4836
5001
|
async updateAppBrand(
|
|
4837
5002
|
{ brandUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4913,8 +5078,8 @@ class Catalog {
|
|
|
4913
5078
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4914
5079
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
4915
5080
|
* @name updateAppCategory
|
|
4916
|
-
* @summary: Update
|
|
4917
|
-
* @description:
|
|
5081
|
+
* @summary: Update application category.
|
|
5082
|
+
* @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/).
|
|
4918
5083
|
*/
|
|
4919
5084
|
async updateAppCategory(
|
|
4920
5085
|
{ categoryUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5077,8 +5242,8 @@ class Catalog {
|
|
|
5077
5242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5078
5243
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5079
5244
|
* @name updateAppDepartment
|
|
5080
|
-
* @summary: Update
|
|
5081
|
-
* @description:
|
|
5245
|
+
* @summary: Update application department.
|
|
5246
|
+
* @description: Modify department data related to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
|
|
5082
5247
|
*/
|
|
5083
5248
|
async updateAppDepartment(
|
|
5084
5249
|
{ departmentUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5160,8 +5325,8 @@ class Catalog {
|
|
|
5160
5325
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5161
5326
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5162
5327
|
* @name updateAppLocation
|
|
5163
|
-
* @summary: Update
|
|
5164
|
-
* @description:
|
|
5328
|
+
* @summary: Update application location.
|
|
5329
|
+
* @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/).
|
|
5165
5330
|
*/
|
|
5166
5331
|
async updateAppLocation(
|
|
5167
5332
|
{ storeUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5241,8 +5406,8 @@ class Catalog {
|
|
|
5241
5406
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5242
5407
|
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
5243
5408
|
* @name updateAppProduct
|
|
5244
|
-
* @summary: Update
|
|
5245
|
-
* @description:
|
|
5409
|
+
* @summary: Update application product data.
|
|
5410
|
+
* @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/).
|
|
5246
5411
|
*/
|
|
5247
5412
|
async updateAppProduct(
|
|
5248
5413
|
{ itemId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5406,7 +5571,7 @@ class Catalog {
|
|
|
5406
5571
|
* @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
|
|
5407
5572
|
* Success response
|
|
5408
5573
|
* @name updateAutocompleteKeyword
|
|
5409
|
-
* @summary:
|
|
5574
|
+
* @summary: Update autocomplete keywords.
|
|
5410
5575
|
* @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/).
|
|
5411
5576
|
*/
|
|
5412
5577
|
async updateAutocompleteKeyword(
|
|
@@ -5570,8 +5735,8 @@ class Catalog {
|
|
|
5570
5735
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5571
5736
|
* @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
|
|
5572
5737
|
* @name updateDefaultSort
|
|
5573
|
-
* @summary: Update
|
|
5574
|
-
* @description:
|
|
5738
|
+
* @summary: Update default sorting.
|
|
5739
|
+
* @description: Modify the default sort key configuration for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
|
|
5575
5740
|
*/
|
|
5576
5741
|
async updateDefaultSort(
|
|
5577
5742
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5651,8 +5816,8 @@ class Catalog {
|
|
|
5651
5816
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5652
5817
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
|
|
5653
5818
|
* @name updateGroupConfiguration
|
|
5654
|
-
* @summary: Update
|
|
5655
|
-
* @description:
|
|
5819
|
+
* @summary: Update group configuration.
|
|
5820
|
+
* @description: Modify the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
|
|
5656
5821
|
*/
|
|
5657
5822
|
async updateGroupConfiguration(
|
|
5658
5823
|
{ configType, groupSlug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5736,8 +5901,8 @@ class Catalog {
|
|
|
5736
5901
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5737
5902
|
* @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
|
|
5738
5903
|
* @name updateListingConfiguration
|
|
5739
|
-
* @summary: Update configuration
|
|
5740
|
-
* @description:
|
|
5904
|
+
* @summary: Update listing configuration.
|
|
5905
|
+
* @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/).
|
|
5741
5906
|
*/
|
|
5742
5907
|
async updateListingConfiguration(
|
|
5743
5908
|
{ configType, configId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5904,7 +6069,7 @@ class Catalog {
|
|
|
5904
6069
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5905
6070
|
* @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
|
|
5906
6071
|
* @name updateSearchKeywords
|
|
5907
|
-
* @summary: Update
|
|
6072
|
+
* @summary: Update search keywords.
|
|
5908
6073
|
* @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/).
|
|
5909
6074
|
*/
|
|
5910
6075
|
async updateSearchKeywords(
|