@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
|
@@ -8,17 +8,17 @@
|
|
|
8
8
|
## Analytics Methods
|
|
9
9
|
Perceptor analytics
|
|
10
10
|
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
13
|
-
* [getComponentStatsCSV](#getcomponentstatscsv)
|
|
14
|
-
* [getComponentStatsPDF](#getcomponentstatspdf)
|
|
15
|
-
* [getComponentStats](#getcomponentstats)
|
|
11
|
+
* [createExportJob](#createexportjob)
|
|
12
|
+
* [getAbandonCartDetail](#getabandoncartdetail)
|
|
16
13
|
* [getAbandonCartList](#getabandoncartlist)
|
|
17
14
|
* [getAbandonCartsCSV](#getabandoncartscsv)
|
|
18
|
-
* [
|
|
19
|
-
* [
|
|
15
|
+
* [getComponentStats](#getcomponentstats)
|
|
16
|
+
* [getComponentStatsCSV](#getcomponentstatscsv)
|
|
17
|
+
* [getComponentStatsPDF](#getcomponentstatspdf)
|
|
20
18
|
* [getExportJobStatus](#getexportjobstatus)
|
|
21
19
|
* [getLogsList](#getlogslist)
|
|
20
|
+
* [getStatiscticsGroupComponents](#getstatiscticsgroupcomponents)
|
|
21
|
+
* [getStatiscticsGroups](#getstatiscticsgroups)
|
|
22
22
|
* [searchLogs](#searchlogs)
|
|
23
23
|
|
|
24
24
|
|
|
@@ -28,32 +28,39 @@ Perceptor analytics
|
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
31
|
-
###
|
|
32
|
-
|
|
31
|
+
### createExportJob
|
|
32
|
+
Create data export job in required format
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
```javascript
|
|
37
37
|
// Promise
|
|
38
|
-
const promise = client.
|
|
38
|
+
const promise = client.analytics.createExportJob({ exportType : value,
|
|
39
|
+
body : value });
|
|
39
40
|
|
|
40
41
|
// Async/Await
|
|
41
|
-
const data = await client.
|
|
42
|
+
const data = await client.analytics.createExportJob({ exportType : value,
|
|
43
|
+
body : value });
|
|
42
44
|
```
|
|
43
45
|
|
|
44
46
|
|
|
45
47
|
|
|
46
48
|
|
|
47
49
|
|
|
50
|
+
| Argument | Type | Required | Description |
|
|
51
|
+
| --------- | ----- | -------- | ----------- |
|
|
52
|
+
| exportType | string | yes | Export type / format |
|
|
53
|
+
| body | [ExportJobReq](#ExportJobReq) | yes | Request body |
|
|
48
54
|
|
|
49
|
-
|
|
55
|
+
|
|
56
|
+
Create data export job in required format
|
|
50
57
|
|
|
51
58
|
*Returned Response:*
|
|
52
59
|
|
|
53
60
|
|
|
54
61
|
|
|
55
62
|
|
|
56
|
-
[
|
|
63
|
+
[ExportJobRes](#ExportJobRes)
|
|
57
64
|
|
|
58
65
|
Success
|
|
59
66
|
|
|
@@ -65,13 +72,8 @@ Success
|
|
|
65
72
|
|
|
66
73
|
```json
|
|
67
74
|
{
|
|
68
|
-
"
|
|
69
|
-
|
|
70
|
-
"key": "general",
|
|
71
|
-
"url": "/v1/group/general",
|
|
72
|
-
"title": "General"
|
|
73
|
-
}
|
|
74
|
-
]
|
|
75
|
+
"status": "queued",
|
|
76
|
+
"job_id": "6047c67060ad8241a948ee42"
|
|
75
77
|
}
|
|
76
78
|
```
|
|
77
79
|
</details>
|
|
@@ -87,17 +89,17 @@ Success
|
|
|
87
89
|
---
|
|
88
90
|
|
|
89
91
|
|
|
90
|
-
###
|
|
91
|
-
Get
|
|
92
|
+
### getAbandonCartDetail
|
|
93
|
+
Get abandon carts details
|
|
92
94
|
|
|
93
95
|
|
|
94
96
|
|
|
95
97
|
```javascript
|
|
96
98
|
// Promise
|
|
97
|
-
const promise = client.application("<APPLICATION_ID>").analytics.
|
|
99
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getAbandonCartDetail({ cartId : value });
|
|
98
100
|
|
|
99
101
|
// Async/Await
|
|
100
|
-
const data = await client.application("<APPLICATION_ID>").analytics.
|
|
102
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getAbandonCartDetail({ cartId : value });
|
|
101
103
|
```
|
|
102
104
|
|
|
103
105
|
|
|
@@ -106,18 +108,18 @@ const data = await client.application("<APPLICATION_ID>").analytics.getStatiscti
|
|
|
106
108
|
|
|
107
109
|
| Argument | Type | Required | Description |
|
|
108
110
|
| --------- | ----- | -------- | ----------- |
|
|
109
|
-
|
|
|
111
|
+
| cartId | string | yes | Cart Id |
|
|
110
112
|
|
|
111
113
|
|
|
112
114
|
|
|
113
|
-
Get
|
|
115
|
+
Get abandon cart details
|
|
114
116
|
|
|
115
117
|
*Returned Response:*
|
|
116
118
|
|
|
117
119
|
|
|
118
120
|
|
|
119
121
|
|
|
120
|
-
[
|
|
122
|
+
[AbandonCartDetail](#AbandonCartDetail)
|
|
121
123
|
|
|
122
124
|
Success
|
|
123
125
|
|
|
@@ -128,18 +130,7 @@ Success
|
|
|
128
130
|
<summary><i> Example:</i></summary>
|
|
129
131
|
|
|
130
132
|
```json
|
|
131
|
-
|
|
132
|
-
"title": "Catalogue & Inventory",
|
|
133
|
-
"components": [
|
|
134
|
-
{
|
|
135
|
-
"key": "catalogue-basic",
|
|
136
|
-
"title": "Catalogue Basic",
|
|
137
|
-
"type": "text-blocks",
|
|
138
|
-
"url": "/stats/component/catalogue-basic",
|
|
139
|
-
"filters": {}
|
|
140
|
-
}
|
|
141
|
-
]
|
|
142
|
-
}
|
|
133
|
+
|
|
143
134
|
```
|
|
144
135
|
</details>
|
|
145
136
|
|
|
@@ -154,17 +145,23 @@ Success
|
|
|
154
145
|
---
|
|
155
146
|
|
|
156
147
|
|
|
157
|
-
###
|
|
158
|
-
Get
|
|
148
|
+
### getAbandonCartList
|
|
149
|
+
Get abandon carts list
|
|
159
150
|
|
|
160
151
|
|
|
161
152
|
|
|
162
153
|
```javascript
|
|
163
154
|
// Promise
|
|
164
|
-
const promise = client.application("<APPLICATION_ID>").analytics.
|
|
155
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getAbandonCartList({ fromDate : value,
|
|
156
|
+
toDate : value,
|
|
157
|
+
pageNo : value,
|
|
158
|
+
pageSize : value });
|
|
165
159
|
|
|
166
160
|
// Async/Await
|
|
167
|
-
const data = await client.application("<APPLICATION_ID>").analytics.
|
|
161
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getAbandonCartList({ fromDate : value,
|
|
162
|
+
toDate : value,
|
|
163
|
+
pageNo : value,
|
|
164
|
+
pageSize : value });
|
|
168
165
|
```
|
|
169
166
|
|
|
170
167
|
|
|
@@ -173,18 +170,21 @@ const data = await client.application("<APPLICATION_ID>").analytics.getComponent
|
|
|
173
170
|
|
|
174
171
|
| Argument | Type | Required | Description |
|
|
175
172
|
| --------- | ----- | -------- | ----------- |
|
|
176
|
-
|
|
|
173
|
+
| fromDate | string | yes | From date |
|
|
174
|
+
| toDate | string | yes | To date |
|
|
175
|
+
| pageNo | number | no | Current page number |
|
|
176
|
+
| pageSize | number | no | Current page size |
|
|
177
177
|
|
|
178
178
|
|
|
179
179
|
|
|
180
|
-
Get
|
|
180
|
+
Get abandon carts list
|
|
181
181
|
|
|
182
182
|
*Returned Response:*
|
|
183
183
|
|
|
184
184
|
|
|
185
185
|
|
|
186
186
|
|
|
187
|
-
[
|
|
187
|
+
[AbandonCartsList](#AbandonCartsList)
|
|
188
188
|
|
|
189
189
|
Success
|
|
190
190
|
|
|
@@ -195,7 +195,27 @@ Success
|
|
|
195
195
|
<summary><i> Example:</i></summary>
|
|
196
196
|
|
|
197
197
|
```json
|
|
198
|
-
|
|
198
|
+
{
|
|
199
|
+
"items": {
|
|
200
|
+
"properties_cart_id": 11517,
|
|
201
|
+
"context_traits_first_name": "Ahmed",
|
|
202
|
+
"context_traits_last_name": "Sakri",
|
|
203
|
+
"context_traits_phone_number": "8433859662",
|
|
204
|
+
"context_traits_email": "ahmedsakri@gofynd.com",
|
|
205
|
+
"context_app_application_id": "000000000000000000000001",
|
|
206
|
+
"properties_breakup_values_raw_total": 4020,
|
|
207
|
+
"received_at": {
|
|
208
|
+
"value": "2021-03-09T05:09:06.840Z"
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"page": {
|
|
212
|
+
"type": "number",
|
|
213
|
+
"size": 10,
|
|
214
|
+
"current": 1,
|
|
215
|
+
"has_next": true,
|
|
216
|
+
"item_total": 15
|
|
217
|
+
}
|
|
218
|
+
}
|
|
199
219
|
```
|
|
200
220
|
</details>
|
|
201
221
|
|
|
@@ -210,17 +230,19 @@ Success
|
|
|
210
230
|
---
|
|
211
231
|
|
|
212
232
|
|
|
213
|
-
###
|
|
214
|
-
Get
|
|
233
|
+
### getAbandonCartsCSV
|
|
234
|
+
Get abandon carts csv
|
|
215
235
|
|
|
216
236
|
|
|
217
237
|
|
|
218
238
|
```javascript
|
|
219
239
|
// Promise
|
|
220
|
-
const promise = client.application("<APPLICATION_ID>").analytics.
|
|
240
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getAbandonCartsCSV({ fromDate : value,
|
|
241
|
+
toDate : value });
|
|
221
242
|
|
|
222
243
|
// Async/Await
|
|
223
|
-
const data = await client.application("<APPLICATION_ID>").analytics.
|
|
244
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getAbandonCartsCSV({ fromDate : value,
|
|
245
|
+
toDate : value });
|
|
224
246
|
```
|
|
225
247
|
|
|
226
248
|
|
|
@@ -229,11 +251,12 @@ const data = await client.application("<APPLICATION_ID>").analytics.getComponent
|
|
|
229
251
|
|
|
230
252
|
| Argument | Type | Required | Description |
|
|
231
253
|
| --------- | ----- | -------- | ----------- |
|
|
232
|
-
|
|
|
254
|
+
| fromDate | string | yes | From date |
|
|
255
|
+
| toDate | string | yes | To date |
|
|
233
256
|
|
|
234
257
|
|
|
235
258
|
|
|
236
|
-
Get
|
|
259
|
+
Get abandon carts csv
|
|
237
260
|
|
|
238
261
|
*Returned Response:*
|
|
239
262
|
|
|
@@ -369,23 +392,17 @@ Success
|
|
|
369
392
|
---
|
|
370
393
|
|
|
371
394
|
|
|
372
|
-
###
|
|
373
|
-
Get
|
|
395
|
+
### getComponentStatsCSV
|
|
396
|
+
Get component statistics csv
|
|
374
397
|
|
|
375
398
|
|
|
376
399
|
|
|
377
400
|
```javascript
|
|
378
401
|
// Promise
|
|
379
|
-
const promise = client.application("<APPLICATION_ID>").analytics.
|
|
380
|
-
toDate : value,
|
|
381
|
-
pageNo : value,
|
|
382
|
-
pageSize : value });
|
|
402
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getComponentStatsCSV({ componentName : value });
|
|
383
403
|
|
|
384
404
|
// Async/Await
|
|
385
|
-
const data = await client.application("<APPLICATION_ID>").analytics.
|
|
386
|
-
toDate : value,
|
|
387
|
-
pageNo : value,
|
|
388
|
-
pageSize : value });
|
|
405
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getComponentStatsCSV({ componentName : value });
|
|
389
406
|
```
|
|
390
407
|
|
|
391
408
|
|
|
@@ -394,21 +411,18 @@ const data = await client.application("<APPLICATION_ID>").analytics.getAbandonCa
|
|
|
394
411
|
|
|
395
412
|
| Argument | Type | Required | Description |
|
|
396
413
|
| --------- | ----- | -------- | ----------- |
|
|
397
|
-
|
|
|
398
|
-
| toDate | string | yes | To date |
|
|
399
|
-
| pageNo | number | no | Current page number |
|
|
400
|
-
| pageSize | number | no | Current page size |
|
|
414
|
+
| componentName | string | yes | Component name |
|
|
401
415
|
|
|
402
416
|
|
|
403
417
|
|
|
404
|
-
Get
|
|
418
|
+
Get component statistics csv
|
|
405
419
|
|
|
406
420
|
*Returned Response:*
|
|
407
421
|
|
|
408
422
|
|
|
409
423
|
|
|
410
424
|
|
|
411
|
-
[
|
|
425
|
+
[string](#string)
|
|
412
426
|
|
|
413
427
|
Success
|
|
414
428
|
|
|
@@ -419,27 +433,7 @@ Success
|
|
|
419
433
|
<summary><i> Example:</i></summary>
|
|
420
434
|
|
|
421
435
|
```json
|
|
422
|
-
|
|
423
|
-
"items": {
|
|
424
|
-
"properties_cart_id": 11517,
|
|
425
|
-
"context_traits_first_name": "Ahmed",
|
|
426
|
-
"context_traits_last_name": "Sakri",
|
|
427
|
-
"context_traits_phone_number": "8433859662",
|
|
428
|
-
"context_traits_email": "ahmedsakri@gofynd.com",
|
|
429
|
-
"context_app_application_id": "000000000000000000000001",
|
|
430
|
-
"properties_breakup_values_raw_total": 4020,
|
|
431
|
-
"received_at": {
|
|
432
|
-
"value": "2021-03-09T05:09:06.840Z"
|
|
433
|
-
}
|
|
434
|
-
},
|
|
435
|
-
"page": {
|
|
436
|
-
"type": "number",
|
|
437
|
-
"size": 10,
|
|
438
|
-
"current": 1,
|
|
439
|
-
"has_next": true,
|
|
440
|
-
"item_total": 15
|
|
441
|
-
}
|
|
442
|
-
}
|
|
436
|
+
|
|
443
437
|
```
|
|
444
438
|
</details>
|
|
445
439
|
|
|
@@ -454,19 +448,17 @@ Success
|
|
|
454
448
|
---
|
|
455
449
|
|
|
456
450
|
|
|
457
|
-
###
|
|
458
|
-
Get
|
|
451
|
+
### getComponentStatsPDF
|
|
452
|
+
Get component statistics pdf
|
|
459
453
|
|
|
460
454
|
|
|
461
455
|
|
|
462
456
|
```javascript
|
|
463
457
|
// Promise
|
|
464
|
-
const promise = client.application("<APPLICATION_ID>").analytics.
|
|
465
|
-
toDate : value });
|
|
458
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getComponentStatsPDF({ componentName : value });
|
|
466
459
|
|
|
467
460
|
// Async/Await
|
|
468
|
-
const data = await client.application("<APPLICATION_ID>").analytics.
|
|
469
|
-
toDate : value });
|
|
461
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getComponentStatsPDF({ componentName : value });
|
|
470
462
|
```
|
|
471
463
|
|
|
472
464
|
|
|
@@ -475,12 +467,11 @@ const data = await client.application("<APPLICATION_ID>").analytics.getAbandonCa
|
|
|
475
467
|
|
|
476
468
|
| Argument | Type | Required | Description |
|
|
477
469
|
| --------- | ----- | -------- | ----------- |
|
|
478
|
-
|
|
|
479
|
-
| toDate | string | yes | To date |
|
|
470
|
+
| componentName | string | yes | Component name |
|
|
480
471
|
|
|
481
472
|
|
|
482
473
|
|
|
483
|
-
Get
|
|
474
|
+
Get component statistics pdf
|
|
484
475
|
|
|
485
476
|
*Returned Response:*
|
|
486
477
|
|
|
@@ -513,17 +504,19 @@ Success
|
|
|
513
504
|
---
|
|
514
505
|
|
|
515
506
|
|
|
516
|
-
###
|
|
517
|
-
Get
|
|
507
|
+
### getExportJobStatus
|
|
508
|
+
Get data export job status
|
|
518
509
|
|
|
519
510
|
|
|
520
511
|
|
|
521
512
|
```javascript
|
|
522
513
|
// Promise
|
|
523
|
-
const promise = client.
|
|
514
|
+
const promise = client.analytics.getExportJobStatus({ exportType : value,
|
|
515
|
+
jobId : value });
|
|
524
516
|
|
|
525
517
|
// Async/Await
|
|
526
|
-
const data = await client.
|
|
518
|
+
const data = await client.analytics.getExportJobStatus({ exportType : value,
|
|
519
|
+
jobId : value });
|
|
527
520
|
```
|
|
528
521
|
|
|
529
522
|
|
|
@@ -532,18 +525,19 @@ const data = await client.application("<APPLICATION_ID>").analytics.getAbandonCa
|
|
|
532
525
|
|
|
533
526
|
| Argument | Type | Required | Description |
|
|
534
527
|
| --------- | ----- | -------- | ----------- |
|
|
535
|
-
|
|
|
528
|
+
| exportType | string | yes | Export type / format |
|
|
529
|
+
| jobId | string | yes | Export job id |
|
|
536
530
|
|
|
537
531
|
|
|
538
532
|
|
|
539
|
-
Get
|
|
533
|
+
Get data export job status
|
|
540
534
|
|
|
541
535
|
*Returned Response:*
|
|
542
536
|
|
|
543
537
|
|
|
544
538
|
|
|
545
539
|
|
|
546
|
-
[
|
|
540
|
+
[ExportJobStatusRes](#ExportJobStatusRes)
|
|
547
541
|
|
|
548
542
|
Success
|
|
549
543
|
|
|
@@ -554,7 +548,11 @@ Success
|
|
|
554
548
|
<summary><i> Example:</i></summary>
|
|
555
549
|
|
|
556
550
|
```json
|
|
557
|
-
|
|
551
|
+
{
|
|
552
|
+
"download_url": "https://marketplace-sync-logs-production.s3.ap-south-1.amazonaws.com/inv-log-37-flipkartAssured-Full_Inventory_Update.csv",
|
|
553
|
+
"status": "success",
|
|
554
|
+
"job_id": "6047c67060ad8241a948ee42"
|
|
555
|
+
}
|
|
558
556
|
```
|
|
559
557
|
</details>
|
|
560
558
|
|
|
@@ -569,19 +567,23 @@ Success
|
|
|
569
567
|
---
|
|
570
568
|
|
|
571
569
|
|
|
572
|
-
###
|
|
573
|
-
|
|
570
|
+
### getLogsList
|
|
571
|
+
Get logs list
|
|
574
572
|
|
|
575
573
|
|
|
576
574
|
|
|
577
575
|
```javascript
|
|
578
576
|
// Promise
|
|
579
|
-
const promise = client.analytics.
|
|
580
|
-
body : value
|
|
577
|
+
const promise = client.analytics.getLogsList({ logType : value,
|
|
578
|
+
body : value,
|
|
579
|
+
pageNo : value,
|
|
580
|
+
pageSize : value });
|
|
581
581
|
|
|
582
582
|
// Async/Await
|
|
583
|
-
const data = await client.analytics.
|
|
584
|
-
body : value
|
|
583
|
+
const data = await client.analytics.getLogsList({ logType : value,
|
|
584
|
+
body : value,
|
|
585
|
+
pageNo : value,
|
|
586
|
+
pageSize : value });
|
|
585
587
|
```
|
|
586
588
|
|
|
587
589
|
|
|
@@ -590,18 +592,20 @@ const data = await client.analytics.createExportJob({ exportType : value,
|
|
|
590
592
|
|
|
591
593
|
| Argument | Type | Required | Description |
|
|
592
594
|
| --------- | ----- | -------- | ----------- |
|
|
593
|
-
|
|
|
594
|
-
|
|
|
595
|
+
| logType | string | yes | Log type |
|
|
596
|
+
| pageNo | number | no | Current page number |
|
|
597
|
+
| pageSize | number | no | Current page size |
|
|
598
|
+
| body | [GetLogsListReq](#GetLogsListReq) | yes | Request body |
|
|
595
599
|
|
|
596
600
|
|
|
597
|
-
|
|
601
|
+
Get logs list
|
|
598
602
|
|
|
599
603
|
*Returned Response:*
|
|
600
604
|
|
|
601
605
|
|
|
602
606
|
|
|
603
607
|
|
|
604
|
-
[
|
|
608
|
+
[GetLogsListRes](#GetLogsListRes)
|
|
605
609
|
|
|
606
610
|
Success
|
|
607
611
|
|
|
@@ -613,8 +617,23 @@ Success
|
|
|
613
617
|
|
|
614
618
|
```json
|
|
615
619
|
{
|
|
616
|
-
"
|
|
617
|
-
|
|
620
|
+
"items": [
|
|
621
|
+
{
|
|
622
|
+
"start_time_iso": "2021-04-06T19:00:17.013Z",
|
|
623
|
+
"end_time_iso": "2021-04-06T19:00:17.015Z",
|
|
624
|
+
"event_type": "FULL_PRICE_UPDATE",
|
|
625
|
+
"trace_id": "marketplaces.aa18fa48-b3e8-4e1e-8396-69488e254ace",
|
|
626
|
+
"count": 17,
|
|
627
|
+
"status": "failed"
|
|
628
|
+
}
|
|
629
|
+
],
|
|
630
|
+
"page": {
|
|
631
|
+
"type": "number",
|
|
632
|
+
"size": 10,
|
|
633
|
+
"current": 1,
|
|
634
|
+
"has_next": true,
|
|
635
|
+
"item_total": 88
|
|
636
|
+
}
|
|
618
637
|
}
|
|
619
638
|
```
|
|
620
639
|
</details>
|
|
@@ -630,19 +649,17 @@ Success
|
|
|
630
649
|
---
|
|
631
650
|
|
|
632
651
|
|
|
633
|
-
###
|
|
634
|
-
Get
|
|
652
|
+
### getStatiscticsGroupComponents
|
|
653
|
+
Get statistics group components
|
|
635
654
|
|
|
636
655
|
|
|
637
656
|
|
|
638
657
|
```javascript
|
|
639
658
|
// Promise
|
|
640
|
-
const promise = client.analytics.
|
|
641
|
-
jobId : value });
|
|
659
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getStatiscticsGroupComponents({ groupName : value });
|
|
642
660
|
|
|
643
661
|
// Async/Await
|
|
644
|
-
const data = await client.analytics.
|
|
645
|
-
jobId : value });
|
|
662
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getStatiscticsGroupComponents({ groupName : value });
|
|
646
663
|
```
|
|
647
664
|
|
|
648
665
|
|
|
@@ -651,19 +668,18 @@ const data = await client.analytics.getExportJobStatus({ exportType : value,
|
|
|
651
668
|
|
|
652
669
|
| Argument | Type | Required | Description |
|
|
653
670
|
| --------- | ----- | -------- | ----------- |
|
|
654
|
-
|
|
|
655
|
-
| jobId | string | yes | Export job id |
|
|
671
|
+
| groupName | string | yes | Group name |
|
|
656
672
|
|
|
657
673
|
|
|
658
674
|
|
|
659
|
-
Get
|
|
675
|
+
Get statistics group components
|
|
660
676
|
|
|
661
677
|
*Returned Response:*
|
|
662
678
|
|
|
663
679
|
|
|
664
680
|
|
|
665
681
|
|
|
666
|
-
[
|
|
682
|
+
[StatsGroupComponents](#StatsGroupComponents)
|
|
667
683
|
|
|
668
684
|
Success
|
|
669
685
|
|
|
@@ -675,9 +691,16 @@ Success
|
|
|
675
691
|
|
|
676
692
|
```json
|
|
677
693
|
{
|
|
678
|
-
"
|
|
679
|
-
"
|
|
680
|
-
|
|
694
|
+
"title": "Catalogue & Inventory",
|
|
695
|
+
"components": [
|
|
696
|
+
{
|
|
697
|
+
"key": "catalogue-basic",
|
|
698
|
+
"title": "Catalogue Basic",
|
|
699
|
+
"type": "text-blocks",
|
|
700
|
+
"url": "/stats/component/catalogue-basic",
|
|
701
|
+
"filters": {}
|
|
702
|
+
}
|
|
703
|
+
]
|
|
681
704
|
}
|
|
682
705
|
```
|
|
683
706
|
</details>
|
|
@@ -693,45 +716,32 @@ Success
|
|
|
693
716
|
---
|
|
694
717
|
|
|
695
718
|
|
|
696
|
-
###
|
|
697
|
-
Get
|
|
719
|
+
### getStatiscticsGroups
|
|
720
|
+
Get statistics groups
|
|
698
721
|
|
|
699
722
|
|
|
700
723
|
|
|
701
724
|
```javascript
|
|
702
725
|
// Promise
|
|
703
|
-
const promise = client.analytics.
|
|
704
|
-
body : value,
|
|
705
|
-
pageNo : value,
|
|
706
|
-
pageSize : value });
|
|
726
|
+
const promise = client.application("<APPLICATION_ID>").analytics.getStatiscticsGroups();
|
|
707
727
|
|
|
708
728
|
// Async/Await
|
|
709
|
-
const data = await client.analytics.
|
|
710
|
-
body : value,
|
|
711
|
-
pageNo : value,
|
|
712
|
-
pageSize : value });
|
|
729
|
+
const data = await client.application("<APPLICATION_ID>").analytics.getStatiscticsGroups();
|
|
713
730
|
```
|
|
714
731
|
|
|
715
732
|
|
|
716
733
|
|
|
717
734
|
|
|
718
735
|
|
|
719
|
-
| Argument | Type | Required | Description |
|
|
720
|
-
| --------- | ----- | -------- | ----------- |
|
|
721
|
-
| logType | string | yes | Log type |
|
|
722
|
-
| pageNo | number | no | Current page number |
|
|
723
|
-
| pageSize | number | no | Current page size |
|
|
724
|
-
| body | [GetLogsListReq](#GetLogsListReq) | yes | Request body |
|
|
725
|
-
|
|
726
736
|
|
|
727
|
-
Get
|
|
737
|
+
Get statistics groups
|
|
728
738
|
|
|
729
739
|
*Returned Response:*
|
|
730
740
|
|
|
731
741
|
|
|
732
742
|
|
|
733
743
|
|
|
734
|
-
[
|
|
744
|
+
[StatsGroups](#StatsGroups)
|
|
735
745
|
|
|
736
746
|
Success
|
|
737
747
|
|
|
@@ -743,23 +753,13 @@ Success
|
|
|
743
753
|
|
|
744
754
|
```json
|
|
745
755
|
{
|
|
746
|
-
"
|
|
756
|
+
"groups": [
|
|
747
757
|
{
|
|
748
|
-
"
|
|
749
|
-
"
|
|
750
|
-
"
|
|
751
|
-
"trace_id": "marketplaces.aa18fa48-b3e8-4e1e-8396-69488e254ace",
|
|
752
|
-
"count": 17,
|
|
753
|
-
"status": "failed"
|
|
758
|
+
"key": "general",
|
|
759
|
+
"url": "/v1/group/general",
|
|
760
|
+
"title": "General"
|
|
754
761
|
}
|
|
755
|
-
]
|
|
756
|
-
"page": {
|
|
757
|
-
"type": "number",
|
|
758
|
-
"size": 10,
|
|
759
|
-
"current": 1,
|
|
760
|
-
"has_next": true,
|
|
761
|
-
"item_total": 88
|
|
762
|
-
}
|
|
762
|
+
]
|
|
763
763
|
}
|
|
764
764
|
```
|
|
765
765
|
</details>
|
|
@@ -866,286 +866,144 @@ Success
|
|
|
866
866
|
|
|
867
867
|
### Schemas
|
|
868
868
|
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
#### [StatGroup](#StatGroup)
|
|
869
|
+
|
|
870
|
+
#### [AbandonCartDetail](#AbandonCartDetail)
|
|
872
871
|
|
|
873
872
|
| Properties | Type | Nullable | Description |
|
|
874
|
-
| ---------- | ---- | -------- | ----------- |
|
|
875
|
-
| key | string | no | |
|
|
876
|
-
| url | string | no | |
|
|
877
|
-
| title | string | no | |
|
|
873
|
+
| ---------- | ---- | -------- | ----------- || _id | string | no | || address | string | no | || articles | [string] | no | || breakup | string | no | || cart_value | string | no | || user_id | string | no | |
|
|
878
874
|
|
|
879
875
|
---
|
|
880
876
|
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
#### [ErrorRes](#ErrorRes)
|
|
877
|
+
#### [AbandonCartsDetail](#AbandonCartsDetail)
|
|
885
878
|
|
|
886
879
|
| Properties | Type | Nullable | Description |
|
|
887
|
-
| ---------- | ---- | -------- | ----------- |
|
|
888
|
-
| message | string | no | |
|
|
880
|
+
| ---------- | ---- | -------- | ----------- || context_app_application_id | string | no | || context_traits_email | string | no | || context_traits_first_name | string | no | || context_traits_last_name | string | no | || context_traits_phone_number | string | no | || properties_breakup_values_raw_total | string | no | || properties_cart_id | string | no | || received_at | [ReceivedAt](#ReceivedAt) | no | |
|
|
889
881
|
|
|
890
882
|
---
|
|
891
883
|
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
#### [StatsGroups](#StatsGroups)
|
|
884
|
+
#### [AbandonCartsList](#AbandonCartsList)
|
|
896
885
|
|
|
897
886
|
| Properties | Type | Nullable | Description |
|
|
898
|
-
| ---------- | ---- | -------- | ----------- |
|
|
899
|
-
| groups | [[StatGroup](#StatGroup)] | no | |
|
|
887
|
+
| ---------- | ---- | -------- | ----------- || cart_total | string | no | || items | [[AbandonCartsDetail](#AbandonCartsDetail)] | no | || page | [Page](#Page) | no | |
|
|
900
888
|
|
|
901
889
|
---
|
|
902
890
|
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
#### [StatsGroupComponent](#StatsGroupComponent)
|
|
891
|
+
#### [ErrorRes](#ErrorRes)
|
|
907
892
|
|
|
908
893
|
| Properties | Type | Nullable | Description |
|
|
909
|
-
| ---------- | ---- | -------- | ----------- |
|
|
910
|
-
| key | string | no | |
|
|
911
|
-
| url | string | no | |
|
|
912
|
-
| title | string | no | |
|
|
913
|
-
| type | string | no | |
|
|
914
|
-
| filters | string | no | |
|
|
894
|
+
| ---------- | ---- | -------- | ----------- || message | string | no | |
|
|
915
895
|
|
|
916
896
|
---
|
|
917
897
|
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
#### [StatsGroupComponents](#StatsGroupComponents)
|
|
898
|
+
#### [ExportJobReq](#ExportJobReq)
|
|
922
899
|
|
|
923
900
|
| Properties | Type | Nullable | Description |
|
|
924
|
-
| ---------- | ---- | -------- | ----------- |
|
|
925
|
-
| title | string | no | |
|
|
926
|
-
| components | [[StatsGroupComponent](#StatsGroupComponent)] | no | |
|
|
901
|
+
| ---------- | ---- | -------- | ----------- || end_time | string | no | || event_type | string | no | || marketplace_name | string | no | || start_time | string | no | || trace_id | string | no | |
|
|
927
902
|
|
|
928
903
|
---
|
|
929
904
|
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
#### [StatsRes](#StatsRes)
|
|
905
|
+
#### [ExportJobRes](#ExportJobRes)
|
|
934
906
|
|
|
935
907
|
| Properties | Type | Nullable | Description |
|
|
936
|
-
| ---------- | ---- | -------- | ----------- |
|
|
937
|
-
| key | string | no | |
|
|
938
|
-
| title | string | no | |
|
|
939
|
-
| type | string | no | |
|
|
940
|
-
| data | string | no | |
|
|
908
|
+
| ---------- | ---- | -------- | ----------- || job_id | string | no | || status | string | no | |
|
|
941
909
|
|
|
942
910
|
---
|
|
943
911
|
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
#### [ReceivedAt](#ReceivedAt)
|
|
912
|
+
#### [ExportJobStatusRes](#ExportJobStatusRes)
|
|
948
913
|
|
|
949
914
|
| Properties | Type | Nullable | Description |
|
|
950
|
-
| ---------- | ---- | -------- | ----------- |
|
|
951
|
-
| value | string | no | |
|
|
915
|
+
| ---------- | ---- | -------- | ----------- || download_url | string | no | || job_id | string | no | || status | string | no | |
|
|
952
916
|
|
|
953
917
|
---
|
|
954
918
|
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
#### [AbandonCartsDetail](#AbandonCartsDetail)
|
|
919
|
+
#### [GetLogsListReq](#GetLogsListReq)
|
|
959
920
|
|
|
960
921
|
| Properties | Type | Nullable | Description |
|
|
961
|
-
| ---------- | ---- | -------- | ----------- |
|
|
962
|
-
| properties_cart_id | string | no | |
|
|
963
|
-
| context_traits_first_name | string | no | |
|
|
964
|
-
| context_traits_last_name | string | no | |
|
|
965
|
-
| context_traits_phone_number | string | no | |
|
|
966
|
-
| context_traits_email | string | no | |
|
|
967
|
-
| context_app_application_id | string | no | |
|
|
968
|
-
| properties_breakup_values_raw_total | string | no | |
|
|
969
|
-
| received_at | [ReceivedAt](#ReceivedAt) | no | |
|
|
922
|
+
| ---------- | ---- | -------- | ----------- || company_id | string | no | || end_date | string | no | || marketplace_name | string | no | || start_date | string | no | |
|
|
970
923
|
|
|
971
924
|
---
|
|
972
925
|
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
#### [Page](#Page)
|
|
926
|
+
#### [GetLogsListRes](#GetLogsListRes)
|
|
977
927
|
|
|
978
928
|
| Properties | Type | Nullable | Description |
|
|
979
|
-
| ---------- | ---- | -------- | ----------- |
|
|
980
|
-
| item_total | number | no | |
|
|
981
|
-
| next_id | string | no | |
|
|
982
|
-
| has_previous | boolean | no | |
|
|
983
|
-
| has_next | boolean | no | |
|
|
984
|
-
| current | number | no | |
|
|
985
|
-
| type | string | yes | |
|
|
986
|
-
| size | number | no | |
|
|
929
|
+
| ---------- | ---- | -------- | ----------- || items | [[MkpLogsResp](#MkpLogsResp)] | no | || page | [Page](#Page) | no | |
|
|
987
930
|
|
|
988
931
|
---
|
|
989
932
|
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
#### [AbandonCartsList](#AbandonCartsList)
|
|
933
|
+
#### [LogInfo](#LogInfo)
|
|
994
934
|
|
|
995
935
|
| Properties | Type | Nullable | Description |
|
|
996
|
-
| ---------- | ---- | -------- | ----------- |
|
|
997
|
-
| items | [[AbandonCartsDetail](#AbandonCartsDetail)] | no | |
|
|
998
|
-
| cart_total | string | no | |
|
|
999
|
-
| page | [Page](#Page) | no | |
|
|
936
|
+
| ---------- | ---- | -------- | ----------- || _id | string | no | || article_id | string | no | || brand_id | number | no | || company_id | number | no | || event | string | no | || event_type | string | no | || item_id | number | no | || marketplace_name | string | no | || seller_identifier | string | no | || status | string | no | || store_code | string | no | || store_id | number | no | || trace_id | string | no | |
|
|
1000
937
|
|
|
1001
938
|
---
|
|
1002
939
|
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
#### [AbandonCartDetail](#AbandonCartDetail)
|
|
940
|
+
#### [MkpLogsResp](#MkpLogsResp)
|
|
1007
941
|
|
|
1008
942
|
| Properties | Type | Nullable | Description |
|
|
1009
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1010
|
-
| _id | string | no | |
|
|
1011
|
-
| user_id | string | no | |
|
|
1012
|
-
| cart_value | string | no | |
|
|
1013
|
-
| articles | [string] | no | |
|
|
1014
|
-
| breakup | string | no | |
|
|
1015
|
-
| address | string | no | |
|
|
943
|
+
| ---------- | ---- | -------- | ----------- || count | string | no | || end_time_iso | string | no | || event_type | string | no | || start_time_iso | string | no | || status | string | no | || trace_id | string | no | |
|
|
1016
944
|
|
|
1017
945
|
---
|
|
1018
946
|
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
#### [ExportJobReq](#ExportJobReq)
|
|
947
|
+
#### [Page](#Page)
|
|
1023
948
|
|
|
1024
949
|
| Properties | Type | Nullable | Description |
|
|
1025
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1026
|
-
| marketplace_name | string | no | |
|
|
1027
|
-
| start_time | string | no | |
|
|
1028
|
-
| end_time | string | no | |
|
|
1029
|
-
| event_type | string | no | |
|
|
1030
|
-
| trace_id | string | no | |
|
|
950
|
+
| ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || has_previous | boolean | no | || item_total | number | no | || next_id | string | no | || size | number | no | || type | string | yes | |
|
|
1031
951
|
|
|
1032
952
|
---
|
|
1033
953
|
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
#### [ExportJobRes](#ExportJobRes)
|
|
954
|
+
#### [ReceivedAt](#ReceivedAt)
|
|
1038
955
|
|
|
1039
956
|
| Properties | Type | Nullable | Description |
|
|
1040
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1041
|
-
| status | string | no | |
|
|
1042
|
-
| job_id | string | no | |
|
|
957
|
+
| ---------- | ---- | -------- | ----------- || value | string | no | |
|
|
1043
958
|
|
|
1044
959
|
---
|
|
1045
960
|
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
#### [ExportJobStatusRes](#ExportJobStatusRes)
|
|
961
|
+
#### [SearchLogReq](#SearchLogReq)
|
|
1050
962
|
|
|
1051
963
|
| Properties | Type | Nullable | Description |
|
|
1052
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1053
|
-
| status | string | no | |
|
|
1054
|
-
| job_id | string | no | |
|
|
1055
|
-
| download_url | string | no | |
|
|
964
|
+
| ---------- | ---- | -------- | ----------- || company_id | string | no | || end_date | string | no | || identifier | string | no | || identifier_value | string | no | || marketplace_name | string | no | || start_date | string | no | |
|
|
1056
965
|
|
|
1057
966
|
---
|
|
1058
967
|
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
#### [GetLogsListReq](#GetLogsListReq)
|
|
968
|
+
#### [SearchLogRes](#SearchLogRes)
|
|
1063
969
|
|
|
1064
970
|
| Properties | Type | Nullable | Description |
|
|
1065
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1066
|
-
| marketplace_name | string | no | |
|
|
1067
|
-
| start_date | string | no | |
|
|
1068
|
-
| company_id | string | no | |
|
|
1069
|
-
| end_date | string | no | |
|
|
971
|
+
| ---------- | ---- | -------- | ----------- || items | [[LogInfo](#LogInfo)] | no | || page | [Page](#Page) | no | |
|
|
1070
972
|
|
|
1071
973
|
---
|
|
1072
974
|
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
#### [MkpLogsResp](#MkpLogsResp)
|
|
975
|
+
#### [StatGroup](#StatGroup)
|
|
1077
976
|
|
|
1078
977
|
| Properties | Type | Nullable | Description |
|
|
1079
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1080
|
-
| start_time_iso | string | no | |
|
|
1081
|
-
| end_time_iso | string | no | |
|
|
1082
|
-
| event_type | string | no | |
|
|
1083
|
-
| trace_id | string | no | |
|
|
1084
|
-
| count | string | no | |
|
|
1085
|
-
| status | string | no | |
|
|
978
|
+
| ---------- | ---- | -------- | ----------- || key | string | no | || title | string | no | || url | string | no | |
|
|
1086
979
|
|
|
1087
980
|
---
|
|
1088
981
|
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
#### [GetLogsListRes](#GetLogsListRes)
|
|
982
|
+
#### [StatsGroupComponent](#StatsGroupComponent)
|
|
1093
983
|
|
|
1094
984
|
| Properties | Type | Nullable | Description |
|
|
1095
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1096
|
-
| items | [[MkpLogsResp](#MkpLogsResp)] | no | |
|
|
1097
|
-
| page | [Page](#Page) | no | |
|
|
985
|
+
| ---------- | ---- | -------- | ----------- || filters | string | no | || key | string | no | || title | string | no | || type | string | no | || url | string | no | |
|
|
1098
986
|
|
|
1099
987
|
---
|
|
1100
988
|
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
#### [SearchLogReq](#SearchLogReq)
|
|
989
|
+
#### [StatsGroupComponents](#StatsGroupComponents)
|
|
1105
990
|
|
|
1106
991
|
| Properties | Type | Nullable | Description |
|
|
1107
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1108
|
-
| marketplace_name | string | no | |
|
|
1109
|
-
| start_date | string | no | |
|
|
1110
|
-
| company_id | string | no | |
|
|
1111
|
-
| end_date | string | no | |
|
|
1112
|
-
| identifier | string | no | |
|
|
1113
|
-
| identifier_value | string | no | |
|
|
992
|
+
| ---------- | ---- | -------- | ----------- || components | [[StatsGroupComponent](#StatsGroupComponent)] | no | || title | string | no | |
|
|
1114
993
|
|
|
1115
994
|
---
|
|
1116
995
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
#### [LogInfo](#LogInfo)
|
|
996
|
+
#### [StatsGroups](#StatsGroups)
|
|
1121
997
|
|
|
1122
998
|
| Properties | Type | Nullable | Description |
|
|
1123
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1124
|
-
| _id | string | no | |
|
|
1125
|
-
| status | string | no | |
|
|
1126
|
-
| event_type | string | no | |
|
|
1127
|
-
| marketplace_name | string | no | |
|
|
1128
|
-
| event | string | no | |
|
|
1129
|
-
| trace_id | string | no | |
|
|
1130
|
-
| company_id | number | no | |
|
|
1131
|
-
| brand_id | number | no | |
|
|
1132
|
-
| store_code | string | no | |
|
|
1133
|
-
| store_id | number | no | |
|
|
1134
|
-
| item_id | number | no | |
|
|
1135
|
-
| article_id | string | no | |
|
|
1136
|
-
| seller_identifier | string | no | |
|
|
999
|
+
| ---------- | ---- | -------- | ----------- || groups | [[StatGroup](#StatGroup)] | no | |
|
|
1137
1000
|
|
|
1138
1001
|
---
|
|
1139
1002
|
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
#### [SearchLogRes](#SearchLogRes)
|
|
1003
|
+
#### [StatsRes](#StatsRes)
|
|
1144
1004
|
|
|
1145
1005
|
| Properties | Type | Nullable | Description |
|
|
1146
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1147
|
-
| items | [[LogInfo](#LogInfo)] | no | |
|
|
1148
|
-
| page | [Page](#Page) | no | |
|
|
1006
|
+
| ---------- | ---- | -------- | ----------- || data | string | no | || key | string | no | || title | string | no | || type | string | no | |
|
|
1149
1007
|
|
|
1150
1008
|
---
|
|
1151
1009
|
|