@gofynd/fdk-client-javascript 1.0.2 → 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 +557 -1279
- 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 +14453 -17192
- 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 +3438 -4172
- 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 +3400 -5361
- 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/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +567 -567
- 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 +1036 -1036
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
- 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 +38 -38
- 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 +26 -26
- 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 +330 -330
- 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 +191 -191
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
- package/sdk/application/Content/ContentApplicationModel.js +467 -884
- 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 +59 -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 +100 -100
- 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 +110 -43
- 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 +85 -85
- package/sdk/application/Order/OrderApplicationClient.js +232 -232
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +352 -656
- 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 +739 -739
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
- 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 +617 -617
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
- package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
- 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 +112 -112
- 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 +84 -84
- 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 +31 -31
- 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 +581 -581
- 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 +51 -51
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
- 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 +60 -60
- package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
- 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 +168 -168
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
- package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
- package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformClient.js +41 -41
- 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 +326 -326
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
- 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 +534 -534
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
- package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
- package/sdk/platform/Content/ContentPlatformModel.js +484 -907
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
- package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
- 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 +24 -24
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
- 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 +63 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
- 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 +73 -73
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
- package/sdk/platform/Lead/LeadPlatformClient.js +212 -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/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
- package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
- package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
- package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
- package/sdk/platform/PlatformApplicationClient.js +1584 -13899
- package/sdk/platform/PlatformClient.d.ts +7965 -7885
- package/sdk/platform/PlatformClient.js +8672 -10105
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
- 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 +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
- 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 +132 -132
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
- 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 +136 -69
- package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
- 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 +31 -31
- package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
- 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 +38 -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 +113 -113
- 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/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -5,91 +5,48 @@ declare class Catalog {
|
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
7
|
* @param {Object} arg - Arg object.
|
|
8
|
-
* @param {string} arg.id - A `id` is a unique identifier
|
|
9
|
-
*
|
|
10
|
-
* @returns {Promise<
|
|
11
|
-
* @summary:
|
|
12
|
-
* @description:
|
|
13
|
-
*/
|
|
14
|
-
getSearchKeywords({ id }?: {
|
|
15
|
-
id: string;
|
|
16
|
-
}): Promise<GetSearchWordsDetailResponse>;
|
|
17
|
-
/**
|
|
18
|
-
* @param {Object} arg - Arg object.
|
|
19
|
-
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
20
|
-
* detail. Pass the `id` of the keywords which you want to delete.
|
|
21
|
-
* @param {CreateSearchKeyword} arg.body
|
|
22
|
-
* @returns {Promise<GetSearchWordsData>} - Success response
|
|
23
|
-
* @summary: Update Search Keyword
|
|
24
|
-
* @description: Update Search Keyword by its id. On successful request, returns the updated collection
|
|
25
|
-
*/
|
|
26
|
-
updateSearchKeywords({ id, body }?: {
|
|
27
|
-
id: string;
|
|
28
|
-
body: CreateSearchKeyword;
|
|
29
|
-
}): Promise<GetSearchWordsData>;
|
|
30
|
-
/**
|
|
31
|
-
* @param {Object} arg - Arg object.
|
|
32
|
-
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
33
|
-
* detail. Pass the `id` of the keywords which you want to delete.
|
|
34
|
-
* @returns {Promise<DeleteResponse>} - Success response
|
|
35
|
-
* @summary: Delete a Search Keywords
|
|
36
|
-
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
|
|
8
|
+
* @param {string} arg.id - A `id` is a unique identifier of a collection.
|
|
9
|
+
* @param {CollectionItemUpdate} arg.body
|
|
10
|
+
* @returns {Promise<UpdatedResponse>} - Success response
|
|
11
|
+
* @summary: Add items to a collection
|
|
12
|
+
* @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
|
|
37
13
|
*/
|
|
38
|
-
|
|
14
|
+
addCollectionItems({ id, body }?: {
|
|
39
15
|
id: string;
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
* @param {Object} arg - Arg object.
|
|
43
|
-
* @param {CreateSearchKeyword} arg.body
|
|
44
|
-
* @returns {Promise<GetSearchWordsData>} - Success response
|
|
45
|
-
* @summary: Add a Custom Search Keywords
|
|
46
|
-
* @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
|
|
47
|
-
*/
|
|
48
|
-
createCustomKeyword({ body }?: {
|
|
49
|
-
body: CreateSearchKeyword;
|
|
50
|
-
}): Promise<GetSearchWordsData>;
|
|
51
|
-
/**
|
|
52
|
-
* @param {Object} arg - Arg object.
|
|
53
|
-
* @returns {Promise<GetSearchWordsResponse>} - Success response
|
|
54
|
-
* @summary: List all Search Custom Keyword Listing
|
|
55
|
-
* @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
|
|
56
|
-
*/
|
|
57
|
-
getAllSearchKeyword({}?: any): Promise<GetSearchWordsResponse>;
|
|
16
|
+
body: CollectionItemUpdate;
|
|
17
|
+
}): Promise<UpdatedResponse>;
|
|
58
18
|
/**
|
|
59
19
|
* @param {Object} arg - Arg object.
|
|
60
|
-
* @param {
|
|
61
|
-
*
|
|
62
|
-
* @
|
|
63
|
-
* @
|
|
64
|
-
* @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
|
|
20
|
+
* @param {CreateCollection} arg.body
|
|
21
|
+
* @returns {Promise<CollectionCreateResponse>} - Success response
|
|
22
|
+
* @summary: Add a Collection
|
|
23
|
+
* @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
|
|
65
24
|
*/
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
}): Promise<
|
|
25
|
+
createCollection({ body }?: {
|
|
26
|
+
body: CreateCollection;
|
|
27
|
+
}): Promise<CollectionCreateResponse>;
|
|
69
28
|
/**
|
|
70
29
|
* @param {Object} arg - Arg object.
|
|
71
|
-
* @param {string} arg.
|
|
72
|
-
*
|
|
73
|
-
* @
|
|
74
|
-
* @
|
|
75
|
-
* @
|
|
76
|
-
* @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
|
|
30
|
+
* @param {string} arg.type - Type can be brands, categories etc.
|
|
31
|
+
* @param {AppConfiguration} arg.body
|
|
32
|
+
* @returns {Promise<GetAppCatalogConfiguration>} - Success response
|
|
33
|
+
* @summary: Add configuration for categories and brands
|
|
34
|
+
* @description: Add configuration for categories & brands.
|
|
77
35
|
*/
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
body:
|
|
81
|
-
}): Promise<
|
|
36
|
+
createConfigurationByType({ type, body }?: {
|
|
37
|
+
type: string;
|
|
38
|
+
body: AppConfiguration;
|
|
39
|
+
}): Promise<GetAppCatalogConfiguration>;
|
|
82
40
|
/**
|
|
83
41
|
* @param {Object} arg - Arg object.
|
|
84
|
-
* @param {
|
|
85
|
-
*
|
|
86
|
-
* @
|
|
87
|
-
* @
|
|
88
|
-
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
|
|
42
|
+
* @param {AppConfiguration} arg.body
|
|
43
|
+
* @returns {Promise<GetAppCatalogConfiguration>} - Success response
|
|
44
|
+
* @summary: Add configuration for products & listings
|
|
45
|
+
* @description: Add configuration for products & listing.
|
|
89
46
|
*/
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
}): Promise<
|
|
47
|
+
createConfigurationProductListing({ body }?: {
|
|
48
|
+
body: AppConfiguration;
|
|
49
|
+
}): Promise<GetAppCatalogConfiguration>;
|
|
93
50
|
/**
|
|
94
51
|
* @param {Object} arg - Arg object.
|
|
95
52
|
* @param {CreateAutocompleteKeyword} arg.body
|
|
@@ -102,47 +59,14 @@ declare class Catalog {
|
|
|
102
59
|
}): Promise<CreateAutocompleteWordsResponse>;
|
|
103
60
|
/**
|
|
104
61
|
* @param {Object} arg - Arg object.
|
|
105
|
-
* @
|
|
106
|
-
* @
|
|
107
|
-
* @
|
|
108
|
-
|
|
109
|
-
getAutocompleteConfig({}?: any): Promise<GetAutocompleteWordsResponse>;
|
|
110
|
-
/**
|
|
111
|
-
* @param {Object} arg - Arg object.
|
|
112
|
-
* @param {string} arg.itemId - Product id for a particular product.
|
|
113
|
-
* @returns {Promise<OwnerAppItemResponse>} - Success response
|
|
114
|
-
* @summary: Get company application product data.
|
|
115
|
-
* @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
|
|
116
|
-
*/
|
|
117
|
-
getAppProduct({ itemId }?: {
|
|
118
|
-
itemId: string;
|
|
119
|
-
}): Promise<OwnerAppItemResponse>;
|
|
120
|
-
/**
|
|
121
|
-
* @param {Object} arg - Arg object.
|
|
122
|
-
* @param {string} arg.itemId - Product id for which the custom_meta is associated.
|
|
123
|
-
* @param {ApplicationItemMeta} arg.body
|
|
124
|
-
* @returns {Promise<SuccessResponse1>} - Success response
|
|
125
|
-
* @summary: Update a single custom meta.
|
|
126
|
-
* @description: This API helps to update data associated to a item custom meta.
|
|
127
|
-
*/
|
|
128
|
-
updateAppProduct({ itemId, body }?: {
|
|
129
|
-
itemId: string;
|
|
130
|
-
body: ApplicationItemMeta;
|
|
131
|
-
}): Promise<SuccessResponse1>;
|
|
132
|
-
/**
|
|
133
|
-
* @param {Object} arg - Arg object.
|
|
134
|
-
* @param {string} arg.configType - A `config_type` is an identifier that
|
|
135
|
-
* defines a specific type of configuration.
|
|
136
|
-
* @param {string} [arg.templateSlug] - Get configuration list filtered by
|
|
137
|
-
* `template_slug` string. This is for the details and comparision groups.
|
|
138
|
-
* @returns {Promise<GetConfigMetadataResponse>} - Success response
|
|
139
|
-
* @summary: Get configuration metadata details for catalog for admin panel
|
|
140
|
-
* @description: Get the configuraion metadata details for catalog.
|
|
62
|
+
* @param {CreateSearchKeyword} arg.body
|
|
63
|
+
* @returns {Promise<GetSearchWordsData>} - Success response
|
|
64
|
+
* @summary: Add a Custom Search Keywords
|
|
65
|
+
* @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
|
|
141
66
|
*/
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
}): Promise<GetConfigMetadataResponse>;
|
|
67
|
+
createCustomKeyword({ body }?: {
|
|
68
|
+
body: CreateSearchKeyword;
|
|
69
|
+
}): Promise<GetSearchWordsData>;
|
|
146
70
|
/**
|
|
147
71
|
* @param {Object} arg - Arg object.
|
|
148
72
|
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
@@ -158,42 +82,38 @@ declare class Catalog {
|
|
|
158
82
|
}): Promise<AppConfigurationDetail>;
|
|
159
83
|
/**
|
|
160
84
|
* @param {Object} arg - Arg object.
|
|
161
|
-
* @param {string} arg.configType - A `config_type` is
|
|
162
|
-
*
|
|
163
|
-
* @param {
|
|
164
|
-
*
|
|
165
|
-
* @
|
|
166
|
-
*
|
|
167
|
-
* @param {string} [arg.search] - Get configuration list filtered by `search` string.
|
|
168
|
-
* @param {string} [arg.templateSlug] - Get configuration list filtered by
|
|
169
|
-
* `template_slug` string. This is for the details and comparision groups.
|
|
170
|
-
* @returns {Promise<GetConfigResponse>} - Success response
|
|
171
|
-
* @summary: Get the details of the application configured configurations of group config types.
|
|
172
|
-
* @description: Get the details of the application configured configurations of group config types.
|
|
85
|
+
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
86
|
+
* for a particular listing configuration type.
|
|
87
|
+
* @param {AppConfigurationsSort} arg.body
|
|
88
|
+
* @returns {Promise<AppConfigurationsSort>} - Success response
|
|
89
|
+
* @summary: Add configuration for listings
|
|
90
|
+
* @description: Add configuration for listing.
|
|
173
91
|
*/
|
|
174
|
-
|
|
92
|
+
createListingConfiguration({ configType, body }?: {
|
|
175
93
|
configType: string;
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
search?: string;
|
|
179
|
-
templateSlug?: string;
|
|
180
|
-
}): Promise<GetConfigResponse>;
|
|
94
|
+
body: AppConfigurationsSort;
|
|
95
|
+
}): Promise<AppConfigurationsSort>;
|
|
181
96
|
/**
|
|
182
97
|
* @param {Object} arg - Arg object.
|
|
183
|
-
* @param {string} arg.
|
|
184
|
-
*
|
|
185
|
-
* @
|
|
186
|
-
*
|
|
187
|
-
* @
|
|
188
|
-
* @returns {Promise<AppConfigurationDetail>} - Success response
|
|
189
|
-
* @summary: Update the group configurations for the application.
|
|
190
|
-
* @description: Update the group configurations for the application.
|
|
98
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
99
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
100
|
+
* @returns {Promise<DeleteResponse>} - Success response
|
|
101
|
+
* @summary: Delete a Autocomplete Keywords
|
|
102
|
+
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
|
|
191
103
|
*/
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
104
|
+
deleteAutocompleteKeyword({ id }?: {
|
|
105
|
+
id: string;
|
|
106
|
+
}): Promise<DeleteResponse>;
|
|
107
|
+
/**
|
|
108
|
+
* @param {Object} arg - Arg object.
|
|
109
|
+
* @param {string} arg.id - A `id` is a unique identifier of a collection.
|
|
110
|
+
* @returns {Promise<DeleteResponse>} - Success response
|
|
111
|
+
* @summary: Delete a Collection
|
|
112
|
+
* @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
|
|
113
|
+
*/
|
|
114
|
+
deleteCollection({ id }?: {
|
|
115
|
+
id: string;
|
|
116
|
+
}): Promise<DeleteResponse>;
|
|
197
117
|
/**
|
|
198
118
|
* @param {Object} arg - Arg object.
|
|
199
119
|
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
@@ -212,271 +132,286 @@ declare class Catalog {
|
|
|
212
132
|
* @param {Object} arg - Arg object.
|
|
213
133
|
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
214
134
|
* for a particular listing configuration type.
|
|
215
|
-
* @param {
|
|
216
|
-
*
|
|
217
|
-
* @
|
|
218
|
-
* @
|
|
135
|
+
* @param {string} arg.configId - A `config_id` is a unique identifier of a
|
|
136
|
+
* particular configuration.
|
|
137
|
+
* @returns {Promise<ConfigSuccessResponse>} - Success response
|
|
138
|
+
* @summary: Delete configuration for listings
|
|
139
|
+
* @description: Delete configuration for listing.
|
|
219
140
|
*/
|
|
220
|
-
|
|
141
|
+
deleteListingConfiguration({ configType, configId }?: {
|
|
221
142
|
configType: string;
|
|
222
|
-
|
|
223
|
-
}): Promise<
|
|
143
|
+
configId: string;
|
|
144
|
+
}): Promise<ConfigSuccessResponse>;
|
|
224
145
|
/**
|
|
225
146
|
* @param {Object} arg - Arg object.
|
|
226
|
-
* @param {string} arg.
|
|
227
|
-
*
|
|
147
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
148
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
149
|
+
* @returns {Promise<DeleteResponse>} - Success response
|
|
150
|
+
* @summary: Delete a Search Keywords
|
|
151
|
+
* @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
|
|
152
|
+
*/
|
|
153
|
+
deleteSearchKeywords({ id }?: {
|
|
154
|
+
id: string;
|
|
155
|
+
}): Promise<DeleteResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* @param {Object} arg - Arg object.
|
|
158
|
+
* @param {string} [arg.q] - Get collection list filtered by q string,
|
|
159
|
+
* @param {string} [arg.scheduleStatus] - Get collection list filtered by
|
|
160
|
+
* scheduled status,
|
|
161
|
+
* @param {string} [arg.type] - Type of the collections
|
|
162
|
+
* @param {string[]} [arg.tags] - Each response will contain next_id param,
|
|
163
|
+
* which should be sent back to make pagination work.
|
|
164
|
+
* @param {boolean} [arg.isActive] - Get collections filtered by active status.
|
|
228
165
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
229
166
|
* given set of results.
|
|
230
167
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
231
168
|
* page. Default is 12.
|
|
232
|
-
* @
|
|
233
|
-
* @
|
|
234
|
-
* @
|
|
235
|
-
* @description: Get the details of the application configured configurations of listing config types.
|
|
169
|
+
* @returns {Promise<GetCollectionListingResponse>} - Success response
|
|
170
|
+
* @summary: List all the collections
|
|
171
|
+
* @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`
|
|
236
172
|
*/
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
* for a particular listing configuration type.
|
|
247
|
-
* @param {string} arg.configId - A `config_id` is a unique identifier of a
|
|
248
|
-
* particular configuration.
|
|
249
|
-
* @param {AppConfigurationsSort} arg.body
|
|
250
|
-
* @returns {Promise<AppConfigurationsSort>} - Success response
|
|
251
|
-
* @summary: Update configuration for listings
|
|
252
|
-
* @description: Update configuration for listing.
|
|
253
|
-
*/
|
|
254
|
-
updateListingConfiguration({ configType, configId, body }?: {
|
|
255
|
-
configType: string;
|
|
256
|
-
configId: string;
|
|
257
|
-
body: AppConfigurationsSort;
|
|
258
|
-
}): Promise<AppConfigurationsSort>;
|
|
259
|
-
/**
|
|
260
|
-
* @param {Object} arg - Arg object.
|
|
261
|
-
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
262
|
-
* for a particular listing configuration type.
|
|
263
|
-
* @param {string} arg.configId - A `config_id` is a unique identifier of a
|
|
264
|
-
* particular configuration.
|
|
265
|
-
* @returns {Promise<ConfigSuccessResponse>} - Success response
|
|
266
|
-
* @summary: Delete configuration for listings
|
|
267
|
-
* @description: Delete configuration for listing.
|
|
268
|
-
*/
|
|
269
|
-
deleteListingConfiguration({ configType, configId }?: {
|
|
270
|
-
configType: string;
|
|
271
|
-
configId: string;
|
|
272
|
-
}): Promise<ConfigSuccessResponse>;
|
|
273
|
-
/**
|
|
274
|
-
* @param {Object} arg - Arg object.
|
|
275
|
-
* @param {AllowSingleRequest} arg.body
|
|
276
|
-
* @returns {Promise<ConfigSuccessResponse>} - Success response
|
|
277
|
-
* @summary: Update allow single flag for filters of the application.
|
|
278
|
-
* @description: Update allow single flag for filters of the application.
|
|
279
|
-
*/
|
|
280
|
-
updateAllowSingle({ body }?: {
|
|
281
|
-
body: AllowSingleRequest;
|
|
282
|
-
}): Promise<ConfigSuccessResponse>;
|
|
283
|
-
/**
|
|
284
|
-
* @param {Object} arg - Arg object.
|
|
285
|
-
* @param {DefaultKeyRequest} arg.body
|
|
286
|
-
* @returns {Promise<ConfigSuccessResponse>} - Success response
|
|
287
|
-
* @summary: Update the default sort key configuration for the application.
|
|
288
|
-
* @description: Update the default sort key configuration for the application.
|
|
289
|
-
*/
|
|
290
|
-
updateDefaultSort({ body }?: {
|
|
291
|
-
body: DefaultKeyRequest;
|
|
292
|
-
}): Promise<ConfigSuccessResponse>;
|
|
293
|
-
/**
|
|
294
|
-
* @param {Object} arg - Arg object.
|
|
295
|
-
* @returns {Promise<GetCatalogConfigurationMetaData>} - Success response
|
|
296
|
-
* @summary: Get configuration meta details for catalog for admin panel
|
|
297
|
-
* @description: configuration meta details for catalog.
|
|
298
|
-
*/
|
|
299
|
-
getCatalogConfiguration({}?: any): Promise<GetCatalogConfigurationMetaData>;
|
|
300
|
-
/**
|
|
301
|
-
* @param {Object} arg - Arg object.
|
|
302
|
-
* @param {AppConfiguration} arg.body
|
|
303
|
-
* @returns {Promise<GetAppCatalogConfiguration>} - Success response
|
|
304
|
-
* @summary: Add configuration for products & listings
|
|
305
|
-
* @description: Add configuration for products & listing.
|
|
306
|
-
*/
|
|
307
|
-
createConfigurationProductListing({ body }?: {
|
|
308
|
-
body: AppConfiguration;
|
|
309
|
-
}): Promise<GetAppCatalogConfiguration>;
|
|
310
|
-
/**
|
|
311
|
-
* @param {Object} arg - Arg object.
|
|
312
|
-
* @returns {Promise<GetAppCatalogConfiguration>} - Success response
|
|
313
|
-
* @summary: Get configured details for catalog
|
|
314
|
-
* @description: configured details for catalog.
|
|
315
|
-
*/
|
|
316
|
-
getConfigurations({}?: any): Promise<GetAppCatalogConfiguration>;
|
|
317
|
-
/**
|
|
318
|
-
* @param {Object} arg - Arg object.
|
|
319
|
-
* @param {string} arg.type - Type can be brands, categories etc.
|
|
320
|
-
* @param {AppConfiguration} arg.body
|
|
321
|
-
* @returns {Promise<GetAppCatalogConfiguration>} - Success response
|
|
322
|
-
* @summary: Add configuration for categories and brands
|
|
323
|
-
* @description: Add configuration for categories & brands.
|
|
324
|
-
*/
|
|
325
|
-
createConfigurationByType({ type, body }?: {
|
|
326
|
-
type: string;
|
|
327
|
-
body: AppConfiguration;
|
|
328
|
-
}): Promise<GetAppCatalogConfiguration>;
|
|
329
|
-
/**
|
|
330
|
-
* @param {Object} arg - Arg object.
|
|
331
|
-
* @param {string} arg.type - Type can be brands, categories etc.
|
|
332
|
-
* @returns {Promise<GetAppCatalogEntityConfiguration>} - Success response
|
|
333
|
-
* @summary: Get configured details for catalog
|
|
334
|
-
* @description: configured details for catalog.
|
|
335
|
-
*/
|
|
336
|
-
getConfigurationByType({ type }?: {
|
|
337
|
-
type: string;
|
|
338
|
-
}): Promise<GetAppCatalogEntityConfiguration>;
|
|
173
|
+
getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, }?: {
|
|
174
|
+
q?: string;
|
|
175
|
+
scheduleStatus?: string;
|
|
176
|
+
type?: string;
|
|
177
|
+
tags?: string[];
|
|
178
|
+
isActive?: boolean;
|
|
179
|
+
pageNo?: number;
|
|
180
|
+
pageSize?: number;
|
|
181
|
+
}): Promise<GetCollectionListingResponse>;
|
|
339
182
|
/**
|
|
340
183
|
* @param {Object} arg - Arg object.
|
|
341
|
-
* @returns {Promise<
|
|
342
|
-
* @summary:
|
|
343
|
-
* @description:
|
|
184
|
+
* @returns {Promise<GetSearchWordsResponse>} - Success response
|
|
185
|
+
* @summary: List all Search Custom Keyword Listing
|
|
186
|
+
* @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
|
|
344
187
|
*/
|
|
345
|
-
|
|
188
|
+
getAllSearchKeyword({}?: any): Promise<GetSearchWordsResponse>;
|
|
346
189
|
/**
|
|
347
190
|
* @param {Object} arg - Arg object.
|
|
348
|
-
* @param {
|
|
349
|
-
* @
|
|
350
|
-
* @
|
|
351
|
-
* @
|
|
191
|
+
* @param {number[]} [arg.itemIds] - The Item Id of the product.
|
|
192
|
+
* @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
|
|
193
|
+
* @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
|
|
194
|
+
* @param {string[]} [arg.sellerIdentifiers] - Unique seller_identifier of
|
|
195
|
+
* the product.
|
|
196
|
+
* @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
197
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
198
|
+
* @param {string} [arg.pageId] - Page ID to retrieve next set of results.
|
|
199
|
+
* @returns {Promise<InventoryStockResponse>} - Success response
|
|
200
|
+
* @summary: Get the stock of a product
|
|
201
|
+
* @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
|
|
352
202
|
*/
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
203
|
+
getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, }?: {
|
|
204
|
+
itemIds?: number[];
|
|
205
|
+
storeIds?: number[];
|
|
206
|
+
brandIds?: number[];
|
|
207
|
+
sellerIdentifiers?: string[];
|
|
208
|
+
timestamp?: string;
|
|
209
|
+
pageSize?: number;
|
|
210
|
+
pageId?: string;
|
|
211
|
+
}): Promise<InventoryStockResponse>;
|
|
356
212
|
/**
|
|
357
213
|
* @param {Object} arg - Arg object.
|
|
358
|
-
* @param {string} [arg.
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
* @param {string
|
|
363
|
-
*
|
|
364
|
-
*
|
|
214
|
+
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
215
|
+
* basis of location type.
|
|
216
|
+
* @param {number[]} [arg.uid] - Helps to sort the location list on the
|
|
217
|
+
* basis of uid list.
|
|
218
|
+
* @param {string} [arg.q] - Query that is to be searched.
|
|
219
|
+
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
220
|
+
* unverified companies.
|
|
365
221
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
366
|
-
* given set of results
|
|
222
|
+
* given set of results
|
|
367
223
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
368
|
-
* page. Default is
|
|
369
|
-
* @returns {Promise<
|
|
370
|
-
* @summary:
|
|
371
|
-
* @description:
|
|
224
|
+
* page. Default is 20.
|
|
225
|
+
* @returns {Promise<LocationListSerializer>} - Success response
|
|
226
|
+
* @summary: Get list of locations
|
|
227
|
+
* @description: This API allows to view all the locations asscoiated to a application.
|
|
372
228
|
*/
|
|
373
|
-
|
|
229
|
+
getAppLocations({ storeType, uid, q, stage, pageNo, pageSize }?: {
|
|
230
|
+
storeType?: string;
|
|
231
|
+
uid?: number[];
|
|
374
232
|
q?: string;
|
|
375
|
-
|
|
376
|
-
type?: string;
|
|
377
|
-
tags?: string[];
|
|
378
|
-
isActive?: boolean;
|
|
233
|
+
stage?: string;
|
|
379
234
|
pageNo?: number;
|
|
380
235
|
pageSize?: number;
|
|
381
|
-
}): Promise<
|
|
382
|
-
/**
|
|
383
|
-
* @param {Object} arg - Arg object.
|
|
384
|
-
* @param {string} arg.slug - A `slug` is a human readable, URL friendly
|
|
385
|
-
* unique identifier of an object. Pass the `slug` of the collection which
|
|
386
|
-
* you want to retrieve.
|
|
387
|
-
* @returns {Promise<CollectionDetailResponse>} - Success response
|
|
388
|
-
* @summary: Get a particular collection
|
|
389
|
-
* @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
|
|
390
|
-
*/
|
|
391
|
-
getCollectionDetail({ slug }?: {
|
|
392
|
-
slug: string;
|
|
393
|
-
}): Promise<CollectionDetailResponse>;
|
|
236
|
+
}): Promise<LocationListSerializer>;
|
|
394
237
|
/**
|
|
395
238
|
* @param {Object} arg - Arg object.
|
|
396
|
-
* @param {string} arg.
|
|
397
|
-
* @param {
|
|
398
|
-
*
|
|
399
|
-
* @
|
|
400
|
-
*
|
|
239
|
+
* @param {string} arg.companyId - Id of the company whose locations are to fetched
|
|
240
|
+
* @param {string} arg.applicationId - Id of the application whose locations
|
|
241
|
+
* are to fetched
|
|
242
|
+
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
243
|
+
* basis of location type.
|
|
244
|
+
* @param {number[]} [arg.uid] - Helps to sort the location list on the
|
|
245
|
+
* basis of uid list.
|
|
246
|
+
* @param {string} [arg.q] - Query that is to be searched.
|
|
247
|
+
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
248
|
+
* unverified companies.
|
|
249
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
250
|
+
* page. Default is 20.
|
|
251
|
+
* @summary: Get list of locations
|
|
252
|
+
* @description: This API allows to view all the locations asscoiated to a application.
|
|
401
253
|
*/
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
254
|
+
getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, }?: {
|
|
255
|
+
companyId: string;
|
|
256
|
+
applicationId: string;
|
|
257
|
+
storeType?: string;
|
|
258
|
+
uid?: number[];
|
|
259
|
+
q?: string;
|
|
260
|
+
stage?: string;
|
|
261
|
+
pageSize?: number;
|
|
262
|
+
}): Paginator;
|
|
406
263
|
/**
|
|
407
264
|
* @param {Object} arg - Arg object.
|
|
408
|
-
* @param {string} arg.
|
|
409
|
-
* @returns {Promise<
|
|
410
|
-
* @summary:
|
|
411
|
-
* @description:
|
|
265
|
+
* @param {string} arg.itemId - Product id for a particular product.
|
|
266
|
+
* @returns {Promise<OwnerAppItemResponse>} - Success response
|
|
267
|
+
* @summary: Get company application product data.
|
|
268
|
+
* @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
|
|
412
269
|
*/
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
}): Promise<
|
|
270
|
+
getAppProduct({ itemId }?: {
|
|
271
|
+
itemId: string;
|
|
272
|
+
}): Promise<OwnerAppItemResponse>;
|
|
416
273
|
/**
|
|
417
274
|
* @param {Object} arg - Arg object.
|
|
418
|
-
* @param {
|
|
419
|
-
* @param {
|
|
420
|
-
*
|
|
421
|
-
* @
|
|
422
|
-
*
|
|
275
|
+
* @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
|
|
276
|
+
* @param {number[]} [arg.categoryIds] - Get multiple products filtered by
|
|
277
|
+
* Category Ids
|
|
278
|
+
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
279
|
+
* Department Ids
|
|
280
|
+
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
281
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
282
|
+
* given set of results
|
|
283
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
284
|
+
* page. Default is 10.
|
|
285
|
+
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
286
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
287
|
+
* @summary: Get applicationwise products
|
|
288
|
+
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
|
|
423
289
|
*/
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
290
|
+
getAppProducts({ brandIds, categoryIds, departmentIds, tags, pageNo, pageSize, q, }?: {
|
|
291
|
+
brandIds?: number[];
|
|
292
|
+
categoryIds?: number[];
|
|
293
|
+
departmentIds?: number[];
|
|
294
|
+
tags?: string[];
|
|
295
|
+
pageNo?: number;
|
|
296
|
+
pageSize?: number;
|
|
297
|
+
q?: string;
|
|
298
|
+
}): Promise<ProductListingResponse>;
|
|
428
299
|
/**
|
|
429
300
|
* @param {Object} arg - Arg object.
|
|
430
|
-
* @param {string} arg.
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
301
|
+
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
302
|
+
* complete name of a either a product, brand or category
|
|
303
|
+
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
304
|
+
* filtered from filter parameters will be passed in **f** parameter in
|
|
305
|
+
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
306
|
+
* @param {string} [arg.c] - The search filter parameters for collection
|
|
307
|
+
* items. All the parameter filtered from filter parameters will be passed
|
|
308
|
+
* in **c** parameter in this format.
|
|
309
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
310
|
+
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
311
|
+
* filter details. This flag is used to fetch all filters
|
|
312
|
+
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
313
|
+
* The supported sort parameters are popularity, price, redemption and
|
|
314
|
+
* discount in either ascending or descending order. See the supported
|
|
315
|
+
* values below.
|
|
316
|
+
* @param {string} [arg.pageId] - Each response will contain **page_id**
|
|
317
|
+
* param, which should be sent back to make pagination work.
|
|
435
318
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
436
319
|
* page. Default is 12.
|
|
437
|
-
* @
|
|
438
|
-
*
|
|
439
|
-
* @
|
|
320
|
+
* @param {number} [arg.pageNo] - If page_type is number then pass it to
|
|
321
|
+
* fetch page items. Default is 1.
|
|
322
|
+
* @param {string} [arg.pageType] - For pagination type should be cursor or
|
|
323
|
+
* number. Default is cursor.
|
|
324
|
+
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
325
|
+
* @returns {Promise<ApplicationProductListingResponse>} - Success response
|
|
326
|
+
* @summary: List the products
|
|
327
|
+
* @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
|
|
440
328
|
*/
|
|
441
|
-
|
|
442
|
-
|
|
329
|
+
getAppicationProducts({ q, f, c, filters, sortOn, pageId, pageSize, pageNo, pageType, itemIds, }?: {
|
|
330
|
+
q?: string;
|
|
331
|
+
f?: string;
|
|
332
|
+
c?: string;
|
|
333
|
+
filters?: boolean;
|
|
443
334
|
sortOn?: string;
|
|
444
335
|
pageId?: string;
|
|
445
336
|
pageSize?: number;
|
|
446
|
-
|
|
337
|
+
pageNo?: number;
|
|
338
|
+
pageType?: string;
|
|
339
|
+
itemIds?: number[];
|
|
340
|
+
}): Promise<ApplicationProductListingResponse>;
|
|
447
341
|
/**
|
|
448
342
|
* @param {Object} arg - Arg object.
|
|
449
|
-
* @param {string}
|
|
450
|
-
*
|
|
451
|
-
* @
|
|
452
|
-
*
|
|
343
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
344
|
+
* a particular seller account.
|
|
345
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
346
|
+
* identifier for a particular sale channel.
|
|
347
|
+
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
348
|
+
* complete name of a either a product, brand or category
|
|
349
|
+
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
350
|
+
* filtered from filter parameters will be passed in **f** parameter in
|
|
351
|
+
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
352
|
+
* @param {string} [arg.c] - The search filter parameters for collection
|
|
353
|
+
* items. All the parameter filtered from filter parameters will be passed
|
|
354
|
+
* in **c** parameter in this format.
|
|
355
|
+
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
356
|
+
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
357
|
+
* filter details. This flag is used to fetch all filters
|
|
358
|
+
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
359
|
+
* The supported sort parameters are popularity, price, redemption and
|
|
360
|
+
* discount in either ascending or descending order. See the supported
|
|
361
|
+
* values below.
|
|
362
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
363
|
+
* page. Default is 12.
|
|
364
|
+
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
365
|
+
* @summary: List the products
|
|
366
|
+
* @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
|
|
453
367
|
*/
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
368
|
+
getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, sortOn, pageSize, itemIds, }?: {
|
|
369
|
+
companyId: string;
|
|
370
|
+
applicationId: string;
|
|
371
|
+
q?: string;
|
|
372
|
+
f?: string;
|
|
373
|
+
c?: string;
|
|
374
|
+
filters?: boolean;
|
|
375
|
+
sortOn?: string;
|
|
376
|
+
pageSize?: number;
|
|
377
|
+
itemIds?: number[];
|
|
378
|
+
}): Paginator;
|
|
457
379
|
/**
|
|
458
380
|
* @param {Object} arg - Arg object.
|
|
459
|
-
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
460
|
-
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
461
|
-
* or Primary Identifier) of which inventory is to get.
|
|
462
381
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
463
382
|
* given set of results
|
|
464
383
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
465
384
|
* page. Default is 12.
|
|
466
|
-
* @param {string} [arg.q] - Search with
|
|
467
|
-
*
|
|
468
|
-
* @returns {Promise<
|
|
469
|
-
* @summary:
|
|
470
|
-
* @description:
|
|
385
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
386
|
+
* to search brands by brand name.
|
|
387
|
+
* @returns {Promise<BrandListingResponse>} - Success response
|
|
388
|
+
* @summary: List all the brands for the application
|
|
389
|
+
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
471
390
|
*/
|
|
472
|
-
|
|
473
|
-
itemId: number;
|
|
474
|
-
sizeIdentifier: string;
|
|
391
|
+
getApplicationBrandListing({ pageNo, pageSize, q }?: {
|
|
475
392
|
pageNo?: number;
|
|
476
393
|
pageSize?: number;
|
|
477
394
|
q?: string;
|
|
478
|
-
|
|
479
|
-
|
|
395
|
+
}): Promise<BrandListingResponse>;
|
|
396
|
+
/**
|
|
397
|
+
* @param {Object} arg - Arg object.
|
|
398
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
399
|
+
* a particular seller account.
|
|
400
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
401
|
+
* identifier for a particular sale channel.
|
|
402
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
403
|
+
* page. Default is 12.
|
|
404
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
405
|
+
* to search brands by brand name.
|
|
406
|
+
* @summary: List all the brands for the application
|
|
407
|
+
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
408
|
+
*/
|
|
409
|
+
getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
410
|
+
companyId: string;
|
|
411
|
+
applicationId: string;
|
|
412
|
+
pageSize?: number;
|
|
413
|
+
q?: string;
|
|
414
|
+
}): Paginator;
|
|
480
415
|
/**
|
|
481
416
|
* @param {Object} arg - Arg object.
|
|
482
417
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -521,21 +456,127 @@ declare class Catalog {
|
|
|
521
456
|
* @summary: List all the brands
|
|
522
457
|
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
523
458
|
*/
|
|
524
|
-
getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
|
|
525
|
-
companyId: string;
|
|
526
|
-
applicationId: string;
|
|
527
|
-
department?: string;
|
|
528
|
-
pageSize?: number;
|
|
529
|
-
q?: string;
|
|
530
|
-
brandId?: number[];
|
|
531
|
-
}): Paginator;
|
|
459
|
+
getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
|
|
460
|
+
companyId: string;
|
|
461
|
+
applicationId: string;
|
|
462
|
+
department?: string;
|
|
463
|
+
pageSize?: number;
|
|
464
|
+
q?: string;
|
|
465
|
+
brandId?: number[];
|
|
466
|
+
}): Paginator;
|
|
467
|
+
/**
|
|
468
|
+
* @param {Object} arg - Arg object.
|
|
469
|
+
* @param {number} [arg.departmentId] - A `department_id` is a unique
|
|
470
|
+
* identifier for a particular department.
|
|
471
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
472
|
+
* given set of results
|
|
473
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
474
|
+
* page. Default is 12.
|
|
475
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
476
|
+
* to search brands by brand name.
|
|
477
|
+
* @returns {Promise<BrandListingResponse>} - Success response
|
|
478
|
+
* @summary: List all the brands for the application
|
|
479
|
+
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
480
|
+
*/
|
|
481
|
+
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, }?: {
|
|
482
|
+
departmentId?: number;
|
|
483
|
+
pageNo?: number;
|
|
484
|
+
pageSize?: number;
|
|
485
|
+
q?: string;
|
|
486
|
+
}): Promise<BrandListingResponse>;
|
|
487
|
+
/**
|
|
488
|
+
* @param {Object} arg - Arg object.
|
|
489
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
490
|
+
* a particular seller account.
|
|
491
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
492
|
+
* identifier for a particular sale channel.
|
|
493
|
+
* @param {number} [arg.departmentId] - A `department_id` is a unique
|
|
494
|
+
* identifier for a particular department.
|
|
495
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
496
|
+
* page. Default is 12.
|
|
497
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
498
|
+
* to search brands by brand name.
|
|
499
|
+
* @summary: List all the brands for the application
|
|
500
|
+
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
501
|
+
*/
|
|
502
|
+
getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
|
|
503
|
+
companyId: string;
|
|
504
|
+
applicationId: string;
|
|
505
|
+
departmentId?: number;
|
|
506
|
+
pageSize?: number;
|
|
507
|
+
q?: string;
|
|
508
|
+
}): Paginator;
|
|
509
|
+
/**
|
|
510
|
+
* @param {Object} arg - Arg object.
|
|
511
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
512
|
+
* given set of results
|
|
513
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
514
|
+
* page. Default is 12.
|
|
515
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
516
|
+
* to search department by name.
|
|
517
|
+
* @returns {Promise<ApplicationDepartmentListingResponse>} - Success response
|
|
518
|
+
* @summary: List all the departments for the application
|
|
519
|
+
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
|
|
520
|
+
*/
|
|
521
|
+
getApplicationDepartmentListing({ pageNo, pageSize, q }?: {
|
|
522
|
+
pageNo?: number;
|
|
523
|
+
pageSize?: number;
|
|
524
|
+
q?: string;
|
|
525
|
+
}): Promise<ApplicationDepartmentListingResponse>;
|
|
526
|
+
/**
|
|
527
|
+
* @param {Object} arg - Arg object.
|
|
528
|
+
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
529
|
+
* a particular seller account.
|
|
530
|
+
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
531
|
+
* identifier for a particular sale channel.
|
|
532
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
533
|
+
* page. Default is 12.
|
|
534
|
+
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
535
|
+
* to search department by name.
|
|
536
|
+
* @summary: List all the departments for the application
|
|
537
|
+
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
|
|
538
|
+
*/
|
|
539
|
+
getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
540
|
+
companyId: string;
|
|
541
|
+
applicationId: string;
|
|
542
|
+
pageSize?: number;
|
|
543
|
+
q?: string;
|
|
544
|
+
}): Paginator;
|
|
545
|
+
/**
|
|
546
|
+
* @param {Object} arg - Arg object.
|
|
547
|
+
* @returns {Promise<GetAutocompleteWordsResponse>} - Success response
|
|
548
|
+
* @summary: List all Autocomplete Keyword Listing
|
|
549
|
+
* @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
|
|
550
|
+
*/
|
|
551
|
+
getAutocompleteConfig({}?: any): Promise<GetAutocompleteWordsResponse>;
|
|
552
|
+
/**
|
|
553
|
+
* @param {Object} arg - Arg object.
|
|
554
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
555
|
+
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
556
|
+
* @returns {Promise<GetAutocompleteWordsResponse>} - Success response
|
|
557
|
+
* @summary: Get a Autocomplete Keywords Details
|
|
558
|
+
* @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
|
|
559
|
+
*/
|
|
560
|
+
getAutocompleteKeywordDetail({ id }?: {
|
|
561
|
+
id: string;
|
|
562
|
+
}): Promise<GetAutocompleteWordsResponse>;
|
|
563
|
+
/**
|
|
564
|
+
* @param {Object} arg - Arg object.
|
|
565
|
+
* @returns {Promise<GetCatalogConfigurationMetaData>} - Success response
|
|
566
|
+
* @summary: Get configuration meta details for catalog for admin panel
|
|
567
|
+
* @description: configuration meta details for catalog.
|
|
568
|
+
*/
|
|
569
|
+
getCatalogConfiguration({}?: any): Promise<GetCatalogConfigurationMetaData>;
|
|
532
570
|
/**
|
|
533
571
|
* @param {Object} arg - Arg object.
|
|
534
|
-
* @
|
|
535
|
-
* @
|
|
536
|
-
* @
|
|
572
|
+
* @param {string} [arg.brand] - Brand slug
|
|
573
|
+
* @returns {Promise<CatalogInsightResponse>} - Success response
|
|
574
|
+
* @summary: Analytics data of catalog and inventory.
|
|
575
|
+
* @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.
|
|
537
576
|
*/
|
|
538
|
-
|
|
577
|
+
getCatalogInsights({ brand }?: {
|
|
578
|
+
brand?: string;
|
|
579
|
+
}): Promise<CatalogInsightResponse>;
|
|
539
580
|
/**
|
|
540
581
|
* @param {Object} arg - Arg object.
|
|
541
582
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -551,232 +592,177 @@ declare class Catalog {
|
|
|
551
592
|
}): Promise<CategoryListingResponse>;
|
|
552
593
|
/**
|
|
553
594
|
* @param {Object} arg - Arg object.
|
|
554
|
-
* @param {string}
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
*
|
|
559
|
-
* @
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
* @param {
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
* @param {string} [arg.pageId] - Each response will contain
|
|
570
|
-
*
|
|
595
|
+
* @param {string} arg.slug - A `slug` is a human readable, URL friendly
|
|
596
|
+
* unique identifier of an object. Pass the `slug` of the collection which
|
|
597
|
+
* you want to retrieve.
|
|
598
|
+
* @returns {Promise<CollectionDetailResponse>} - Success response
|
|
599
|
+
* @summary: Get a particular collection
|
|
600
|
+
* @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
|
|
601
|
+
*/
|
|
602
|
+
getCollectionDetail({ slug }?: {
|
|
603
|
+
slug: string;
|
|
604
|
+
}): Promise<CollectionDetailResponse>;
|
|
605
|
+
/**
|
|
606
|
+
* @param {Object} arg - Arg object.
|
|
607
|
+
* @param {string} arg.id - A `id` is a unique identifier of a collection.
|
|
608
|
+
* @param {string} [arg.sortOn] - Each response will contain sort_on param,
|
|
609
|
+
* which should be sent back to make pagination work.
|
|
610
|
+
* @param {string} [arg.pageId] - Each response will contain next_id param,
|
|
611
|
+
* which should be sent back to make pagination work.
|
|
571
612
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
572
613
|
* page. Default is 12.
|
|
573
|
-
* @
|
|
574
|
-
*
|
|
575
|
-
* @
|
|
576
|
-
* number. Default is cursor.
|
|
577
|
-
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
578
|
-
* @returns {Promise<ApplicationProductListingResponse>} - Success response
|
|
579
|
-
* @summary: List the products
|
|
580
|
-
* @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
|
|
614
|
+
* @returns {Promise<GetCollectionItemsResponse>} - Success response
|
|
615
|
+
* @summary: Get the items for a collection
|
|
616
|
+
* @description: Get items from a collection specified by its `id`.
|
|
581
617
|
*/
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
f?: string;
|
|
585
|
-
c?: string;
|
|
586
|
-
filters?: boolean;
|
|
618
|
+
getCollectionItems({ id, sortOn, pageId, pageSize }?: {
|
|
619
|
+
id: string;
|
|
587
620
|
sortOn?: string;
|
|
588
621
|
pageId?: string;
|
|
589
622
|
pageSize?: number;
|
|
590
|
-
|
|
591
|
-
pageType?: string;
|
|
592
|
-
itemIds?: number[];
|
|
593
|
-
}): Promise<ApplicationProductListingResponse>;
|
|
623
|
+
}): Promise<GetCollectionItemsResponse>;
|
|
594
624
|
/**
|
|
595
625
|
* @param {Object} arg - Arg object.
|
|
596
|
-
* @param {string} arg.
|
|
597
|
-
*
|
|
598
|
-
* @
|
|
599
|
-
*
|
|
600
|
-
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
601
|
-
* complete name of a either a product, brand or category
|
|
602
|
-
* @param {string} [arg.f] - The search filter parameters. All the parameter
|
|
603
|
-
* filtered from filter parameters will be passed in **f** parameter in
|
|
604
|
-
* this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
|
|
605
|
-
* @param {string} [arg.c] - The search filter parameters for collection
|
|
606
|
-
* items. All the parameter filtered from filter parameters will be passed
|
|
607
|
-
* in **c** parameter in this format.
|
|
608
|
-
* **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
|
|
609
|
-
* @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
|
|
610
|
-
* filter details. This flag is used to fetch all filters
|
|
611
|
-
* @param {string} [arg.sortOn] - The order to sort the list of products on.
|
|
612
|
-
* The supported sort parameters are popularity, price, redemption and
|
|
613
|
-
* discount in either ascending or descending order. See the supported
|
|
614
|
-
* values below.
|
|
615
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
616
|
-
* page. Default is 12.
|
|
617
|
-
* @param {number[]} [arg.itemIds] - Item Ids of product
|
|
618
|
-
* @summary: List the products
|
|
619
|
-
* @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
|
|
626
|
+
* @param {string} arg.type - Type can be brands, categories etc.
|
|
627
|
+
* @returns {Promise<GetAppCatalogEntityConfiguration>} - Success response
|
|
628
|
+
* @summary: Get configured details for catalog
|
|
629
|
+
* @description: configured details for catalog.
|
|
620
630
|
*/
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
q?: string;
|
|
625
|
-
f?: string;
|
|
626
|
-
c?: string;
|
|
627
|
-
filters?: boolean;
|
|
628
|
-
sortOn?: string;
|
|
629
|
-
pageSize?: number;
|
|
630
|
-
itemIds?: number[];
|
|
631
|
-
}): Paginator;
|
|
631
|
+
getConfigurationByType({ type }?: {
|
|
632
|
+
type: string;
|
|
633
|
+
}): Promise<GetAppCatalogEntityConfiguration>;
|
|
632
634
|
/**
|
|
633
635
|
* @param {Object} arg - Arg object.
|
|
634
|
-
* @param {string} arg.
|
|
635
|
-
*
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
* @
|
|
639
|
-
* @
|
|
636
|
+
* @param {string} arg.configType - A `config_type` is an identifier that
|
|
637
|
+
* defines a specific type of configuration.
|
|
638
|
+
* @param {string} [arg.templateSlug] - Get configuration list filtered by
|
|
639
|
+
* `template_slug` string. This is for the details and comparision groups.
|
|
640
|
+
* @returns {Promise<GetConfigMetadataResponse>} - Success response
|
|
641
|
+
* @summary: Get configuration metadata details for catalog for admin panel
|
|
642
|
+
* @description: Get the configuraion metadata details for catalog.
|
|
640
643
|
*/
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
+
getConfigurationMetadata({ configType, templateSlug }?: {
|
|
645
|
+
configType: string;
|
|
646
|
+
templateSlug?: string;
|
|
647
|
+
}): Promise<GetConfigMetadataResponse>;
|
|
644
648
|
/**
|
|
645
649
|
* @param {Object} arg - Arg object.
|
|
646
|
-
* @
|
|
647
|
-
* @
|
|
648
|
-
*
|
|
649
|
-
* @param {number[]} [arg.departmentIds] - Get multiple products filtered by
|
|
650
|
-
* Department Ids
|
|
651
|
-
* @param {string[]} [arg.tags] - Get multiple products filtered by tags
|
|
652
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
653
|
-
* given set of results
|
|
654
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
655
|
-
* page. Default is 10.
|
|
656
|
-
* @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
|
|
657
|
-
* @returns {Promise<ProductListingResponse>} - Success response
|
|
658
|
-
* @summary: Get applicationwise products
|
|
659
|
-
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
|
|
650
|
+
* @returns {Promise<GetAppCatalogConfiguration>} - Success response
|
|
651
|
+
* @summary: Get configured details for catalog
|
|
652
|
+
* @description: configured details for catalog.
|
|
660
653
|
*/
|
|
661
|
-
|
|
662
|
-
brandIds?: number[];
|
|
663
|
-
categoryIds?: number[];
|
|
664
|
-
departmentIds?: number[];
|
|
665
|
-
tags?: string[];
|
|
666
|
-
pageNo?: number;
|
|
667
|
-
pageSize?: number;
|
|
668
|
-
q?: string;
|
|
669
|
-
}): Promise<ProductListingResponse>;
|
|
654
|
+
getConfigurations({}?: any): Promise<GetAppCatalogConfiguration>;
|
|
670
655
|
/**
|
|
671
656
|
* @param {Object} arg - Arg object.
|
|
672
|
-
* @
|
|
673
|
-
* @
|
|
674
|
-
* @
|
|
675
|
-
* @param {string[]} [arg.sellerIdentifiers] - Unique seller_identifier of
|
|
676
|
-
* the product.
|
|
677
|
-
* @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
678
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
679
|
-
* @param {string} [arg.pageId] - Page ID to retrieve next set of results.
|
|
680
|
-
* @returns {Promise<InventoryStockResponse>} - Success response
|
|
681
|
-
* @summary: Get the stock of a product
|
|
682
|
-
* @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
|
|
657
|
+
* @returns {Promise<DepartmentResponse>} - Success response
|
|
658
|
+
* @summary: List all the departments
|
|
659
|
+
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
|
|
683
660
|
*/
|
|
684
|
-
|
|
685
|
-
itemIds?: number[];
|
|
686
|
-
storeIds?: number[];
|
|
687
|
-
brandIds?: number[];
|
|
688
|
-
sellerIdentifiers?: string[];
|
|
689
|
-
timestamp?: string;
|
|
690
|
-
pageSize?: number;
|
|
691
|
-
pageId?: string;
|
|
692
|
-
}): Promise<InventoryStockResponse>;
|
|
661
|
+
getDepartments({}?: any): Promise<DepartmentResponse>;
|
|
693
662
|
/**
|
|
694
663
|
* @param {Object} arg - Arg object.
|
|
695
|
-
* @param {
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
* basis of uid list.
|
|
699
|
-
* @param {string} [arg.q] - Query that is to be searched.
|
|
700
|
-
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
701
|
-
* unverified companies.
|
|
664
|
+
* @param {number} arg.itemId - Item code of the product of which size is to be get.
|
|
665
|
+
* @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
|
|
666
|
+
* or Primary Identifier) of which inventory is to get.
|
|
702
667
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
703
668
|
* given set of results
|
|
704
669
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
705
|
-
* page. Default is
|
|
706
|
-
* @
|
|
707
|
-
* @
|
|
708
|
-
* @
|
|
670
|
+
* page. Default is 12.
|
|
671
|
+
* @param {string} [arg.q] - Search with help of store code.
|
|
672
|
+
* @param {number[]} [arg.locationIds] - Search by store ids.
|
|
673
|
+
* @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
|
|
674
|
+
* @summary: Get Inventory for company
|
|
675
|
+
* @description: This API allows get Inventory data for particular company grouped by size and store.
|
|
709
676
|
*/
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
q?: string;
|
|
714
|
-
stage?: string;
|
|
677
|
+
getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
|
|
678
|
+
itemId: number;
|
|
679
|
+
sizeIdentifier: string;
|
|
715
680
|
pageNo?: number;
|
|
716
681
|
pageSize?: number;
|
|
717
|
-
|
|
682
|
+
q?: string;
|
|
683
|
+
locationIds?: number[];
|
|
684
|
+
}): Promise<InventorySellerIdentifierResponsePaginated>;
|
|
718
685
|
/**
|
|
719
686
|
* @param {Object} arg - Arg object.
|
|
720
|
-
* @param {string} arg.
|
|
721
|
-
*
|
|
722
|
-
*
|
|
723
|
-
*
|
|
724
|
-
* basis of location type.
|
|
725
|
-
* @param {number[]} [arg.uid] - Helps to sort the location list on the
|
|
726
|
-
* basis of uid list.
|
|
727
|
-
* @param {string} [arg.q] - Query that is to be searched.
|
|
728
|
-
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
729
|
-
* unverified companies.
|
|
687
|
+
* @param {string} arg.configType - A `config_type` is an identifier that
|
|
688
|
+
* defines a specific type of configuration.
|
|
689
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
690
|
+
* given set of results.
|
|
730
691
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
731
|
-
* page. Default is
|
|
732
|
-
* @
|
|
733
|
-
* @
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
692
|
+
* page. Default is 12.
|
|
693
|
+
* @param {string} [arg.search] - Get configuration list filtered by `search` string.
|
|
694
|
+
* @param {string} [arg.templateSlug] - Get configuration list filtered by
|
|
695
|
+
* `template_slug` string. This is for the details and comparision groups.
|
|
696
|
+
* @returns {Promise<GetConfigResponse>} - Success response
|
|
697
|
+
* @summary: Get the details of the application configured configurations of group config types.
|
|
698
|
+
* @description: Get the details of the application configured configurations of group config types.
|
|
699
|
+
*/
|
|
700
|
+
getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, }?: {
|
|
701
|
+
configType: string;
|
|
702
|
+
pageNo?: number;
|
|
742
703
|
pageSize?: number;
|
|
743
|
-
|
|
704
|
+
search?: string;
|
|
705
|
+
templateSlug?: string;
|
|
706
|
+
}): Promise<GetConfigResponse>;
|
|
744
707
|
/**
|
|
745
708
|
* @param {Object} arg - Arg object.
|
|
709
|
+
* @param {string} arg.configType - A `config_type` is an identifier that
|
|
710
|
+
* defines a specific type of configuration.
|
|
746
711
|
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
747
|
-
* given set of results
|
|
712
|
+
* given set of results.
|
|
748
713
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
749
714
|
* page. Default is 12.
|
|
750
|
-
* @param {string} [arg.
|
|
751
|
-
*
|
|
752
|
-
* @
|
|
753
|
-
* @
|
|
754
|
-
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
715
|
+
* @param {string} [arg.search] - Get configuration list filtered by `search` string.
|
|
716
|
+
* @returns {Promise<GetConfigResponse>} - Success response
|
|
717
|
+
* @summary: Get the details of the application configured configurations of listing config types.
|
|
718
|
+
* @description: Get the details of the application configured configurations of listing config types.
|
|
755
719
|
*/
|
|
756
|
-
|
|
720
|
+
getListingConfigurations({ configType, pageNo, pageSize, search, }?: {
|
|
721
|
+
configType: string;
|
|
757
722
|
pageNo?: number;
|
|
758
723
|
pageSize?: number;
|
|
759
|
-
|
|
760
|
-
}): Promise<
|
|
724
|
+
search?: string;
|
|
725
|
+
}): Promise<GetConfigResponse>;
|
|
761
726
|
/**
|
|
762
727
|
* @param {Object} arg - Arg object.
|
|
763
|
-
* @param {string} arg.
|
|
764
|
-
* a
|
|
765
|
-
*
|
|
766
|
-
*
|
|
767
|
-
* @
|
|
768
|
-
*
|
|
769
|
-
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
770
|
-
* to search brands by brand name.
|
|
771
|
-
* @summary: List all the brands for the application
|
|
772
|
-
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
728
|
+
* @param {string} arg.slug - The unique identifier of a product. i.e;
|
|
729
|
+
* `slug` of a product. You can retrieve these from the APIs that list
|
|
730
|
+
* products like **v1.0/products/**
|
|
731
|
+
* @returns {Promise<ProductDetail>} - Success response
|
|
732
|
+
* @summary: Get a product
|
|
733
|
+
* @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`
|
|
773
734
|
*/
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
735
|
+
getProductDetailBySlug({ slug }?: {
|
|
736
|
+
slug: string;
|
|
737
|
+
}): Promise<ProductDetail>;
|
|
738
|
+
/**
|
|
739
|
+
* @param {Object} arg - Arg object.
|
|
740
|
+
* @returns {Promise<GetCollectionQueryOptionResponse>} - Success response
|
|
741
|
+
* @summary: Get query filters to configure a collection
|
|
742
|
+
* @description: Get query filters to configure a collection
|
|
743
|
+
*/
|
|
744
|
+
getQueryFilters({}?: any): Promise<GetCollectionQueryOptionResponse>;
|
|
745
|
+
/**
|
|
746
|
+
* @param {Object} arg - Arg object.
|
|
747
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
748
|
+
* detail. Pass the `id` of the keywords which you want to retrieve.
|
|
749
|
+
* @returns {Promise<GetSearchWordsDetailResponse>} - Success response
|
|
750
|
+
* @summary: Get a Search Keywords Details
|
|
751
|
+
* @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
|
|
752
|
+
*/
|
|
753
|
+
getSearchKeywords({ id }?: {
|
|
754
|
+
id: string;
|
|
755
|
+
}): Promise<GetSearchWordsDetailResponse>;
|
|
756
|
+
/**
|
|
757
|
+
* @param {Object} arg - Arg object.
|
|
758
|
+
* @param {AllowSingleRequest} arg.body
|
|
759
|
+
* @returns {Promise<ConfigSuccessResponse>} - Success response
|
|
760
|
+
* @summary: Update allow single flag for filters of the application.
|
|
761
|
+
* @description: Update allow single flag for filters of the application.
|
|
762
|
+
*/
|
|
763
|
+
updateAllowSingle({ body }?: {
|
|
764
|
+
body: AllowSingleRequest;
|
|
765
|
+
}): Promise<ConfigSuccessResponse>;
|
|
780
766
|
/**
|
|
781
767
|
* @param {Object} arg - Arg object.
|
|
782
768
|
* @param {string} arg.brandUid - Brand id for which the custom_json is associated.
|
|
@@ -789,48 +775,6 @@ declare class Catalog {
|
|
|
789
775
|
brandUid: string;
|
|
790
776
|
body: ApplicationBrandJson;
|
|
791
777
|
}): Promise<SuccessResponse1>;
|
|
792
|
-
/**
|
|
793
|
-
* @param {Object} arg - Arg object.
|
|
794
|
-
* @param {number} [arg.departmentId] - A `department_id` is a unique
|
|
795
|
-
* identifier for a particular department.
|
|
796
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
797
|
-
* given set of results
|
|
798
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
799
|
-
* page. Default is 12.
|
|
800
|
-
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
801
|
-
* to search brands by brand name.
|
|
802
|
-
* @returns {Promise<BrandListingResponse>} - Success response
|
|
803
|
-
* @summary: List all the brands for the application
|
|
804
|
-
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
805
|
-
*/
|
|
806
|
-
getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, }?: {
|
|
807
|
-
departmentId?: number;
|
|
808
|
-
pageNo?: number;
|
|
809
|
-
pageSize?: number;
|
|
810
|
-
q?: string;
|
|
811
|
-
}): Promise<BrandListingResponse>;
|
|
812
|
-
/**
|
|
813
|
-
* @param {Object} arg - Arg object.
|
|
814
|
-
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
815
|
-
* a particular seller account.
|
|
816
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
817
|
-
* identifier for a particular sale channel.
|
|
818
|
-
* @param {number} [arg.departmentId] - A `department_id` is a unique
|
|
819
|
-
* identifier for a particular department.
|
|
820
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
821
|
-
* page. Default is 12.
|
|
822
|
-
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
823
|
-
* to search brands by brand name.
|
|
824
|
-
* @summary: List all the brands for the application
|
|
825
|
-
* @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
|
|
826
|
-
*/
|
|
827
|
-
getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
|
|
828
|
-
companyId: string;
|
|
829
|
-
applicationId: string;
|
|
830
|
-
departmentId?: number;
|
|
831
|
-
pageSize?: number;
|
|
832
|
-
q?: string;
|
|
833
|
-
}): Paginator;
|
|
834
778
|
/**
|
|
835
779
|
* @param {Object} arg - Arg object.
|
|
836
780
|
* @param {string} arg.categoryUid - Category id for which the custom_json
|
|
@@ -844,42 +788,6 @@ declare class Catalog {
|
|
|
844
788
|
categoryUid: string;
|
|
845
789
|
body: ApplicationCategoryJson;
|
|
846
790
|
}): Promise<SuccessResponse1>;
|
|
847
|
-
/**
|
|
848
|
-
* @param {Object} arg - Arg object.
|
|
849
|
-
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
850
|
-
* given set of results
|
|
851
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
852
|
-
* page. Default is 12.
|
|
853
|
-
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
854
|
-
* to search department by name.
|
|
855
|
-
* @returns {Promise<ApplicationDepartmentListingResponse>} - Success response
|
|
856
|
-
* @summary: List all the departments for the application
|
|
857
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
|
|
858
|
-
*/
|
|
859
|
-
getApplicationDepartmentListing({ pageNo, pageSize, q }?: {
|
|
860
|
-
pageNo?: number;
|
|
861
|
-
pageSize?: number;
|
|
862
|
-
q?: string;
|
|
863
|
-
}): Promise<ApplicationDepartmentListingResponse>;
|
|
864
|
-
/**
|
|
865
|
-
* @param {Object} arg - Arg object.
|
|
866
|
-
* @param {string} arg.companyId - A `company_id` is a unique identifier for
|
|
867
|
-
* a particular seller account.
|
|
868
|
-
* @param {string} arg.applicationId - A `application_id` is a unique
|
|
869
|
-
* identifier for a particular sale channel.
|
|
870
|
-
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
871
|
-
* page. Default is 12.
|
|
872
|
-
* @param {string} [arg.q] - Search query with brand name.Use this parameter
|
|
873
|
-
* to search department by name.
|
|
874
|
-
* @summary: List all the departments for the application
|
|
875
|
-
* @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
|
|
876
|
-
*/
|
|
877
|
-
getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
878
|
-
companyId: string;
|
|
879
|
-
applicationId: string;
|
|
880
|
-
pageSize?: number;
|
|
881
|
-
q?: string;
|
|
882
|
-
}): Paginator;
|
|
883
791
|
/**
|
|
884
792
|
* @param {Object} arg - Arg object.
|
|
885
793
|
* @param {string} arg.departmentUid - Department id for which the
|
|
@@ -905,5 +813,97 @@ declare class Catalog {
|
|
|
905
813
|
storeUid: string;
|
|
906
814
|
body: ApplicationStoreJson;
|
|
907
815
|
}): Promise<SuccessResponse1>;
|
|
816
|
+
/**
|
|
817
|
+
* @param {Object} arg - Arg object.
|
|
818
|
+
* @param {string} arg.itemId - Product id for which the custom_meta is associated.
|
|
819
|
+
* @param {ApplicationItemMeta} arg.body
|
|
820
|
+
* @returns {Promise<SuccessResponse1>} - Success response
|
|
821
|
+
* @summary: Update a single custom meta.
|
|
822
|
+
* @description: This API helps to update data associated to a item custom meta.
|
|
823
|
+
*/
|
|
824
|
+
updateAppProduct({ itemId, body }?: {
|
|
825
|
+
itemId: string;
|
|
826
|
+
body: ApplicationItemMeta;
|
|
827
|
+
}): Promise<SuccessResponse1>;
|
|
828
|
+
/**
|
|
829
|
+
* @param {Object} arg - Arg object.
|
|
830
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
831
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
832
|
+
* @param {CreateAutocompleteKeyword} arg.body
|
|
833
|
+
* @returns {Promise<GetAutocompleteWordsResponse>} - Success response
|
|
834
|
+
* @summary: Create & Update Autocomplete Keyword
|
|
835
|
+
* @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
|
|
836
|
+
*/
|
|
837
|
+
updateAutocompleteKeyword({ id, body }?: {
|
|
838
|
+
id: string;
|
|
839
|
+
body: CreateAutocompleteKeyword;
|
|
840
|
+
}): Promise<GetAutocompleteWordsResponse>;
|
|
841
|
+
/**
|
|
842
|
+
* @param {Object} arg - Arg object.
|
|
843
|
+
* @param {string} arg.id - A `id` is a unique identifier of a collection.
|
|
844
|
+
* @param {UpdateCollection} arg.body
|
|
845
|
+
* @returns {Promise<UpdateCollection>} - Success response
|
|
846
|
+
* @summary: Update a collection
|
|
847
|
+
* @description: Update a collection by it's id. On successful request, returns the updated collection
|
|
848
|
+
*/
|
|
849
|
+
updateCollection({ id, body }?: {
|
|
850
|
+
id: string;
|
|
851
|
+
body: UpdateCollection;
|
|
852
|
+
}): Promise<UpdateCollection>;
|
|
853
|
+
/**
|
|
854
|
+
* @param {Object} arg - Arg object.
|
|
855
|
+
* @param {DefaultKeyRequest} arg.body
|
|
856
|
+
* @returns {Promise<ConfigSuccessResponse>} - Success response
|
|
857
|
+
* @summary: Update the default sort key configuration for the application.
|
|
858
|
+
* @description: Update the default sort key configuration for the application.
|
|
859
|
+
*/
|
|
860
|
+
updateDefaultSort({ body }?: {
|
|
861
|
+
body: DefaultKeyRequest;
|
|
862
|
+
}): Promise<ConfigSuccessResponse>;
|
|
863
|
+
/**
|
|
864
|
+
* @param {Object} arg - Arg object.
|
|
865
|
+
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
866
|
+
* for a particular group configuration type.
|
|
867
|
+
* @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
|
|
868
|
+
* a particular configuration.
|
|
869
|
+
* @param {AppConfigurationDetail} arg.body
|
|
870
|
+
* @returns {Promise<AppConfigurationDetail>} - Success response
|
|
871
|
+
* @summary: Update the group configurations for the application.
|
|
872
|
+
* @description: Update the group configurations for the application.
|
|
873
|
+
*/
|
|
874
|
+
updateGroupConfiguration({ configType, groupSlug, body }?: {
|
|
875
|
+
configType: string;
|
|
876
|
+
groupSlug: string;
|
|
877
|
+
body: AppConfigurationDetail;
|
|
878
|
+
}): Promise<AppConfigurationDetail>;
|
|
879
|
+
/**
|
|
880
|
+
* @param {Object} arg - Arg object.
|
|
881
|
+
* @param {string} arg.configType - A `config_type` is a unique identifier
|
|
882
|
+
* for a particular listing configuration type.
|
|
883
|
+
* @param {string} arg.configId - A `config_id` is a unique identifier of a
|
|
884
|
+
* particular configuration.
|
|
885
|
+
* @param {AppConfigurationsSort} arg.body
|
|
886
|
+
* @returns {Promise<AppConfigurationsSort>} - Success response
|
|
887
|
+
* @summary: Update configuration for listings
|
|
888
|
+
* @description: Update configuration for listing.
|
|
889
|
+
*/
|
|
890
|
+
updateListingConfiguration({ configType, configId, body }?: {
|
|
891
|
+
configType: string;
|
|
892
|
+
configId: string;
|
|
893
|
+
body: AppConfigurationsSort;
|
|
894
|
+
}): Promise<AppConfigurationsSort>;
|
|
895
|
+
/**
|
|
896
|
+
* @param {Object} arg - Arg object.
|
|
897
|
+
* @param {string} arg.id - A `id` is a unique identifier for a particular
|
|
898
|
+
* detail. Pass the `id` of the keywords which you want to delete.
|
|
899
|
+
* @param {CreateSearchKeyword} arg.body
|
|
900
|
+
* @returns {Promise<GetSearchWordsData>} - Success response
|
|
901
|
+
* @summary: Update Search Keyword
|
|
902
|
+
* @description: Update Search Keyword by its id. On successful request, returns the updated collection
|
|
903
|
+
*/
|
|
904
|
+
updateSearchKeywords({ id, body }?: {
|
|
905
|
+
id: string;
|
|
906
|
+
body: CreateSearchKeyword;
|
|
907
|
+
}): Promise<GetSearchWordsData>;
|
|
908
908
|
}
|
|
909
909
|
import Paginator = require("../../common/Paginator");
|