@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -2,193 +2,217 @@ 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>;
|
|
5
15
|
/**
|
|
6
16
|
* @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
|
|
7
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
19
|
* @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
|
|
10
20
|
* @name allSizes
|
|
11
|
-
* @summary: Get
|
|
21
|
+
* @summary: Get product sizes
|
|
12
22
|
* @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
|
|
13
23
|
*/
|
|
14
24
|
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>;
|
|
15
35
|
/**
|
|
16
36
|
* @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
|
|
17
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
39
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
20
40
|
* @name createBulkInventory
|
|
21
|
-
* @summary: Create bulk inventory
|
|
41
|
+
* @summary: Create bulk inventory
|
|
22
42
|
* @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/).
|
|
23
43
|
*/
|
|
24
|
-
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
44
|
+
createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
25
45
|
/**
|
|
26
46
|
* @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
|
|
27
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
49
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
30
50
|
* @name createBulkInventoryJob
|
|
31
|
-
* @summary: Create bulk inventory upload job
|
|
51
|
+
* @summary: Create bulk inventory upload job
|
|
32
52
|
* @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
|
|
33
53
|
*/
|
|
34
|
-
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
54
|
+
createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
35
55
|
/**
|
|
36
56
|
* @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
|
|
37
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
59
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
40
60
|
* @name createBulkProductUploadJob
|
|
41
|
-
* @summary: Create
|
|
61
|
+
* @summary: Create products bulk upload
|
|
42
62
|
* @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/).
|
|
43
63
|
*/
|
|
44
|
-
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
64
|
+
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
|
|
45
65
|
/**
|
|
46
66
|
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
47
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
69
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
|
|
70
|
+
* Success response
|
|
50
71
|
* @name createInventoryExport
|
|
51
|
-
* @summary: Create inventory export
|
|
52
|
-
* @description:
|
|
72
|
+
* @summary: Create inventory export
|
|
73
|
+
* @description: creates export job for inventory data associated with a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
|
|
53
74
|
*/
|
|
54
|
-
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
75
|
+
createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
|
|
55
76
|
/**
|
|
56
77
|
* @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
|
|
57
78
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
80
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
|
|
81
|
+
* Success response
|
|
60
82
|
* @name createInventoryExportJob
|
|
61
|
-
* @summary: Create inventory export job
|
|
83
|
+
* @summary: Create inventory export job
|
|
62
84
|
* @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
|
|
63
85
|
*/
|
|
64
|
-
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
86
|
+
createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
|
|
65
87
|
/**
|
|
66
88
|
* @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
|
|
67
89
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
90
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
91
|
+
* @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>}
|
|
70
92
|
* - Success response
|
|
71
93
|
*
|
|
72
94
|
* @name createMarketplaceOptin
|
|
73
|
-
* @summary: Update
|
|
74
|
-
* @description:
|
|
95
|
+
* @summary: Create or Update opt-in infomation
|
|
96
|
+
* @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
|
|
75
97
|
*/
|
|
76
|
-
createMarketplaceOptin({
|
|
98
|
+
createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>;
|
|
77
99
|
/**
|
|
78
100
|
* @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
|
|
79
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
80
102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
81
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
103
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
|
|
82
104
|
* @name createProduct
|
|
83
|
-
* @summary: Create
|
|
84
|
-
* @description:
|
|
105
|
+
* @summary: Create product
|
|
106
|
+
* @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
|
|
85
107
|
*/
|
|
86
|
-
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
108
|
+
createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
|
|
87
109
|
/**
|
|
88
110
|
* @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
|
|
89
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
112
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
113
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
92
114
|
* @name createProductAssetsInBulk
|
|
93
|
-
* @summary: Create product assets in bulk
|
|
115
|
+
* @summary: Create product assets in bulk
|
|
94
116
|
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
95
117
|
*/
|
|
96
|
-
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
118
|
+
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
97
119
|
/**
|
|
98
120
|
* @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
|
|
99
121
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
100
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
123
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
|
|
102
124
|
* - Success response
|
|
103
125
|
*
|
|
104
126
|
* @name createProductBundle
|
|
105
|
-
* @summary: Create
|
|
106
|
-
* @description: Create product bundle in the catalog
|
|
127
|
+
* @summary: Create product bundle
|
|
128
|
+
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
|
|
107
129
|
*/
|
|
108
|
-
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
130
|
+
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
109
131
|
/**
|
|
110
132
|
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
111
133
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
134
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
113
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
135
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
|
|
114
136
|
* - Success response
|
|
115
137
|
*
|
|
116
138
|
* @name createProductExportJob
|
|
117
|
-
* @summary: Create product export job
|
|
118
|
-
* @description:
|
|
139
|
+
* @summary: Create product export job
|
|
140
|
+
* @description: Allows to create a product export job for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
|
|
119
141
|
*/
|
|
120
|
-
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
142
|
+
createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
121
143
|
/**
|
|
122
144
|
* @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
|
|
123
145
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
124
146
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
125
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
147
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
126
148
|
* @name createProductsInBulk
|
|
127
|
-
* @summary: Create products in bulk
|
|
149
|
+
* @summary: Create products in bulk
|
|
128
150
|
* @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/).
|
|
129
151
|
*/
|
|
130
|
-
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
152
|
+
createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
131
153
|
/**
|
|
132
154
|
* @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
|
|
133
155
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
134
156
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
135
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
157
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
136
158
|
* @name createSizeGuide
|
|
137
|
-
* @summary: Create
|
|
138
|
-
* @description: Allows to create a size guide associated to a
|
|
159
|
+
* @summary: Create size guide
|
|
160
|
+
* @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
|
|
139
161
|
*/
|
|
140
|
-
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
162
|
+
createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
141
163
|
/**
|
|
142
164
|
* @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
|
|
143
165
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
144
166
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
145
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
167
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
146
168
|
* @name deleteBulkInventoryJob
|
|
147
|
-
* @summary: Delete inventory bulk upload job
|
|
169
|
+
* @summary: Delete inventory bulk upload job
|
|
148
170
|
* @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
|
|
149
171
|
*/
|
|
150
|
-
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
172
|
+
deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
151
173
|
/**
|
|
152
174
|
* @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
|
|
153
175
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
154
176
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
155
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
177
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
156
178
|
* @name deleteProduct
|
|
157
|
-
* @summary: Delete
|
|
158
|
-
* @description:
|
|
179
|
+
* @summary: Delete product
|
|
180
|
+
* @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
|
|
159
181
|
*/
|
|
160
|
-
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
182
|
+
deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
161
183
|
/**
|
|
162
184
|
* @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
|
|
163
185
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
164
186
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
165
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
187
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
166
188
|
* @name deleteProductBulkJob
|
|
167
|
-
* @summary: Delete product bulk
|
|
189
|
+
* @summary: Delete product bulk-upload job
|
|
168
190
|
* @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
|
|
169
191
|
*/
|
|
170
|
-
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
192
|
+
deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
171
193
|
/**
|
|
172
194
|
* @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
|
|
173
195
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
174
196
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
197
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
|
|
198
|
+
* Success response
|
|
176
199
|
* @name deleteRealtimeInventory
|
|
177
|
-
* @summary: Delete
|
|
178
|
-
* @description:
|
|
200
|
+
* @summary: Delete an inventory
|
|
201
|
+
* @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
|
|
179
202
|
*/
|
|
180
|
-
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
203
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
181
204
|
/**
|
|
182
205
|
* @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
|
|
183
206
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
184
207
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
186
|
-
* Success response
|
|
208
|
+
* @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>}
|
|
209
|
+
* - Success response
|
|
210
|
+
*
|
|
187
211
|
* @name deleteSize
|
|
188
|
-
* @summary: Delete product size
|
|
212
|
+
* @summary: Delete product size
|
|
189
213
|
* @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
|
|
190
214
|
*/
|
|
191
|
-
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
215
|
+
deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
|
|
192
216
|
/**
|
|
193
217
|
* @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
|
|
194
218
|
* - Arg object
|
|
@@ -197,10 +221,10 @@ declare class Catalog {
|
|
|
197
221
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
222
|
* @returns {Promise<string>} - Success response
|
|
199
223
|
* @name downloadInventoryTemplateView
|
|
200
|
-
* @summary: Download inventory template
|
|
201
|
-
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
224
|
+
* @summary: Download inventory template data
|
|
225
|
+
* @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
|
|
202
226
|
*/
|
|
203
|
-
downloadInventoryTemplateView({
|
|
227
|
+
downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
|
|
204
228
|
/**
|
|
205
229
|
* @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
|
|
206
230
|
* - Arg object
|
|
@@ -209,30 +233,30 @@ declare class Catalog {
|
|
|
209
233
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
210
234
|
* @returns {Promise<string>} - Success response
|
|
211
235
|
* @name downloadProductTemplateViews
|
|
212
|
-
* @summary: Download product template
|
|
213
|
-
* @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
236
|
+
* @summary: Download product template view
|
|
237
|
+
* @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
|
|
214
238
|
*/
|
|
215
239
|
downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
|
|
216
240
|
/**
|
|
217
241
|
* @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
|
|
218
242
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
219
243
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
244
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
221
245
|
* @name editProduct
|
|
222
|
-
* @summary:
|
|
246
|
+
* @summary: Update a product
|
|
223
247
|
* @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/).
|
|
224
248
|
*/
|
|
225
|
-
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
249
|
+
editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
226
250
|
/**
|
|
227
251
|
* @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
|
|
228
252
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
229
253
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
230
254
|
* @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
|
|
231
255
|
* @name exportInventoryConfig
|
|
232
|
-
* @summary:
|
|
256
|
+
* @summary: Get export inventory configuration
|
|
233
257
|
* @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/).
|
|
234
258
|
*/
|
|
235
|
-
exportInventoryConfig({
|
|
259
|
+
exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
|
|
236
260
|
/**
|
|
237
261
|
* @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
|
|
238
262
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -241,8 +265,8 @@ declare class Catalog {
|
|
|
241
265
|
* - Success response
|
|
242
266
|
*
|
|
243
267
|
* @name getAllProductHsnCodes
|
|
244
|
-
* @summary:
|
|
245
|
-
* @description: Retrieve all HSN codes associated with products
|
|
268
|
+
* @summary: List product HSN codes
|
|
269
|
+
* @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
246
270
|
*/
|
|
247
271
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
248
272
|
/**
|
|
@@ -259,12 +283,13 @@ declare class Catalog {
|
|
|
259
283
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
260
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
285
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
286
|
+
* @returns {Promise<CatalogPlatformModel.SingleCategoryResponseSchema>} -
|
|
287
|
+
* Success response
|
|
263
288
|
* @name getCategoryData
|
|
264
|
-
* @summary: Get category
|
|
265
|
-
* @description: Retrieve detailed information about a specific category
|
|
289
|
+
* @summary: Get category by uid
|
|
290
|
+
* @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
|
|
266
291
|
*/
|
|
267
|
-
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
292
|
+
getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponseSchema>;
|
|
268
293
|
/**
|
|
269
294
|
* @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
|
|
270
295
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -272,29 +297,18 @@ declare class Catalog {
|
|
|
272
297
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
|
|
273
298
|
* Success response
|
|
274
299
|
* @name getCompanyBrandDetail
|
|
275
|
-
* @summary:
|
|
276
|
-
* @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/).
|
|
300
|
+
* @summary: list Company Brand of Optin
|
|
301
|
+
* @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
|
|
277
302
|
*/
|
|
278
303
|
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
|
|
279
|
-
/**
|
|
280
|
-
* @param {CatalogPlatformValidator.GetCompanyBrandsDRIParam} arg - Arg object
|
|
281
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
282
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
283
|
-
* @returns {Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>} -
|
|
284
|
-
* Success response
|
|
285
|
-
* @name getCompanyBrandsDRI
|
|
286
|
-
* @summary: Get support representative's associated to a company
|
|
287
|
-
* @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/).
|
|
288
|
-
*/
|
|
289
|
-
getCompanyBrandsDRI({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandsDRIParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>;
|
|
290
304
|
/**
|
|
291
305
|
* @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
|
|
292
306
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
293
307
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
294
308
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
|
|
295
309
|
* @name getCompanyDetail
|
|
296
|
-
* @summary: Get
|
|
297
|
-
* @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/).
|
|
310
|
+
* @summary: Get Company
|
|
311
|
+
* @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
|
|
298
312
|
*/
|
|
299
313
|
getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
|
|
300
314
|
/**
|
|
@@ -303,38 +317,28 @@ declare class Catalog {
|
|
|
303
317
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
318
|
* @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
|
|
305
319
|
* @name getCompanyMetrics
|
|
306
|
-
* @summary: Get company metrics
|
|
307
|
-
* @description: Allows
|
|
320
|
+
* @summary: Get company metrics
|
|
321
|
+
* @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
|
|
308
322
|
*/
|
|
309
323
|
getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
|
|
310
|
-
/**
|
|
311
|
-
* @param {CatalogPlatformValidator.GetCompanyVerificationParam} arg - Arg object
|
|
312
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
313
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
314
|
-
* @returns {Promise<CatalogPlatformModel.CompanyVerificationResponse>} -
|
|
315
|
-
* Success response
|
|
316
|
-
* @name getCompanyVerification
|
|
317
|
-
* @summary: Get company verification status
|
|
318
|
-
* @description: This API gets company verification details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyVerification/).
|
|
319
|
-
*/
|
|
320
|
-
getCompanyVerification({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyVerificationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyVerificationResponse>;
|
|
321
324
|
/**
|
|
322
325
|
* @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
|
|
323
326
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
324
327
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
325
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
328
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
|
|
329
|
+
* Success response
|
|
326
330
|
* @name getDepartmentData
|
|
327
|
-
* @summary: Get department
|
|
328
|
-
* @description: Retrieve detailed information about a specific department by
|
|
331
|
+
* @summary: Get department by uid
|
|
332
|
+
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
329
333
|
*/
|
|
330
|
-
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
334
|
+
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
331
335
|
/**
|
|
332
336
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
333
337
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
334
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
339
|
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
336
340
|
* @name getHsnCode
|
|
337
|
-
* @summary:
|
|
341
|
+
* @summary: List HSN code
|
|
338
342
|
* @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
|
|
339
343
|
*/
|
|
340
344
|
getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
@@ -342,12 +346,60 @@ declare class Catalog {
|
|
|
342
346
|
* @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
|
|
343
347
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
344
348
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
345
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
349
|
+
* @returns {Promise<CatalogPlatformModel.GetInventoriesResponseSchema>} -
|
|
350
|
+
* Success response
|
|
346
351
|
* @name getInventories
|
|
347
|
-
* @summary:
|
|
348
|
-
* @description: Allows to get Inventories data for particular company.
|
|
349
|
-
*/
|
|
350
|
-
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers,
|
|
352
|
+
* @summary: List Inventory
|
|
353
|
+
* @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
|
|
354
|
+
*/
|
|
355
|
+
getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponseSchema>;
|
|
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>;
|
|
351
403
|
/**
|
|
352
404
|
* @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
|
|
353
405
|
* - Arg object
|
|
@@ -356,10 +408,23 @@ declare class Catalog {
|
|
|
356
408
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
357
409
|
* @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
|
|
358
410
|
* @name getInventoryBulkUploadHistory
|
|
359
|
-
* @summary:
|
|
360
|
-
* @description: Helps to get bulk Inventory upload jobs
|
|
411
|
+
* @summary: List bulk inventory upload history
|
|
412
|
+
* @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
|
|
413
|
+
*/
|
|
414
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize, search, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
|
|
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.
|
|
361
423
|
*/
|
|
362
|
-
|
|
424
|
+
getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
|
|
425
|
+
pageSize?: number;
|
|
426
|
+
search?: string;
|
|
427
|
+
}): Paginator<CatalogPlatformModel.BulkInventoryGet>;
|
|
363
428
|
/**
|
|
364
429
|
* @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
|
|
365
430
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -367,10 +432,29 @@ declare class Catalog {
|
|
|
367
432
|
* @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
|
|
368
433
|
* Success response
|
|
369
434
|
* @name getInventoryBySize
|
|
370
|
-
* @summary:
|
|
371
|
-
* @description:
|
|
435
|
+
* @summary: List inventory by size
|
|
436
|
+
* @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)." - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
|
|
372
437
|
*/
|
|
373
438
|
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>;
|
|
374
458
|
/**
|
|
375
459
|
* @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
|
|
376
460
|
* - Arg object
|
|
@@ -381,194 +465,206 @@ declare class Catalog {
|
|
|
381
465
|
* - Success response
|
|
382
466
|
*
|
|
383
467
|
* @name getInventoryBySizeIdentifier
|
|
384
|
-
* @summary:
|
|
385
|
-
* @description:
|
|
468
|
+
* @summary: List inventory by size
|
|
469
|
+
* @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
|
|
386
470
|
*/
|
|
387
471
|
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>;
|
|
388
492
|
/**
|
|
389
493
|
* @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
|
|
390
494
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
391
495
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
392
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
393
|
-
* Success response
|
|
496
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
|
|
394
497
|
* @name getInventoryExport
|
|
395
|
-
* @summary:
|
|
396
|
-
* @description:
|
|
397
|
-
*/
|
|
398
|
-
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobResponse>;
|
|
399
|
-
/**
|
|
400
|
-
* @param {CatalogPlatformValidator.GetInventoryExportDetailParam} arg - Arg object
|
|
401
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
402
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
403
|
-
* @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
|
|
404
|
-
* - Success response
|
|
405
|
-
*
|
|
406
|
-
* @name getInventoryExportDetail
|
|
407
|
-
* @summary: Get Detail Product export detail.
|
|
408
|
-
* @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExportDetail/).
|
|
498
|
+
* @summary: list product inventory
|
|
499
|
+
* @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
|
|
409
500
|
*/
|
|
410
|
-
|
|
501
|
+
getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
|
|
411
502
|
/**
|
|
412
|
-
* @param {CatalogPlatformValidator.
|
|
503
|
+
* @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object
|
|
413
504
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
414
505
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
415
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
416
|
-
* @name
|
|
417
|
-
* @summary: Get
|
|
418
|
-
* @description:
|
|
506
|
+
* @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
|
|
507
|
+
* @name getMarketplaceOptinDetail
|
|
508
|
+
* @summary: Get opt-in
|
|
509
|
+
* @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
|
|
419
510
|
*/
|
|
420
|
-
|
|
511
|
+
getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
|
|
421
512
|
/**
|
|
422
513
|
* @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object
|
|
423
514
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
424
515
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
425
516
|
* @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
|
|
426
517
|
* @name getMarketplaces
|
|
427
|
-
* @summary: List
|
|
428
|
-
* @description:
|
|
518
|
+
* @summary: List marketplaces
|
|
519
|
+
* @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
|
|
429
520
|
*/
|
|
430
521
|
getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
|
|
522
|
+
/**
|
|
523
|
+
* @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
524
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
525
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
526
|
+
* @returns {Promise<CatalogPlatformModel.StoreAssignResponseSchema>} -
|
|
527
|
+
* Success response
|
|
528
|
+
* @name getOptimalLocations
|
|
529
|
+
* @summary: Get optimal locations
|
|
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/).
|
|
531
|
+
*/
|
|
532
|
+
getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponseSchema>;
|
|
431
533
|
/**
|
|
432
534
|
* @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
|
|
433
535
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
434
536
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
435
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
537
|
+
* @returns {Promise<CatalogPlatformModel.SingleProductResponseSchema>} -
|
|
538
|
+
* Success response
|
|
436
539
|
* @name getProduct
|
|
437
|
-
* @summary: Get product
|
|
540
|
+
* @summary: Get a product
|
|
438
541
|
* @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
|
|
439
542
|
*/
|
|
440
|
-
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
543
|
+
getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponseSchema>;
|
|
441
544
|
/**
|
|
442
545
|
* @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
|
|
443
546
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
444
547
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
445
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
548
|
+
* @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
|
|
446
549
|
* @name getProductAssetsInBulk
|
|
447
|
-
* @summary:
|
|
550
|
+
* @summary: Get product assets
|
|
448
551
|
* @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/).
|
|
449
552
|
*/
|
|
450
|
-
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
553
|
+
getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponseSchema>;
|
|
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>;
|
|
451
565
|
/**
|
|
452
566
|
* @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
|
|
453
567
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
454
568
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
455
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
456
|
-
* Success response
|
|
569
|
+
* @returns {Promise<CatalogPlatformModel.ProductAttributesResponseSchema>}
|
|
570
|
+
* - Success response
|
|
571
|
+
*
|
|
457
572
|
* @name getProductAttributes
|
|
458
|
-
* @summary:
|
|
459
|
-
* @description:
|
|
573
|
+
* @summary: List product attributes
|
|
574
|
+
* @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
|
|
460
575
|
*/
|
|
461
|
-
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
576
|
+
getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponseSchema>;
|
|
462
577
|
/**
|
|
463
578
|
* @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
|
|
464
579
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
465
580
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
466
581
|
* @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
|
|
467
582
|
* @name getProductBulkUploadHistory
|
|
468
|
-
* @summary:
|
|
583
|
+
* @summary: List product bulk upload history
|
|
469
584
|
* @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
|
|
470
585
|
*/
|
|
471
586
|
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>;
|
|
472
600
|
/**
|
|
473
601
|
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
474
602
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
475
603
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
476
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
604
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>}
|
|
477
605
|
* - Success response
|
|
478
606
|
*
|
|
479
607
|
* @name getProductBundle
|
|
480
|
-
* @summary:
|
|
481
|
-
* @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/).
|
|
608
|
+
* @summary: List product bundles
|
|
609
|
+
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
|
|
482
610
|
*/
|
|
483
|
-
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
611
|
+
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
|
|
484
612
|
/**
|
|
485
613
|
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
486
614
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
487
615
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
488
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
489
|
-
* Success response
|
|
616
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponseSchema>}
|
|
617
|
+
* - Success response
|
|
618
|
+
*
|
|
490
619
|
* @name getProductBundleDetail
|
|
491
|
-
* @summary: Get product bundle
|
|
492
|
-
* @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
620
|
+
* @summary: Get product bundle
|
|
621
|
+
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
|
|
493
622
|
*/
|
|
494
|
-
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
495
|
-
/**
|
|
496
|
-
* @param {CatalogPlatformValidator.GetProductExportDetailParam} arg - Arg object
|
|
497
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
498
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
499
|
-
* @returns {Promise<CatalogPlatformModel.GetProductDownloadsResponse>} -
|
|
500
|
-
* Success response
|
|
501
|
-
* @name getProductExportDetail
|
|
502
|
-
* @summary: Get Detail Product export detail.
|
|
503
|
-
* @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportDetail/).
|
|
504
|
-
*/
|
|
505
|
-
getProductExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductDownloadsResponse>;
|
|
623
|
+
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
|
|
506
624
|
/**
|
|
507
625
|
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
508
626
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
509
627
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
510
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
511
|
-
* Success response
|
|
628
|
+
* @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
|
|
629
|
+
* - Success response
|
|
630
|
+
*
|
|
512
631
|
* @name getProductExportJobs
|
|
513
|
-
* @summary:
|
|
514
|
-
* @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
632
|
+
* @summary: Get product export jobs
|
|
633
|
+
* @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
515
634
|
*/
|
|
516
|
-
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
635
|
+
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
517
636
|
/**
|
|
518
637
|
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
519
638
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
520
639
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
521
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
640
|
+
* @returns {Promise<CatalogPlatformModel.ProductListingResponseSchema>} -
|
|
641
|
+
* Success response
|
|
522
642
|
* @name getProductSize
|
|
523
|
-
* @summary:
|
|
643
|
+
* @summary: List product size
|
|
524
644
|
* @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
|
|
525
645
|
*/
|
|
526
|
-
getProductSize({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
646
|
+
getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseSchema>;
|
|
527
647
|
/**
|
|
528
648
|
* @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
|
|
529
649
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
530
650
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
531
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
651
|
+
* @returns {Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>} -
|
|
652
|
+
* Success response
|
|
532
653
|
* @name getProductTags
|
|
533
|
-
* @summary:
|
|
654
|
+
* @summary: List product tags
|
|
534
655
|
* @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
|
|
535
656
|
*/
|
|
536
|
-
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
537
|
-
/**
|
|
538
|
-
* @param {CatalogPlatformValidator.GetProductTemplateBySlugParam} arg - Arg object
|
|
539
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
540
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
541
|
-
* @returns {Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>}
|
|
542
|
-
* - Success response
|
|
543
|
-
*
|
|
544
|
-
* @name getProductTemplateBySlug
|
|
545
|
-
* @summary: Update marketplace optin
|
|
546
|
-
* @description: This API retrieves template for a given slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTemplateBySlug/).
|
|
547
|
-
*/
|
|
548
|
-
getProductTemplateBySlug({ slug, requestHeaders }?: CatalogPlatformValidator.GetProductTemplateBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>;
|
|
657
|
+
getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>;
|
|
549
658
|
/**
|
|
550
659
|
* @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
|
|
551
660
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
552
661
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
553
662
|
* @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
|
|
554
663
|
* @name getProductValidation
|
|
555
|
-
* @summary: Get
|
|
556
|
-
* @description: Retrieve validation data for
|
|
557
|
-
*/
|
|
558
|
-
getProductValidation({ type, slug, requestHeaders }?: CatalogPlatformValidator.GetProductValidationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
559
|
-
/**
|
|
560
|
-
* @param {CatalogPlatformValidator.GetProductVerificationDetailsParam} arg
|
|
561
|
-
* - Arg object
|
|
562
|
-
*
|
|
563
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
564
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
565
|
-
* @returns {Promise<CatalogPlatformModel.ProductVerificationModel>} -
|
|
566
|
-
* Success response
|
|
567
|
-
* @name getProductVerificationDetails
|
|
568
|
-
* @summary: Get the verification detail of a product
|
|
569
|
-
* @description: Get the verification detail of a product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductVerificationDetails/).
|
|
664
|
+
* @summary: Get valid products
|
|
665
|
+
* @description: Retrieve validation data for products at company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
|
|
570
666
|
*/
|
|
571
|
-
|
|
667
|
+
getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
|
|
572
668
|
/**
|
|
573
669
|
* @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
|
|
574
670
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -576,146 +672,263 @@ declare class Catalog {
|
|
|
576
672
|
* @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
|
|
577
673
|
* Success response
|
|
578
674
|
* @name getProducts
|
|
579
|
-
* @summary:
|
|
580
|
-
* @description: Retrieve a list of products
|
|
581
|
-
*/
|
|
582
|
-
getProducts({ brandIds,
|
|
675
|
+
* @summary: List products
|
|
676
|
+
* @description: Retrieve a list of available products - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
|
|
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>;
|
|
583
716
|
/**
|
|
584
717
|
* @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
|
|
585
718
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
586
719
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
587
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
720
|
+
* @returns {Promise<CatalogPlatformModel.CrossSellingResponseSchema>} -
|
|
721
|
+
* Success response
|
|
588
722
|
* @name getSellerInsights
|
|
589
|
-
* @summary: Get seller
|
|
590
|
-
* @description: Retrieve
|
|
723
|
+
* @summary: Get seller catalog counts
|
|
724
|
+
* @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
|
|
591
725
|
*/
|
|
592
|
-
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
726
|
+
getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponseSchema>;
|
|
593
727
|
/**
|
|
594
728
|
* @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
|
|
595
729
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
596
730
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
597
731
|
* @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
|
|
598
732
|
* @name getSingleProductHSNCode
|
|
599
|
-
* @summary: Get
|
|
600
|
-
* @description: Retrieve
|
|
733
|
+
* @summary: Get product HSN code
|
|
734
|
+
* @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
|
|
601
735
|
*/
|
|
602
736
|
getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
|
|
603
737
|
/**
|
|
604
738
|
* @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
|
|
605
739
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
606
740
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
607
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
741
|
+
* @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
|
|
608
742
|
* @name getSizeGuide
|
|
609
|
-
* @summary: Get size guide
|
|
610
|
-
* @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
743
|
+
* @summary: Get size guide
|
|
744
|
+
* @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
|
|
611
745
|
*/
|
|
612
|
-
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
746
|
+
getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponseSchema>;
|
|
613
747
|
/**
|
|
614
748
|
* @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
|
|
615
749
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
616
750
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
617
751
|
* @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
|
|
618
752
|
* @name getSizeGuides
|
|
619
|
-
* @summary:
|
|
620
|
-
* @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/).
|
|
753
|
+
* @summary: List size guides
|
|
754
|
+
* @description: Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
|
|
621
755
|
*/
|
|
622
|
-
getSizeGuides({ active, q,
|
|
756
|
+
getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
|
|
623
757
|
/**
|
|
624
758
|
* @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
|
|
625
759
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
626
760
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
627
761
|
* @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
|
|
628
762
|
* @name getStoreDetail
|
|
629
|
-
* @summary: Get
|
|
630
|
-
* @description:
|
|
763
|
+
* @summary: Get selling location
|
|
764
|
+
* @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
|
|
631
765
|
*/
|
|
632
766
|
getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
|
|
633
767
|
/**
|
|
634
|
-
* @param {
|
|
635
|
-
* @param {
|
|
636
|
-
* @param {
|
|
637
|
-
*
|
|
638
|
-
* @
|
|
639
|
-
* @summary: Get
|
|
640
|
-
* @description:
|
|
768
|
+
* @param {Object} arg - Arg object.
|
|
769
|
+
* @param {string} [arg.q] - The search related the store for the company id.
|
|
770
|
+
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
771
|
+
* the page for the company id.
|
|
772
|
+
* @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
|
|
773
|
+
* @summary: Get selling location
|
|
774
|
+
* @description: Retrieve the details of the selling location (store) associated with a specific company passed.
|
|
641
775
|
*/
|
|
642
|
-
|
|
776
|
+
getStoreDetailPaginator({ q, pageSize }?: {
|
|
777
|
+
q?: string;
|
|
778
|
+
pageSize?: number;
|
|
779
|
+
}): Paginator<CatalogPlatformModel.OptinStoreDetails>;
|
|
643
780
|
/**
|
|
644
781
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
645
782
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
646
783
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
647
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
784
|
+
* @returns {Promise<CatalogPlatformModel.ProductVariantsResponseSchema>} -
|
|
785
|
+
* Success response
|
|
648
786
|
* @name getVariantsOfProducts
|
|
649
|
-
* @summary: Get variants
|
|
787
|
+
* @summary: Get variants
|
|
650
788
|
* @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
|
|
651
789
|
*/
|
|
652
|
-
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
790
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponseSchema>;
|
|
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>;
|
|
653
806
|
/**
|
|
654
807
|
* @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
|
|
655
808
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
656
809
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
657
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
810
|
+
* @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
|
|
658
811
|
* @name listCategories
|
|
659
|
-
* @summary: List categories
|
|
660
|
-
* @description: Retrieve a list of
|
|
661
|
-
*/
|
|
662
|
-
listCategories({ level, department, q, pageNo, pageSize, uids, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
812
|
+
* @summary: List categories
|
|
813
|
+
* @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
|
|
814
|
+
*/
|
|
815
|
+
listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
|
|
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>;
|
|
663
837
|
/**
|
|
664
838
|
* @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
|
|
665
839
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
666
840
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
667
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
841
|
+
* @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
|
|
842
|
+
* Success response
|
|
668
843
|
* @name listDepartmentsData
|
|
669
|
-
* @summary: List department
|
|
670
|
-
* @description: Allows you to list all departments
|
|
671
|
-
*/
|
|
672
|
-
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive,
|
|
844
|
+
* @summary: List company department
|
|
845
|
+
* @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
|
|
846
|
+
*/
|
|
847
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
|
|
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>;
|
|
673
872
|
/**
|
|
674
873
|
* @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
|
|
675
874
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
676
875
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
677
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
876
|
+
* @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
|
|
678
877
|
* @name listHSNCodes
|
|
679
|
-
* @summary: List HSN codes
|
|
680
|
-
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
878
|
+
* @summary: List HSN codes
|
|
879
|
+
* @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
|
|
681
880
|
*/
|
|
682
|
-
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
881
|
+
listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponseSchema>;
|
|
683
882
|
/**
|
|
684
883
|
* @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
|
|
685
884
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
686
885
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
687
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
886
|
+
* @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>}
|
|
688
887
|
* - Success response
|
|
689
888
|
*
|
|
690
889
|
* @name listInventoryExport
|
|
691
|
-
* @summary: List inventory
|
|
692
|
-
* @description:
|
|
890
|
+
* @summary: List inventory export jobs
|
|
891
|
+
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
693
892
|
*/
|
|
694
|
-
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
893
|
+
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>;
|
|
695
894
|
/**
|
|
696
895
|
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
697
896
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
698
897
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
699
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
898
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
|
|
700
899
|
* @name listProductTemplate
|
|
701
|
-
* @summary: List product templates
|
|
702
|
-
* @description: Allows you to list all product templates
|
|
900
|
+
* @summary: List product templates
|
|
901
|
+
* @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
|
|
703
902
|
*/
|
|
704
|
-
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
903
|
+
listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
|
|
705
904
|
/**
|
|
706
905
|
* @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
|
|
707
906
|
* - Arg object
|
|
708
907
|
*
|
|
709
908
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
710
909
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
711
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
910
|
+
* @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>}
|
|
712
911
|
* - Success response
|
|
713
912
|
*
|
|
714
913
|
* @name listProductTemplateCategories
|
|
715
|
-
* @summary: List product template categories
|
|
716
|
-
* @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/).
|
|
914
|
+
* @summary: List product template categories
|
|
915
|
+
* @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
|
|
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/).
|
|
717
930
|
*/
|
|
718
|
-
|
|
931
|
+
listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
|
|
719
932
|
/**
|
|
720
933
|
* @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
|
|
721
934
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -723,121 +936,151 @@ declare class Catalog {
|
|
|
723
936
|
* @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
|
|
724
937
|
* Success response
|
|
725
938
|
* @name listTemplateBrandTypeValues
|
|
726
|
-
* @summary: List template brand
|
|
727
|
-
* @description: Retrieve values related to template brand types. The filter type query parameter defines what type of data to return.
|
|
939
|
+
* @summary: List template brand
|
|
940
|
+
* @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
728
941
|
*/
|
|
729
942
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
730
943
|
/**
|
|
731
|
-
* @param {CatalogPlatformValidator.
|
|
944
|
+
* @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
|
|
732
945
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
733
946
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
734
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
735
|
-
*
|
|
736
|
-
*
|
|
737
|
-
* @
|
|
738
|
-
* @summary: Edit notification_emails and status of export job.
|
|
739
|
-
* @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/).
|
|
947
|
+
* @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
|
|
948
|
+
* @name updateHsnCode
|
|
949
|
+
* @summary: Update HSN code
|
|
950
|
+
* @description: Modify the HSN code associated with a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
|
|
740
951
|
*/
|
|
741
|
-
|
|
952
|
+
updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
|
|
742
953
|
/**
|
|
743
|
-
* @param {CatalogPlatformValidator.
|
|
954
|
+
* @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
|
|
744
955
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
745
956
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
746
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
957
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
|
|
747
958
|
* Success response
|
|
748
|
-
* @name
|
|
749
|
-
* @summary:
|
|
750
|
-
* @description:
|
|
959
|
+
* @name updateInventories
|
|
960
|
+
* @summary: Update inventories
|
|
961
|
+
* @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
|
|
751
962
|
*/
|
|
752
|
-
|
|
963
|
+
updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
753
964
|
/**
|
|
754
|
-
* @param {CatalogPlatformValidator.
|
|
965
|
+
* @param {CatalogPlatformValidator.UpdateLocationPriceParam} arg - Arg object
|
|
755
966
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
756
967
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
757
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
758
|
-
*
|
|
759
|
-
*
|
|
760
|
-
* @
|
|
968
|
+
* @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
|
|
969
|
+
* - Success response
|
|
970
|
+
*
|
|
971
|
+
* @name updateLocationPrice
|
|
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/).
|
|
974
|
+
*/
|
|
975
|
+
updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
976
|
+
/**
|
|
977
|
+
* @param {CatalogPlatformValidator.UpdateLocationQuantityParam} arg - Arg object
|
|
978
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
979
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
980
|
+
* @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
|
|
981
|
+
* - Success response
|
|
982
|
+
*
|
|
983
|
+
* @name updateLocationQuantity
|
|
984
|
+
* @summary: Update an Article Quantity
|
|
985
|
+
* @description: enables you to update article quantity for a specific size and selling location (store). The quantity updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateLocationQuantity/).
|
|
761
986
|
*/
|
|
762
|
-
|
|
987
|
+
updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
|
|
763
988
|
/**
|
|
764
989
|
* @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
|
|
765
990
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
766
991
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
767
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
992
|
+
* @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>}
|
|
768
993
|
* - Success response
|
|
769
994
|
*
|
|
770
995
|
* @name updateMarketplaceOptin
|
|
771
996
|
* @summary: Update marketplace optin
|
|
772
|
-
* @description:
|
|
997
|
+
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
|
|
773
998
|
*/
|
|
774
|
-
updateMarketplaceOptin({
|
|
999
|
+
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
|
|
775
1000
|
/**
|
|
776
1001
|
* @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
|
|
777
1002
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
778
1003
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
779
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1004
|
+
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
|
|
780
1005
|
* - Success response
|
|
781
1006
|
*
|
|
782
1007
|
* @name updateProductBundle
|
|
783
|
-
* @summary: Update
|
|
784
|
-
* @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
1008
|
+
* @summary: Update product bundle
|
|
1009
|
+
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
|
|
785
1010
|
*/
|
|
786
|
-
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1011
|
+
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
787
1012
|
/**
|
|
788
1013
|
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
789
1014
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
790
1015
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
791
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1016
|
+
* @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
|
|
1017
|
+
* Success response
|
|
792
1018
|
* @name updateRealtimeInventory
|
|
793
|
-
* @summary: Update
|
|
794
|
-
* @description:
|
|
1019
|
+
* @summary: Update an inventory
|
|
1020
|
+
* @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
|
|
795
1021
|
*/
|
|
796
|
-
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1022
|
+
updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
|
|
797
1023
|
/**
|
|
798
1024
|
* @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
|
|
799
1025
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
800
1026
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
801
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1027
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
802
1028
|
* @name updateSizeGuide
|
|
803
|
-
* @summary: Update
|
|
804
|
-
* @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
1029
|
+
* @summary: Update size guide
|
|
1030
|
+
* @description: Allows to edit a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
|
|
805
1031
|
*/
|
|
806
|
-
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1032
|
+
updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
807
1033
|
/**
|
|
808
1034
|
* @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
|
|
809
1035
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
810
1036
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
811
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
1037
|
+
* @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
|
|
812
1038
|
* @name uploadBulkProducts
|
|
813
|
-
* @summary: Upload bulk products
|
|
814
|
-
* @description:
|
|
1039
|
+
* @summary: Upload bulk products
|
|
1040
|
+
* @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
|
|
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/).
|
|
815
1055
|
*/
|
|
816
|
-
|
|
1056
|
+
validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
|
|
817
1057
|
/**
|
|
818
1058
|
* @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
|
|
819
1059
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
820
1060
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
821
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
822
|
-
* Success response
|
|
1061
|
+
* @returns {Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>}
|
|
1062
|
+
* - Success response
|
|
1063
|
+
*
|
|
823
1064
|
* @name validateProductTemplate
|
|
824
|
-
* @summary: Validate product template
|
|
825
|
-
* @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/).
|
|
1065
|
+
* @summary: Validate product template
|
|
1066
|
+
* @description: Allows you to list all product templates validation values by its slug 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/validateProductTemplate/).
|
|
826
1067
|
*/
|
|
827
|
-
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.
|
|
1068
|
+
validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>;
|
|
828
1069
|
/**
|
|
829
1070
|
* @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
|
|
830
1071
|
* - Arg object
|
|
831
1072
|
*
|
|
832
1073
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
833
1074
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
834
|
-
* @returns {Promise<CatalogPlatformModel.
|
|
835
|
-
* Success response
|
|
1075
|
+
* @returns {Promise<CatalogPlatformModel.InventoryValidationResponseSchema>}
|
|
1076
|
+
* - Success response
|
|
1077
|
+
*
|
|
836
1078
|
* @name validateProductTemplateSchema
|
|
837
|
-
* @summary: Validate product template schema
|
|
838
|
-
* @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/).
|
|
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 for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
|
|
839
1081
|
*/
|
|
840
|
-
validateProductTemplateSchema({ itemType,
|
|
1082
|
+
validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
|
|
841
1083
|
}
|
|
842
1084
|
import CatalogPlatformValidator = require("./CatalogPlatformValidator");
|
|
843
1085
|
import CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
1086
|
+
import Paginator = require("../../common/Paginator");
|