@gofynd/fdk-client-javascript 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -2
- package/index.d.ts +4 -4
- package/index.js +9 -10
- package/package.json +14 -14
- package/sdk/APIClient.d.ts +11 -0
- package/sdk/APIClient.js +35 -0
- package/sdk/Client.d.ts +6 -0
- package/sdk/Client.js +17 -0
- package/sdk/Config.d.ts +9 -0
- package/sdk/Config.js +17 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +595 -594
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +490 -885
- 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 +1079 -1078
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +683 -1249
- 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 +43 -42
- 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 +32 -31
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +350 -349
- 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 +216 -215
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
- package/sdk/application/Content/ContentApplicationModel.js +468 -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 +65 -64
- 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 +109 -108
- 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 +31 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +115 -49
- 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 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
- package/sdk/application/Order/OrderApplicationClient.js +247 -246
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +361 -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 +781 -780
- 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 +646 -645
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
- package/sdk/application/PosCart/PosCartApplicationModel.js +476 -870
- 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 +122 -121
- 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 +94 -93
- 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 +38 -37
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
- package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +280 -280
- package/sdk/application/User/UserApplicationClient.js +619 -618
- 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 +18 -7
- package/sdk/constructUrl.d.ts +5 -0
- package/sdk/constructUrl.js +13 -0
- package/sdk/index.d.ts +3 -0
- package/sdk/index.js +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +182 -180
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +21 -21
- package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +44 -43
- 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 +7 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
- package/sdk/platform/Billing/BillingPlatformClient.js +184 -183
- 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 +26 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +192 -165
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +686 -510
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +14 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +77 -61
- package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
- package/sdk/platform/Cart/CartPlatformModel.js +676 -1206
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1558 -1556
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +688 -688
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1556 -1559
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2133 -3910
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -228
- package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformClient.js +40 -51
- 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 +7 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +945 -943
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +88 -88
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +217 -216
- 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 +25 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +617 -552
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +70 -64
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +348 -347
- 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 +39 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +524 -534
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1287 -1346
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +49 -50
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +153 -159
- package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
- package/sdk/platform/Content/ContentPlatformModel.js +485 -907
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
- package/sdk/platform/Discount/DiscountPlatformClient.js +219 -218
- 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 +30 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +25 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +83 -61
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +53 -53
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +147 -125
- 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 +12 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +231 -230
- 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 +29 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +203 -201
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +29 -29
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
- package/sdk/platform/Lead/LeadPlatformClient.js +215 -214
- 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 +25 -24
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +68 -66
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
- package/sdk/platform/Order/OrderPlatformClient.js +1046 -1033
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
- package/sdk/platform/Order/OrderPlatformModel.js +1575 -2861
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +161 -160
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +178 -178
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +24 -24
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
- package/sdk/platform/Payment/PaymentPlatformClient.js +156 -155
- 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 +22 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
- package/sdk/platform/PlatformApplicationClient.js +1584 -13899
- package/sdk/platform/PlatformClient.d.ts +7972 -7888
- package/sdk/platform/PlatformClient.js +8678 -10107
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +85 -85
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +299 -280
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +35 -35
- 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 +62 -60
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +7 -7
- 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 +314 -312
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +45 -45
- 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 +507 -166
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +62 -24
- 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 +91 -90
- 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 +15 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +40 -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 +115 -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/WebhookPublicClient.js +2 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/.github/workflows/on_create_release.yml +0 -23
- package/.github/workflows/on_merge_main.yml +0 -38
- package/.github/workflows/on_pull_request.yml +0 -35
- package/.prettierrc +0 -5
- package/documentation/application/CART.md +0 -7339
- package/documentation/application/CATALOG.md +0 -9597
- package/documentation/application/COMMON.md +0 -452
- package/documentation/application/COMMUNICATION.md +0 -467
- package/documentation/application/CONFIGURATION.md +0 -2906
- package/documentation/application/CONTENT.md +0 -3351
- package/documentation/application/FILESTORAGE.md +0 -578
- package/documentation/application/LEAD.md +0 -1895
- package/documentation/application/LOGISTIC.md +0 -765
- package/documentation/application/ORDER.md +0 -3432
- package/documentation/application/PAYMENT.md +0 -5221
- package/documentation/application/POSCART.md +0 -7938
- package/documentation/application/README.md +0 -21
- package/documentation/application/REWARDS.md +0 -708
- package/documentation/application/SHARE.md +0 -733
- package/documentation/application/THEME.md +0 -5800
- package/documentation/application/USER.md +0 -4335
- package/documentation/platform/ANALYTICS.md +0 -1154
- package/documentation/platform/AUDITTRAIL.md +0 -576
- package/documentation/platform/BILLING.md +0 -2400
- package/documentation/platform/CART.md +0 -5559
- package/documentation/platform/CATALOG.md +0 -23261
- package/documentation/platform/COMMON.md +0 -452
- package/documentation/platform/COMMUNICATION.md +0 -5718
- package/documentation/platform/COMPANYPROFILE.md +0 -2031
- package/documentation/platform/CONFIGURATION.md +0 -7339
- package/documentation/platform/CONTENT.md +0 -9098
- package/documentation/platform/DISCOUNT.md +0 -863
- package/documentation/platform/FILESTORAGE.md +0 -1081
- package/documentation/platform/INVENTORY.md +0 -1779
- package/documentation/platform/LEAD.md +0 -4740
- package/documentation/platform/ORDER.md +0 -8486
- package/documentation/platform/PARTNER.md +0 -220
- package/documentation/platform/PAYMENT.md +0 -3448
- package/documentation/platform/README.md +0 -27
- package/documentation/platform/REWARDS.md +0 -1083
- package/documentation/platform/SHARE.md +0 -606
- package/documentation/platform/THEME.md +0 -35729
- package/documentation/platform/USER.md +0 -2319
- package/documentation/platform/WEBHOOK.md +0 -591
- package/documentation/public/CONFIGURATION.md +0 -452
- package/documentation/public/INVENTORY.md +0 -690
- package/documentation/public/WEBHOOK.md +0 -352
- package/jest.config.d.ts +0 -4
- package/jest.config.js +0 -6
- package/tests/application/catalog.spec.js +0 -47
- package/tests/common/action-url.spec.js +0 -35
- package/tests/common/schema/action-url.json +0 -178
- package/tests/common/schema/url-action.json +0 -683
- package/tests/common/url-action.spec.js +0 -48
- package/tests/helpers/cookie.helper.js +0 -31
- package/tests/helpers/oauth.helper.js +0 -43
- package/tests/platform/catalog.spec.js +0 -49
- package/tests/public/location.spec.js +0 -39
|
@@ -1,9 +1,12 @@
|
|
|
1
|
-
const Paginator = require("../../common/Paginator");
|
|
2
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
3
2
|
const { FDKClientValidationError } = require("../../common/FDKError");
|
|
3
|
+
const Paginator = require("../../common/Paginator");
|
|
4
4
|
const FileStorageValidator = require("./FileStoragePlatformApplicationValidator");
|
|
5
5
|
const FileStorageModel = require("./FileStoragePlatformModel");
|
|
6
6
|
const { Logger } = require("./../../common/Logger");
|
|
7
|
+
const Joi = require("joi");
|
|
8
|
+
|
|
9
|
+
const axios = require("axios");
|
|
7
10
|
|
|
8
11
|
class FileStorage {
|
|
9
12
|
constructor(config, applicationId) {
|
|
@@ -14,9 +17,9 @@ class FileStorage {
|
|
|
14
17
|
/**
|
|
15
18
|
* @param {Object} arg - Arg object.
|
|
16
19
|
* @param {string} arg.namespace - Bucket name
|
|
17
|
-
* @param {
|
|
18
|
-
* @returns {Promise<
|
|
19
|
-
* @summary: This
|
|
20
|
+
* @param {StartResponse} arg.body
|
|
21
|
+
* @returns {Promise<CompleteResponse>} - Success response
|
|
22
|
+
* @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
|
|
20
23
|
* @description: Uploads an arbitrarily sized buffer or blob.
|
|
21
24
|
*
|
|
22
25
|
* It has three Major Steps:
|
|
@@ -36,10 +39,15 @@ class FileStorage {
|
|
|
36
39
|
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
37
40
|
* This operation will return the url for the uploaded file.
|
|
38
41
|
*/
|
|
39
|
-
async
|
|
40
|
-
|
|
42
|
+
async appCompleteUpload({
|
|
43
|
+
namespace,
|
|
44
|
+
|
|
45
|
+
body,
|
|
46
|
+
} = {}) {
|
|
47
|
+
const { error } = FileStorageValidator.appCompleteUpload().validate(
|
|
41
48
|
{
|
|
42
49
|
namespace,
|
|
50
|
+
|
|
43
51
|
body,
|
|
44
52
|
},
|
|
45
53
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -49,9 +57,12 @@ class FileStorage {
|
|
|
49
57
|
}
|
|
50
58
|
|
|
51
59
|
// Showing warrnings if extra unknown parameters are found
|
|
52
|
-
const {
|
|
60
|
+
const {
|
|
61
|
+
error: warrning,
|
|
62
|
+
} = FileStorageValidator.appCompleteUpload().validate(
|
|
53
63
|
{
|
|
54
64
|
namespace,
|
|
65
|
+
|
|
55
66
|
body,
|
|
56
67
|
},
|
|
57
68
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -59,7 +70,7 @@ class FileStorage {
|
|
|
59
70
|
if (warrning) {
|
|
60
71
|
Logger({
|
|
61
72
|
level: "WARN",
|
|
62
|
-
message: "Parameter Validation warrnings for
|
|
73
|
+
message: "Parameter Validation warrnings for appCompleteUpload",
|
|
63
74
|
});
|
|
64
75
|
Logger({ level: "WARN", message: warrning });
|
|
65
76
|
}
|
|
@@ -69,14 +80,14 @@ class FileStorage {
|
|
|
69
80
|
const response = await PlatformAPIClient.execute(
|
|
70
81
|
this.config,
|
|
71
82
|
"post",
|
|
72
|
-
`/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/
|
|
83
|
+
`/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/complete/`,
|
|
73
84
|
query_params,
|
|
74
85
|
body
|
|
75
86
|
);
|
|
76
87
|
|
|
77
88
|
const {
|
|
78
89
|
error: res_error,
|
|
79
|
-
} = FileStorageModel.
|
|
90
|
+
} = FileStorageModel.CompleteResponse().validate(response, {
|
|
80
91
|
abortEarly: false,
|
|
81
92
|
allowUnknown: false,
|
|
82
93
|
});
|
|
@@ -84,7 +95,7 @@ class FileStorage {
|
|
|
84
95
|
if (res_error) {
|
|
85
96
|
Logger({
|
|
86
97
|
level: "WARN",
|
|
87
|
-
message: "Response Validation Warnnings for
|
|
98
|
+
message: "Response Validation Warnnings for appCompleteUpload",
|
|
88
99
|
});
|
|
89
100
|
Logger({ level: "WARN", message: res_error });
|
|
90
101
|
}
|
|
@@ -94,34 +105,17 @@ class FileStorage {
|
|
|
94
105
|
|
|
95
106
|
/**
|
|
96
107
|
* @param {Object} arg - Arg object.
|
|
97
|
-
* @param {
|
|
98
|
-
* @param {
|
|
99
|
-
* @returns {Promise<
|
|
100
|
-
* @summary:
|
|
101
|
-
* @description:
|
|
102
|
-
*
|
|
103
|
-
* It has three Major Steps:
|
|
104
|
-
* Start
|
|
105
|
-
* Upload
|
|
106
|
-
* Complete
|
|
107
|
-
*
|
|
108
|
-
* ### Start
|
|
109
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
110
|
-
* It returns the storage link in response.
|
|
111
|
-
*
|
|
112
|
-
* ### Upload
|
|
113
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
114
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
115
|
-
*
|
|
116
|
-
* ### Complete
|
|
117
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
118
|
-
* This operation will return the url for the uploaded file.
|
|
108
|
+
* @param {boolean} [arg.sync] - Sync
|
|
109
|
+
* @param {BulkRequest} arg.body
|
|
110
|
+
* @returns {Promise<BulkUploadResponse>} - Success response
|
|
111
|
+
* @summary: Copy Files
|
|
112
|
+
* @description: Copy Files
|
|
119
113
|
*/
|
|
120
|
-
async
|
|
121
|
-
const { error } = FileStorageValidator.
|
|
114
|
+
async appCopyFiles({ body, sync } = {}) {
|
|
115
|
+
const { error } = FileStorageValidator.appCopyFiles().validate(
|
|
122
116
|
{
|
|
123
|
-
namespace,
|
|
124
117
|
body,
|
|
118
|
+
sync,
|
|
125
119
|
},
|
|
126
120
|
{ abortEarly: false, allowUnknown: true }
|
|
127
121
|
);
|
|
@@ -130,36 +124,35 @@ class FileStorage {
|
|
|
130
124
|
}
|
|
131
125
|
|
|
132
126
|
// Showing warrnings if extra unknown parameters are found
|
|
133
|
-
const {
|
|
134
|
-
error: warrning,
|
|
135
|
-
} = FileStorageValidator.appCompleteUpload().validate(
|
|
127
|
+
const { error: warrning } = FileStorageValidator.appCopyFiles().validate(
|
|
136
128
|
{
|
|
137
|
-
namespace,
|
|
138
129
|
body,
|
|
130
|
+
sync,
|
|
139
131
|
},
|
|
140
132
|
{ abortEarly: false, allowUnknown: false }
|
|
141
133
|
);
|
|
142
134
|
if (warrning) {
|
|
143
135
|
Logger({
|
|
144
136
|
level: "WARN",
|
|
145
|
-
message: "Parameter Validation warrnings for
|
|
137
|
+
message: "Parameter Validation warrnings for appCopyFiles",
|
|
146
138
|
});
|
|
147
139
|
Logger({ level: "WARN", message: warrning });
|
|
148
140
|
}
|
|
149
141
|
|
|
150
142
|
const query_params = {};
|
|
143
|
+
query_params["sync"] = sync;
|
|
151
144
|
|
|
152
145
|
const response = await PlatformAPIClient.execute(
|
|
153
146
|
this.config,
|
|
154
147
|
"post",
|
|
155
|
-
`/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/
|
|
148
|
+
`/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/uploads/copy/`,
|
|
156
149
|
query_params,
|
|
157
150
|
body
|
|
158
151
|
);
|
|
159
152
|
|
|
160
153
|
const {
|
|
161
154
|
error: res_error,
|
|
162
|
-
} = FileStorageModel.
|
|
155
|
+
} = FileStorageModel.BulkUploadResponse().validate(response, {
|
|
163
156
|
abortEarly: false,
|
|
164
157
|
allowUnknown: false,
|
|
165
158
|
});
|
|
@@ -167,7 +160,7 @@ class FileStorage {
|
|
|
167
160
|
if (res_error) {
|
|
168
161
|
Logger({
|
|
169
162
|
level: "WARN",
|
|
170
|
-
message: "Response Validation Warnnings for
|
|
163
|
+
message: "Response Validation Warnnings for appCopyFiles",
|
|
171
164
|
});
|
|
172
165
|
Logger({ level: "WARN", message: res_error });
|
|
173
166
|
}
|
|
@@ -177,17 +170,39 @@ class FileStorage {
|
|
|
177
170
|
|
|
178
171
|
/**
|
|
179
172
|
* @param {Object} arg - Arg object.
|
|
180
|
-
* @param {
|
|
181
|
-
* @param {
|
|
182
|
-
* @returns {Promise<
|
|
183
|
-
* @summary:
|
|
184
|
-
* @description:
|
|
173
|
+
* @param {string} arg.namespace - Bucket name
|
|
174
|
+
* @param {StartRequest} arg.body
|
|
175
|
+
* @returns {Promise<StartResponse>} - Success response
|
|
176
|
+
* @summary: 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.
|
|
177
|
+
* @description: Uploads an arbitrarily sized buffer or blob.
|
|
178
|
+
*
|
|
179
|
+
* It has three Major Steps:
|
|
180
|
+
* Start
|
|
181
|
+
* Upload
|
|
182
|
+
* Complete
|
|
183
|
+
*
|
|
184
|
+
* ### Start
|
|
185
|
+
* Initiates the assets upload using `appStartUpload`.
|
|
186
|
+
* It returns the storage link in response.
|
|
187
|
+
*
|
|
188
|
+
* ### Upload
|
|
189
|
+
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
190
|
+
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
191
|
+
*
|
|
192
|
+
* ### Complete
|
|
193
|
+
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
194
|
+
* This operation will return the url for the uploaded file.
|
|
185
195
|
*/
|
|
186
|
-
async
|
|
187
|
-
|
|
196
|
+
async appStartUpload({
|
|
197
|
+
namespace,
|
|
198
|
+
|
|
199
|
+
body,
|
|
200
|
+
} = {}) {
|
|
201
|
+
const { error } = FileStorageValidator.appStartUpload().validate(
|
|
188
202
|
{
|
|
203
|
+
namespace,
|
|
204
|
+
|
|
189
205
|
body,
|
|
190
|
-
sync,
|
|
191
206
|
},
|
|
192
207
|
{ abortEarly: false, allowUnknown: true }
|
|
193
208
|
);
|
|
@@ -196,35 +211,35 @@ class FileStorage {
|
|
|
196
211
|
}
|
|
197
212
|
|
|
198
213
|
// Showing warrnings if extra unknown parameters are found
|
|
199
|
-
const { error: warrning } = FileStorageValidator.
|
|
214
|
+
const { error: warrning } = FileStorageValidator.appStartUpload().validate(
|
|
200
215
|
{
|
|
216
|
+
namespace,
|
|
217
|
+
|
|
201
218
|
body,
|
|
202
|
-
sync,
|
|
203
219
|
},
|
|
204
220
|
{ abortEarly: false, allowUnknown: false }
|
|
205
221
|
);
|
|
206
222
|
if (warrning) {
|
|
207
223
|
Logger({
|
|
208
224
|
level: "WARN",
|
|
209
|
-
message: "Parameter Validation warrnings for
|
|
225
|
+
message: "Parameter Validation warrnings for appStartUpload",
|
|
210
226
|
});
|
|
211
227
|
Logger({ level: "WARN", message: warrning });
|
|
212
228
|
}
|
|
213
229
|
|
|
214
230
|
const query_params = {};
|
|
215
|
-
query_params["sync"] = sync;
|
|
216
231
|
|
|
217
232
|
const response = await PlatformAPIClient.execute(
|
|
218
233
|
this.config,
|
|
219
234
|
"post",
|
|
220
|
-
`/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/
|
|
235
|
+
`/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/start/`,
|
|
221
236
|
query_params,
|
|
222
237
|
body
|
|
223
238
|
);
|
|
224
239
|
|
|
225
240
|
const {
|
|
226
241
|
error: res_error,
|
|
227
|
-
} = FileStorageModel.
|
|
242
|
+
} = FileStorageModel.StartResponse().validate(response, {
|
|
228
243
|
abortEarly: false,
|
|
229
244
|
allowUnknown: false,
|
|
230
245
|
});
|
|
@@ -232,7 +247,7 @@ class FileStorage {
|
|
|
232
247
|
if (res_error) {
|
|
233
248
|
Logger({
|
|
234
249
|
level: "WARN",
|
|
235
|
-
message: "Response Validation Warnnings for
|
|
250
|
+
message: "Response Validation Warnnings for appStartUpload",
|
|
236
251
|
});
|
|
237
252
|
Logger({ level: "WARN", message: res_error });
|
|
238
253
|
}
|
|
@@ -248,10 +263,15 @@ class FileStorage {
|
|
|
248
263
|
* @summary: Browse Files
|
|
249
264
|
* @description: Browse Files
|
|
250
265
|
*/
|
|
251
|
-
async browse({
|
|
266
|
+
async browse({
|
|
267
|
+
namespace,
|
|
268
|
+
|
|
269
|
+
pageNo,
|
|
270
|
+
} = {}) {
|
|
252
271
|
const { error } = FileStorageValidator.browse().validate(
|
|
253
272
|
{
|
|
254
273
|
namespace,
|
|
274
|
+
|
|
255
275
|
pageNo,
|
|
256
276
|
},
|
|
257
277
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -264,6 +284,7 @@ class FileStorage {
|
|
|
264
284
|
const { error: warrning } = FileStorageValidator.browse().validate(
|
|
265
285
|
{
|
|
266
286
|
namespace,
|
|
287
|
+
|
|
267
288
|
pageNo,
|
|
268
289
|
},
|
|
269
290
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -335,7 +356,6 @@ class FileStorage {
|
|
|
335
356
|
return paginator;
|
|
336
357
|
}
|
|
337
358
|
}
|
|
338
|
-
module.exports = FileStorage;
|
|
339
359
|
|
|
340
360
|
/**
|
|
341
361
|
* @param data
|
|
@@ -385,3 +405,5 @@ FileStorage.prototype.upload = function ({
|
|
|
385
405
|
}
|
|
386
406
|
});
|
|
387
407
|
};
|
|
408
|
+
|
|
409
|
+
module.exports = FileStorage;
|
|
@@ -1,15 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
|
-
const FileStorageModel = require("./FileStoragePlatformModel");
|
|
3
2
|
|
|
3
|
+
const FileStorageModel = require("./FileStoragePlatformModel");
|
|
4
4
|
class FileStorageValidator {
|
|
5
|
-
static appStartUpload() {
|
|
6
|
-
return Joi.object({
|
|
7
|
-
namespace: Joi.string().allow("").required(),
|
|
8
|
-
|
|
9
|
-
body: FileStorageModel.StartRequest().required(),
|
|
10
|
-
}).required();
|
|
11
|
-
}
|
|
12
|
-
|
|
13
5
|
static appCompleteUpload() {
|
|
14
6
|
return Joi.object({
|
|
15
7
|
namespace: Joi.string().allow("").required(),
|
|
@@ -26,6 +18,14 @@ class FileStorageValidator {
|
|
|
26
18
|
}).required();
|
|
27
19
|
}
|
|
28
20
|
|
|
21
|
+
static appStartUpload() {
|
|
22
|
+
return Joi.object({
|
|
23
|
+
namespace: Joi.string().allow("").required(),
|
|
24
|
+
|
|
25
|
+
body: FileStorageModel.StartRequest().required(),
|
|
26
|
+
}).required();
|
|
27
|
+
}
|
|
28
|
+
|
|
29
29
|
static browse() {
|
|
30
30
|
return Joi.object({
|
|
31
31
|
namespace: Joi.string().allow("").required(),
|
|
@@ -5,32 +5,24 @@ declare class FileStorage {
|
|
|
5
5
|
/**
|
|
6
6
|
* @param {Object} arg - Arg object.
|
|
7
7
|
* @param {string} arg.namespace - Bucket name
|
|
8
|
-
* @param {
|
|
9
|
-
* @returns {Promise<
|
|
10
|
-
* @summary:
|
|
11
|
-
* @description:
|
|
12
|
-
*
|
|
13
|
-
* It has three Major Steps:
|
|
14
|
-
* Start
|
|
15
|
-
* Upload
|
|
16
|
-
* Complete
|
|
17
|
-
*
|
|
18
|
-
* ### Start
|
|
19
|
-
* Initiates the assets upload using `startUpload`.
|
|
20
|
-
* It returns the storage link in response.
|
|
21
|
-
*
|
|
22
|
-
* ### Upload
|
|
23
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
24
|
-
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
25
|
-
*
|
|
26
|
-
* ### Complete
|
|
27
|
-
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
28
|
-
* This operation will return the url for the uploaded file.
|
|
8
|
+
* @param {number} [arg.pageNo] - Page no
|
|
9
|
+
* @returns {Promise<BrowseResponse>} - Success response
|
|
10
|
+
* @summary: Browse Files
|
|
11
|
+
* @description: Browse Files
|
|
29
12
|
*/
|
|
30
|
-
|
|
13
|
+
browse({ namespace, pageNo, }?: {
|
|
31
14
|
namespace: string;
|
|
32
|
-
|
|
33
|
-
}): Promise<
|
|
15
|
+
pageNo?: number;
|
|
16
|
+
}): Promise<BrowseResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* @param {Object} arg - Arg object.
|
|
19
|
+
* @param {string} arg.namespace - Bucket name
|
|
20
|
+
* @summary: Browse Files
|
|
21
|
+
* @description: Browse Files
|
|
22
|
+
*/
|
|
23
|
+
browsePaginator({ namespace }?: {
|
|
24
|
+
namespace: string;
|
|
25
|
+
}): Paginator;
|
|
34
26
|
/**
|
|
35
27
|
* @param {Object} arg - Arg object.
|
|
36
28
|
* @param {string} arg.namespace - Bucket name
|
|
@@ -56,20 +48,10 @@ declare class FileStorage {
|
|
|
56
48
|
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
57
49
|
* This operation will return the url for the uploaded file.
|
|
58
50
|
*/
|
|
59
|
-
completeUpload({ namespace, body }?: {
|
|
51
|
+
completeUpload({ namespace, body, }?: {
|
|
60
52
|
namespace: string;
|
|
61
53
|
body: StartResponse;
|
|
62
54
|
}): Promise<CompleteResponse>;
|
|
63
|
-
/**
|
|
64
|
-
* @param {Object} arg - Arg object.
|
|
65
|
-
* @param {SignUrlRequest} arg.body
|
|
66
|
-
* @returns {Promise<SignUrlResponse>} - Success response
|
|
67
|
-
* @summary: Gives signed urls to access private files
|
|
68
|
-
* @description: Describe here
|
|
69
|
-
*/
|
|
70
|
-
getSignUrls({ body }?: {
|
|
71
|
-
body: SignUrlRequest;
|
|
72
|
-
}): Promise<SignUrlResponse>;
|
|
73
55
|
/**
|
|
74
56
|
* @param {Object} arg - Arg object.
|
|
75
57
|
* @param {boolean} [arg.sync] - Sync
|
|
@@ -84,25 +66,14 @@ declare class FileStorage {
|
|
|
84
66
|
}): Promise<BulkUploadResponse>;
|
|
85
67
|
/**
|
|
86
68
|
* @param {Object} arg - Arg object.
|
|
87
|
-
* @param {
|
|
88
|
-
* @
|
|
89
|
-
* @
|
|
90
|
-
* @
|
|
91
|
-
* @description: Browse Files
|
|
92
|
-
*/
|
|
93
|
-
browse({ namespace, pageNo }?: {
|
|
94
|
-
namespace: string;
|
|
95
|
-
pageNo?: number;
|
|
96
|
-
}): Promise<BrowseResponse>;
|
|
97
|
-
/**
|
|
98
|
-
* @param {Object} arg - Arg object.
|
|
99
|
-
* @param {string} arg.namespace - Bucket name
|
|
100
|
-
* @summary: Browse Files
|
|
101
|
-
* @description: Browse Files
|
|
69
|
+
* @param {SignUrlRequest} arg.body
|
|
70
|
+
* @returns {Promise<SignUrlResponse>} - Success response
|
|
71
|
+
* @summary: Gives signed urls to access private files
|
|
72
|
+
* @description: Describe here
|
|
102
73
|
*/
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
}):
|
|
74
|
+
getSignUrls({ body }?: {
|
|
75
|
+
body: SignUrlRequest;
|
|
76
|
+
}): Promise<SignUrlResponse>;
|
|
106
77
|
/**
|
|
107
78
|
* @param {Object} arg - Arg object.
|
|
108
79
|
* @param {string} arg.url - Url
|
|
@@ -113,6 +84,35 @@ declare class FileStorage {
|
|
|
113
84
|
proxy({ url }?: {
|
|
114
85
|
url: string;
|
|
115
86
|
}): Promise<string>;
|
|
87
|
+
/**
|
|
88
|
+
* @param {Object} arg - Arg object.
|
|
89
|
+
* @param {string} arg.namespace - Bucket name
|
|
90
|
+
* @param {StartRequest} arg.body
|
|
91
|
+
* @returns {Promise<StartResponse>} - Success response
|
|
92
|
+
* @summary: 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.
|
|
93
|
+
* @description: Uploads an arbitrarily sized buffer or blob.
|
|
94
|
+
*
|
|
95
|
+
* It has three Major Steps:
|
|
96
|
+
* Start
|
|
97
|
+
* Upload
|
|
98
|
+
* Complete
|
|
99
|
+
*
|
|
100
|
+
* ### Start
|
|
101
|
+
* Initiates the assets upload using `startUpload`.
|
|
102
|
+
* It returns the storage link in response.
|
|
103
|
+
*
|
|
104
|
+
* ### Upload
|
|
105
|
+
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
106
|
+
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
107
|
+
*
|
|
108
|
+
* ### Complete
|
|
109
|
+
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
110
|
+
* This operation will return the url for the uploaded file.
|
|
111
|
+
*/
|
|
112
|
+
startUpload({ namespace, body, }?: {
|
|
113
|
+
namespace: string;
|
|
114
|
+
body: StartRequest;
|
|
115
|
+
}): Promise<StartResponse>;
|
|
116
116
|
/**
|
|
117
117
|
* @param data
|
|
118
118
|
* @param {string} file_name
|