@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
- package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -2,217 +2,214 @@ export = Catalog;
|
|
|
2
2
|
declare class Catalog {
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
|
-
/**
|
|
6
|
-
* @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
|
|
7
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
10
|
-
* @name addInventory
|
|
11
|
-
* @summary: Create Inventory
|
|
12
|
-
* @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
|
|
13
|
-
*/
|
|
14
|
-
addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
15
5
|
/**
|
|
16
6
|
* @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
|
|
17
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
9
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
20
10
|
* @name allSizes
|
|
21
|
-
* @summary: Get product sizes
|
|
11
|
+
* @summary: Get all product sizes.
|
|
22
12
|
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
|
|
23
13
|
*/
|
|
24
14
|
allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
|
|
25
|
-
/**
|
|
26
|
-
* @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
|
|
27
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
-
* @returns {Promise<CatalogPlatformModel.BulkHsnResponseSchema>} - Success response
|
|
30
|
-
* @name bulkHsnCode
|
|
31
|
-
* @summary: Create Bulk update HSN
|
|
32
|
-
* @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
|
|
33
|
-
*/
|
|
34
|
-
bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
|
|
35
15
|
/**
|
|
36
16
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
37
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
19
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
40
20
|
* @name createBulkInventory
|
|
41
|
-
* @summary: Create bulk inventory
|
|
21
|
+
* @summary: Create bulk inventory.
|
|
42
22
|
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
|
|
43
23
|
*/
|
|
44
|
-
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
24
|
+
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
45
25
|
/**
|
|
46
26
|
* @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
|
|
47
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
29
|
+
* @returns {Promise<CatalogPlatformModel.InventoryBulkResponse>} - Success response
|
|
50
30
|
* @name createBulkInventoryJob
|
|
51
|
-
* @summary: Create bulk inventory upload job
|
|
31
|
+
* @summary: Create bulk inventory upload job.
|
|
52
32
|
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
53
33
|
*/
|
|
54
|
-
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
34
|
+
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryBulkResponse>;
|
|
55
35
|
/**
|
|
56
36
|
* @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
|
|
57
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
39
|
+
* @returns {Promise<CatalogPlatformModel.ProductBulkResponse>} - Success response
|
|
60
40
|
* @name createBulkProductUploadJob
|
|
61
|
-
* @summary: Create
|
|
41
|
+
* @summary: Create a Bulk product to upload job.
|
|
62
42
|
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
|
|
63
43
|
*/
|
|
64
|
-
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
44
|
+
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
|
|
65
45
|
/**
|
|
66
|
-
* @param {CatalogPlatformValidator.
|
|
46
|
+
* @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
|
|
67
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
49
|
+
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
50
|
+
* @name createCategories
|
|
51
|
+
* @summary: Create categories.
|
|
52
|
+
* @description: Lets user create product categories on for the seller on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
53
|
+
*/
|
|
54
|
+
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
|
|
57
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
70
60
|
* Success response
|
|
61
|
+
* @name createDepartments
|
|
62
|
+
* @summary: Create departments.
|
|
63
|
+
* @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
64
|
+
*/
|
|
65
|
+
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
66
|
+
/**
|
|
67
|
+
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
68
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
71
71
|
* @name createInventoryExport
|
|
72
|
-
* @summary: Create inventory export
|
|
73
|
-
* @description:
|
|
72
|
+
* @summary: Create inventory export.
|
|
73
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
74
74
|
*/
|
|
75
|
-
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
75
|
+
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
|
|
78
78
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
81
|
-
* Success response
|
|
80
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
|
|
82
81
|
* @name createInventoryExportJob
|
|
83
|
-
* @summary: Create inventory export job
|
|
82
|
+
* @summary: Create inventory export job.
|
|
84
83
|
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
85
84
|
*/
|
|
86
|
-
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
85
|
+
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
|
|
87
86
|
/**
|
|
88
87
|
* @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
|
|
89
88
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
90
|
+
* @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>}
|
|
92
91
|
* - Success response
|
|
93
92
|
*
|
|
94
93
|
* @name createMarketplaceOptin
|
|
95
|
-
* @summary:
|
|
96
|
-
* @description:
|
|
94
|
+
* @summary: Update marketplace optin
|
|
95
|
+
* @description: This API allows to create marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
|
|
97
96
|
*/
|
|
98
|
-
createMarketplaceOptin({
|
|
97
|
+
createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>;
|
|
99
98
|
/**
|
|
100
99
|
* @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
|
|
101
100
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
102
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
|
|
104
103
|
* @name createProduct
|
|
105
|
-
* @summary: Create product
|
|
106
|
-
* @description:
|
|
104
|
+
* @summary: Create a product.
|
|
105
|
+
* @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
|
|
107
106
|
*/
|
|
108
|
-
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
107
|
+
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
|
|
109
108
|
/**
|
|
110
109
|
* @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
|
|
111
110
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
111
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
113
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
112
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
114
113
|
* @name createProductAssetsInBulk
|
|
115
|
-
* @summary: Create product assets in bulk
|
|
114
|
+
* @summary: Create product assets in bulk.
|
|
116
115
|
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
117
116
|
*/
|
|
118
|
-
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
117
|
+
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
119
118
|
/**
|
|
120
119
|
* @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
|
|
121
120
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
121
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
122
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
124
123
|
* - Success response
|
|
125
124
|
*
|
|
126
125
|
* @name createProductBundle
|
|
127
|
-
* @summary: Create product bundle
|
|
128
|
-
* @description: Create product bundle in the catalog
|
|
126
|
+
* @summary: Create a product bundle.
|
|
127
|
+
* @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
129
128
|
*/
|
|
130
|
-
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
129
|
+
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
131
130
|
/**
|
|
132
131
|
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
133
132
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
134
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
135
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
134
|
+
* @returns {Promise<CatalogPlatformModel.CreateProductDownloadsResponse>}
|
|
136
135
|
* - Success response
|
|
137
136
|
*
|
|
138
137
|
* @name createProductExportJob
|
|
139
|
-
* @summary: Create product export job
|
|
140
|
-
* @description:
|
|
138
|
+
* @summary: Create product export job.
|
|
139
|
+
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
141
140
|
*/
|
|
142
|
-
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
141
|
+
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateProductDownloadsResponse>;
|
|
143
142
|
/**
|
|
144
143
|
* @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
|
|
145
144
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
146
145
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
146
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
148
147
|
* @name createProductsInBulk
|
|
149
|
-
* @summary: Create products in bulk
|
|
148
|
+
* @summary: Create products in bulk.
|
|
150
149
|
* @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
|
|
151
150
|
*/
|
|
152
|
-
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
151
|
+
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
153
152
|
/**
|
|
154
153
|
* @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
|
|
155
154
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
156
155
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
157
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
156
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
158
157
|
* @name createSizeGuide
|
|
159
|
-
* @summary: Create size guide
|
|
160
|
-
* @description: Allows to create a size guide associated to a
|
|
158
|
+
* @summary: Create a size guide.
|
|
159
|
+
* @description: Allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
161
160
|
*/
|
|
162
|
-
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
161
|
+
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
163
162
|
/**
|
|
164
163
|
* @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
|
|
165
164
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
165
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
166
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
168
167
|
* @name deleteBulkInventoryJob
|
|
169
|
-
* @summary: Delete inventory bulk upload job
|
|
168
|
+
* @summary: Delete inventory bulk upload job.
|
|
170
169
|
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
171
170
|
*/
|
|
172
|
-
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
171
|
+
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
173
172
|
/**
|
|
174
173
|
* @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
|
|
175
174
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
176
175
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
177
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
176
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
178
177
|
* @name deleteProduct
|
|
179
|
-
* @summary: Delete product
|
|
180
|
-
* @description:
|
|
178
|
+
* @summary: Delete a product.
|
|
179
|
+
* @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
181
180
|
*/
|
|
182
|
-
deleteProduct({ itemId,
|
|
181
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
183
182
|
/**
|
|
184
183
|
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
185
184
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
185
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
186
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
188
187
|
* @name deleteProductBulkJob
|
|
189
|
-
* @summary: Delete product bulk
|
|
188
|
+
* @summary: Delete product bulk upload job.
|
|
190
189
|
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
191
190
|
*/
|
|
192
|
-
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
191
|
+
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
193
192
|
/**
|
|
194
193
|
* @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
|
|
195
194
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
196
195
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
197
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
198
|
-
* Success response
|
|
196
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
199
197
|
* @name deleteRealtimeInventory
|
|
200
|
-
* @summary: Delete
|
|
201
|
-
* @description:
|
|
198
|
+
* @summary: Delete realtime inventory.
|
|
199
|
+
* @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
202
200
|
*/
|
|
203
|
-
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
201
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
204
202
|
/**
|
|
205
203
|
* @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
|
|
206
204
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
205
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
209
|
-
*
|
|
210
|
-
*
|
|
206
|
+
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
|
|
207
|
+
* Success response
|
|
211
208
|
* @name deleteSize
|
|
212
|
-
* @summary: Delete product size
|
|
209
|
+
* @summary: Delete product size.
|
|
213
210
|
* @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
214
211
|
*/
|
|
215
|
-
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
212
|
+
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
|
|
216
213
|
/**
|
|
217
214
|
* @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
|
|
218
215
|
* - Arg object
|
|
@@ -221,10 +218,10 @@ declare class Catalog {
|
|
|
221
218
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
222
219
|
* @returns {Promise<string>} - Success response
|
|
223
220
|
* @name downloadInventoryTemplateView
|
|
224
|
-
* @summary: Download inventory template
|
|
225
|
-
* @description: Allows you to download
|
|
221
|
+
* @summary: Download inventory template view.
|
|
222
|
+
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
226
223
|
*/
|
|
227
|
-
downloadInventoryTemplateView({
|
|
224
|
+
downloadInventoryTemplateView({ type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
228
225
|
/**
|
|
229
226
|
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
230
227
|
* - Arg object
|
|
@@ -233,30 +230,30 @@ declare class Catalog {
|
|
|
233
230
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
234
231
|
* @returns {Promise<string>} - Success response
|
|
235
232
|
* @name downloadProductTemplateViews
|
|
236
|
-
* @summary: Download product template
|
|
237
|
-
* @description: Allows you to download product template data
|
|
233
|
+
* @summary: Download product template views.
|
|
234
|
+
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
238
235
|
*/
|
|
239
236
|
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
240
237
|
/**
|
|
241
238
|
* @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
|
|
242
239
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
243
240
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
244
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
241
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
245
242
|
* @name editProduct
|
|
246
|
-
* @summary:
|
|
243
|
+
* @summary: Edit a product.
|
|
247
244
|
* @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
|
|
248
245
|
*/
|
|
249
|
-
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
246
|
+
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
250
247
|
/**
|
|
251
248
|
* @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
|
|
252
249
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
253
250
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
254
251
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
255
252
|
* @name exportInventoryConfig
|
|
256
|
-
* @summary:
|
|
253
|
+
* @summary: Export inventory configuration.
|
|
257
254
|
* @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportInventoryConfig/).
|
|
258
255
|
*/
|
|
259
|
-
exportInventoryConfig({
|
|
256
|
+
exportInventoryConfig({ filter, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
260
257
|
/**
|
|
261
258
|
* @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
|
|
262
259
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -265,31 +262,20 @@ declare class Catalog {
|
|
|
265
262
|
* - Success response
|
|
266
263
|
*
|
|
267
264
|
* @name getAllProductHsnCodes
|
|
268
|
-
* @summary:
|
|
269
|
-
* @description: Retrieve all HSN codes associated with
|
|
265
|
+
* @summary: Get all product HSN codes.
|
|
266
|
+
* @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
270
267
|
*/
|
|
271
268
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
272
|
-
/**
|
|
273
|
-
* @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
|
|
274
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
275
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
276
|
-
* @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
|
|
277
|
-
* @name getAttribute
|
|
278
|
-
* @summary: Get attribute detail by slug
|
|
279
|
-
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAttribute/).
|
|
280
|
-
*/
|
|
281
|
-
getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
|
|
282
269
|
/**
|
|
283
270
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
284
271
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
285
272
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
286
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
287
|
-
* Success response
|
|
273
|
+
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
|
|
288
274
|
* @name getCategoryData
|
|
289
|
-
* @summary: Get category
|
|
290
|
-
* @description: Retrieve detailed information about a specific category
|
|
275
|
+
* @summary: Get category data.
|
|
276
|
+
* @description: Retrieve detailed information about a specific category with the associated meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
291
277
|
*/
|
|
292
|
-
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
278
|
+
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
|
|
293
279
|
/**
|
|
294
280
|
* @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
|
|
295
281
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -297,18 +283,29 @@ declare class Catalog {
|
|
|
297
283
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
|
|
298
284
|
* Success response
|
|
299
285
|
* @name getCompanyBrandDetail
|
|
300
|
-
* @summary:
|
|
301
|
-
* @description: Get the details of the Brands associated with the given company_id passed
|
|
286
|
+
* @summary: Get the Company Brand details of Optin.
|
|
287
|
+
* @description: Get the details of the Brands associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
|
|
302
288
|
*/
|
|
303
289
|
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
290
|
+
/**
|
|
291
|
+
* @param {CatalogPlatformValidator.GetCompanyBrandsDRIParam} arg - Arg object
|
|
292
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
293
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
294
|
+
* @returns {Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>} -
|
|
295
|
+
* Success response
|
|
296
|
+
* @name getCompanyBrandsDRI
|
|
297
|
+
* @summary: Get support representative's associated to a company
|
|
298
|
+
* @description: This API helps to view support representative's associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandsDRI/).
|
|
299
|
+
*/
|
|
300
|
+
getCompanyBrandsDRI({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandsDRIParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>;
|
|
304
301
|
/**
|
|
305
302
|
* @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
|
|
306
303
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
307
304
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
308
305
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
309
306
|
* @name getCompanyDetail
|
|
310
|
-
* @summary: Get Company
|
|
311
|
-
* @description: Get the details of the company associated with the given company_id passed
|
|
307
|
+
* @summary: Get the Company details.
|
|
308
|
+
* @description: Get the details of the company associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
|
|
312
309
|
*/
|
|
313
310
|
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
314
311
|
/**
|
|
@@ -317,28 +314,48 @@ declare class Catalog {
|
|
|
317
314
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
318
315
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
319
316
|
* @name getCompanyMetrics
|
|
320
|
-
* @summary: Get company metrics
|
|
321
|
-
* @description: Allows
|
|
317
|
+
* @summary: Get company metrics.
|
|
318
|
+
* @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
|
|
322
319
|
*/
|
|
323
320
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
324
321
|
/**
|
|
325
|
-
* @param {CatalogPlatformValidator.
|
|
322
|
+
* @param {CatalogPlatformValidator.GetCompanyVerificationParam} arg - Arg object
|
|
326
323
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
327
324
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
328
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
325
|
+
* @returns {Promise<CatalogPlatformModel.CompanyVerificationResponse>} -
|
|
329
326
|
* Success response
|
|
327
|
+
* @name getCompanyVerification
|
|
328
|
+
* @summary: Get company verification status
|
|
329
|
+
* @description: This API gets company verification details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyVerification/).
|
|
330
|
+
*/
|
|
331
|
+
getCompanyVerification({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyVerificationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyVerificationResponse>;
|
|
332
|
+
/**
|
|
333
|
+
* @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
|
|
334
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
330
337
|
* @name getDepartmentData
|
|
331
|
-
* @summary: Get department
|
|
332
|
-
* @description: Retrieve detailed information about a specific department
|
|
338
|
+
* @summary: Get department data.
|
|
339
|
+
* @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
333
340
|
*/
|
|
334
|
-
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
341
|
+
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
342
|
+
/**
|
|
343
|
+
* @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
|
|
344
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
+
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
347
|
+
* @name getGenderAttribute
|
|
348
|
+
* @summary: Get gender attribute.
|
|
349
|
+
* @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
350
|
+
*/
|
|
351
|
+
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
335
352
|
/**
|
|
336
353
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
337
354
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
338
355
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
356
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
340
357
|
* @name getHsnCode
|
|
341
|
-
* @summary:
|
|
358
|
+
* @summary: Get HSN code.
|
|
342
359
|
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
|
|
343
360
|
*/
|
|
344
361
|
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
@@ -346,60 +363,12 @@ declare class Catalog {
|
|
|
346
363
|
* @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
|
|
347
364
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
365
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
349
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
350
|
-
* Success response
|
|
366
|
+
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
|
|
351
367
|
* @name getInventories
|
|
352
|
-
* @summary:
|
|
353
|
-
* @description: Allows to get Inventories data for particular company.
|
|
354
|
-
*/
|
|
355
|
-
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers,
|
|
356
|
-
/**
|
|
357
|
-
* @param {Object} arg - Arg object.
|
|
358
|
-
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
359
|
-
* @param {string} [arg.size] - Size of which inventory is to get.
|
|
360
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
361
|
-
* page. Default is 12.
|
|
362
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
363
|
-
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
364
|
-
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
365
|
-
* @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
|
|
366
|
-
* @param {string[]} [arg.sellerIdentifiers] - The Seller Identifier or
|
|
367
|
-
* Primary Identifier of the inventory.
|
|
368
|
-
* @param {number} [arg.qtyGt] - This field allows you to filter for
|
|
369
|
-
* inventories that have quantity greater than to the specified value
|
|
370
|
-
* based on qty_type filter.
|
|
371
|
-
* @param {number} [arg.qtyLt] - This field allows you to filter for
|
|
372
|
-
* inventories that have a quantity less than to the specified value based
|
|
373
|
-
* on qty_type filter.
|
|
374
|
-
* @param {string} [arg.qtyType] - This field provides flexibility in
|
|
375
|
-
* selecting filter for inventory quantity counts and date queries. For
|
|
376
|
-
* example, you might use this field to specify "total" or "sellable" quantity.
|
|
377
|
-
* @param {string} [arg.fromDate] - Inventory updated on filter to get
|
|
378
|
-
* inventories greater then or equal to provided date based on qty_type value.
|
|
379
|
-
* @param {string} [arg.toDate] - Inventory updated on filter to get
|
|
380
|
-
* inventories less then or equal to provided date based on qty_type value.
|
|
381
|
-
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
382
|
-
* or Primary Identifier) of which inventory is to get.
|
|
383
|
-
* @returns {Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>}
|
|
384
|
-
* @summary: List Inventory
|
|
385
|
-
* @description: Allows to get Inventories data for particular company.
|
|
386
|
-
*/
|
|
387
|
-
getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, }?: {
|
|
388
|
-
itemId?: string;
|
|
389
|
-
size?: string;
|
|
390
|
-
pageSize?: number;
|
|
391
|
-
q?: string;
|
|
392
|
-
sellable?: boolean;
|
|
393
|
-
storeIds?: number[];
|
|
394
|
-
brandIds?: number[];
|
|
395
|
-
sellerIdentifiers?: string[];
|
|
396
|
-
qtyGt?: number;
|
|
397
|
-
qtyLt?: number;
|
|
398
|
-
qtyType?: string;
|
|
399
|
-
fromDate?: string;
|
|
400
|
-
toDate?: string;
|
|
401
|
-
sizeIdentifier?: string;
|
|
402
|
-
}): Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>;
|
|
368
|
+
* @summary: Retrieve inventories.
|
|
369
|
+
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
370
|
+
*/
|
|
371
|
+
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, minSellable, maxSellable, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
|
|
403
372
|
/**
|
|
404
373
|
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
405
374
|
* - Arg object
|
|
@@ -408,23 +377,10 @@ declare class Catalog {
|
|
|
408
377
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
409
378
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
410
379
|
* @name getInventoryBulkUploadHistory
|
|
411
|
-
* @summary:
|
|
412
|
-
* @description: Helps to get bulk Inventory upload jobs
|
|
380
|
+
* @summary: Retrieve inventory bulk upload history.
|
|
381
|
+
* @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
413
382
|
*/
|
|
414
|
-
getInventoryBulkUploadHistory({ pageNo, pageSize,
|
|
415
|
-
/**
|
|
416
|
-
* @param {Object} arg - Arg object.
|
|
417
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
418
|
-
* page. Default is 12.
|
|
419
|
-
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
420
|
-
* @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
|
|
421
|
-
* @summary: List bulk inventory upload history
|
|
422
|
-
* @description: Helps to get bulk Inventory upload jobs status.
|
|
423
|
-
*/
|
|
424
|
-
getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
|
|
425
|
-
pageSize?: number;
|
|
426
|
-
search?: string;
|
|
427
|
-
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
383
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
428
384
|
/**
|
|
429
385
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
430
386
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -432,29 +388,10 @@ declare class Catalog {
|
|
|
432
388
|
* @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
|
|
433
389
|
* Success response
|
|
434
390
|
* @name getInventoryBySize
|
|
435
|
-
* @summary:
|
|
436
|
-
* @description:
|
|
391
|
+
* @summary: Get inventory by size.
|
|
392
|
+
* @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/getInventoryBySize/).
|
|
437
393
|
*/
|
|
438
394
|
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
439
|
-
/**
|
|
440
|
-
* @param {Object} arg - Arg object.
|
|
441
|
-
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
442
|
-
* @param {string} arg.size - Size of which inventory is to get.
|
|
443
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
444
|
-
* page. Default is 12.
|
|
445
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
446
|
-
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
447
|
-
* @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
|
|
448
|
-
* @summary: List inventory by size
|
|
449
|
-
* @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)."
|
|
450
|
-
*/
|
|
451
|
-
getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: {
|
|
452
|
-
itemId: number;
|
|
453
|
-
size: string;
|
|
454
|
-
pageSize?: number;
|
|
455
|
-
q?: string;
|
|
456
|
-
sellable?: boolean;
|
|
457
|
-
}): Paginator<CatalogPlatformModel.InventoryResponsePaginated>;
|
|
458
395
|
/**
|
|
459
396
|
* @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
|
|
460
397
|
* - Arg object
|
|
@@ -465,206 +402,194 @@ declare class Catalog {
|
|
|
465
402
|
* - Success response
|
|
466
403
|
*
|
|
467
404
|
* @name getInventoryBySizeIdentifier
|
|
468
|
-
* @summary:
|
|
469
|
-
* @description:
|
|
405
|
+
* @summary: Get inventory by size identifier.
|
|
406
|
+
* @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/getInventoryBySizeIdentifier/).
|
|
470
407
|
*/
|
|
471
408
|
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
472
|
-
/**
|
|
473
|
-
* @param {Object} arg - Arg object.
|
|
474
|
-
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
475
|
-
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
476
|
-
* or Primary Identifier) of which inventory is to get.
|
|
477
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
478
|
-
* page. Default is 12.
|
|
479
|
-
* @param {string} [arg.q] - Search with help of store code.
|
|
480
|
-
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
481
|
-
* @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
|
|
482
|
-
* @summary: List inventory by size
|
|
483
|
-
* @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs.
|
|
484
|
-
*/
|
|
485
|
-
getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
|
|
486
|
-
itemId: number;
|
|
487
|
-
sizeIdentifier: string;
|
|
488
|
-
pageSize?: number;
|
|
489
|
-
q?: string;
|
|
490
|
-
locationIds?: number[];
|
|
491
|
-
}): Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
|
|
492
409
|
/**
|
|
493
410
|
* @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
|
|
494
411
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
412
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
496
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
413
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJobResponse>} -
|
|
414
|
+
* Success response
|
|
497
415
|
* @name getInventoryExport
|
|
498
|
-
* @summary:
|
|
499
|
-
* @description:
|
|
416
|
+
* @summary: Retrieve inventory export data.
|
|
417
|
+
* @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
|
|
500
418
|
*/
|
|
501
|
-
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
419
|
+
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobResponse>;
|
|
502
420
|
/**
|
|
503
|
-
* @param {CatalogPlatformValidator.
|
|
421
|
+
* @param {CatalogPlatformValidator.GetInventoryExportDetailParam} arg - Arg object
|
|
504
422
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
505
423
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
506
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
* @
|
|
424
|
+
* @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
|
|
425
|
+
* - Success response
|
|
426
|
+
*
|
|
427
|
+
* @name getInventoryExportDetail
|
|
428
|
+
* @summary: Get Detail Product export detail.
|
|
429
|
+
* @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExportDetail/).
|
|
510
430
|
*/
|
|
511
|
-
|
|
431
|
+
getInventoryExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetInventoryExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>;
|
|
512
432
|
/**
|
|
513
|
-
* @param {CatalogPlatformValidator.
|
|
433
|
+
* @param {CatalogPlatformValidator.GetLocationTagsParam} arg - Arg object
|
|
514
434
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
515
435
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
516
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
517
|
-
* @name
|
|
518
|
-
* @summary:
|
|
519
|
-
* @description:
|
|
436
|
+
* @returns {Promise<CatalogPlatformModel.StoreTagsResponseSchema>} - Success response
|
|
437
|
+
* @name getLocationTags
|
|
438
|
+
* @summary: Get tags associated with locations for a company.
|
|
439
|
+
* @description: This API fetches all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getLocationTags/).
|
|
520
440
|
*/
|
|
521
|
-
|
|
441
|
+
getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreTagsResponseSchema>;
|
|
522
442
|
/**
|
|
523
|
-
* @param {CatalogPlatformValidator.
|
|
443
|
+
* @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object
|
|
524
444
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
525
445
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
526
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
527
|
-
*
|
|
528
|
-
* @
|
|
529
|
-
* @
|
|
530
|
-
* @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
|
|
446
|
+
* @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
|
|
447
|
+
* @name getMarketplaces
|
|
448
|
+
* @summary: List all marketplaces
|
|
449
|
+
* @description: This API allows to get marketplace information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
|
|
531
450
|
*/
|
|
532
|
-
|
|
451
|
+
getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
|
|
533
452
|
/**
|
|
534
453
|
* @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
|
|
535
454
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
536
455
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
537
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
538
|
-
* Success response
|
|
456
|
+
* @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
|
|
539
457
|
* @name getProduct
|
|
540
|
-
* @summary: Get
|
|
458
|
+
* @summary: Get product details.
|
|
541
459
|
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
542
460
|
*/
|
|
543
|
-
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
461
|
+
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
|
|
544
462
|
/**
|
|
545
463
|
* @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
|
|
546
464
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
547
465
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
466
|
+
* @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
|
|
549
467
|
* @name getProductAssetsInBulk
|
|
550
|
-
* @summary:
|
|
468
|
+
* @summary: Retrieve product assets in bulk.
|
|
551
469
|
* @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
|
|
552
470
|
*/
|
|
553
|
-
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
554
|
-
/**
|
|
555
|
-
* @param {Object} arg - Arg object.
|
|
556
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
557
|
-
* page. Default is 12.
|
|
558
|
-
* @returns {Paginator<CatalogPlatformModel.BulkAssetResponseSchema>}
|
|
559
|
-
* @summary: Get product assets
|
|
560
|
-
* @description: Helps to retrieve bulk asset jobs data associated to a particular company.
|
|
561
|
-
*/
|
|
562
|
-
getProductAssetsInBulkPaginator({ pageSize }?: {
|
|
563
|
-
pageSize?: number;
|
|
564
|
-
}): Paginator<CatalogPlatformModel.BulkAssetResponseSchema>;
|
|
471
|
+
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
|
|
565
472
|
/**
|
|
566
473
|
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
567
474
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
568
475
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
569
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
570
|
-
*
|
|
571
|
-
*
|
|
476
|
+
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
|
|
477
|
+
* Success response
|
|
572
478
|
* @name getProductAttributes
|
|
573
|
-
* @summary:
|
|
574
|
-
* @description:
|
|
479
|
+
* @summary: Get product attributes.
|
|
480
|
+
* @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
575
481
|
*/
|
|
576
|
-
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
482
|
+
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
|
|
577
483
|
/**
|
|
578
484
|
* @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
|
|
579
485
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
580
486
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
581
487
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
582
488
|
* @name getProductBulkUploadHistory
|
|
583
|
-
* @summary:
|
|
489
|
+
* @summary: Retrieve product bulk upload history.
|
|
584
490
|
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
585
491
|
*/
|
|
586
492
|
getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
|
|
587
|
-
/**
|
|
588
|
-
* @param {Object} arg - Arg object.
|
|
589
|
-
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
590
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
591
|
-
* page. Default is 12.
|
|
592
|
-
* @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
|
|
593
|
-
* @summary: List product bulk upload history
|
|
594
|
-
* @description: Helps to get bulk product upload jobs data.
|
|
595
|
-
*/
|
|
596
|
-
getProductBulkUploadHistoryPaginator({ search, pageSize }?: {
|
|
597
|
-
search?: string;
|
|
598
|
-
pageSize?: number;
|
|
599
|
-
}): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
|
|
600
493
|
/**
|
|
601
494
|
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
602
495
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
603
496
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
497
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
|
|
605
498
|
* - Success response
|
|
606
499
|
*
|
|
607
500
|
* @name getProductBundle
|
|
608
|
-
* @summary:
|
|
609
|
-
* @description: Retrieve a list of product bundles available in the catalog
|
|
501
|
+
* @summary: Retrieve product bundles.
|
|
502
|
+
* @description: Retrieve a list of product bundles available in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
610
503
|
*/
|
|
611
|
-
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
504
|
+
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
|
|
612
505
|
/**
|
|
613
506
|
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
614
507
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
615
508
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
616
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
617
|
-
*
|
|
618
|
-
*
|
|
509
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
|
|
510
|
+
* Success response
|
|
619
511
|
* @name getProductBundleDetail
|
|
620
|
-
* @summary: Get product bundle
|
|
621
|
-
* @description: Retrieve detailed information about a specific product bundle
|
|
512
|
+
* @summary: Get product bundle details.
|
|
513
|
+
* @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
622
514
|
*/
|
|
623
|
-
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
515
|
+
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
|
|
516
|
+
/**
|
|
517
|
+
* @param {CatalogPlatformValidator.GetProductExportDetailParam} arg - Arg object
|
|
518
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
519
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
520
|
+
* @returns {Promise<CatalogPlatformModel.GetProductDownloadsResponse>} -
|
|
521
|
+
* Success response
|
|
522
|
+
* @name getProductExportDetail
|
|
523
|
+
* @summary: Get Detail Product export detail.
|
|
524
|
+
* @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportDetail/).
|
|
525
|
+
*/
|
|
526
|
+
getProductExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductDownloadsResponse>;
|
|
624
527
|
/**
|
|
625
528
|
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
626
529
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
627
530
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
628
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
629
|
-
*
|
|
630
|
-
*
|
|
531
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
|
|
532
|
+
* Success response
|
|
631
533
|
* @name getProductExportJobs
|
|
632
|
-
* @summary:
|
|
633
|
-
* @description:
|
|
534
|
+
* @summary: Retrieve product export jobs.
|
|
535
|
+
* @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
634
536
|
*/
|
|
635
|
-
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
537
|
+
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
636
538
|
/**
|
|
637
539
|
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
638
540
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
639
541
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
640
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
641
|
-
* Success response
|
|
542
|
+
* @returns {Promise<CatalogPlatformModel.Product>} - Success response
|
|
642
543
|
* @name getProductSize
|
|
643
|
-
* @summary:
|
|
544
|
+
* @summary: Get product size details.
|
|
644
545
|
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
645
546
|
*/
|
|
646
|
-
getProductSize({ itemId,
|
|
547
|
+
getProductSize({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.Product>;
|
|
647
548
|
/**
|
|
648
549
|
* @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
|
|
649
550
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
650
551
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
651
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
652
|
-
* Success response
|
|
552
|
+
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
|
|
653
553
|
* @name getProductTags
|
|
654
|
-
* @summary:
|
|
554
|
+
* @summary: Get product tags.
|
|
655
555
|
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
656
556
|
*/
|
|
657
|
-
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
557
|
+
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
|
|
558
|
+
/**
|
|
559
|
+
* @param {CatalogPlatformValidator.GetProductTemplateBySlugParam} arg - Arg object
|
|
560
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
561
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
562
|
+
* @returns {Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>}
|
|
563
|
+
* - Success response
|
|
564
|
+
*
|
|
565
|
+
* @name getProductTemplateBySlug
|
|
566
|
+
* @summary: Update marketplace optin
|
|
567
|
+
* @description: This API retrieves template for a given slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTemplateBySlug/).
|
|
568
|
+
*/
|
|
569
|
+
getProductTemplateBySlug({ slug, requestHeaders }?: CatalogPlatformValidator.GetProductTemplateBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>;
|
|
658
570
|
/**
|
|
659
571
|
* @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
|
|
660
572
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
661
573
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
662
574
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
663
575
|
* @name getProductValidation
|
|
664
|
-
* @summary: Get
|
|
665
|
-
* @description: Retrieve validation data for
|
|
576
|
+
* @summary: Get product validation.
|
|
577
|
+
* @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
|
|
578
|
+
*/
|
|
579
|
+
getProductValidation({ type, slug, requestHeaders }?: CatalogPlatformValidator.GetProductValidationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
580
|
+
/**
|
|
581
|
+
* @param {CatalogPlatformValidator.GetProductVerificationDetailsParam} arg
|
|
582
|
+
* - Arg object
|
|
583
|
+
*
|
|
584
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
585
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
586
|
+
* @returns {Promise<CatalogPlatformModel.ProductVerificationModel>} -
|
|
587
|
+
* Success response
|
|
588
|
+
* @name getProductVerificationDetails
|
|
589
|
+
* @summary: Get the verification detail of a product
|
|
590
|
+
* @description: Get the verification detail of a product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductVerificationDetails/).
|
|
666
591
|
*/
|
|
667
|
-
|
|
592
|
+
getProductVerificationDetails({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductVerificationDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVerificationModel>;
|
|
668
593
|
/**
|
|
669
594
|
* @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
|
|
670
595
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -672,263 +597,146 @@ declare class Catalog {
|
|
|
672
597
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
|
|
673
598
|
* Success response
|
|
674
599
|
* @name getProducts
|
|
675
|
-
* @summary:
|
|
676
|
-
* @description: Retrieve a list of available
|
|
677
|
-
*/
|
|
678
|
-
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
679
|
-
/**
|
|
680
|
-
* @param {Object} arg - Arg object.
|
|
681
|
-
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
682
|
-
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
683
|
-
* Category Ids
|
|
684
|
-
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
685
|
-
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
686
|
-
* Department Ids
|
|
687
|
-
* @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
|
|
688
|
-
* @param {string} [arg.name] - Get multiple products filtered by Name (Pattern Match)
|
|
689
|
-
* @param {string} [arg.slug] - Get multiple products filtered by Slug
|
|
690
|
-
* @param {string[]} [arg.allIdentifiers] - Get multiple products filtered
|
|
691
|
-
* by All Identifiers
|
|
692
|
-
* @param {string} [arg.q] - Get multiple products filtered by q string
|
|
693
|
-
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
694
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
695
|
-
* page. Default is 10.
|
|
696
|
-
* @param {string} [arg.sortOn] - Field which is to be used for sorting,
|
|
697
|
-
* default is latest. Value can be latest (modified_on) or created (record id)
|
|
698
|
-
* @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
|
|
699
|
-
* @summary: List products
|
|
700
|
-
* @description: Retrieve a list of available products
|
|
701
|
-
*/
|
|
702
|
-
getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageSize, sortOn, }?: {
|
|
703
|
-
brandIds?: number[];
|
|
704
|
-
categoryIds?: number[];
|
|
705
|
-
itemIds?: number[];
|
|
706
|
-
departmentIds?: number[];
|
|
707
|
-
itemCode?: string[];
|
|
708
|
-
name?: string;
|
|
709
|
-
slug?: string;
|
|
710
|
-
allIdentifiers?: string[];
|
|
711
|
-
q?: string;
|
|
712
|
-
tags?: string[];
|
|
713
|
-
pageSize?: number;
|
|
714
|
-
sortOn?: string;
|
|
715
|
-
}): Paginator<CatalogPlatformModel.ProductListingResponseV2>;
|
|
600
|
+
* @summary: Retrieve products.
|
|
601
|
+
* @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
|
|
602
|
+
*/
|
|
603
|
+
getProducts({ brandIds, multiSize, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
|
|
716
604
|
/**
|
|
717
605
|
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
718
606
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
719
607
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
720
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
721
|
-
* Success response
|
|
608
|
+
* @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
|
|
722
609
|
* @name getSellerInsights
|
|
723
|
-
* @summary: Get seller
|
|
724
|
-
* @description: Retrieve
|
|
610
|
+
* @summary: Get seller insights.
|
|
611
|
+
* @description: Retrieve insights and analytics related to sellers within the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
725
612
|
*/
|
|
726
|
-
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
613
|
+
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
|
|
727
614
|
/**
|
|
728
615
|
* @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
|
|
729
616
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
730
617
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
731
618
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
732
619
|
* @name getSingleProductHSNCode
|
|
733
|
-
* @summary: Get product HSN code
|
|
734
|
-
* @description: Retrieve HSN
|
|
620
|
+
* @summary: Get single product HSN code.
|
|
621
|
+
* @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
735
622
|
*/
|
|
736
623
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
737
624
|
/**
|
|
738
625
|
* @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
|
|
739
626
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
740
627
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
741
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
628
|
+
* @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
|
|
742
629
|
* @name getSizeGuide
|
|
743
|
-
* @summary: Get size guide
|
|
744
|
-
* @description: Retrieve data associated about a specific size guide.
|
|
630
|
+
* @summary: Get size guide details.
|
|
631
|
+
* @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
745
632
|
*/
|
|
746
|
-
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
633
|
+
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
|
|
747
634
|
/**
|
|
748
635
|
* @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
|
|
749
636
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
750
637
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
751
638
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
752
639
|
* @name getSizeGuides
|
|
753
|
-
* @summary:
|
|
754
|
-
* @description: Allows to view all the size guides associated to the seller.
|
|
640
|
+
* @summary: Retrieve size guides.
|
|
641
|
+
* @description: Allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
|
|
755
642
|
*/
|
|
756
|
-
getSizeGuides({ active, q, tag, pageNo, pageSize,
|
|
643
|
+
getSizeGuides({ active, q, brandId, tag, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
757
644
|
/**
|
|
758
645
|
* @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
|
|
759
646
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
760
647
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
761
648
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
762
649
|
* @name getStoreDetail
|
|
763
|
-
* @summary: Get
|
|
764
|
-
* @description:
|
|
650
|
+
* @summary: Get the Store details.
|
|
651
|
+
* @description: Get the details of the store associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
|
|
765
652
|
*/
|
|
766
653
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
767
654
|
/**
|
|
768
|
-
* @param {
|
|
769
|
-
* @param {
|
|
770
|
-
* @param {
|
|
771
|
-
*
|
|
772
|
-
* @
|
|
773
|
-
* @summary: Get
|
|
774
|
-
* @description:
|
|
655
|
+
* @param {CatalogPlatformValidator.GetVariantTypesParam} arg - Arg object
|
|
656
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
657
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
658
|
+
* @returns {Promise<CatalogPlatformModel.VariantTypesResponse>} - Success response
|
|
659
|
+
* @name getVariantTypes
|
|
660
|
+
* @summary: Get variant type list
|
|
661
|
+
* @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantTypes/).
|
|
775
662
|
*/
|
|
776
|
-
|
|
777
|
-
q?: string;
|
|
778
|
-
pageSize?: number;
|
|
779
|
-
}): Paginator<CatalogPlatformModel.OptinStoreDetails>;
|
|
663
|
+
getVariantTypes({ templateTag, requestHeaders }?: CatalogPlatformValidator.GetVariantTypesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.VariantTypesResponse>;
|
|
780
664
|
/**
|
|
781
665
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
782
666
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
783
667
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
784
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
785
|
-
* Success response
|
|
668
|
+
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
|
|
786
669
|
* @name getVariantsOfProducts
|
|
787
|
-
* @summary: Get variants
|
|
670
|
+
* @summary: Get variants of products.
|
|
788
671
|
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
789
672
|
*/
|
|
790
|
-
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
791
|
-
/**
|
|
792
|
-
* @param {Object} arg - Arg object.
|
|
793
|
-
* @param {number} arg.itemId - Get list of variants of item Id
|
|
794
|
-
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
795
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
796
|
-
* page. Default is 10.
|
|
797
|
-
* @returns {Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>}
|
|
798
|
-
* @summary: Get variants
|
|
799
|
-
* @description: Retrieve variants of a specific product.
|
|
800
|
-
*/
|
|
801
|
-
getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: {
|
|
802
|
-
itemId: number;
|
|
803
|
-
variantType: string;
|
|
804
|
-
pageSize?: number;
|
|
805
|
-
}): Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>;
|
|
673
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
|
|
806
674
|
/**
|
|
807
675
|
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
808
676
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
809
677
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
810
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
678
|
+
* @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
|
|
811
679
|
* @name listCategories
|
|
812
|
-
* @summary: List categories
|
|
813
|
-
* @description: Retrieve a list of
|
|
814
|
-
*/
|
|
815
|
-
listCategories({ level, department, q, pageNo, pageSize, uids,
|
|
816
|
-
/**
|
|
817
|
-
* @param {Object} arg - Arg object.
|
|
818
|
-
* @param {string} [arg.level] - Get category for multiple levels
|
|
819
|
-
* @param {number} [arg.department] - Get category for multiple departments filtered
|
|
820
|
-
* @param {string} [arg.q] - Get multiple categories filtered by search string
|
|
821
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
822
|
-
* page. Default is 10.
|
|
823
|
-
* @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
|
|
824
|
-
* @param {string} [arg.slug] - Get category by slug
|
|
825
|
-
* @returns {Paginator<CatalogPlatformModel.CategoryResponseSchema>}
|
|
826
|
-
* @summary: List categories
|
|
827
|
-
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
|
|
828
|
-
*/
|
|
829
|
-
listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
|
|
830
|
-
level?: string;
|
|
831
|
-
department?: number;
|
|
832
|
-
q?: string;
|
|
833
|
-
pageSize?: number;
|
|
834
|
-
uids?: number[];
|
|
835
|
-
slug?: string;
|
|
836
|
-
}): Paginator<CatalogPlatformModel.CategoryResponseSchema>;
|
|
680
|
+
* @summary: List categories.
|
|
681
|
+
* @description: Retrieve a list of meta associated available product categories in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
682
|
+
*/
|
|
683
|
+
listCategories({ level, department, q, pageNo, pageSize, uids, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
|
|
837
684
|
/**
|
|
838
685
|
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
839
686
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
840
687
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
841
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
842
|
-
* Success response
|
|
688
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
|
|
843
689
|
* @name listDepartmentsData
|
|
844
|
-
* @summary: List
|
|
845
|
-
* @description: Allows you to list all departments
|
|
846
|
-
*/
|
|
847
|
-
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive,
|
|
848
|
-
/**
|
|
849
|
-
* @param {Object} arg - Arg object.
|
|
850
|
-
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
851
|
-
* set, standard, digital
|
|
852
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
853
|
-
* page. Default is 10.
|
|
854
|
-
* @param {string} [arg.name] - Can search departments by passing name.
|
|
855
|
-
* @param {string} [arg.search] - Can search departments by passing name of
|
|
856
|
-
* the department in search parameter.
|
|
857
|
-
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
858
|
-
* whether they are active or inactive.
|
|
859
|
-
* @param {string} [arg.slug] - Can filter by slug
|
|
860
|
-
* @returns {Paginator<CatalogPlatformModel.DepartmentsResponseSchema>}
|
|
861
|
-
* @summary: List company department
|
|
862
|
-
* @description: Allows you to list all departments data for a specific company.
|
|
863
|
-
*/
|
|
864
|
-
listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: {
|
|
865
|
-
itemType?: string;
|
|
866
|
-
pageSize?: number;
|
|
867
|
-
name?: string;
|
|
868
|
-
search?: string;
|
|
869
|
-
isActive?: boolean;
|
|
870
|
-
slug?: string;
|
|
871
|
-
}): Paginator<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
690
|
+
* @summary: List department data.
|
|
691
|
+
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
|
|
692
|
+
*/
|
|
693
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, uids, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
872
694
|
/**
|
|
873
695
|
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
874
696
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
875
697
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
876
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
698
|
+
* @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
|
|
877
699
|
* @name listHSNCodes
|
|
878
|
-
* @summary: List HSN codes
|
|
879
|
-
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes
|
|
700
|
+
* @summary: List HSN codes.
|
|
701
|
+
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
880
702
|
*/
|
|
881
|
-
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
703
|
+
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
|
|
882
704
|
/**
|
|
883
705
|
* @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
|
|
884
706
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
885
707
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
886
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
708
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
|
|
887
709
|
* - Success response
|
|
888
710
|
*
|
|
889
711
|
* @name listInventoryExport
|
|
890
|
-
* @summary: List inventory
|
|
891
|
-
* @description:
|
|
712
|
+
* @summary: List inventory exports.
|
|
713
|
+
* @description: Helps you the retrieve the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
892
714
|
*/
|
|
893
|
-
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
715
|
+
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
894
716
|
/**
|
|
895
717
|
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
896
718
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
897
719
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
898
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
720
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
|
|
899
721
|
* @name listProductTemplate
|
|
900
|
-
* @summary: List product templates
|
|
901
|
-
* @description: Allows you to list all product templates
|
|
722
|
+
* @summary: List product templates.
|
|
723
|
+
* @description: Allows you to list all product templates, also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
902
724
|
*/
|
|
903
|
-
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
725
|
+
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
|
|
904
726
|
/**
|
|
905
727
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
906
728
|
* - Arg object
|
|
907
729
|
*
|
|
908
730
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
909
731
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
910
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
732
|
+
* @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
|
|
911
733
|
* - Success response
|
|
912
734
|
*
|
|
913
735
|
* @name listProductTemplateCategories
|
|
914
|
-
* @summary: List product template categories
|
|
915
|
-
* @description: Allows you to list all product
|
|
916
|
-
*/
|
|
917
|
-
listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>;
|
|
918
|
-
/**
|
|
919
|
-
* @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
|
|
920
|
-
* - Arg object
|
|
921
|
-
*
|
|
922
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
923
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
924
|
-
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
|
|
925
|
-
* - Success response
|
|
926
|
-
*
|
|
927
|
-
* @name listProductTemplateExportDetails
|
|
928
|
-
* @summary: List export product templates
|
|
929
|
-
* @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
|
|
736
|
+
* @summary: List product template categories.
|
|
737
|
+
* @description: Allows you to list all product categories values for the departments specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
930
738
|
*/
|
|
931
|
-
|
|
739
|
+
listProductTemplateCategories({ departments, itemType, pageSize, pageNo, q, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
|
|
932
740
|
/**
|
|
933
741
|
* @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
|
|
934
742
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -936,151 +744,141 @@ declare class Catalog {
|
|
|
936
744
|
* @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
|
|
937
745
|
* Success response
|
|
938
746
|
* @name listTemplateBrandTypeValues
|
|
939
|
-
* @summary: List template brand
|
|
940
|
-
* @description: Retrieve values related to template brand types
|
|
747
|
+
* @summary: List template brand type values.
|
|
748
|
+
* @description: Retrieve values related to template brand types. The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
941
749
|
*/
|
|
942
750
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
943
751
|
/**
|
|
944
|
-
* @param {CatalogPlatformValidator.
|
|
752
|
+
* @param {CatalogPlatformValidator.PatchInventoryExportDetailParam} arg - Arg object
|
|
945
753
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
946
754
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
947
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
948
|
-
*
|
|
949
|
-
*
|
|
950
|
-
* @
|
|
755
|
+
* @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
|
|
756
|
+
* - Success response
|
|
757
|
+
*
|
|
758
|
+
* @name patchInventoryExportDetail
|
|
759
|
+
* @summary: Edit notification_emails and status of export job.
|
|
760
|
+
* @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchInventoryExportDetail/).
|
|
951
761
|
*/
|
|
952
|
-
|
|
762
|
+
patchInventoryExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchInventoryExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>;
|
|
953
763
|
/**
|
|
954
|
-
* @param {CatalogPlatformValidator.
|
|
764
|
+
* @param {CatalogPlatformValidator.PatchProductExportDetailParam} arg - Arg object
|
|
955
765
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
956
766
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
957
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
767
|
+
* @returns {Promise<CatalogPlatformModel.PatchProductDownloadsResponse>} -
|
|
958
768
|
* Success response
|
|
959
|
-
* @name
|
|
960
|
-
* @summary:
|
|
961
|
-
* @description:
|
|
769
|
+
* @name patchProductExportDetail
|
|
770
|
+
* @summary: Edit notification_emails and status of export job.
|
|
771
|
+
* @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchProductExportDetail/).
|
|
962
772
|
*/
|
|
963
|
-
|
|
773
|
+
patchProductExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PatchProductDownloadsResponse>;
|
|
964
774
|
/**
|
|
965
|
-
* @param {CatalogPlatformValidator.
|
|
775
|
+
* @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
|
|
966
776
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
967
777
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
968
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
969
|
-
*
|
|
970
|
-
*
|
|
971
|
-
* @
|
|
972
|
-
* @summary: Update an Article Price
|
|
973
|
-
* @description: enables you to update article price for a specific size and selling location (store). The price updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateLocationPrice/).
|
|
778
|
+
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
779
|
+
* @name updateCategory
|
|
780
|
+
* @summary: Update category data.
|
|
781
|
+
* @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
974
782
|
*/
|
|
975
|
-
|
|
783
|
+
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
976
784
|
/**
|
|
977
|
-
* @param {CatalogPlatformValidator.
|
|
785
|
+
* @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
|
|
978
786
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
979
787
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
980
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
981
|
-
*
|
|
982
|
-
*
|
|
983
|
-
* @
|
|
984
|
-
|
|
985
|
-
|
|
788
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
789
|
+
* @name updateDepartment
|
|
790
|
+
* @summary: Update department data.
|
|
791
|
+
* @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
792
|
+
*/
|
|
793
|
+
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
794
|
+
/**
|
|
795
|
+
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
796
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
797
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
798
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
799
|
+
* @name updateInventories
|
|
800
|
+
* @summary: Update inventories.
|
|
801
|
+
* @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
986
802
|
*/
|
|
987
|
-
|
|
803
|
+
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
988
804
|
/**
|
|
989
805
|
* @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
|
|
990
806
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
991
807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
992
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
808
|
+
* @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>}
|
|
993
809
|
* - Success response
|
|
994
810
|
*
|
|
995
811
|
* @name updateMarketplaceOptin
|
|
996
812
|
* @summary: Update marketplace optin
|
|
997
|
-
* @description:
|
|
813
|
+
* @description: This API allows to update marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
|
|
998
814
|
*/
|
|
999
|
-
updateMarketplaceOptin({
|
|
815
|
+
updateMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>;
|
|
1000
816
|
/**
|
|
1001
817
|
* @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
|
|
1002
818
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1003
819
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1004
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
820
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
|
|
1005
821
|
* - Success response
|
|
1006
822
|
*
|
|
1007
823
|
* @name updateProductBundle
|
|
1008
|
-
* @summary: Update product bundle
|
|
1009
|
-
* @description: Modify the details of an existing product bundle
|
|
824
|
+
* @summary: Update a product bundle.
|
|
825
|
+
* @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
1010
826
|
*/
|
|
1011
|
-
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
827
|
+
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
|
|
1012
828
|
/**
|
|
1013
829
|
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
1014
830
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1015
831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1016
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1017
|
-
* Success response
|
|
832
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
|
|
1018
833
|
* @name updateRealtimeInventory
|
|
1019
|
-
* @summary: Update
|
|
1020
|
-
* @description:
|
|
834
|
+
* @summary: Update realtime inventory.
|
|
835
|
+
* @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
1021
836
|
*/
|
|
1022
|
-
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
837
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
|
|
1023
838
|
/**
|
|
1024
839
|
* @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
|
|
1025
840
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1026
841
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1027
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
842
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
|
|
1028
843
|
* @name updateSizeGuide
|
|
1029
|
-
* @summary: Update size guide
|
|
1030
|
-
* @description: Allows to edit a
|
|
844
|
+
* @summary: Update a size guide.
|
|
845
|
+
* @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
1031
846
|
*/
|
|
1032
|
-
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
847
|
+
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
|
|
1033
848
|
/**
|
|
1034
849
|
* @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
|
|
1035
850
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1036
851
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1037
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
852
|
+
* @returns {Promise<CatalogPlatformModel.ProductBulkResponse>} - Success response
|
|
1038
853
|
* @name uploadBulkProducts
|
|
1039
|
-
* @summary: Upload bulk products
|
|
1040
|
-
* @description:
|
|
1041
|
-
*/
|
|
1042
|
-
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
1043
|
-
/**
|
|
1044
|
-
* @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
|
|
1045
|
-
* - Arg object
|
|
1046
|
-
*
|
|
1047
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1048
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1049
|
-
* @returns {Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>}
|
|
1050
|
-
* - Success response
|
|
1051
|
-
*
|
|
1052
|
-
* @name validateProductGlobalTemplate
|
|
1053
|
-
* @summary: Validate product template
|
|
1054
|
-
* @description: Allows you to list all product templates global validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductGlobalTemplate/).
|
|
854
|
+
* @summary: Upload bulk products.
|
|
855
|
+
* @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
1055
856
|
*/
|
|
1056
|
-
|
|
857
|
+
uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
|
|
1057
858
|
/**
|
|
1058
859
|
* @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
|
|
1059
860
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1060
861
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1061
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
862
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
|
|
863
|
+
* Success response
|
|
1064
864
|
* @name validateProductTemplate
|
|
1065
|
-
* @summary: Validate product template
|
|
1066
|
-
* @description: Allows you to list all product templates validation values
|
|
865
|
+
* @summary: Validate product template.
|
|
866
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
|
|
1067
867
|
*/
|
|
1068
|
-
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
868
|
+
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
|
|
1069
869
|
/**
|
|
1070
870
|
* @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
|
|
1071
871
|
* - Arg object
|
|
1072
872
|
*
|
|
1073
873
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1074
874
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1075
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1076
|
-
*
|
|
1077
|
-
*
|
|
875
|
+
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
|
|
876
|
+
* Success response
|
|
1078
877
|
* @name validateProductTemplateSchema
|
|
1079
|
-
* @summary: Validate product template schema
|
|
1080
|
-
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
878
|
+
* @summary: Validate product template schema.
|
|
879
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
1081
880
|
*/
|
|
1082
|
-
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
881
|
+
validateProductTemplateSchema({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
|
|
1083
882
|
}
|
|
1084
883
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
1085
884
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
1086
|
-
import Paginator = require("../../common/Paginator");
|