@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
|
@@ -10,16 +10,16 @@ File Storage
|
|
|
10
10
|
|
|
11
11
|
* [upload](#upload)
|
|
12
12
|
|
|
13
|
-
* [startUpload](#startupload)
|
|
14
|
-
* [completeUpload](#completeupload)
|
|
15
|
-
* [appStartUpload](#appstartupload)
|
|
16
13
|
* [appCompleteUpload](#appcompleteupload)
|
|
17
|
-
* [getSignUrls](#getsignurls)
|
|
18
|
-
* [copyFiles](#copyfiles)
|
|
19
14
|
* [appCopyFiles](#appcopyfiles)
|
|
15
|
+
* [appStartUpload](#appstartupload)
|
|
20
16
|
* [browse](#browse)
|
|
21
17
|
* [browse](#browse)
|
|
18
|
+
* [completeUpload](#completeupload)
|
|
19
|
+
* [copyFiles](#copyfiles)
|
|
20
|
+
* [getSignUrls](#getsignurls)
|
|
22
21
|
* [proxy](#proxy)
|
|
22
|
+
* [startUpload](#startupload)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -107,18 +107,18 @@ Use this API to perform the upload of an arbitrarily sized buffer or blob.
|
|
|
107
107
|
|
|
108
108
|
|
|
109
109
|
|
|
110
|
-
###
|
|
111
|
-
This
|
|
110
|
+
### appCompleteUpload
|
|
111
|
+
This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
|
|
112
112
|
|
|
113
113
|
|
|
114
114
|
|
|
115
115
|
```javascript
|
|
116
116
|
// Promise
|
|
117
|
-
const promise = client.fileStorage.
|
|
117
|
+
const promise = client.application("<APPLICATION_ID>").fileStorage.appCompleteUpload({ namespace : value,
|
|
118
118
|
body : value });
|
|
119
119
|
|
|
120
120
|
// Async/Await
|
|
121
|
-
const data = await client.fileStorage.
|
|
121
|
+
const data = await client.application("<APPLICATION_ID>").fileStorage.appCompleteUpload({ namespace : value,
|
|
122
122
|
body : value });
|
|
123
123
|
```
|
|
124
124
|
|
|
@@ -129,7 +129,7 @@ const data = await client.fileStorage.startUpload({ namespace : value,
|
|
|
129
129
|
| Argument | Type | Required | Description |
|
|
130
130
|
| --------- | ----- | -------- | ----------- |
|
|
131
131
|
| namespace | string | yes | bucket name |
|
|
132
|
-
| body | [
|
|
132
|
+
| body | [StartResponse](#StartResponse) | yes | Request body |
|
|
133
133
|
|
|
134
134
|
|
|
135
135
|
Uploads an arbitrarily sized buffer or blob.
|
|
@@ -140,15 +140,15 @@ It has three Major Steps:
|
|
|
140
140
|
* Complete
|
|
141
141
|
|
|
142
142
|
### Start
|
|
143
|
-
Initiates the assets upload using `
|
|
143
|
+
Initiates the assets upload using `appStartUpload`.
|
|
144
144
|
It returns the storage link in response.
|
|
145
145
|
|
|
146
146
|
### Upload
|
|
147
147
|
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
148
|
-
Make a `PUT` request on storage link received from `
|
|
148
|
+
Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
149
149
|
|
|
150
150
|
### Complete
|
|
151
|
-
After successfully upload, call `
|
|
151
|
+
After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
152
152
|
This operation will return the url for the uploaded file.
|
|
153
153
|
|
|
154
154
|
|
|
@@ -157,7 +157,7 @@ This operation will return the url for the uploaded file.
|
|
|
157
157
|
|
|
158
158
|
|
|
159
159
|
|
|
160
|
-
[
|
|
160
|
+
[CompleteResponse](#CompleteResponse)
|
|
161
161
|
|
|
162
162
|
Success
|
|
163
163
|
|
|
@@ -183,19 +183,19 @@ Success
|
|
|
183
183
|
---
|
|
184
184
|
|
|
185
185
|
|
|
186
|
-
###
|
|
187
|
-
|
|
186
|
+
### appCopyFiles
|
|
187
|
+
Copy Files
|
|
188
188
|
|
|
189
189
|
|
|
190
190
|
|
|
191
191
|
```javascript
|
|
192
192
|
// Promise
|
|
193
|
-
const promise = client.fileStorage.
|
|
194
|
-
|
|
193
|
+
const promise = client.application("<APPLICATION_ID>").fileStorage.appCopyFiles({ body : value,
|
|
194
|
+
sync : value });
|
|
195
195
|
|
|
196
196
|
// Async/Await
|
|
197
|
-
const data = await client.fileStorage.
|
|
198
|
-
|
|
197
|
+
const data = await client.application("<APPLICATION_ID>").fileStorage.appCopyFiles({ body : value,
|
|
198
|
+
sync : value });
|
|
199
199
|
```
|
|
200
200
|
|
|
201
201
|
|
|
@@ -203,37 +203,19 @@ const data = await client.fileStorage.completeUpload({ namespace : value,
|
|
|
203
203
|
|
|
204
204
|
|
|
205
205
|
| Argument | Type | Required | Description |
|
|
206
|
-
| --------- | ----- | -------- | ----------- |
|
|
207
|
-
|
|
|
208
|
-
| body | [
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
Uploads an arbitrarily sized buffer or blob.
|
|
212
|
-
|
|
213
|
-
It has three Major Steps:
|
|
214
|
-
* Start
|
|
215
|
-
* Upload
|
|
216
|
-
* Complete
|
|
217
|
-
|
|
218
|
-
### Start
|
|
219
|
-
Initiates the assets upload using `startUpload`.
|
|
220
|
-
It returns the storage link in response.
|
|
221
|
-
|
|
222
|
-
### Upload
|
|
223
|
-
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
224
|
-
Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
206
|
+
| --------- | ----- | -------- | ----------- |
|
|
207
|
+
| sync | boolean | no | sync |
|
|
208
|
+
| body | [BulkRequest](#BulkRequest) | yes | Request body |
|
|
225
209
|
|
|
226
|
-
### Complete
|
|
227
|
-
After successfully upload, call `completeUpload` api to complete the upload process.
|
|
228
|
-
This operation will return the url for the uploaded file.
|
|
229
210
|
|
|
211
|
+
Copy Files
|
|
230
212
|
|
|
231
213
|
*Returned Response:*
|
|
232
214
|
|
|
233
215
|
|
|
234
216
|
|
|
235
217
|
|
|
236
|
-
[
|
|
218
|
+
[BulkUploadResponse](#BulkUploadResponse)
|
|
237
219
|
|
|
238
220
|
Success
|
|
239
221
|
|
|
@@ -244,7 +226,34 @@ Success
|
|
|
244
226
|
<summary><i> Example:</i></summary>
|
|
245
227
|
|
|
246
228
|
```json
|
|
247
|
-
|
|
229
|
+
{
|
|
230
|
+
"tracking_url": "https://xxx.xxx.xxx/2",
|
|
231
|
+
"task": {
|
|
232
|
+
"id": "2",
|
|
233
|
+
"name": "__default__",
|
|
234
|
+
"data": {
|
|
235
|
+
"urls": [
|
|
236
|
+
"https://xxx.xxx.xxx/files.csv"
|
|
237
|
+
],
|
|
238
|
+
"destination": {
|
|
239
|
+
"namespace": "/domaine/path",
|
|
240
|
+
"rewrite": "{{namespace}}/bar/{{dest.path}}"
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"opts": {
|
|
244
|
+
"attempts": 1,
|
|
245
|
+
"delay": 0,
|
|
246
|
+
"timestamp": 1613534206645
|
|
247
|
+
},
|
|
248
|
+
"progress": 0,
|
|
249
|
+
"delay": 0,
|
|
250
|
+
"timestamp": 1613534206645,
|
|
251
|
+
"attempts_made": 0,
|
|
252
|
+
"stacktrace": [],
|
|
253
|
+
"finished_on": 1613534206645,
|
|
254
|
+
"processed_on": 1613534206645
|
|
255
|
+
}
|
|
256
|
+
}
|
|
248
257
|
```
|
|
249
258
|
</details>
|
|
250
259
|
|
|
@@ -335,19 +344,19 @@ Success
|
|
|
335
344
|
---
|
|
336
345
|
|
|
337
346
|
|
|
338
|
-
###
|
|
339
|
-
|
|
347
|
+
### browse
|
|
348
|
+
Browse Files
|
|
340
349
|
|
|
341
350
|
|
|
342
351
|
|
|
343
352
|
```javascript
|
|
344
353
|
// Promise
|
|
345
|
-
const promise = client.
|
|
346
|
-
|
|
354
|
+
const promise = client.fileStorage.browse({ namespace : value,
|
|
355
|
+
pageNo : value });
|
|
347
356
|
|
|
348
357
|
// Async/Await
|
|
349
|
-
const data = await client.
|
|
350
|
-
|
|
358
|
+
const data = await client.fileStorage.browse({ namespace : value,
|
|
359
|
+
pageNo : value });
|
|
351
360
|
```
|
|
352
361
|
|
|
353
362
|
|
|
@@ -356,36 +365,19 @@ const data = await client.application("<APPLICATION_ID>").fileStorage.appComplet
|
|
|
356
365
|
|
|
357
366
|
| Argument | Type | Required | Description |
|
|
358
367
|
| --------- | ----- | -------- | ----------- |
|
|
359
|
-
| namespace | string | yes | bucket name |
|
|
360
|
-
|
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
Uploads an arbitrarily sized buffer or blob.
|
|
364
|
-
|
|
365
|
-
It has three Major Steps:
|
|
366
|
-
* Start
|
|
367
|
-
* Upload
|
|
368
|
-
* Complete
|
|
369
|
-
|
|
370
|
-
### Start
|
|
371
|
-
Initiates the assets upload using `appStartUpload`.
|
|
372
|
-
It returns the storage link in response.
|
|
368
|
+
| namespace | string | yes | bucket name |
|
|
369
|
+
| pageNo | number | no | page no |
|
|
373
370
|
|
|
374
|
-
### Upload
|
|
375
|
-
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
376
|
-
Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
377
371
|
|
|
378
|
-
### Complete
|
|
379
|
-
After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
380
|
-
This operation will return the url for the uploaded file.
|
|
381
372
|
|
|
373
|
+
Browse Files
|
|
382
374
|
|
|
383
375
|
*Returned Response:*
|
|
384
376
|
|
|
385
377
|
|
|
386
378
|
|
|
387
379
|
|
|
388
|
-
[
|
|
380
|
+
[BrowseResponse](#BrowseResponse)
|
|
389
381
|
|
|
390
382
|
Success
|
|
391
383
|
|
|
@@ -411,17 +403,19 @@ Success
|
|
|
411
403
|
---
|
|
412
404
|
|
|
413
405
|
|
|
414
|
-
###
|
|
415
|
-
|
|
406
|
+
### browse
|
|
407
|
+
Browse Files
|
|
416
408
|
|
|
417
409
|
|
|
418
410
|
|
|
419
411
|
```javascript
|
|
420
412
|
// Promise
|
|
421
|
-
const promise = client.fileStorage.
|
|
413
|
+
const promise = client.application("<APPLICATION_ID>").fileStorage.browse({ namespace : value,
|
|
414
|
+
pageNo : value });
|
|
422
415
|
|
|
423
416
|
// Async/Await
|
|
424
|
-
const data = await client.fileStorage.
|
|
417
|
+
const data = await client.application("<APPLICATION_ID>").fileStorage.browse({ namespace : value,
|
|
418
|
+
pageNo : value });
|
|
425
419
|
```
|
|
426
420
|
|
|
427
421
|
|
|
@@ -429,18 +423,20 @@ const data = await client.fileStorage.getSignUrls({ body : value });
|
|
|
429
423
|
|
|
430
424
|
|
|
431
425
|
| Argument | Type | Required | Description |
|
|
432
|
-
| --------- | ----- | -------- | ----------- |
|
|
433
|
-
|
|
|
426
|
+
| --------- | ----- | -------- | ----------- |
|
|
427
|
+
| namespace | string | yes | bucket name |
|
|
428
|
+
| pageNo | number | no | page no |
|
|
434
429
|
|
|
435
430
|
|
|
436
|
-
|
|
431
|
+
|
|
432
|
+
Browse Files
|
|
437
433
|
|
|
438
434
|
*Returned Response:*
|
|
439
435
|
|
|
440
436
|
|
|
441
437
|
|
|
442
438
|
|
|
443
|
-
[
|
|
439
|
+
[BrowseResponse](#BrowseResponse)
|
|
444
440
|
|
|
445
441
|
Success
|
|
446
442
|
|
|
@@ -466,19 +462,19 @@ Success
|
|
|
466
462
|
---
|
|
467
463
|
|
|
468
464
|
|
|
469
|
-
###
|
|
470
|
-
|
|
465
|
+
### completeUpload
|
|
466
|
+
This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
|
|
471
467
|
|
|
472
468
|
|
|
473
469
|
|
|
474
470
|
```javascript
|
|
475
471
|
// Promise
|
|
476
|
-
const promise = client.fileStorage.
|
|
477
|
-
|
|
472
|
+
const promise = client.fileStorage.completeUpload({ namespace : value,
|
|
473
|
+
body : value });
|
|
478
474
|
|
|
479
475
|
// Async/Await
|
|
480
|
-
const data = await client.fileStorage.
|
|
481
|
-
|
|
476
|
+
const data = await client.fileStorage.completeUpload({ namespace : value,
|
|
477
|
+
body : value });
|
|
482
478
|
```
|
|
483
479
|
|
|
484
480
|
|
|
@@ -486,19 +482,37 @@ const data = await client.fileStorage.copyFiles({ body : value,
|
|
|
486
482
|
|
|
487
483
|
|
|
488
484
|
| Argument | Type | Required | Description |
|
|
489
|
-
| --------- | ----- | -------- | ----------- |
|
|
490
|
-
|
|
|
491
|
-
| body | [
|
|
485
|
+
| --------- | ----- | -------- | ----------- |
|
|
486
|
+
| namespace | string | yes | bucket name |
|
|
487
|
+
| body | [StartResponse](#StartResponse) | yes | Request body |
|
|
492
488
|
|
|
493
489
|
|
|
494
|
-
|
|
490
|
+
Uploads an arbitrarily sized buffer or blob.
|
|
491
|
+
|
|
492
|
+
It has three Major Steps:
|
|
493
|
+
* Start
|
|
494
|
+
* Upload
|
|
495
|
+
* Complete
|
|
496
|
+
|
|
497
|
+
### Start
|
|
498
|
+
Initiates the assets upload using `startUpload`.
|
|
499
|
+
It returns the storage link in response.
|
|
500
|
+
|
|
501
|
+
### Upload
|
|
502
|
+
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
503
|
+
Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
504
|
+
|
|
505
|
+
### Complete
|
|
506
|
+
After successfully upload, call `completeUpload` api to complete the upload process.
|
|
507
|
+
This operation will return the url for the uploaded file.
|
|
508
|
+
|
|
495
509
|
|
|
496
510
|
*Returned Response:*
|
|
497
511
|
|
|
498
512
|
|
|
499
513
|
|
|
500
514
|
|
|
501
|
-
[
|
|
515
|
+
[CompleteResponse](#CompleteResponse)
|
|
502
516
|
|
|
503
517
|
Success
|
|
504
518
|
|
|
@@ -509,34 +523,7 @@ Success
|
|
|
509
523
|
<summary><i> Example:</i></summary>
|
|
510
524
|
|
|
511
525
|
```json
|
|
512
|
-
|
|
513
|
-
"tracking_url": "https://xxx.xxx.xxx/2",
|
|
514
|
-
"task": {
|
|
515
|
-
"id": "2",
|
|
516
|
-
"name": "__default__",
|
|
517
|
-
"data": {
|
|
518
|
-
"urls": [
|
|
519
|
-
"https://xxx.xxx.xxx/files.csv"
|
|
520
|
-
],
|
|
521
|
-
"destination": {
|
|
522
|
-
"namespace": "/domaine/path",
|
|
523
|
-
"rewrite": "{{namespace}}/bar/{{dest.path}}"
|
|
524
|
-
}
|
|
525
|
-
},
|
|
526
|
-
"opts": {
|
|
527
|
-
"attempts": 1,
|
|
528
|
-
"delay": 0,
|
|
529
|
-
"timestamp": 1613534206645
|
|
530
|
-
},
|
|
531
|
-
"progress": 0,
|
|
532
|
-
"delay": 0,
|
|
533
|
-
"timestamp": 1613534206645,
|
|
534
|
-
"attempts_made": 0,
|
|
535
|
-
"stacktrace": [],
|
|
536
|
-
"finished_on": 1613534206645,
|
|
537
|
-
"processed_on": 1613534206645
|
|
538
|
-
}
|
|
539
|
-
}
|
|
526
|
+
|
|
540
527
|
```
|
|
541
528
|
</details>
|
|
542
529
|
|
|
@@ -551,18 +538,18 @@ Success
|
|
|
551
538
|
---
|
|
552
539
|
|
|
553
540
|
|
|
554
|
-
###
|
|
541
|
+
### copyFiles
|
|
555
542
|
Copy Files
|
|
556
543
|
|
|
557
544
|
|
|
558
545
|
|
|
559
546
|
```javascript
|
|
560
547
|
// Promise
|
|
561
|
-
const promise = client.
|
|
548
|
+
const promise = client.fileStorage.copyFiles({ body : value,
|
|
562
549
|
sync : value });
|
|
563
550
|
|
|
564
551
|
// Async/Await
|
|
565
|
-
const data = await client.
|
|
552
|
+
const data = await client.fileStorage.copyFiles({ body : value,
|
|
566
553
|
sync : value });
|
|
567
554
|
```
|
|
568
555
|
|
|
@@ -636,19 +623,17 @@ Success
|
|
|
636
623
|
---
|
|
637
624
|
|
|
638
625
|
|
|
639
|
-
###
|
|
640
|
-
|
|
626
|
+
### getSignUrls
|
|
627
|
+
Gives signed urls to access private files
|
|
641
628
|
|
|
642
629
|
|
|
643
630
|
|
|
644
631
|
```javascript
|
|
645
632
|
// Promise
|
|
646
|
-
const promise = client.fileStorage.
|
|
647
|
-
pageNo : value });
|
|
633
|
+
const promise = client.fileStorage.getSignUrls({ body : value });
|
|
648
634
|
|
|
649
635
|
// Async/Await
|
|
650
|
-
const data = await client.fileStorage.
|
|
651
|
-
pageNo : value });
|
|
636
|
+
const data = await client.fileStorage.getSignUrls({ body : value });
|
|
652
637
|
```
|
|
653
638
|
|
|
654
639
|
|
|
@@ -656,20 +641,18 @@ const data = await client.fileStorage.browse({ namespace : value,
|
|
|
656
641
|
|
|
657
642
|
|
|
658
643
|
| Argument | Type | Required | Description |
|
|
659
|
-
| --------- | ----- | -------- | ----------- |
|
|
660
|
-
|
|
|
661
|
-
| pageNo | number | no | page no |
|
|
662
|
-
|
|
644
|
+
| --------- | ----- | -------- | ----------- |
|
|
645
|
+
| body | [SignUrlRequest](#SignUrlRequest) | yes | Request body |
|
|
663
646
|
|
|
664
647
|
|
|
665
|
-
|
|
648
|
+
Describe here
|
|
666
649
|
|
|
667
650
|
*Returned Response:*
|
|
668
651
|
|
|
669
652
|
|
|
670
653
|
|
|
671
654
|
|
|
672
|
-
[
|
|
655
|
+
[SignUrlResponse](#SignUrlResponse)
|
|
673
656
|
|
|
674
657
|
Success
|
|
675
658
|
|
|
@@ -695,19 +678,17 @@ Success
|
|
|
695
678
|
---
|
|
696
679
|
|
|
697
680
|
|
|
698
|
-
###
|
|
699
|
-
|
|
681
|
+
### proxy
|
|
682
|
+
Proxy
|
|
700
683
|
|
|
701
684
|
|
|
702
685
|
|
|
703
686
|
```javascript
|
|
704
687
|
// Promise
|
|
705
|
-
const promise = client.
|
|
706
|
-
pageNo : value });
|
|
688
|
+
const promise = client.fileStorage.proxy({ url : value });
|
|
707
689
|
|
|
708
690
|
// Async/Await
|
|
709
|
-
const data = await client.
|
|
710
|
-
pageNo : value });
|
|
691
|
+
const data = await client.fileStorage.proxy({ url : value });
|
|
711
692
|
```
|
|
712
693
|
|
|
713
694
|
|
|
@@ -716,19 +697,18 @@ const data = await client.application("<APPLICATION_ID>").fileStorage.browse({
|
|
|
716
697
|
|
|
717
698
|
| Argument | Type | Required | Description |
|
|
718
699
|
| --------- | ----- | -------- | ----------- |
|
|
719
|
-
|
|
|
720
|
-
| pageNo | number | no | page no |
|
|
700
|
+
| url | string | yes | url |
|
|
721
701
|
|
|
722
702
|
|
|
723
703
|
|
|
724
|
-
|
|
704
|
+
Proxy
|
|
725
705
|
|
|
726
706
|
*Returned Response:*
|
|
727
707
|
|
|
728
708
|
|
|
729
709
|
|
|
730
710
|
|
|
731
|
-
[
|
|
711
|
+
[string](#string)
|
|
732
712
|
|
|
733
713
|
Success
|
|
734
714
|
|
|
@@ -754,17 +734,19 @@ Success
|
|
|
754
734
|
---
|
|
755
735
|
|
|
756
736
|
|
|
757
|
-
###
|
|
758
|
-
|
|
737
|
+
### startUpload
|
|
738
|
+
This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
|
|
759
739
|
|
|
760
740
|
|
|
761
741
|
|
|
762
742
|
```javascript
|
|
763
743
|
// Promise
|
|
764
|
-
const promise = client.fileStorage.
|
|
744
|
+
const promise = client.fileStorage.startUpload({ namespace : value,
|
|
745
|
+
body : value });
|
|
765
746
|
|
|
766
747
|
// Async/Await
|
|
767
|
-
const data = await client.fileStorage.
|
|
748
|
+
const data = await client.fileStorage.startUpload({ namespace : value,
|
|
749
|
+
body : value });
|
|
768
750
|
```
|
|
769
751
|
|
|
770
752
|
|
|
@@ -773,18 +755,36 @@ const data = await client.fileStorage.proxy({ url : value });
|
|
|
773
755
|
|
|
774
756
|
| Argument | Type | Required | Description |
|
|
775
757
|
| --------- | ----- | -------- | ----------- |
|
|
776
|
-
|
|
|
758
|
+
| namespace | string | yes | bucket name |
|
|
759
|
+
| body | [StartRequest](#StartRequest) | yes | Request body |
|
|
777
760
|
|
|
778
761
|
|
|
762
|
+
Uploads an arbitrarily sized buffer or blob.
|
|
763
|
+
|
|
764
|
+
It has three Major Steps:
|
|
765
|
+
* Start
|
|
766
|
+
* Upload
|
|
767
|
+
* Complete
|
|
768
|
+
|
|
769
|
+
### Start
|
|
770
|
+
Initiates the assets upload using `startUpload`.
|
|
771
|
+
It returns the storage link in response.
|
|
772
|
+
|
|
773
|
+
### Upload
|
|
774
|
+
Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
775
|
+
Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
776
|
+
|
|
777
|
+
### Complete
|
|
778
|
+
After successfully upload, call `completeUpload` api to complete the upload process.
|
|
779
|
+
This operation will return the url for the uploaded file.
|
|
779
780
|
|
|
780
|
-
Proxy
|
|
781
781
|
|
|
782
782
|
*Returned Response:*
|
|
783
783
|
|
|
784
784
|
|
|
785
785
|
|
|
786
786
|
|
|
787
|
-
[
|
|
787
|
+
[StartResponse](#StartResponse)
|
|
788
788
|
|
|
789
789
|
Success
|
|
790
790
|
|
|
@@ -813,266 +813,130 @@ Success
|
|
|
813
813
|
|
|
814
814
|
### Schemas
|
|
815
815
|
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
#### [FailedResponse](#FailedResponse)
|
|
816
|
+
|
|
817
|
+
#### [BrowseResponse](#BrowseResponse)
|
|
819
818
|
|
|
820
819
|
| Properties | Type | Nullable | Description |
|
|
821
|
-
| ---------- | ---- | -------- | ----------- |
|
|
822
|
-
| message | string | yes | |
|
|
820
|
+
| ---------- | ---- | -------- | ----------- || items | [[DbRecord](#DbRecord)] | yes | || page | [Page](#Page) | yes | |
|
|
823
821
|
|
|
824
822
|
---
|
|
825
823
|
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
#### [CDN](#CDN)
|
|
824
|
+
#### [BulkRequest](#BulkRequest)
|
|
830
825
|
|
|
831
826
|
| Properties | Type | Nullable | Description |
|
|
832
|
-
| ---------- | ---- | -------- | ----------- |
|
|
833
|
-
| url | string | yes | |
|
|
834
|
-
| absolute_url | string | no | |
|
|
835
|
-
| relative_url | string | no | |
|
|
827
|
+
| ---------- | ---- | -------- | ----------- || configuration | [ReqConfiguration](#ReqConfiguration) | no | || destination | [Destination](#Destination) | yes | || urls | [string] | yes | |
|
|
836
828
|
|
|
837
829
|
---
|
|
838
830
|
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
#### [Upload](#Upload)
|
|
831
|
+
#### [BulkUploadResponse](#BulkUploadResponse)
|
|
843
832
|
|
|
844
833
|
| Properties | Type | Nullable | Description |
|
|
845
|
-
| ---------- | ---- | -------- | ----------- |
|
|
846
|
-
| expiry | number | yes | |
|
|
847
|
-
| url | string | yes | |
|
|
834
|
+
| ---------- | ---- | -------- | ----------- || task | [CopyFileTask](#CopyFileTask) | yes | || tracking_url | string | yes | |
|
|
848
835
|
|
|
849
836
|
---
|
|
850
837
|
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
#### [StartResponse](#StartResponse)
|
|
838
|
+
#### [CDN](#CDN)
|
|
855
839
|
|
|
856
840
|
| Properties | Type | Nullable | Description |
|
|
857
|
-
| ---------- | ---- | -------- | ----------- |
|
|
858
|
-
| file_name | string | yes | |
|
|
859
|
-
| file_path | string | yes | |
|
|
860
|
-
| content_type | string | yes | |
|
|
861
|
-
| method | string | no | |
|
|
862
|
-
| namespace | string | yes | |
|
|
863
|
-
| operation | string | yes | |
|
|
864
|
-
| size | number | yes | |
|
|
865
|
-
| upload | [Upload](#Upload) | yes | |
|
|
866
|
-
| cdn | [CDN](#CDN) | yes | |
|
|
867
|
-
| tags | [string] | no | |
|
|
841
|
+
| ---------- | ---- | -------- | ----------- || absolute_url | string | no | || relative_url | string | no | || url | string | yes | |
|
|
868
842
|
|
|
869
843
|
---
|
|
870
844
|
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
#### [StartRequest](#StartRequest)
|
|
845
|
+
#### [CompleteResponse](#CompleteResponse)
|
|
875
846
|
|
|
876
847
|
| Properties | Type | Nullable | Description |
|
|
877
|
-
| ---------- | ---- | -------- | ----------- |
|
|
878
|
-
| file_name | string | yes | |
|
|
879
|
-
| content_type | string | yes | |
|
|
880
|
-
| size | number | yes | |
|
|
881
|
-
| tags | [string] | no | |
|
|
882
|
-
| params | string | no | |
|
|
848
|
+
| ---------- | ---- | -------- | ----------- || _id | string | yes | || cdn | [CDN](#CDN) | yes | || content_type | string | yes | || created_on | string | yes | || file_name | string | yes | || file_path | string | yes | || modified_on | string | yes | || namespace | string | yes | || operation | string | yes | || size | number | yes | || success | boolean | yes | || tags | [string] | no | || upload | [Upload](#Upload) | yes | |
|
|
883
849
|
|
|
884
850
|
---
|
|
885
851
|
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
#### [CompleteResponse](#CompleteResponse)
|
|
852
|
+
#### [CopyFileTask](#CopyFileTask)
|
|
890
853
|
|
|
891
854
|
| Properties | Type | Nullable | Description |
|
|
892
|
-
| ---------- | ---- | -------- | ----------- |
|
|
893
|
-
| _id | string | yes | |
|
|
894
|
-
| file_name | string | yes | |
|
|
895
|
-
| file_path | string | yes | |
|
|
896
|
-
| content_type | string | yes | |
|
|
897
|
-
| namespace | string | yes | |
|
|
898
|
-
| operation | string | yes | |
|
|
899
|
-
| size | number | yes | |
|
|
900
|
-
| upload | [Upload](#Upload) | yes | |
|
|
901
|
-
| cdn | [CDN](#CDN) | yes | |
|
|
902
|
-
| success | boolean | yes | |
|
|
903
|
-
| tags | [string] | no | |
|
|
904
|
-
| created_on | string | yes | |
|
|
905
|
-
| modified_on | string | yes | |
|
|
855
|
+
| ---------- | ---- | -------- | ----------- || attempts_made | number | yes | || data | [BulkRequest](#BulkRequest) | yes | || delay | number | yes | || finished_on | number | yes | || id | string | yes | || name | string | yes | || opts | [Opts](#Opts) | yes | || processed_on | number | yes | || progress | number | yes | || stacktrace | [string] | no | || timestamp | number | yes | |
|
|
906
856
|
|
|
907
857
|
---
|
|
908
858
|
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
#### [Opts](#Opts)
|
|
859
|
+
#### [DbRecord](#DbRecord)
|
|
913
860
|
|
|
914
861
|
| Properties | Type | Nullable | Description |
|
|
915
|
-
| ---------- | ---- | -------- | ----------- |
|
|
916
|
-
| attempts | number | no | |
|
|
917
|
-
| timestamp | number | no | |
|
|
918
|
-
| delay | number | no | |
|
|
862
|
+
| ---------- | ---- | -------- | ----------- || _id | string | yes | || cdn | [CDN](#CDN) | yes | || content_type | string | yes | || created_on | string | yes | || file_name | string | yes | || file_path | string | yes | || modified_on | string | yes | || namespace | string | yes | || operation | string | no | || success | boolean | yes | || tags | [string] | yes | || upload | [Upload](#Upload) | yes | |
|
|
919
863
|
|
|
920
864
|
---
|
|
921
865
|
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
#### [CopyFileTask](#CopyFileTask)
|
|
866
|
+
#### [Destination](#Destination)
|
|
926
867
|
|
|
927
868
|
| Properties | Type | Nullable | Description |
|
|
928
|
-
| ---------- | ---- | -------- | ----------- |
|
|
929
|
-
| id | string | yes | |
|
|
930
|
-
| name | string | yes | |
|
|
931
|
-
| data | [BulkRequest](#BulkRequest) | yes | |
|
|
932
|
-
| opts | [Opts](#Opts) | yes | |
|
|
933
|
-
| progress | number | yes | |
|
|
934
|
-
| delay | number | yes | |
|
|
935
|
-
| timestamp | number | yes | |
|
|
936
|
-
| attempts_made | number | yes | |
|
|
937
|
-
| stacktrace | [string] | no | |
|
|
938
|
-
| finished_on | number | yes | |
|
|
939
|
-
| processed_on | number | yes | |
|
|
869
|
+
| ---------- | ---- | -------- | ----------- || basepath | string | no | || namespace | string | yes | || rewrite | string | yes | |
|
|
940
870
|
|
|
941
871
|
---
|
|
942
872
|
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
#### [BulkUploadResponse](#BulkUploadResponse)
|
|
873
|
+
#### [FailedResponse](#FailedResponse)
|
|
947
874
|
|
|
948
875
|
| Properties | Type | Nullable | Description |
|
|
949
|
-
| ---------- | ---- | -------- | ----------- |
|
|
950
|
-
| tracking_url | string | yes | |
|
|
951
|
-
| task | [CopyFileTask](#CopyFileTask) | yes | |
|
|
876
|
+
| ---------- | ---- | -------- | ----------- || message | string | yes | |
|
|
952
877
|
|
|
953
878
|
---
|
|
954
879
|
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
#### [ReqConfiguration](#ReqConfiguration)
|
|
880
|
+
#### [Opts](#Opts)
|
|
959
881
|
|
|
960
882
|
| Properties | Type | Nullable | Description |
|
|
961
|
-
| ---------- | ---- | -------- | ----------- |
|
|
962
|
-
| concurrency | number | no | |
|
|
883
|
+
| ---------- | ---- | -------- | ----------- || attempts | number | no | || delay | number | no | || timestamp | number | no | |
|
|
963
884
|
|
|
964
885
|
---
|
|
965
886
|
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
#### [Destination](#Destination)
|
|
887
|
+
#### [Page](#Page)
|
|
970
888
|
|
|
971
889
|
| Properties | Type | Nullable | Description |
|
|
972
|
-
| ---------- | ---- | -------- | ----------- |
|
|
973
|
-
| namespace | string | yes | |
|
|
974
|
-
| rewrite | string | yes | |
|
|
975
|
-
| basepath | string | no | |
|
|
890
|
+
| ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || has_previous | boolean | no | || item_total | number | no | || next_id | string | no | || size | number | no | || type | number | yes | |
|
|
976
891
|
|
|
977
892
|
---
|
|
978
893
|
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
#### [BulkRequest](#BulkRequest)
|
|
894
|
+
#### [ReqConfiguration](#ReqConfiguration)
|
|
983
895
|
|
|
984
896
|
| Properties | Type | Nullable | Description |
|
|
985
|
-
| ---------- | ---- | -------- | ----------- |
|
|
986
|
-
| urls | [string] | yes | |
|
|
987
|
-
| destination | [Destination](#Destination) | yes | |
|
|
988
|
-
| configuration | [ReqConfiguration](#ReqConfiguration) | no | |
|
|
897
|
+
| ---------- | ---- | -------- | ----------- || concurrency | number | no | |
|
|
989
898
|
|
|
990
899
|
---
|
|
991
900
|
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
#### [Urls](#Urls)
|
|
901
|
+
#### [SignUrlRequest](#SignUrlRequest)
|
|
996
902
|
|
|
997
903
|
| Properties | Type | Nullable | Description |
|
|
998
|
-
| ---------- | ---- | -------- | ----------- |
|
|
999
|
-
| url | string | yes | |
|
|
1000
|
-
| signed_url | string | yes | |
|
|
1001
|
-
| expiry | number | yes | |
|
|
904
|
+
| ---------- | ---- | -------- | ----------- || expiry | number | yes | || urls | [string] | yes | |
|
|
1002
905
|
|
|
1003
906
|
---
|
|
1004
907
|
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
#### [SignUrlResponse](#SignUrlResponse)
|
|
908
|
+
#### [SignUrlResponse](#SignUrlResponse)
|
|
1009
909
|
|
|
1010
910
|
| Properties | Type | Nullable | Description |
|
|
1011
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1012
|
-
| urls | [[Urls](#Urls)] | yes | |
|
|
911
|
+
| ---------- | ---- | -------- | ----------- || urls | [[Urls](#Urls)] | yes | |
|
|
1013
912
|
|
|
1014
913
|
---
|
|
1015
914
|
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
#### [SignUrlRequest](#SignUrlRequest)
|
|
915
|
+
#### [StartRequest](#StartRequest)
|
|
1020
916
|
|
|
1021
917
|
| Properties | Type | Nullable | Description |
|
|
1022
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1023
|
-
| expiry | number | yes | |
|
|
1024
|
-
| urls | [string] | yes | |
|
|
918
|
+
| ---------- | ---- | -------- | ----------- || content_type | string | yes | || file_name | string | yes | || params | string | no | || size | number | yes | || tags | [string] | no | |
|
|
1025
919
|
|
|
1026
920
|
---
|
|
1027
921
|
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
#### [Page](#Page)
|
|
922
|
+
#### [StartResponse](#StartResponse)
|
|
1032
923
|
|
|
1033
924
|
| Properties | Type | Nullable | Description |
|
|
1034
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1035
|
-
| item_total | number | no | |
|
|
1036
|
-
| next_id | string | no | |
|
|
1037
|
-
| has_previous | boolean | no | |
|
|
1038
|
-
| has_next | boolean | no | |
|
|
1039
|
-
| current | number | no | |
|
|
1040
|
-
| type | number | yes | |
|
|
1041
|
-
| size | number | no | |
|
|
925
|
+
| ---------- | ---- | -------- | ----------- || cdn | [CDN](#CDN) | yes | || content_type | string | yes | || file_name | string | yes | || file_path | string | yes | || method | string | no | || namespace | string | yes | || operation | string | yes | || size | number | yes | || tags | [string] | no | || upload | [Upload](#Upload) | yes | |
|
|
1042
926
|
|
|
1043
927
|
---
|
|
1044
928
|
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
#### [DbRecord](#DbRecord)
|
|
929
|
+
#### [Upload](#Upload)
|
|
1049
930
|
|
|
1050
931
|
| Properties | Type | Nullable | Description |
|
|
1051
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1052
|
-
| success | boolean | yes | |
|
|
1053
|
-
| tags | [string] | yes | |
|
|
1054
|
-
| _id | string | yes | |
|
|
1055
|
-
| file_name | string | yes | |
|
|
1056
|
-
| operation | string | no | |
|
|
1057
|
-
| namespace | string | yes | |
|
|
1058
|
-
| content_type | string | yes | |
|
|
1059
|
-
| file_path | string | yes | |
|
|
1060
|
-
| upload | [Upload](#Upload) | yes | |
|
|
1061
|
-
| cdn | [CDN](#CDN) | yes | |
|
|
1062
|
-
| created_on | string | yes | |
|
|
1063
|
-
| modified_on | string | yes | |
|
|
932
|
+
| ---------- | ---- | -------- | ----------- || expiry | number | yes | || url | string | yes | |
|
|
1064
933
|
|
|
1065
934
|
---
|
|
1066
935
|
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
#### [BrowseResponse](#BrowseResponse)
|
|
936
|
+
#### [Urls](#Urls)
|
|
1071
937
|
|
|
1072
938
|
| Properties | Type | Nullable | Description |
|
|
1073
|
-
| ---------- | ---- | -------- | ----------- |
|
|
1074
|
-
| items | [[DbRecord](#DbRecord)] | yes | |
|
|
1075
|
-
| page | [Page](#Page) | yes | |
|
|
939
|
+
| ---------- | ---- | -------- | ----------- || expiry | number | yes | || signed_url | string | yes | || url | string | yes | |
|
|
1076
940
|
|
|
1077
941
|
---
|
|
1078
942
|
|