@gofynd/fdk-client-javascript 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/documentation/application/CART.md +5934 -4502
- package/documentation/application/CATALOG.md +6338 -7245
- package/documentation/application/COMMON.md +95 -222
- package/documentation/application/COMMUNICATION.md +106 -186
- package/documentation/application/CONFIGURATION.md +903 -1597
- package/documentation/application/CONTENT.md +562 -1270
- package/documentation/application/FILESTORAGE.md +84 -220
- package/documentation/application/LEAD.md +314 -660
- package/documentation/application/LOGISTIC.md +229 -305
- package/documentation/application/ORDER.md +642 -1137
- package/documentation/application/PAYMENT.md +2285 -3031
- package/documentation/application/POSCART.md +6079 -4642
- package/documentation/application/REWARDS.md +94 -248
- package/documentation/application/SHARE.md +152 -250
- package/documentation/application/THEME.md +952 -1235
- package/documentation/application/USER.md +1228 -1765
- package/documentation/platform/ANALYTICS.md +207 -349
- package/documentation/platform/AUDITTRAIL.md +121 -204
- package/documentation/platform/BILLING.md +865 -1376
- package/documentation/platform/CART.md +2814 -3662
- package/documentation/platform/CATALOG.md +15266 -17619
- package/documentation/platform/COMMON.md +95 -222
- package/documentation/platform/COMMUNICATION.md +1632 -2380
- package/documentation/platform/COMPANYPROFILE.md +572 -957
- package/documentation/platform/CONFIGURATION.md +3050 -4073
- package/documentation/platform/CONTENT.md +3509 -4121
- package/documentation/platform/DISCOUNT.md +140 -236
- package/documentation/platform/FILESTORAGE.md +187 -323
- package/documentation/platform/INVENTORY.md +268 -911
- package/documentation/platform/LEAD.md +2195 -2541
- package/documentation/platform/ORDER.md +3750 -5636
- package/documentation/platform/PARTNER.md +9 -36
- package/documentation/platform/PAYMENT.md +903 -1213
- package/documentation/platform/REWARDS.md +183 -347
- package/documentation/platform/SHARE.md +120 -213
- package/documentation/platform/THEME.md +12956 -13239
- package/documentation/platform/USER.md +975 -1120
- package/documentation/platform/WEBHOOK.md +78 -184
- package/documentation/public/CONFIGURATION.md +95 -222
- package/documentation/public/INVENTORY.md +100 -282
- package/documentation/public/WEBHOOK.md +27 -133
- package/package.json +1 -1
- package/sdk/application/ApplicationConfig.js +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +1058 -547
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +489 -886
- package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
- package/sdk/application/Cart/CartApplicationValidator.js +98 -98
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
- package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
- package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
- package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
- package/sdk/application/Common/CommonApplicationClient.js +76 -36
- package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
- package/sdk/application/Common/CommonApplicationModel.js +83 -160
- package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
- package/sdk/application/Common/CommonApplicationValidator.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
- package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
- package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
- package/sdk/application/Content/ContentApplicationClient.js +581 -213
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
- package/sdk/application/Content/ContentApplicationModel.js +468 -875
- package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
- package/sdk/application/Content/ContentApplicationValidator.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
- package/sdk/application/Lead/LeadApplicationClient.js +230 -96
- package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
- package/sdk/application/Lead/LeadApplicationModel.js +267 -474
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
- package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
- package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
- package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
- package/sdk/application/Order/OrderApplicationClient.js +448 -215
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +357 -661
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
- package/sdk/application/Order/OrderApplicationValidator.js +28 -28
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
- package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
- package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
- package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
- package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
- package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
- package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
- package/sdk/application/Share/ShareApplicationClient.js +221 -96
- package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
- package/sdk/application/Share/ShareApplicationModel.js +63 -123
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationValidator.js +12 -12
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
- package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +280 -280
- package/sdk/application/User/UserApplicationClient.js +1201 -543
- package/sdk/application/User/UserApplicationModel.d.ts +79 -72
- package/sdk/application/User/UserApplicationModel.js +440 -689
- package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
- package/sdk/application/User/UserApplicationValidator.js +89 -89
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
- package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
- package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
- package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
- package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
- package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
- package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
- package/sdk/platform/Common/CommonPlatformClient.js +80 -37
- package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformModel.js +83 -160
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
- package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
- package/sdk/platform/Content/ContentPlatformModel.js +486 -867
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
- package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
- package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
- package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
- package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
- package/sdk/platform/OAuthClient.js +8 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
- package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
- package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
- package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
- package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
- package/sdk/platform/PlatformApplicationClient.js +1584 -13691
- package/sdk/platform/PlatformClient.d.ts +7918 -7666
- package/sdk/platform/PlatformClient.js +8701 -9926
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
- package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
- package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
- package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
- package/sdk/platform/Share/SharePlatformModel.js +60 -118
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
- package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
- package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
- package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
- package/sdk/platform/User/UserPlatformModel.js +440 -689
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
- package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
- package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
- package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
- package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
- package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
- package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -4,481 +4,612 @@ declare class Catalog {
|
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
6
|
* @param {Object} arg - Arg object.
|
|
7
|
-
* @param {
|
|
8
|
-
*
|
|
9
|
-
* @param {
|
|
10
|
-
* @
|
|
11
|
-
* @
|
|
7
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
8
|
+
* @param {string} arg.size - Size in which inventory is to be added.
|
|
9
|
+
* @param {InventoryRequest} arg.body
|
|
10
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
11
|
+
* @summary: Add Inventory for particular size and store.
|
|
12
|
+
* @description: This API allows add Inventory for particular size and store.
|
|
12
13
|
*/
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
addInventory({ itemId, size, body }?: {
|
|
15
|
+
itemId: number;
|
|
16
|
+
size: string;
|
|
17
|
+
body: InventoryRequest;
|
|
18
|
+
}): Promise<SuccessResponse>;
|
|
17
19
|
/**
|
|
18
20
|
* @param {Object} arg - Arg object.
|
|
19
|
-
* @param {
|
|
20
|
-
* @
|
|
21
|
-
* @
|
|
21
|
+
* @param {number} arg.itemId - Id of the product to be updated.
|
|
22
|
+
* @returns {Promise<GetAllSizes>} - Success response
|
|
23
|
+
* @summary: All Sizes for a given Product
|
|
24
|
+
* @description: This API allows to get All Sizes for a given Product.
|
|
22
25
|
*/
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
}): Promise<
|
|
26
|
+
allSizes({ itemId }?: {
|
|
27
|
+
itemId: number;
|
|
28
|
+
}): Promise<GetAllSizes>;
|
|
26
29
|
/**
|
|
27
30
|
* @param {Object} arg - Arg object.
|
|
28
|
-
* @param {
|
|
29
|
-
*
|
|
30
|
-
* @summary:
|
|
31
|
-
* @description:
|
|
31
|
+
* @param {BulkHsnUpsert} arg.body
|
|
32
|
+
* @returns {Promise<BulkHsnResponse>} - Success response
|
|
33
|
+
* @summary: Bulk Create or Update Hsn Code.
|
|
34
|
+
* @description: Bulk Create or Update Hsn Code.
|
|
32
35
|
*/
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
}): Promise<
|
|
36
|
+
bulkHsnCode({ body }?: {
|
|
37
|
+
body: BulkHsnUpsert;
|
|
38
|
+
}): Promise<BulkHsnResponse>;
|
|
36
39
|
/**
|
|
37
40
|
* @param {Object} arg - Arg object.
|
|
38
|
-
* @param {string} arg.
|
|
39
|
-
*
|
|
40
|
-
* @
|
|
41
|
-
* @summary:
|
|
42
|
-
* @description:
|
|
41
|
+
* @param {string} arg.batchId - Batch Id of the bulk create job.
|
|
42
|
+
* @param {InventoryBulkRequest} arg.body
|
|
43
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
44
|
+
* @summary: Create products in bulk associated with given batch Id.
|
|
45
|
+
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
43
46
|
*/
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
body:
|
|
47
|
-
}): Promise<
|
|
47
|
+
createBulkInventory({ batchId, body }?: {
|
|
48
|
+
batchId: string;
|
|
49
|
+
body: InventoryBulkRequest;
|
|
50
|
+
}): Promise<SuccessResponse>;
|
|
48
51
|
/**
|
|
49
52
|
* @param {Object} arg - Arg object.
|
|
50
|
-
* @param {
|
|
51
|
-
* @
|
|
52
|
-
* @
|
|
53
|
-
* @
|
|
54
|
-
* given set of results
|
|
55
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
56
|
-
* page. Default is 10.
|
|
57
|
-
* @summary: Get list of size guides
|
|
58
|
-
* @description: This API allows to view all the size guides associated to the seller.
|
|
53
|
+
* @param {BulkJob} arg.body
|
|
54
|
+
* @returns {Promise<BulkResponse>} - Success response
|
|
55
|
+
* @summary: Create a Bulk Inventory upload Job.
|
|
56
|
+
* @description: This API helps to create a bulk Inventory upload job.
|
|
59
57
|
*/
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
tag?: string;
|
|
64
|
-
pageNo?: number;
|
|
65
|
-
pageSize?: number;
|
|
66
|
-
}): Promise<any>;
|
|
58
|
+
createBulkInventoryJob({ body }?: {
|
|
59
|
+
body: BulkJob;
|
|
60
|
+
}): Promise<BulkResponse>;
|
|
67
61
|
/**
|
|
68
62
|
* @param {Object} arg - Arg object.
|
|
69
|
-
* @param {
|
|
70
|
-
* @
|
|
71
|
-
* @
|
|
63
|
+
* @param {BulkJob} arg.body
|
|
64
|
+
* @returns {Promise<BulkResponse>} - Success response
|
|
65
|
+
* @summary: Create a Bulk product to upload job.
|
|
66
|
+
* @description: This API helps to create a bulk products upload job.
|
|
72
67
|
*/
|
|
73
|
-
|
|
74
|
-
body:
|
|
75
|
-
}): Promise<
|
|
68
|
+
createBulkProductUploadJob({ body }?: {
|
|
69
|
+
body: BulkJob;
|
|
70
|
+
}): Promise<BulkResponse>;
|
|
76
71
|
/**
|
|
77
72
|
* @param {Object} arg - Arg object.
|
|
78
|
-
* @param {
|
|
79
|
-
* @
|
|
80
|
-
* @
|
|
73
|
+
* @param {CategoryRequestBody} arg.body
|
|
74
|
+
* @returns {Promise<CategoryCreateResponse>} - Success response
|
|
75
|
+
* @summary: Create product categories
|
|
76
|
+
* @description: This API lets user create product categories
|
|
81
77
|
*/
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
}): Promise<
|
|
78
|
+
createCategories({ body }?: {
|
|
79
|
+
body: CategoryRequestBody;
|
|
80
|
+
}): Promise<CategoryCreateResponse>;
|
|
85
81
|
/**
|
|
86
82
|
* @param {Object} arg - Arg object.
|
|
87
|
-
* @param {
|
|
88
|
-
* @
|
|
89
|
-
* @summary:
|
|
90
|
-
* @description:
|
|
83
|
+
* @param {DepartmentCreateUpdate} arg.body
|
|
84
|
+
* @returns {Promise<DepartmentCreateResponse>} - Success response
|
|
85
|
+
* @summary: Create the department.
|
|
86
|
+
* @description: Create departments using the API.
|
|
91
87
|
*/
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
}): Promise<any>;
|
|
88
|
+
createDepartments({ body }?: {
|
|
89
|
+
body: DepartmentCreateUpdate;
|
|
90
|
+
}): Promise<DepartmentCreateResponse>;
|
|
96
91
|
/**
|
|
97
92
|
* @param {Object} arg - Arg object.
|
|
98
|
-
* @param {
|
|
99
|
-
*
|
|
100
|
-
* @summary:
|
|
101
|
-
* @description:
|
|
93
|
+
* @param {InventoryCreateRequest} arg.body
|
|
94
|
+
* @returns {Promise<InventoryExportResponse>} - Success response
|
|
95
|
+
* @summary: Create an inventory export job.
|
|
96
|
+
* @description: This API helps to create a Inventory export job.
|
|
102
97
|
*/
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
}): Promise<
|
|
98
|
+
createInventoryExport({ body }?: {
|
|
99
|
+
body: InventoryCreateRequest;
|
|
100
|
+
}): Promise<InventoryExportResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* @param {Object} arg - Arg object.
|
|
103
|
+
* @param {InventoryExportRequest} arg.body
|
|
104
|
+
* @returns {Promise<InventoryExportResponse>} - Success response
|
|
105
|
+
* @summary: Create a Inventory export Job.
|
|
106
|
+
* @description: This API helps to create a Inventory export job.
|
|
107
|
+
*/
|
|
108
|
+
createInventoryExportJob({ body }?: {
|
|
109
|
+
body: InventoryExportRequest;
|
|
110
|
+
}): Promise<InventoryExportResponse>;
|
|
106
111
|
/**
|
|
107
112
|
* @param {Object} arg - Arg object.
|
|
108
113
|
* @param {string} arg.marketplace - The marketplace for which the detail
|
|
109
114
|
* needs to be retrieved.
|
|
110
115
|
* @param {OptInPostRequest} arg.body
|
|
116
|
+
* @returns {Promise<UpdatedResponse>} - Success response
|
|
111
117
|
* @summary: Create/Update opt-in infomation.
|
|
112
118
|
* @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema`
|
|
113
119
|
*/
|
|
114
120
|
createMarketplaceOptin({ marketplace, body }?: {
|
|
115
121
|
marketplace: string;
|
|
116
122
|
body: OptInPostRequest;
|
|
117
|
-
}): Promise<
|
|
123
|
+
}): Promise<UpdatedResponse>;
|
|
118
124
|
/**
|
|
119
125
|
* @param {Object} arg - Arg object.
|
|
120
|
-
* @
|
|
121
|
-
* @
|
|
126
|
+
* @param {ProductCreateUpdateSchemaV2} arg.body
|
|
127
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
128
|
+
* @summary: Create a product.
|
|
129
|
+
* @description: This API allows to create product.
|
|
122
130
|
*/
|
|
123
|
-
|
|
131
|
+
createProduct({ body }?: {
|
|
132
|
+
body: ProductCreateUpdateSchemaV2;
|
|
133
|
+
}): Promise<SuccessResponse>;
|
|
124
134
|
/**
|
|
125
135
|
* @param {Object} arg - Arg object.
|
|
126
|
-
* @
|
|
127
|
-
* @
|
|
136
|
+
* @param {ProductBulkAssets} arg.body
|
|
137
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
138
|
+
* @summary: Create a Bulk asset upload Job.
|
|
139
|
+
* @description: This API helps to create a bulk asset upload job.
|
|
128
140
|
*/
|
|
129
|
-
|
|
141
|
+
createProductAssetsInBulk({ body }?: {
|
|
142
|
+
body: ProductBulkAssets;
|
|
143
|
+
}): Promise<SuccessResponse>;
|
|
130
144
|
/**
|
|
131
145
|
* @param {Object} arg - Arg object.
|
|
132
|
-
* @param {
|
|
133
|
-
* @
|
|
134
|
-
* @
|
|
135
|
-
* @
|
|
136
|
-
* the page for the company id.
|
|
137
|
-
* @param {string} [arg.marketplace] - The marketplace platform associated
|
|
138
|
-
* with the company id.
|
|
139
|
-
* @summary: Get the Company Brand details of Optin.
|
|
140
|
-
* @description: Get the details of the Brands associated with the given company_id passed.
|
|
146
|
+
* @param {ProductBundleRequest} arg.body
|
|
147
|
+
* @returns {Promise<GetProductBundleCreateResponse>} - Success response
|
|
148
|
+
* @summary: Create Product Bundle
|
|
149
|
+
* @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id
|
|
141
150
|
*/
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
pageNo?: number;
|
|
146
|
-
pageSize?: number;
|
|
147
|
-
marketplace?: string;
|
|
148
|
-
}): Promise<any>;
|
|
151
|
+
createProductBundle({ body }?: {
|
|
152
|
+
body: ProductBundleRequest;
|
|
153
|
+
}): Promise<GetProductBundleCreateResponse>;
|
|
149
154
|
/**
|
|
150
155
|
* @param {Object} arg - Arg object.
|
|
151
|
-
* @
|
|
152
|
-
* @
|
|
156
|
+
* @param {ProductTemplateDownloadsExport} arg.body
|
|
157
|
+
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
158
|
+
* @summary: Create a product export job.
|
|
159
|
+
* @description: This API helps to create a Inventory export job.
|
|
153
160
|
*/
|
|
154
|
-
|
|
161
|
+
createProductExportJob({ body }?: {
|
|
162
|
+
body: ProductTemplateDownloadsExport;
|
|
163
|
+
}): Promise<ProductDownloadsResponse>;
|
|
155
164
|
/**
|
|
156
165
|
* @param {Object} arg - Arg object.
|
|
157
|
-
* @param {string}
|
|
158
|
-
* @param {
|
|
159
|
-
* @
|
|
160
|
-
*
|
|
161
|
-
* @
|
|
162
|
-
* @description: Get the details of the store associated with the company ID passed.
|
|
166
|
+
* @param {string} arg.batchId - Batch Id in which assets to be uploaded.
|
|
167
|
+
* @param {BulkProductRequest} arg.body
|
|
168
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
169
|
+
* @summary: Create products in bulk associated with given batch Id.
|
|
170
|
+
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
163
171
|
*/
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
}): Promise<any>;
|
|
172
|
+
createProductsInBulk({ batchId, body }?: {
|
|
173
|
+
batchId: string;
|
|
174
|
+
body: BulkProductRequest;
|
|
175
|
+
}): Promise<SuccessResponse>;
|
|
169
176
|
/**
|
|
170
177
|
* @param {Object} arg - Arg object.
|
|
171
|
-
* @param {
|
|
172
|
-
*
|
|
173
|
-
* @summary:
|
|
174
|
-
* @description: This API allows to
|
|
178
|
+
* @param {ValidateSizeGuide} arg.body
|
|
179
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
180
|
+
* @summary: Create a size guide.
|
|
181
|
+
* @description: This API allows to create a size guide associated to a brand.
|
|
175
182
|
*/
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
}): Promise<
|
|
183
|
+
createSizeGuide({ body }?: {
|
|
184
|
+
body: ValidateSizeGuide;
|
|
185
|
+
}): Promise<SuccessResponse>;
|
|
179
186
|
/**
|
|
180
187
|
* @param {Object} arg - Arg object.
|
|
181
|
-
* @param {string} arg.
|
|
182
|
-
*
|
|
183
|
-
* @
|
|
184
|
-
*
|
|
185
|
-
* @summary: List Department specifiec product categories
|
|
186
|
-
* @description: Allows you to list all product categories values for the departments specified
|
|
188
|
+
* @param {string} arg.batchId - Batch Id of the bulk delete job.
|
|
189
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
190
|
+
* @summary: Delete Bulk Inventory job.
|
|
191
|
+
* @description: This API allows to delete bulk Inventory job associated with company.
|
|
187
192
|
*/
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
}): Promise<any>;
|
|
193
|
+
deleteBulkInventoryJob({ batchId }?: {
|
|
194
|
+
batchId: string;
|
|
195
|
+
}): Promise<SuccessResponse>;
|
|
192
196
|
/**
|
|
193
197
|
* @param {Object} arg - Arg object.
|
|
194
|
-
* @param {
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
* @
|
|
200
|
-
*
|
|
201
|
-
* @
|
|
202
|
-
* whether they are active or inactive.
|
|
203
|
-
* @summary: List all Departments.
|
|
204
|
-
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
198
|
+
* @param {string} arg.size - Size that is to be deleted.
|
|
199
|
+
* @param {number} arg.itemId - Id of the product associated with Inventory
|
|
200
|
+
* to be deleted.
|
|
201
|
+
* @param {number} arg.locationId - Location ID of store of which inventory
|
|
202
|
+
* is to be deleted.
|
|
203
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
204
|
+
* @summary: Delete a Inventory.
|
|
205
|
+
* @description: This API allows to delete inventory of a particular product for particular company.
|
|
205
206
|
*/
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
isActive?: boolean;
|
|
212
|
-
}): Promise<any>;
|
|
207
|
+
deleteInventory({ size, itemId, locationId }?: {
|
|
208
|
+
size: string;
|
|
209
|
+
itemId: number;
|
|
210
|
+
locationId: number;
|
|
211
|
+
}): Promise<SuccessResponse>;
|
|
213
212
|
/**
|
|
214
213
|
* @param {Object} arg - Arg object.
|
|
215
|
-
* @param {
|
|
216
|
-
* @
|
|
217
|
-
* @
|
|
214
|
+
* @param {number} arg.itemId - Id of the product to be updated.
|
|
215
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
216
|
+
* @summary: Delete a product.
|
|
217
|
+
* @description: This API allows to delete product.
|
|
218
218
|
*/
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
}): Promise<
|
|
219
|
+
deleteProduct({ itemId }?: {
|
|
220
|
+
itemId: number;
|
|
221
|
+
}): Promise<SuccessResponse>;
|
|
222
222
|
/**
|
|
223
223
|
* @param {Object} arg - Arg object.
|
|
224
|
-
* @param {
|
|
225
|
-
* @
|
|
226
|
-
* @
|
|
224
|
+
* @param {number} arg.batchId - Batch Id of the bulk product job to be deleted.
|
|
225
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
226
|
+
* @summary: Delete Bulk product job.
|
|
227
|
+
* @description: This API allows to delete bulk product job associated with company.
|
|
227
228
|
*/
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
}): Promise<
|
|
229
|
+
deleteProductBulkJob({ batchId }?: {
|
|
230
|
+
batchId: number;
|
|
231
|
+
}): Promise<SuccessResponse>;
|
|
231
232
|
/**
|
|
232
233
|
* @param {Object} arg - Arg object.
|
|
233
|
-
* @param {
|
|
234
|
-
* @param {
|
|
235
|
-
*
|
|
236
|
-
* @
|
|
234
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
235
|
+
* @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
|
|
236
|
+
* or Primary Identifier) of which inventory is to get.
|
|
237
|
+
* @param {InventoryRequestSchemaV2} arg.body
|
|
238
|
+
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
239
|
+
* @summary: Add Inventory for particular size and store.
|
|
240
|
+
* @description: This API allows add Inventory for particular size and store.
|
|
237
241
|
*/
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
+
deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
|
|
243
|
+
itemId: number;
|
|
244
|
+
sellerIdentifier: string;
|
|
245
|
+
body: InventoryRequestSchemaV2;
|
|
246
|
+
}): Promise<InventoryUpdateResponse>;
|
|
242
247
|
/**
|
|
243
248
|
* @param {Object} arg - Arg object.
|
|
244
|
-
* @param {
|
|
245
|
-
*
|
|
246
|
-
* @
|
|
247
|
-
* @
|
|
249
|
+
* @param {number} arg.itemId - Item Id of the product associated with size
|
|
250
|
+
* to be deleted.
|
|
251
|
+
* @param {string} arg.size - Size to be deleted.
|
|
252
|
+
* @returns {Promise<ProductSizeDeleteResponse>} - Success response
|
|
253
|
+
* @summary: Delete a Size associated with product.
|
|
254
|
+
* @description: This API allows to delete size associated with product.
|
|
248
255
|
*/
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
256
|
+
deleteSize({ itemId, size }?: {
|
|
257
|
+
itemId: number;
|
|
258
|
+
size: string;
|
|
259
|
+
}): Promise<ProductSizeDeleteResponse>;
|
|
252
260
|
/**
|
|
253
261
|
* @param {Object} arg - Arg object.
|
|
254
|
-
* @param {string} arg.
|
|
255
|
-
*
|
|
256
|
-
* @summary:
|
|
257
|
-
* @description: Allows you to
|
|
262
|
+
* @param {string} arg.itemType - An `item_type` defines the type of item.
|
|
263
|
+
* @returns {Promise<string>} - Success response
|
|
264
|
+
* @summary: Download Product Template View
|
|
265
|
+
* @description: Allows you to download product template data
|
|
258
266
|
*/
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
}): Promise<
|
|
267
|
+
downloadInventoryTemplateView({ itemType }?: {
|
|
268
|
+
itemType: string;
|
|
269
|
+
}): Promise<string>;
|
|
262
270
|
/**
|
|
263
271
|
* @param {Object} arg - Arg object.
|
|
264
272
|
* @param {string} arg.slug - A `slug` is a unique identifier for a
|
|
265
273
|
* particular template.
|
|
274
|
+
* @returns {Promise<string>} - Success response
|
|
266
275
|
* @summary: Download Product Template View
|
|
267
276
|
* @description: Allows you to download product template data
|
|
268
277
|
*/
|
|
269
278
|
downloadProductTemplateViews({ slug }?: {
|
|
270
279
|
slug: string;
|
|
271
|
-
}): Promise<
|
|
280
|
+
}): Promise<string>;
|
|
272
281
|
/**
|
|
273
282
|
* @param {Object} arg - Arg object.
|
|
274
|
-
* @param {
|
|
275
|
-
* @
|
|
276
|
-
* @
|
|
283
|
+
* @param {number} arg.itemId - Id of the product to be updated.
|
|
284
|
+
* @param {ProductCreateUpdateSchemaV2} arg.body
|
|
285
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
286
|
+
* @summary: Edit a product.
|
|
287
|
+
* @description: This API allows to edit product.
|
|
277
288
|
*/
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
289
|
+
editProduct({ itemId, body }?: {
|
|
290
|
+
itemId: number;
|
|
291
|
+
body: ProductCreateUpdateSchemaV2;
|
|
292
|
+
}): Promise<SuccessResponse>;
|
|
281
293
|
/**
|
|
282
294
|
* @param {Object} arg - Arg object.
|
|
283
|
-
* @param {string} arg.
|
|
284
|
-
*
|
|
285
|
-
* @
|
|
286
|
-
* @
|
|
295
|
+
* @param {string} [arg.filterType] - Filter type from any one of ['brand',
|
|
296
|
+
* 'store', 'type']
|
|
297
|
+
* @returns {Promise<InventoryConfig>} - Success response
|
|
298
|
+
* @summary: Get List of different filters for inventory export
|
|
299
|
+
* @description: This API allows get List of different filters like brand, store, and type for inventory export.
|
|
287
300
|
*/
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
}): Promise<
|
|
301
|
+
exportInventoryConfig({ filterType }?: {
|
|
302
|
+
filterType?: string;
|
|
303
|
+
}): Promise<InventoryConfig>;
|
|
291
304
|
/**
|
|
292
305
|
* @param {Object} arg - Arg object.
|
|
293
|
-
* @
|
|
294
|
-
* @
|
|
306
|
+
* @param {number} [arg.pageNo] - Page no
|
|
307
|
+
* @param {number} [arg.pageSize] - Page size
|
|
308
|
+
* @param {string} [arg.q] - Search using hsn code, description, reporting_hsn
|
|
309
|
+
* @param {string} [arg.type] - Search using type
|
|
310
|
+
* @returns {Promise<HsnCodesListingResponseSchemaV2>} - Success response
|
|
311
|
+
* @summary: Hsn Code List.
|
|
312
|
+
* @description: Hsn Code List.
|
|
295
313
|
*/
|
|
296
|
-
|
|
314
|
+
getAllProductHsnCodes({ pageNo, pageSize, q, type }?: {
|
|
315
|
+
pageNo?: number;
|
|
316
|
+
pageSize?: number;
|
|
317
|
+
q?: string;
|
|
318
|
+
type?: string;
|
|
319
|
+
}): Promise<HsnCodesListingResponseSchemaV2>;
|
|
297
320
|
/**
|
|
298
321
|
* @param {Object} arg - Arg object.
|
|
299
|
-
* @
|
|
300
|
-
* @
|
|
322
|
+
* @param {string} arg.uid - Category unique id
|
|
323
|
+
* @returns {Promise<SingleCategoryResponse>} - Success response
|
|
324
|
+
* @summary: Get product category by uid
|
|
325
|
+
* @description: This API gets meta associated to product categories.
|
|
301
326
|
*/
|
|
302
|
-
|
|
327
|
+
getCategoryData({ uid }?: {
|
|
328
|
+
uid: string;
|
|
329
|
+
}): Promise<SingleCategoryResponse>;
|
|
303
330
|
/**
|
|
304
331
|
* @param {Object} arg - Arg object.
|
|
305
|
-
* @param {
|
|
306
|
-
*
|
|
307
|
-
* @
|
|
308
|
-
* @
|
|
332
|
+
* @param {boolean} [arg.isActive] - The is_active status for the optin id.
|
|
333
|
+
* @param {boolean} [arg.q] - The search value to filter the list.
|
|
334
|
+
* @param {number} [arg.pageNo] - The number of page for the company id.
|
|
335
|
+
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
336
|
+
* the page for the company id.
|
|
337
|
+
* @param {string} [arg.marketplace] - The marketplace platform associated
|
|
338
|
+
* with the company id.
|
|
339
|
+
* @returns {Promise<OptinCompanyBrandDetailsView>} - Success response
|
|
340
|
+
* @summary: Get the Company Brand details of Optin.
|
|
341
|
+
* @description: Get the details of the Brands associated with the given company_id passed.
|
|
309
342
|
*/
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
343
|
+
getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, }?: {
|
|
344
|
+
isActive?: boolean;
|
|
345
|
+
q?: boolean;
|
|
346
|
+
pageNo?: number;
|
|
347
|
+
pageSize?: number;
|
|
348
|
+
marketplace?: string;
|
|
349
|
+
}): Promise<OptinCompanyBrandDetailsView>;
|
|
313
350
|
/**
|
|
314
351
|
* @param {Object} arg - Arg object.
|
|
315
|
-
* @
|
|
316
|
-
* @
|
|
317
|
-
* @
|
|
318
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
319
|
-
* given set of results
|
|
320
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
321
|
-
* page. Default is 10.
|
|
322
|
-
* @summary: Get product categories list
|
|
323
|
-
* @description: This API gets meta associated to product categories.
|
|
352
|
+
* @returns {Promise<OptinCompanyDetail>} - Success response
|
|
353
|
+
* @summary: Get the Company details.
|
|
354
|
+
* @description: Get the details of the company associated with the given company_id passed.
|
|
324
355
|
*/
|
|
325
|
-
|
|
326
|
-
level?: string;
|
|
327
|
-
departments?: string;
|
|
328
|
-
q?: string;
|
|
329
|
-
pageNo?: number;
|
|
330
|
-
pageSize?: number;
|
|
331
|
-
}): Promise<any>;
|
|
356
|
+
getCompanyDetail({}?: any): Promise<OptinCompanyDetail>;
|
|
332
357
|
/**
|
|
333
358
|
* @param {Object} arg - Arg object.
|
|
334
|
-
* @
|
|
335
|
-
* @summary:
|
|
336
|
-
* @description:
|
|
359
|
+
* @returns {Promise<OptinCompanyMetrics>} - Success response
|
|
360
|
+
* @summary: Get the Company metrics
|
|
361
|
+
* @description: Get the Company metrics associated with the company ID passed.
|
|
337
362
|
*/
|
|
338
|
-
|
|
339
|
-
body: CategoryRequestBody;
|
|
340
|
-
}): Promise<any>;
|
|
363
|
+
getCompanyMetrics({}?: any): Promise<OptinCompanyMetrics>;
|
|
341
364
|
/**
|
|
342
365
|
* @param {Object} arg - Arg object.
|
|
343
|
-
* @param {string} arg.uid -
|
|
344
|
-
* @
|
|
345
|
-
* @
|
|
366
|
+
* @param {string} arg.uid - A `uid` is a unique identifier of a department.
|
|
367
|
+
* @returns {Promise<DepartmentsResponse>} - Success response
|
|
368
|
+
* @summary: Get specific departments details by passing in unique id of the department.
|
|
369
|
+
* @description: Allows you to get department data, by uid.
|
|
346
370
|
*/
|
|
347
|
-
|
|
371
|
+
getDepartmentData({ uid }?: {
|
|
348
372
|
uid: string;
|
|
349
|
-
}): Promise<
|
|
373
|
+
}): Promise<DepartmentsResponse>;
|
|
350
374
|
/**
|
|
351
375
|
* @param {Object} arg - Arg object.
|
|
352
|
-
* @param {string} arg.
|
|
353
|
-
*
|
|
354
|
-
* @
|
|
355
|
-
* @
|
|
376
|
+
* @param {string} arg.attributeSlug - Slug of the attribute for which you
|
|
377
|
+
* want to view the genders
|
|
378
|
+
* @returns {Promise<GenderDetail>} - Success response
|
|
379
|
+
* @summary: Get gender attribute details
|
|
380
|
+
* @description: This API allows to view the gender attribute details.
|
|
356
381
|
*/
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
}): Promise<any>;
|
|
382
|
+
getGenderAttribute({ attributeSlug }?: {
|
|
383
|
+
attributeSlug: string;
|
|
384
|
+
}): Promise<GenderDetail>;
|
|
361
385
|
/**
|
|
362
386
|
* @param {Object} arg - Arg object.
|
|
363
|
-
* @param {
|
|
364
|
-
* @
|
|
365
|
-
*
|
|
366
|
-
* @
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
387
|
+
* @param {string} arg.id - Unique id
|
|
388
|
+
* @returns {Promise<HsnCode>} - Success response
|
|
389
|
+
* @summary: Fetch Hsn Code.
|
|
390
|
+
* @description: Fetch Hsn Code.
|
|
391
|
+
*/
|
|
392
|
+
getHsnCode({ id }?: {
|
|
393
|
+
id: string;
|
|
394
|
+
}): Promise<HsnCode>;
|
|
395
|
+
/**
|
|
396
|
+
* @param {Object} arg - Arg object.
|
|
397
|
+
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
398
|
+
* @param {string} [arg.size] - Size of which inventory is to get.
|
|
372
399
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
373
400
|
* given set of results
|
|
374
401
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
375
|
-
* page. Default is
|
|
376
|
-
* @
|
|
377
|
-
* @
|
|
402
|
+
* page. Default is 12.
|
|
403
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
404
|
+
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
405
|
+
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
406
|
+
* @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
|
|
407
|
+
* or Primary Identifier) of which inventory is to get.
|
|
408
|
+
* @returns {Promise<GetInventoriesResponse>} - Success response
|
|
409
|
+
* @summary: Get Inventory for company
|
|
410
|
+
* @description: This API allows get Inventories data for particular company.
|
|
378
411
|
*/
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
itemCode?: string[];
|
|
412
|
+
getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
|
|
413
|
+
itemId?: string;
|
|
414
|
+
size?: string;
|
|
415
|
+
pageNo?: number;
|
|
416
|
+
pageSize?: number;
|
|
385
417
|
q?: string;
|
|
386
|
-
|
|
418
|
+
sellable?: boolean;
|
|
419
|
+
storeIds?: number[];
|
|
420
|
+
sizeIdentifier?: string;
|
|
421
|
+
}): Promise<GetInventoriesResponse>;
|
|
422
|
+
/**
|
|
423
|
+
* @param {Object} arg - Arg object.
|
|
424
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
425
|
+
* given set of results
|
|
426
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
427
|
+
* page. Default is 12.
|
|
428
|
+
* @returns {Promise<BulkInventoryGet>} - Success response
|
|
429
|
+
* @summary: Get a list of all bulk Inventory upload jobs.
|
|
430
|
+
* @description: This API helps to get bulk Inventory upload jobs data.
|
|
431
|
+
*/
|
|
432
|
+
getInventoryBulkUploadHistory({ pageNo, pageSize }?: {
|
|
433
|
+
pageNo?: number;
|
|
434
|
+
pageSize?: number;
|
|
435
|
+
}): Promise<BulkInventoryGet>;
|
|
436
|
+
/**
|
|
437
|
+
* @param {Object} arg - Arg object.
|
|
438
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
439
|
+
* @param {string} arg.size - Size of which inventory is to get.
|
|
440
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
441
|
+
* given set of results
|
|
442
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
443
|
+
* page. Default is 12.
|
|
444
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
445
|
+
* @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
|
|
446
|
+
* @returns {Promise<InventoryResponsePaginated>} - Success response
|
|
447
|
+
* @summary: Get Inventory for company
|
|
448
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
449
|
+
*/
|
|
450
|
+
getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, }?: {
|
|
451
|
+
itemId: number;
|
|
452
|
+
size: string;
|
|
387
453
|
pageNo?: number;
|
|
388
454
|
pageSize?: number;
|
|
389
|
-
|
|
455
|
+
q?: string;
|
|
456
|
+
sellable?: boolean;
|
|
457
|
+
}): Promise<InventoryResponsePaginated>;
|
|
458
|
+
/**
|
|
459
|
+
* @param {Object} arg - Arg object.
|
|
460
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
461
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
462
|
+
* or Primary Identifier) of which inventory is to get.
|
|
463
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
464
|
+
* given set of results
|
|
465
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
466
|
+
* page. Default is 12.
|
|
467
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
468
|
+
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
469
|
+
* @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
|
|
470
|
+
* @summary: Get Inventory for company
|
|
471
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
472
|
+
*/
|
|
473
|
+
getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
|
|
474
|
+
itemId: number;
|
|
475
|
+
sizeIdentifier: string;
|
|
476
|
+
pageNo?: number;
|
|
477
|
+
pageSize?: number;
|
|
478
|
+
q?: string;
|
|
479
|
+
locationIds?: number[];
|
|
480
|
+
}): Promise<InventorySellerIdentifierResponsePaginated>;
|
|
481
|
+
/**
|
|
482
|
+
* @param {Object} arg - Arg object.
|
|
483
|
+
* @returns {Promise<InventoryExportJob>} - Success response
|
|
484
|
+
* @summary: Get Inventory export history.
|
|
485
|
+
* @description: This API helps to get Inventory export history.
|
|
486
|
+
*/
|
|
487
|
+
getInventoryExport({}?: any): Promise<InventoryExportJob>;
|
|
488
|
+
/**
|
|
489
|
+
* @param {Object} arg - Arg object.
|
|
490
|
+
* @returns {Promise<GetOptInPlatform>} - Success response
|
|
491
|
+
* @summary: Get opt-in infomation.
|
|
492
|
+
* @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema`
|
|
493
|
+
*/
|
|
494
|
+
getMarketplaceOptinDetail({}?: any): Promise<GetOptInPlatform>;
|
|
390
495
|
/**
|
|
391
496
|
* @param {Object} arg - Arg object.
|
|
392
|
-
* @param {
|
|
393
|
-
* @
|
|
394
|
-
* @
|
|
497
|
+
* @param {AssignStore} arg.body
|
|
498
|
+
* @returns {Promise<StoreAssignResponse>} - Success response
|
|
499
|
+
* @summary: Location Reassignment
|
|
500
|
+
* @description:
|
|
395
501
|
*/
|
|
396
|
-
|
|
397
|
-
body:
|
|
398
|
-
}): Promise<
|
|
502
|
+
getOptimalLocations({ body }?: {
|
|
503
|
+
body: AssignStore;
|
|
504
|
+
}): Promise<StoreAssignResponse>;
|
|
505
|
+
/**
|
|
506
|
+
* @param {Object} arg - Arg object.
|
|
507
|
+
* @param {number} arg.itemId - Item Id of the product.
|
|
508
|
+
* @param {number} [arg.brandUid] - Brand Id of the product.
|
|
509
|
+
* @param {string} [arg.itemCode] - Item code of the product.
|
|
510
|
+
* @returns {Promise<SingleProductResponse>} - Success response
|
|
511
|
+
* @summary: Get a single product.
|
|
512
|
+
* @description: This API helps to get data associated to a particular product.
|
|
513
|
+
*/
|
|
514
|
+
getProduct({ itemId, brandUid, itemCode }?: {
|
|
515
|
+
itemId: number;
|
|
516
|
+
brandUid?: number;
|
|
517
|
+
itemCode?: string;
|
|
518
|
+
}): Promise<SingleProductResponse>;
|
|
399
519
|
/**
|
|
400
520
|
* @param {Object} arg - Arg object.
|
|
401
|
-
* @param {number} arg.itemId - Get list of variants of item Id
|
|
402
|
-
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
403
521
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
404
522
|
* given set of results
|
|
405
523
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
406
|
-
* page. Default is
|
|
407
|
-
* @
|
|
408
|
-
* @
|
|
524
|
+
* page. Default is 12.
|
|
525
|
+
* @returns {Promise<BulkAssetResponse>} - Success response
|
|
526
|
+
* @summary: Get a list of all bulk asset jobs.
|
|
527
|
+
* @description: This API helps to get bulk asset jobs data associated to a particular company.
|
|
409
528
|
*/
|
|
410
|
-
|
|
411
|
-
itemId: number;
|
|
412
|
-
variantType: string;
|
|
529
|
+
getProductAssetsInBulk({ pageNo, pageSize }?: {
|
|
413
530
|
pageNo?: number;
|
|
414
531
|
pageSize?: number;
|
|
415
|
-
}): Promise<
|
|
532
|
+
}): Promise<BulkAssetResponse>;
|
|
416
533
|
/**
|
|
417
534
|
* @param {Object} arg - Arg object.
|
|
418
535
|
* @param {string} arg.category - It is the name of the l3 cateogry
|
|
419
536
|
* @param {boolean} [arg.filter] - If true, returns filtered values, else
|
|
420
537
|
* returns all the attributes
|
|
538
|
+
* @returns {Promise<ProductAttributesResponse>} - Success response
|
|
421
539
|
* @summary: Get list of all the attributes by their l3_categories
|
|
422
540
|
* @description: This API allows to list all the attributes by their l3_categories.
|
|
423
541
|
*/
|
|
424
542
|
getProductAttributes({ category, filter }?: {
|
|
425
543
|
category: string;
|
|
426
544
|
filter?: boolean;
|
|
427
|
-
}): Promise<
|
|
428
|
-
/**
|
|
429
|
-
* @param {Object} arg - Arg object.
|
|
430
|
-
* @param {number} arg.itemId - Item Id of the product.
|
|
431
|
-
* @param {number} [arg.brandUid] - Brand Id of the product.
|
|
432
|
-
* @param {string} [arg.itemCode] - Item code of the product.
|
|
433
|
-
* @summary: Get a single product.
|
|
434
|
-
* @description: This API helps to get data associated to a particular product.
|
|
435
|
-
*/
|
|
436
|
-
getProduct({ itemId, brandUid, itemCode }?: {
|
|
437
|
-
itemId: number;
|
|
438
|
-
brandUid?: number;
|
|
439
|
-
itemCode?: string;
|
|
440
|
-
}): Promise<any>;
|
|
545
|
+
}): Promise<ProductAttributesResponse>;
|
|
441
546
|
/**
|
|
442
547
|
* @param {Object} arg - Arg object.
|
|
443
|
-
* @param {
|
|
444
|
-
* @param {
|
|
445
|
-
*
|
|
446
|
-
* @
|
|
548
|
+
* @param {string} [arg.search] - Search string to filter the results by batch id
|
|
549
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
550
|
+
* given set of results
|
|
551
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
552
|
+
* page. Default is 12.
|
|
553
|
+
* @returns {Promise<ProductBulkRequestList>} - Success response
|
|
554
|
+
* @summary: Get a list of all bulk product upload jobs.
|
|
555
|
+
* @description: This API helps to get bulk product upload jobs data.
|
|
447
556
|
*/
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
557
|
+
getProductBulkUploadHistory({ search, pageNo, pageSize }?: {
|
|
558
|
+
search?: string;
|
|
559
|
+
pageNo?: number;
|
|
560
|
+
pageSize?: number;
|
|
561
|
+
}): Promise<ProductBulkRequestList>;
|
|
452
562
|
/**
|
|
453
563
|
* @param {Object} arg - Arg object.
|
|
454
|
-
* @param {
|
|
455
|
-
*
|
|
456
|
-
* @
|
|
564
|
+
* @param {string} [arg.q] - A search string that is searched with product
|
|
565
|
+
* bundle name.
|
|
566
|
+
* @param {string[]} [arg.slug] - Slugs of bundles to be retrieved.
|
|
567
|
+
* @returns {Promise<GetProductBundleListingResponse>} - Success response
|
|
568
|
+
* @summary: List all Product Bundles
|
|
569
|
+
* @description: Get all product bundles for a particular company
|
|
457
570
|
*/
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
571
|
+
getProductBundle({ q, slug }?: {
|
|
572
|
+
q?: string;
|
|
573
|
+
slug?: string[];
|
|
574
|
+
}): Promise<GetProductBundleListingResponse>;
|
|
461
575
|
/**
|
|
462
576
|
* @param {Object} arg - Arg object.
|
|
463
|
-
* @param {
|
|
464
|
-
*
|
|
465
|
-
* @
|
|
577
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
578
|
+
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
579
|
+
* @returns {Promise<GetProductBundleResponse>} - Success response
|
|
580
|
+
* @summary: Get a particular Product Bundle details
|
|
581
|
+
* @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
|
|
466
582
|
*/
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
}): Promise<
|
|
470
|
-
/**
|
|
471
|
-
* @param {Object} arg - Arg object.
|
|
472
|
-
* @
|
|
473
|
-
*
|
|
583
|
+
getProductBundleDetail({ id }?: {
|
|
584
|
+
id: string;
|
|
585
|
+
}): Promise<GetProductBundleResponse>;
|
|
586
|
+
/**
|
|
587
|
+
* @param {Object} arg - Arg object.
|
|
588
|
+
* @param {string} [arg.status] - This is a parameter used to find all the
|
|
589
|
+
* jobs with the specified status.
|
|
590
|
+
* @param {string} [arg.fromDate] - This is a parameter used to find the job
|
|
591
|
+
* from the date specified to the current date.
|
|
592
|
+
* @param {string} [arg.toDate] - This is a parameter used to find the job
|
|
593
|
+
* from the from_date specified to the to_date.
|
|
594
|
+
* @param {string} [arg.q] - It is a query parameter to search the export
|
|
595
|
+
* job with the task ID.
|
|
596
|
+
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
597
|
+
* @summary: Allows you to list all product templates export list details
|
|
598
|
+
* @description: Can view details including trigger data, task id , etc.
|
|
474
599
|
*/
|
|
475
|
-
|
|
600
|
+
getProductExportJobs({ status, fromDate, toDate, q }?: {
|
|
601
|
+
status?: string;
|
|
602
|
+
fromDate?: string;
|
|
603
|
+
toDate?: string;
|
|
604
|
+
q?: string;
|
|
605
|
+
}): Promise<ProductDownloadsResponse>;
|
|
476
606
|
/**
|
|
477
607
|
* @param {Object} arg - Arg object.
|
|
478
608
|
* @param {string} [arg.itemCode] - Item code of the product size.
|
|
479
609
|
* @param {number} arg.itemId - Item Id of the product size.
|
|
480
610
|
* @param {number} [arg.brandUid] - Brand Id of the product size.
|
|
481
611
|
* @param {number} [arg.uid] - Id of the product size.
|
|
612
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
482
613
|
* @summary: Get a single product size.
|
|
483
614
|
* @description: This API helps to get data associated to a particular product size.
|
|
484
615
|
*/
|
|
@@ -487,289 +618,320 @@ declare class Catalog {
|
|
|
487
618
|
itemId: number;
|
|
488
619
|
brandUid?: number;
|
|
489
620
|
uid?: number;
|
|
490
|
-
}): Promise<
|
|
621
|
+
}): Promise<ProductListingResponse>;
|
|
491
622
|
/**
|
|
492
623
|
* @param {Object} arg - Arg object.
|
|
493
|
-
* @
|
|
494
|
-
* @
|
|
495
|
-
*
|
|
496
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
497
|
-
* page. Default is 12.
|
|
498
|
-
* @summary: Get a list of all bulk product upload jobs.
|
|
499
|
-
* @description: This API helps to get bulk product upload jobs data.
|
|
624
|
+
* @returns {Promise<ProductTagsViewResponse>} - Success response
|
|
625
|
+
* @summary: Get a list of all tags associated with company.
|
|
626
|
+
* @description: This API helps to get tags data associated to a particular company.
|
|
500
627
|
*/
|
|
501
|
-
|
|
502
|
-
search?: string;
|
|
503
|
-
pageNo?: number;
|
|
504
|
-
pageSize?: number;
|
|
505
|
-
}): Promise<any>;
|
|
628
|
+
getProductTags({}?: any): Promise<ProductTagsViewResponse>;
|
|
506
629
|
/**
|
|
507
630
|
* @param {Object} arg - Arg object.
|
|
508
|
-
* @
|
|
509
|
-
* @summary:
|
|
510
|
-
* @description: This API
|
|
631
|
+
* @returns {Promise<ValidateProduct>} - Success response
|
|
632
|
+
* @summary: Validate product/size data
|
|
633
|
+
* @description: This API validates product data.
|
|
511
634
|
*/
|
|
512
|
-
|
|
513
|
-
body: BulkJob;
|
|
514
|
-
}): Promise<any>;
|
|
635
|
+
getProductValidation({}?: any): Promise<ValidateProduct>;
|
|
515
636
|
/**
|
|
516
637
|
* @param {Object} arg - Arg object.
|
|
517
|
-
* @param {
|
|
518
|
-
* @param {
|
|
519
|
-
*
|
|
520
|
-
* @param {
|
|
521
|
-
* @
|
|
522
|
-
*
|
|
638
|
+
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
639
|
+
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
640
|
+
* Category Ids
|
|
641
|
+
* @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
|
|
642
|
+
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
643
|
+
* Department Ids
|
|
644
|
+
* @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
|
|
645
|
+
* @param {string} [arg.q] - Get multiple products filtered by q string
|
|
646
|
+
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
647
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
648
|
+
* given set of results
|
|
649
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
650
|
+
* page. Default is 10.
|
|
651
|
+
* @returns {Promise<ProductListingResponseV2>} - Success response
|
|
652
|
+
* @summary: Get product list
|
|
653
|
+
* @description: This API gets meta associated to products.
|
|
523
654
|
*/
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
655
|
+
getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: {
|
|
656
|
+
brandIds?: number[];
|
|
657
|
+
categoryIds?: number[];
|
|
658
|
+
itemIds?: number[];
|
|
659
|
+
departmentIds?: number[];
|
|
660
|
+
itemCode?: string[];
|
|
661
|
+
q?: string;
|
|
662
|
+
tags?: string[];
|
|
663
|
+
pageNo?: number;
|
|
664
|
+
pageSize?: number;
|
|
665
|
+
}): Promise<ProductListingResponseV2>;
|
|
529
666
|
/**
|
|
530
667
|
* @param {Object} arg - Arg object.
|
|
531
|
-
* @param {
|
|
532
|
-
*
|
|
533
|
-
* @
|
|
668
|
+
* @param {string} arg.sellerAppId - Id of the seller application which is
|
|
669
|
+
* serving the invetory/catalog of the company
|
|
670
|
+
* @returns {Promise<CrossSellingResponse>} - Success response
|
|
671
|
+
* @summary: Analytics data of catalog and inventory that are being cross-selled.
|
|
672
|
+
* @description: Analytics data of catalog and inventory that are being cross-selled.
|
|
534
673
|
*/
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
}): Promise<
|
|
674
|
+
getSellerInsights({ sellerAppId }?: {
|
|
675
|
+
sellerAppId: string;
|
|
676
|
+
}): Promise<CrossSellingResponse>;
|
|
538
677
|
/**
|
|
539
678
|
* @param {Object} arg - Arg object.
|
|
540
|
-
* @param {string} arg.
|
|
541
|
-
* @
|
|
542
|
-
* @summary:
|
|
543
|
-
* @description:
|
|
679
|
+
* @param {string} arg.reportingHsn - Reporting_hsn
|
|
680
|
+
* @returns {Promise<HSNDataInsertV2>} - Success response
|
|
681
|
+
* @summary: Hsn Code List.
|
|
682
|
+
* @description: Hsn Code List.
|
|
544
683
|
*/
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
}): Promise<any>;
|
|
684
|
+
getSingleProductHSNCode({ reportingHsn }?: {
|
|
685
|
+
reportingHsn: string;
|
|
686
|
+
}): Promise<HSNDataInsertV2>;
|
|
549
687
|
/**
|
|
550
688
|
* @param {Object} arg - Arg object.
|
|
551
|
-
* @
|
|
552
|
-
* @
|
|
689
|
+
* @param {string} arg.id - Id of the size guide to be viewed.
|
|
690
|
+
* @returns {Promise<SizeGuideResponse>} - Success response
|
|
691
|
+
* @summary: Get a single size guide.
|
|
692
|
+
* @description: This API helps to get data associated to a size guide.
|
|
553
693
|
*/
|
|
554
|
-
|
|
694
|
+
getSizeGuide({ id }?: {
|
|
695
|
+
id: string;
|
|
696
|
+
}): Promise<SizeGuideResponse>;
|
|
555
697
|
/**
|
|
556
698
|
* @param {Object} arg - Arg object.
|
|
699
|
+
* @param {boolean} [arg.active] - Filter size guide on basis of active, in-active
|
|
700
|
+
* @param {string} [arg.q] - Query that is to be searched.
|
|
701
|
+
* @param {string} [arg.tag] - To filter size guide on basis of tag.
|
|
557
702
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
558
703
|
* given set of results
|
|
559
704
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
560
|
-
* page. Default is
|
|
561
|
-
* @
|
|
562
|
-
* @
|
|
705
|
+
* page. Default is 10.
|
|
706
|
+
* @returns {Promise<ListSizeGuide>} - Success response
|
|
707
|
+
* @summary: Get list of size guides
|
|
708
|
+
* @description: This API allows to view all the size guides associated to the seller.
|
|
563
709
|
*/
|
|
564
|
-
|
|
710
|
+
getSizeGuides({ active, q, tag, pageNo, pageSize }?: {
|
|
711
|
+
active?: boolean;
|
|
712
|
+
q?: string;
|
|
713
|
+
tag?: string;
|
|
565
714
|
pageNo?: number;
|
|
566
715
|
pageSize?: number;
|
|
567
|
-
}): Promise<
|
|
568
|
-
/**
|
|
569
|
-
* @param {Object} arg - Arg object.
|
|
570
|
-
* @param {ProductBulkAssets} arg.body
|
|
571
|
-
* @summary: Create a Bulk asset upload Job.
|
|
572
|
-
* @description: This API helps to create a bulk asset upload job.
|
|
573
|
-
*/
|
|
574
|
-
createProductAssetsInBulk({ body }?: {
|
|
575
|
-
body: ProductBulkAssets;
|
|
576
|
-
}): Promise<any>;
|
|
716
|
+
}): Promise<ListSizeGuide>;
|
|
577
717
|
/**
|
|
578
718
|
* @param {Object} arg - Arg object.
|
|
579
|
-
* @param {
|
|
580
|
-
*
|
|
581
|
-
* @param {
|
|
582
|
-
*
|
|
583
|
-
* @
|
|
719
|
+
* @param {string} [arg.q] - The search related the store for the company id.
|
|
720
|
+
* @param {number} [arg.pageNo] - The number of page for the company id.
|
|
721
|
+
* @param {number} [arg.pageSize] - Number of records that can be seen on
|
|
722
|
+
* the page for the company id.
|
|
723
|
+
* @returns {Promise<OptinStoreDetails>} - Success response
|
|
724
|
+
* @summary: Get the Store details.
|
|
725
|
+
* @description: Get the details of the store associated with the company ID passed.
|
|
584
726
|
*/
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
727
|
+
getStoreDetail({ q, pageNo, pageSize }?: {
|
|
728
|
+
q?: string;
|
|
729
|
+
pageNo?: number;
|
|
730
|
+
pageSize?: number;
|
|
731
|
+
}): Promise<OptinStoreDetails>;
|
|
589
732
|
/**
|
|
590
733
|
* @param {Object} arg - Arg object.
|
|
591
|
-
* @param {
|
|
592
|
-
* @param {string} arg.
|
|
734
|
+
* @param {number} arg.itemId - Get list of variants of item Id
|
|
735
|
+
* @param {string} arg.variantType - Get multiple products filtered by variant type
|
|
593
736
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
594
737
|
* given set of results
|
|
595
738
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
596
|
-
* page. Default is
|
|
597
|
-
* @
|
|
598
|
-
* @
|
|
599
|
-
* @
|
|
600
|
-
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
739
|
+
* page. Default is 10.
|
|
740
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
741
|
+
* @summary: Get product list
|
|
742
|
+
* @description: This API gets meta associated to products.
|
|
601
743
|
*/
|
|
602
|
-
|
|
603
|
-
itemId:
|
|
604
|
-
|
|
744
|
+
getVariantsOfProducts({ itemId, variantType, pageNo, pageSize }?: {
|
|
745
|
+
itemId: number;
|
|
746
|
+
variantType: string;
|
|
605
747
|
pageNo?: number;
|
|
606
748
|
pageSize?: number;
|
|
607
|
-
|
|
608
|
-
sellable?: boolean;
|
|
609
|
-
}): Promise<any>;
|
|
749
|
+
}): Promise<ProductVariantsResponse>;
|
|
610
750
|
/**
|
|
611
751
|
* @param {Object} arg - Arg object.
|
|
612
|
-
* @param {
|
|
613
|
-
* @param {string} arg.
|
|
614
|
-
* @param {
|
|
615
|
-
* @summary: Add Inventory for particular size and store.
|
|
616
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
617
|
-
*/
|
|
618
|
-
addInventory({ itemId, size, body }?: {
|
|
619
|
-
itemId: number;
|
|
620
|
-
size: string;
|
|
621
|
-
body: InventoryRequest;
|
|
622
|
-
}): Promise<any>;
|
|
623
|
-
/**
|
|
624
|
-
* @param {Object} arg - Arg object.
|
|
625
|
-
* @param {string} arg.itemId - Item code of the product of which size is to be get.
|
|
626
|
-
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
627
|
-
* or Primary Identifier) of which inventory is to get.
|
|
752
|
+
* @param {string} [arg.level] - Get category for multiple levels
|
|
753
|
+
* @param {string} [arg.departments] - Get category for multiple departments filtered
|
|
754
|
+
* @param {string} [arg.q] - Get multiple categories filtered by search string
|
|
628
755
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
629
756
|
* given set of results
|
|
630
757
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
631
|
-
* page. Default is
|
|
632
|
-
* @
|
|
633
|
-
* @
|
|
634
|
-
* @
|
|
635
|
-
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
758
|
+
* page. Default is 10.
|
|
759
|
+
* @returns {Promise<CategoryResponse>} - Success response
|
|
760
|
+
* @summary: Get product categories list
|
|
761
|
+
* @description: This API gets meta associated to product categories.
|
|
636
762
|
*/
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
763
|
+
listCategories({ level, departments, q, pageNo, pageSize }?: {
|
|
764
|
+
level?: string;
|
|
765
|
+
departments?: string;
|
|
766
|
+
q?: string;
|
|
640
767
|
pageNo?: number;
|
|
641
768
|
pageSize?: number;
|
|
642
|
-
|
|
643
|
-
locationIds?: number[];
|
|
644
|
-
}): Promise<any>;
|
|
769
|
+
}): Promise<CategoryResponse>;
|
|
645
770
|
/**
|
|
646
771
|
* @param {Object} arg - Arg object.
|
|
647
|
-
* @param {string} [arg.itemId] - Item code of the product of which size is to be get.
|
|
648
|
-
* @param {string} [arg.size] - Size of which inventory is to get.
|
|
649
772
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
650
773
|
* given set of results
|
|
774
|
+
* @param {string} [arg.itemType] - A `item_type` is a type of product eg.
|
|
775
|
+
* set, standard, digital
|
|
651
776
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
652
|
-
* page. Default is
|
|
653
|
-
* @param {string} [arg.
|
|
654
|
-
* @param {
|
|
655
|
-
*
|
|
656
|
-
* @param {
|
|
657
|
-
*
|
|
658
|
-
* @
|
|
659
|
-
* @
|
|
777
|
+
* page. Default is 10.
|
|
778
|
+
* @param {string} [arg.name] - Can search departments by passing name.
|
|
779
|
+
* @param {string} [arg.search] - Can search departments by passing name of
|
|
780
|
+
* the department in search parameter.
|
|
781
|
+
* @param {boolean} [arg.isActive] - Can query for departments based on
|
|
782
|
+
* whether they are active or inactive.
|
|
783
|
+
* @returns {Promise<DepartmentsResponse>} - Success response
|
|
784
|
+
* @summary: List all Departments.
|
|
785
|
+
* @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
|
|
660
786
|
*/
|
|
661
|
-
|
|
662
|
-
itemId?: string;
|
|
663
|
-
size?: string;
|
|
787
|
+
listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, }?: {
|
|
664
788
|
pageNo?: number;
|
|
789
|
+
itemType?: string;
|
|
665
790
|
pageSize?: number;
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
}): Promise<any>;
|
|
791
|
+
name?: string;
|
|
792
|
+
search?: string;
|
|
793
|
+
isActive?: boolean;
|
|
794
|
+
}): Promise<DepartmentsResponse>;
|
|
671
795
|
/**
|
|
672
796
|
* @param {Object} arg - Arg object.
|
|
673
|
-
* @
|
|
674
|
-
* @
|
|
675
|
-
*
|
|
676
|
-
* @param {number} arg.locationId - Location ID of store of which inventory
|
|
677
|
-
* is to be deleted.
|
|
678
|
-
* @summary: Delete a Inventory.
|
|
679
|
-
* @description: This API allows to delete inventory of a particular product for particular company.
|
|
797
|
+
* @returns {Promise<HSNCodesResponse>} - Success response
|
|
798
|
+
* @summary: List HSN Codes
|
|
799
|
+
* @description: Allows you to list all hsn Codes
|
|
680
800
|
*/
|
|
681
|
-
|
|
682
|
-
size: string;
|
|
683
|
-
itemId: number;
|
|
684
|
-
locationId: number;
|
|
685
|
-
}): Promise<any>;
|
|
801
|
+
listHSNCodes({}?: any): Promise<HSNCodesResponse>;
|
|
686
802
|
/**
|
|
687
803
|
* @param {Object} arg - Arg object.
|
|
688
|
-
* @param {
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
693
|
-
* @
|
|
804
|
+
* @param {string} [arg.status] - Status of the export job.
|
|
805
|
+
* @param {string} [arg.fromDate] - Inventory export history filtered
|
|
806
|
+
* according to from_date.
|
|
807
|
+
* @param {string} [arg.toDate] - Inventory export history filtered
|
|
808
|
+
* according to from_date.
|
|
809
|
+
* @param {string} [arg.q] - Inventory export history filtered according to task ID.
|
|
810
|
+
* @returns {Promise<InventoryExportJobListResponse>} - Success response
|
|
811
|
+
* @summary: Get the history of the inventory export.
|
|
812
|
+
* @description: This API helps you the get the history of inventory jobs depending on the filtered criteria.
|
|
694
813
|
*/
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
814
|
+
listInventoryExport({ status, fromDate, toDate, q }?: {
|
|
815
|
+
status?: string;
|
|
816
|
+
fromDate?: string;
|
|
817
|
+
toDate?: string;
|
|
818
|
+
q?: string;
|
|
819
|
+
}): Promise<InventoryExportJobListResponse>;
|
|
699
820
|
/**
|
|
700
821
|
* @param {Object} arg - Arg object.
|
|
701
|
-
* @param {
|
|
702
|
-
*
|
|
703
|
-
* @
|
|
822
|
+
* @param {string} arg.department - A `department` is the name of a
|
|
823
|
+
* particular department.
|
|
824
|
+
* @returns {Promise<TemplatesResponse>} - Success response
|
|
825
|
+
* @summary: List all Templates
|
|
826
|
+
* @description: Allows you to list all product templates, also can filter by department
|
|
704
827
|
*/
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
}): Promise<
|
|
828
|
+
listProductTemplate({ department }?: {
|
|
829
|
+
department: string;
|
|
830
|
+
}): Promise<TemplatesResponse>;
|
|
708
831
|
/**
|
|
709
832
|
* @param {Object} arg - Arg object.
|
|
710
|
-
* @param {string} arg.
|
|
711
|
-
*
|
|
712
|
-
* @
|
|
833
|
+
* @param {string} arg.departments - A `department` is name of a departments
|
|
834
|
+
* whose category needs to be listed. Can specify multiple departments.
|
|
835
|
+
* @param {string} arg.itemType - An `item_type` is the type of item, it can
|
|
836
|
+
* be `set`, `standard`, `digital`, etc.
|
|
837
|
+
* @returns {Promise<ProdcutTemplateCategoriesResponse>} - Success response
|
|
838
|
+
* @summary: List Department specifiec product categories
|
|
839
|
+
* @description: Allows you to list all product categories values for the departments specified
|
|
713
840
|
*/
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
841
|
+
listProductTemplateCategories({ departments, itemType }?: {
|
|
842
|
+
departments: string;
|
|
843
|
+
itemType: string;
|
|
844
|
+
}): Promise<ProdcutTemplateCategoriesResponse>;
|
|
717
845
|
/**
|
|
718
846
|
* @param {Object} arg - Arg object.
|
|
719
|
-
* @
|
|
720
|
-
* @
|
|
721
|
-
* @
|
|
722
|
-
* @description: This API helps to create products in bulk push to kafka for approval/creation.
|
|
847
|
+
* @returns {Promise<ProductDownloadsResponse>} - Success response
|
|
848
|
+
* @summary: Allows you to list all product templates export list details
|
|
849
|
+
* @description: Can view details including trigger data, task id , etc.
|
|
723
850
|
*/
|
|
724
|
-
|
|
725
|
-
batchId: string;
|
|
726
|
-
body: InventoryBulkRequest;
|
|
727
|
-
}): Promise<any>;
|
|
851
|
+
listProductTemplateExportDetails({}?: any): Promise<ProductDownloadsResponse>;
|
|
728
852
|
/**
|
|
729
853
|
* @param {Object} arg - Arg object.
|
|
730
|
-
* @
|
|
731
|
-
*
|
|
854
|
+
* @param {string} arg.filter - A `filter` is the unique identifier of the
|
|
855
|
+
* type of value required.
|
|
856
|
+
* @param {string} [arg.templateTag] - A `template_tag` is the identifier of
|
|
857
|
+
* the type of template required.
|
|
858
|
+
* @param {string} [arg.itemType] - A `item_type` is the identifier of the
|
|
859
|
+
* type of template required.
|
|
860
|
+
* @returns {Promise<ProductConfigurationDownloads>} - Success response
|
|
861
|
+
* @summary: Allows you to list all values for Templates, Brands or Type
|
|
862
|
+
* @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
|
|
732
863
|
*/
|
|
733
|
-
|
|
864
|
+
listTemplateBrandTypeValues({ filter, templateTag, itemType }?: {
|
|
865
|
+
filter: string;
|
|
866
|
+
templateTag?: string;
|
|
867
|
+
itemType?: string;
|
|
868
|
+
}): Promise<ProductConfigurationDownloads>;
|
|
734
869
|
/**
|
|
735
870
|
* @param {Object} arg - Arg object.
|
|
736
|
-
* @param {
|
|
737
|
-
* @
|
|
738
|
-
* @
|
|
871
|
+
* @param {string} arg.uid - Category unique id
|
|
872
|
+
* @param {CategoryRequestBody} arg.body
|
|
873
|
+
* @returns {Promise<CategoryUpdateResponse>} - Success response
|
|
874
|
+
* @summary: Update product categories
|
|
875
|
+
* @description: Update a product category using this apu
|
|
739
876
|
*/
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
877
|
+
updateCategory({ uid, body }?: {
|
|
878
|
+
uid: string;
|
|
879
|
+
body: CategoryRequestBody;
|
|
880
|
+
}): Promise<CategoryUpdateResponse>;
|
|
743
881
|
/**
|
|
744
882
|
* @param {Object} arg - Arg object.
|
|
745
|
-
* @param {string}
|
|
746
|
-
*
|
|
747
|
-
* @
|
|
748
|
-
* @
|
|
883
|
+
* @param {string} arg.uid - A `uid` is a unique identifier of a department.
|
|
884
|
+
* @param {DepartmentCreateUpdate} arg.body
|
|
885
|
+
* @returns {Promise<DepartmentModel>} - Success response
|
|
886
|
+
* @summary: Update the department by their uid.
|
|
887
|
+
* @description: Update the department by their uid using this API.
|
|
749
888
|
*/
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
889
|
+
updateDepartment({ uid, body }?: {
|
|
890
|
+
uid: string;
|
|
891
|
+
body: DepartmentCreateUpdate;
|
|
892
|
+
}): Promise<DepartmentModel>;
|
|
893
|
+
/**
|
|
894
|
+
* @param {Object} arg - Arg object.
|
|
895
|
+
* @param {string} arg.id - Unique id
|
|
896
|
+
* @param {HsnUpsert} arg.body
|
|
897
|
+
* @returns {Promise<HsnCode>} - Success response
|
|
898
|
+
* @summary: Update Hsn Code.
|
|
899
|
+
* @description: Update Hsn Code.
|
|
900
|
+
*/
|
|
901
|
+
updateHsnCode({ id, body }?: {
|
|
902
|
+
id: string;
|
|
903
|
+
body: HsnUpsert;
|
|
904
|
+
}): Promise<HsnCode>;
|
|
753
905
|
/**
|
|
754
906
|
* @param {Object} arg - Arg object.
|
|
755
|
-
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
756
|
-
* @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
|
|
757
|
-
* or Primary Identifier) of which inventory is to get.
|
|
758
907
|
* @param {InventoryRequestSchemaV2} arg.body
|
|
908
|
+
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
759
909
|
* @summary: Add Inventory for particular size and store.
|
|
760
910
|
* @description: This API allows add Inventory for particular size and store.
|
|
761
911
|
*/
|
|
762
|
-
|
|
763
|
-
itemId: number;
|
|
764
|
-
sellerIdentifier: string;
|
|
912
|
+
updateInventories({ body }?: {
|
|
765
913
|
body: InventoryRequestSchemaV2;
|
|
766
|
-
}): Promise<
|
|
914
|
+
}): Promise<InventoryUpdateResponse>;
|
|
915
|
+
/**
|
|
916
|
+
* @param {Object} arg - Arg object.
|
|
917
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
918
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
919
|
+
* @param {ProductBundleUpdateRequest} arg.body
|
|
920
|
+
* @returns {Promise<GetProductBundleCreateResponse>} - Success response
|
|
921
|
+
* @summary: Update a Product Bundle
|
|
922
|
+
* @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
|
|
923
|
+
*/
|
|
924
|
+
updateProductBundle({ id, body }?: {
|
|
925
|
+
id: string;
|
|
926
|
+
body: ProductBundleUpdateRequest;
|
|
927
|
+
}): Promise<GetProductBundleCreateResponse>;
|
|
767
928
|
/**
|
|
768
929
|
* @param {Object} arg - Arg object.
|
|
769
930
|
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
770
931
|
* @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
|
|
771
932
|
* or Primary Identifier) of which inventory is to get.
|
|
772
933
|
* @param {InventoryRequestSchemaV2} arg.body
|
|
934
|
+
* @returns {Promise<InventoryUpdateResponse>} - Success response
|
|
773
935
|
* @summary: Add Inventory for particular size and store.
|
|
774
936
|
* @description: This API allows add Inventory for particular size and store.
|
|
775
937
|
*/
|
|
@@ -777,98 +939,54 @@ declare class Catalog {
|
|
|
777
939
|
itemId: number;
|
|
778
940
|
sellerIdentifier: string;
|
|
779
941
|
body: InventoryRequestSchemaV2;
|
|
780
|
-
}): Promise<
|
|
781
|
-
/**
|
|
782
|
-
* @param {Object} arg - Arg object.
|
|
783
|
-
* @param {InventoryRequestSchemaV2} arg.body
|
|
784
|
-
* @summary: Add Inventory for particular size and store.
|
|
785
|
-
* @description: This API allows add Inventory for particular size and store.
|
|
786
|
-
*/
|
|
787
|
-
updateInventories({ body }?: {
|
|
788
|
-
body: InventoryRequestSchemaV2;
|
|
789
|
-
}): Promise<any>;
|
|
790
|
-
/**
|
|
791
|
-
* @param {Object} arg - Arg object.
|
|
792
|
-
* @param {number} [arg.pageNo] - Page no
|
|
793
|
-
* @param {number} [arg.pageSize] - Page size
|
|
794
|
-
* @param {string} [arg.q] - Search using hsn code.
|
|
795
|
-
* @summary: Hsn Code List.
|
|
796
|
-
* @description: Hsn Code List.
|
|
797
|
-
*/
|
|
798
|
-
getAllHsnCodes({ pageNo, pageSize, q }?: {
|
|
799
|
-
pageNo?: number;
|
|
800
|
-
pageSize?: number;
|
|
801
|
-
q?: string;
|
|
802
|
-
}): Promise<any>;
|
|
803
|
-
/**
|
|
804
|
-
* @param {Object} arg - Arg object.
|
|
805
|
-
* @param {HsnUpsert} arg.body
|
|
806
|
-
* @summary: Create Hsn Code.
|
|
807
|
-
* @description: Create Hsn Code.
|
|
808
|
-
*/
|
|
809
|
-
createHsnCode({ body }?: {
|
|
810
|
-
body: HsnUpsert;
|
|
811
|
-
}): Promise<any>;
|
|
812
|
-
/**
|
|
813
|
-
* @param {Object} arg - Arg object.
|
|
814
|
-
* @param {string} arg.id - Unique id
|
|
815
|
-
* @summary: Fetch Hsn Code.
|
|
816
|
-
* @description: Fetch Hsn Code.
|
|
817
|
-
*/
|
|
818
|
-
getHsnCode({ id }?: {
|
|
819
|
-
id: string;
|
|
820
|
-
}): Promise<any>;
|
|
942
|
+
}): Promise<InventoryUpdateResponse>;
|
|
821
943
|
/**
|
|
822
944
|
* @param {Object} arg - Arg object.
|
|
823
|
-
* @param {string} arg.id -
|
|
824
|
-
* @param {
|
|
825
|
-
* @
|
|
826
|
-
* @
|
|
945
|
+
* @param {string} arg.id - Mongo id of the size guide to be edited
|
|
946
|
+
* @param {ValidateSizeGuide} arg.body
|
|
947
|
+
* @returns {Promise<SuccessResponse>} - Success response
|
|
948
|
+
* @summary: Edit a size guide.
|
|
949
|
+
* @description: This API allows to edit a size guide.
|
|
827
950
|
*/
|
|
828
|
-
|
|
951
|
+
updateSizeGuide({ id, body }?: {
|
|
829
952
|
id: string;
|
|
830
|
-
body:
|
|
831
|
-
}): Promise<
|
|
832
|
-
/**
|
|
833
|
-
* @param {Object} arg - Arg object.
|
|
834
|
-
* @param {BulkHsnUpsert} arg.body
|
|
835
|
-
* @summary: Bulk Create or Update Hsn Code.
|
|
836
|
-
* @description: Bulk Create or Update Hsn Code.
|
|
837
|
-
*/
|
|
838
|
-
bulkHsnCode({ body }?: {
|
|
839
|
-
body: BulkHsnUpsert;
|
|
840
|
-
}): Promise<any>;
|
|
953
|
+
body: ValidateSizeGuide;
|
|
954
|
+
}): Promise<SuccessResponse>;
|
|
841
955
|
/**
|
|
842
956
|
* @param {Object} arg - Arg object.
|
|
843
|
-
* @param {
|
|
844
|
-
* @param {
|
|
845
|
-
*
|
|
846
|
-
* @param {
|
|
847
|
-
* @
|
|
848
|
-
* @
|
|
957
|
+
* @param {string} arg.department - Department of the product to be uploaded.
|
|
958
|
+
* @param {string} arg.productType - Product type of the product to be
|
|
959
|
+
* uploaded i.e. set, standard , digital.
|
|
960
|
+
* @param {BulkJob} arg.body
|
|
961
|
+
* @returns {Promise<BulkResponse>} - Success response
|
|
962
|
+
* @summary: Create a Bulk product to upload job.
|
|
963
|
+
* @description: This API helps to create a bulk products upload job.
|
|
849
964
|
*/
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
}): Promise<any>;
|
|
965
|
+
uploadBulkProducts({ department, productType, body }?: {
|
|
966
|
+
department: string;
|
|
967
|
+
productType: string;
|
|
968
|
+
body: BulkJob;
|
|
969
|
+
}): Promise<BulkResponse>;
|
|
856
970
|
/**
|
|
857
971
|
* @param {Object} arg - Arg object.
|
|
858
|
-
* @param {string} arg.
|
|
859
|
-
*
|
|
860
|
-
* @
|
|
972
|
+
* @param {string} arg.slug - A `slug` is a unique identifier for a
|
|
973
|
+
* particular template.
|
|
974
|
+
* @returns {Promise<TemplatesValidationResponse>} - Success response
|
|
975
|
+
* @summary: Validate Product Template Schema
|
|
976
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
861
977
|
*/
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
}): Promise<
|
|
978
|
+
validateProductTemplate({ slug }?: {
|
|
979
|
+
slug: string;
|
|
980
|
+
}): Promise<TemplatesValidationResponse>;
|
|
865
981
|
/**
|
|
866
982
|
* @param {Object} arg - Arg object.
|
|
867
|
-
* @param {
|
|
868
|
-
*
|
|
869
|
-
* @
|
|
983
|
+
* @param {string} arg.itemType - An `item_type` defines the type of item.
|
|
984
|
+
* The default value is standard.
|
|
985
|
+
* @returns {Promise<InventoryValidationResponse>} - Success response
|
|
986
|
+
* @summary: Validate Product Template Schema
|
|
987
|
+
* @description: Allows you to list all product templates validation values for all the fields present in the database
|
|
870
988
|
*/
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
}): Promise<
|
|
989
|
+
validateProductTemplateSchema({ itemType }?: {
|
|
990
|
+
itemType: string;
|
|
991
|
+
}): Promise<InventoryValidationResponse>;
|
|
874
992
|
}
|