@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.5
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 +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +304 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +437 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +22 -1
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +157 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +297 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +50 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +74 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +159 -87
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +195 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +473 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +75 -7
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +66 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +418 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +16 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +21 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +20 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -5,7 +5,7 @@ export = FileStoragePlatformApplicationValidator;
|
|
|
5
5
|
* files(products, orders, logistics etc), Required for validating the data of
|
|
6
6
|
* the file being uploaded, decides where exactly the file will be stored
|
|
7
7
|
* inside the storage bucket.
|
|
8
|
-
* @property {FileStoragePlatformModel.
|
|
8
|
+
* @property {FileStoragePlatformModel.StartResponse} body
|
|
9
9
|
*/
|
|
10
10
|
/**
|
|
11
11
|
* @typedef AppCopyFilesParam
|
|
@@ -18,7 +18,7 @@ export = FileStoragePlatformApplicationValidator;
|
|
|
18
18
|
* files(products, orders, logistics etc), Required for validating the data of
|
|
19
19
|
* the file being uploaded, decides where exactly the file will be stored
|
|
20
20
|
* inside the storage bucket.
|
|
21
|
-
* @property {FileStoragePlatformModel.
|
|
21
|
+
* @property {FileStoragePlatformModel.StartRequest} body
|
|
22
22
|
*/
|
|
23
23
|
/**
|
|
24
24
|
* @typedef AppbrowseParam
|
|
@@ -41,51 +41,30 @@ export = FileStoragePlatformApplicationValidator;
|
|
|
41
41
|
* @property {string} [search] - Search
|
|
42
42
|
* @property {FileStoragePlatformModel.ExtensionSlug} body
|
|
43
43
|
*/
|
|
44
|
-
/**
|
|
45
|
-
* @typedef DeletePdfGeneratorConfigParam
|
|
46
|
-
* @property {string} id
|
|
47
|
-
*/
|
|
48
|
-
/**
|
|
49
|
-
* @typedef FetchPdfDefaultTemplateByIdParam
|
|
50
|
-
* @property {string} id
|
|
51
|
-
*/
|
|
52
|
-
/**
|
|
53
|
-
* @typedef FetchPdfTypeByIdParam
|
|
54
|
-
* @property {string} id
|
|
55
|
-
*/
|
|
56
44
|
/**
|
|
57
45
|
* @typedef GeneratePaymentReceiptParam
|
|
58
46
|
* @property {FileStoragePlatformModel.PaymentReceiptRequestBody} body
|
|
59
47
|
*/
|
|
60
48
|
/**
|
|
61
|
-
* @typedef
|
|
62
|
-
* @property {string} id
|
|
63
|
-
*/
|
|
64
|
-
/**
|
|
65
|
-
* @typedef GetDefaultPdfDataParam
|
|
49
|
+
* @typedef GetDefaultHtmlTemplateParam
|
|
66
50
|
* @property {number} pdfTypeId
|
|
51
|
+
* @property {string} format
|
|
67
52
|
* @property {string} [countryCode]
|
|
68
53
|
*/
|
|
69
54
|
/**
|
|
70
|
-
* @typedef
|
|
55
|
+
* @typedef GetDefaultPdfDataParam
|
|
71
56
|
* @property {number} pdfTypeId
|
|
72
|
-
* @property {string} format
|
|
73
57
|
* @property {string} [countryCode]
|
|
74
58
|
*/
|
|
75
59
|
/**
|
|
76
|
-
* @typedef
|
|
60
|
+
* @typedef GetDefaultPdfTemplateParam
|
|
77
61
|
* @property {number} pdfTypeId
|
|
78
62
|
* @property {string} format
|
|
79
63
|
* @property {string} [countryCode]
|
|
80
64
|
*/
|
|
81
|
-
/**
|
|
82
|
-
* @typedef GetPdfPayloadByIdParam
|
|
83
|
-
* @property {string} id
|
|
84
|
-
*/
|
|
85
65
|
/**
|
|
86
66
|
* @typedef GetPdfTypesParam
|
|
87
67
|
* @property {string} [countryCode]
|
|
88
|
-
* @property {boolean} storeOs
|
|
89
68
|
*/
|
|
90
69
|
/**
|
|
91
70
|
* @typedef SaveHtmlTemplateParam
|
|
@@ -107,24 +86,14 @@ declare class FileStoragePlatformApplicationValidator {
|
|
|
107
86
|
static appbrowse(): AppbrowseParam;
|
|
108
87
|
/** @returns {BrowsefilesParam} */
|
|
109
88
|
static browsefiles(): BrowsefilesParam;
|
|
110
|
-
/** @returns {DeletePdfGeneratorConfigParam} */
|
|
111
|
-
static deletePdfGeneratorConfig(): DeletePdfGeneratorConfigParam;
|
|
112
|
-
/** @returns {FetchPdfDefaultTemplateByIdParam} */
|
|
113
|
-
static fetchPdfDefaultTemplateById(): FetchPdfDefaultTemplateByIdParam;
|
|
114
|
-
/** @returns {FetchPdfTypeByIdParam} */
|
|
115
|
-
static fetchPdfTypeById(): FetchPdfTypeByIdParam;
|
|
116
89
|
/** @returns {GeneratePaymentReceiptParam} */
|
|
117
90
|
static generatePaymentReceipt(): GeneratePaymentReceiptParam;
|
|
118
|
-
/** @returns {
|
|
119
|
-
static
|
|
91
|
+
/** @returns {GetDefaultHtmlTemplateParam} */
|
|
92
|
+
static getDefaultHtmlTemplate(): GetDefaultHtmlTemplateParam;
|
|
120
93
|
/** @returns {GetDefaultPdfDataParam} */
|
|
121
94
|
static getDefaultPdfData(): GetDefaultPdfDataParam;
|
|
122
95
|
/** @returns {GetDefaultPdfTemplateParam} */
|
|
123
96
|
static getDefaultPdfTemplate(): GetDefaultPdfTemplateParam;
|
|
124
|
-
/** @returns {GetHtmlTemplateConfigParam} */
|
|
125
|
-
static getHtmlTemplateConfig(): GetHtmlTemplateConfigParam;
|
|
126
|
-
/** @returns {GetPdfPayloadByIdParam} */
|
|
127
|
-
static getPdfPayloadById(): GetPdfPayloadByIdParam;
|
|
128
97
|
/** @returns {GetPdfTypesParam} */
|
|
129
98
|
static getPdfTypes(): GetPdfTypesParam;
|
|
130
99
|
/** @returns {SaveHtmlTemplateParam} */
|
|
@@ -133,7 +102,7 @@ declare class FileStoragePlatformApplicationValidator {
|
|
|
133
102
|
static updateHtmlTemplate(): UpdateHtmlTemplateParam;
|
|
134
103
|
}
|
|
135
104
|
declare namespace FileStoragePlatformApplicationValidator {
|
|
136
|
-
export { AppCompleteUploadParam, AppCopyFilesParam, AppStartUploadParam, AppbrowseParam, BrowsefilesParam,
|
|
105
|
+
export { AppCompleteUploadParam, AppCopyFilesParam, AppStartUploadParam, AppbrowseParam, BrowsefilesParam, GeneratePaymentReceiptParam, GetDefaultHtmlTemplateParam, GetDefaultPdfDataParam, GetDefaultPdfTemplateParam, GetPdfTypesParam, SaveHtmlTemplateParam, UpdateHtmlTemplateParam };
|
|
137
106
|
}
|
|
138
107
|
type AppCompleteUploadParam = {
|
|
139
108
|
/**
|
|
@@ -143,7 +112,7 @@ type AppCompleteUploadParam = {
|
|
|
143
112
|
* inside the storage bucket.
|
|
144
113
|
*/
|
|
145
114
|
namespace: string;
|
|
146
|
-
body: FileStoragePlatformModel.
|
|
115
|
+
body: FileStoragePlatformModel.StartResponse;
|
|
147
116
|
};
|
|
148
117
|
type AppCopyFilesParam = {
|
|
149
118
|
/**
|
|
@@ -160,7 +129,7 @@ type AppStartUploadParam = {
|
|
|
160
129
|
* inside the storage bucket.
|
|
161
130
|
*/
|
|
162
131
|
namespace: string;
|
|
163
|
-
body: FileStoragePlatformModel.
|
|
132
|
+
body: FileStoragePlatformModel.StartRequest;
|
|
164
133
|
};
|
|
165
134
|
type AppbrowseParam = {
|
|
166
135
|
/**
|
|
@@ -205,41 +174,25 @@ type BrowsefilesParam = {
|
|
|
205
174
|
search?: string;
|
|
206
175
|
body: FileStoragePlatformModel.ExtensionSlug;
|
|
207
176
|
};
|
|
208
|
-
type DeletePdfGeneratorConfigParam = {
|
|
209
|
-
id: string;
|
|
210
|
-
};
|
|
211
|
-
type FetchPdfDefaultTemplateByIdParam = {
|
|
212
|
-
id: string;
|
|
213
|
-
};
|
|
214
|
-
type FetchPdfTypeByIdParam = {
|
|
215
|
-
id: string;
|
|
216
|
-
};
|
|
217
177
|
type GeneratePaymentReceiptParam = {
|
|
218
178
|
body: FileStoragePlatformModel.PaymentReceiptRequestBody;
|
|
219
179
|
};
|
|
220
|
-
type
|
|
221
|
-
id: string;
|
|
222
|
-
};
|
|
223
|
-
type GetDefaultPdfDataParam = {
|
|
180
|
+
type GetDefaultHtmlTemplateParam = {
|
|
224
181
|
pdfTypeId: number;
|
|
182
|
+
format: string;
|
|
225
183
|
countryCode?: string;
|
|
226
184
|
};
|
|
227
|
-
type
|
|
185
|
+
type GetDefaultPdfDataParam = {
|
|
228
186
|
pdfTypeId: number;
|
|
229
|
-
format: string;
|
|
230
187
|
countryCode?: string;
|
|
231
188
|
};
|
|
232
|
-
type
|
|
189
|
+
type GetDefaultPdfTemplateParam = {
|
|
233
190
|
pdfTypeId: number;
|
|
234
191
|
format: string;
|
|
235
192
|
countryCode?: string;
|
|
236
193
|
};
|
|
237
|
-
type GetPdfPayloadByIdParam = {
|
|
238
|
-
id: string;
|
|
239
|
-
};
|
|
240
194
|
type GetPdfTypesParam = {
|
|
241
195
|
countryCode?: string;
|
|
242
|
-
storeOs: boolean;
|
|
243
196
|
};
|
|
244
197
|
type SaveHtmlTemplateParam = {
|
|
245
198
|
body: FileStoragePlatformModel.PdfConfig;
|
|
@@ -8,7 +8,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
|
|
|
8
8
|
* files(products, orders, logistics etc), Required for validating the data of
|
|
9
9
|
* the file being uploaded, decides where exactly the file will be stored
|
|
10
10
|
* inside the storage bucket.
|
|
11
|
-
* @property {FileStoragePlatformModel.
|
|
11
|
+
* @property {FileStoragePlatformModel.StartResponse} body
|
|
12
12
|
*/
|
|
13
13
|
|
|
14
14
|
/**
|
|
@@ -23,7 +23,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
|
|
|
23
23
|
* files(products, orders, logistics etc), Required for validating the data of
|
|
24
24
|
* the file being uploaded, decides where exactly the file will be stored
|
|
25
25
|
* inside the storage bucket.
|
|
26
|
-
* @property {FileStoragePlatformModel.
|
|
26
|
+
* @property {FileStoragePlatformModel.StartRequest} body
|
|
27
27
|
*/
|
|
28
28
|
|
|
29
29
|
/**
|
|
@@ -49,60 +49,34 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
|
|
|
49
49
|
* @property {FileStoragePlatformModel.ExtensionSlug} body
|
|
50
50
|
*/
|
|
51
51
|
|
|
52
|
-
/**
|
|
53
|
-
* @typedef DeletePdfGeneratorConfigParam
|
|
54
|
-
* @property {string} id
|
|
55
|
-
*/
|
|
56
|
-
|
|
57
|
-
/**
|
|
58
|
-
* @typedef FetchPdfDefaultTemplateByIdParam
|
|
59
|
-
* @property {string} id
|
|
60
|
-
*/
|
|
61
|
-
|
|
62
|
-
/**
|
|
63
|
-
* @typedef FetchPdfTypeByIdParam
|
|
64
|
-
* @property {string} id
|
|
65
|
-
*/
|
|
66
|
-
|
|
67
52
|
/**
|
|
68
53
|
* @typedef GeneratePaymentReceiptParam
|
|
69
54
|
* @property {FileStoragePlatformModel.PaymentReceiptRequestBody} body
|
|
70
55
|
*/
|
|
71
56
|
|
|
72
57
|
/**
|
|
73
|
-
* @typedef
|
|
74
|
-
* @property {string} id
|
|
75
|
-
*/
|
|
76
|
-
|
|
77
|
-
/**
|
|
78
|
-
* @typedef GetDefaultPdfDataParam
|
|
58
|
+
* @typedef GetDefaultHtmlTemplateParam
|
|
79
59
|
* @property {number} pdfTypeId
|
|
60
|
+
* @property {string} format
|
|
80
61
|
* @property {string} [countryCode]
|
|
81
62
|
*/
|
|
82
63
|
|
|
83
64
|
/**
|
|
84
|
-
* @typedef
|
|
65
|
+
* @typedef GetDefaultPdfDataParam
|
|
85
66
|
* @property {number} pdfTypeId
|
|
86
|
-
* @property {string} format
|
|
87
67
|
* @property {string} [countryCode]
|
|
88
68
|
*/
|
|
89
69
|
|
|
90
70
|
/**
|
|
91
|
-
* @typedef
|
|
71
|
+
* @typedef GetDefaultPdfTemplateParam
|
|
92
72
|
* @property {number} pdfTypeId
|
|
93
73
|
* @property {string} format
|
|
94
74
|
* @property {string} [countryCode]
|
|
95
75
|
*/
|
|
96
76
|
|
|
97
|
-
/**
|
|
98
|
-
* @typedef GetPdfPayloadByIdParam
|
|
99
|
-
* @property {string} id
|
|
100
|
-
*/
|
|
101
|
-
|
|
102
77
|
/**
|
|
103
78
|
* @typedef GetPdfTypesParam
|
|
104
79
|
* @property {string} [countryCode]
|
|
105
|
-
* @property {boolean} storeOs
|
|
106
80
|
*/
|
|
107
81
|
|
|
108
82
|
/**
|
|
@@ -122,7 +96,7 @@ class FileStoragePlatformApplicationValidator {
|
|
|
122
96
|
return Joi.object({
|
|
123
97
|
namespace: Joi.string().allow("").required(),
|
|
124
98
|
|
|
125
|
-
body: FileStoragePlatformModel.
|
|
99
|
+
body: FileStoragePlatformModel.StartResponse().required(),
|
|
126
100
|
}).required();
|
|
127
101
|
}
|
|
128
102
|
|
|
@@ -140,7 +114,7 @@ class FileStoragePlatformApplicationValidator {
|
|
|
140
114
|
return Joi.object({
|
|
141
115
|
namespace: Joi.string().allow("").required(),
|
|
142
116
|
|
|
143
|
-
body: FileStoragePlatformModel.
|
|
117
|
+
body: FileStoragePlatformModel.StartRequest().required(),
|
|
144
118
|
}).required();
|
|
145
119
|
}
|
|
146
120
|
|
|
@@ -167,27 +141,6 @@ class FileStoragePlatformApplicationValidator {
|
|
|
167
141
|
}).required();
|
|
168
142
|
}
|
|
169
143
|
|
|
170
|
-
/** @returns {DeletePdfGeneratorConfigParam} */
|
|
171
|
-
static deletePdfGeneratorConfig() {
|
|
172
|
-
return Joi.object({
|
|
173
|
-
id: Joi.string().allow("").required(),
|
|
174
|
-
}).required();
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
/** @returns {FetchPdfDefaultTemplateByIdParam} */
|
|
178
|
-
static fetchPdfDefaultTemplateById() {
|
|
179
|
-
return Joi.object({
|
|
180
|
-
id: Joi.string().allow("").required(),
|
|
181
|
-
}).required();
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
/** @returns {FetchPdfTypeByIdParam} */
|
|
185
|
-
static fetchPdfTypeById() {
|
|
186
|
-
return Joi.object({
|
|
187
|
-
id: Joi.string().allow("").required(),
|
|
188
|
-
}).required();
|
|
189
|
-
}
|
|
190
|
-
|
|
191
144
|
/** @returns {GeneratePaymentReceiptParam} */
|
|
192
145
|
static generatePaymentReceipt() {
|
|
193
146
|
return Joi.object({
|
|
@@ -195,10 +148,12 @@ class FileStoragePlatformApplicationValidator {
|
|
|
195
148
|
}).required();
|
|
196
149
|
}
|
|
197
150
|
|
|
198
|
-
/** @returns {
|
|
199
|
-
static
|
|
151
|
+
/** @returns {GetDefaultHtmlTemplateParam} */
|
|
152
|
+
static getDefaultHtmlTemplate() {
|
|
200
153
|
return Joi.object({
|
|
201
|
-
|
|
154
|
+
pdfTypeId: Joi.number().required(),
|
|
155
|
+
format: Joi.string().allow("").required(),
|
|
156
|
+
countryCode: Joi.string().allow(""),
|
|
202
157
|
}).required();
|
|
203
158
|
}
|
|
204
159
|
|
|
@@ -219,27 +174,10 @@ class FileStoragePlatformApplicationValidator {
|
|
|
219
174
|
}).required();
|
|
220
175
|
}
|
|
221
176
|
|
|
222
|
-
/** @returns {GetHtmlTemplateConfigParam} */
|
|
223
|
-
static getHtmlTemplateConfig() {
|
|
224
|
-
return Joi.object({
|
|
225
|
-
pdfTypeId: Joi.number().required(),
|
|
226
|
-
format: Joi.string().allow("").required(),
|
|
227
|
-
countryCode: Joi.string().allow(""),
|
|
228
|
-
}).required();
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
/** @returns {GetPdfPayloadByIdParam} */
|
|
232
|
-
static getPdfPayloadById() {
|
|
233
|
-
return Joi.object({
|
|
234
|
-
id: Joi.string().allow("").required(),
|
|
235
|
-
}).required();
|
|
236
|
-
}
|
|
237
|
-
|
|
238
177
|
/** @returns {GetPdfTypesParam} */
|
|
239
178
|
static getPdfTypes() {
|
|
240
179
|
return Joi.object({
|
|
241
180
|
countryCode: Joi.string().allow(""),
|
|
242
|
-
storeOs: Joi.boolean().required(),
|
|
243
181
|
}).required();
|
|
244
182
|
}
|
|
245
183
|
|
|
@@ -8,7 +8,7 @@ declare class FileStorage {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<Object>} - Success response
|
|
10
10
|
* @name browse
|
|
11
|
-
* @summary: Browse files
|
|
11
|
+
* @summary: Browse files
|
|
12
12
|
* @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browse/).
|
|
13
13
|
*/
|
|
14
14
|
browse({ namespace, page, limit, requestHeaders }?: FileStoragePlatformValidator.BrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -16,52 +16,52 @@ declare class FileStorage {
|
|
|
16
16
|
* @param {FileStoragePlatformValidator.CompleteUploadParam} arg - Arg object
|
|
17
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
19
|
+
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
20
20
|
* @name completeUpload
|
|
21
|
-
* @summary: Complete file upload
|
|
22
|
-
* @description:
|
|
21
|
+
* @summary: Complete file upload
|
|
22
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database at platform level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
|
|
23
23
|
*/
|
|
24
|
-
completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.
|
|
24
|
+
completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
|
|
25
25
|
/**
|
|
26
26
|
* @param {FileStoragePlatformValidator.CopyFilesParam} arg - Arg object
|
|
27
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<Object>} - Success response
|
|
30
30
|
* @name copyFiles
|
|
31
|
-
* @summary: Copy files
|
|
32
|
-
* @description:
|
|
31
|
+
* @summary: Copy files
|
|
32
|
+
* @description: Handle multiple file uploads, updating progress and providing detailed status reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
|
|
33
33
|
*/
|
|
34
34
|
copyFiles({ body, sync, requestHeaders }?: FileStoragePlatformValidator.CopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
35
35
|
/**
|
|
36
36
|
* @param {FileStoragePlatformValidator.GetSignUrlsParam} arg - Arg object
|
|
37
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
39
|
+
* @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
|
|
40
40
|
* @name getSignUrls
|
|
41
|
-
* @summary: Get signed URLs
|
|
42
|
-
* @description:
|
|
41
|
+
* @summary: Get signed URLs
|
|
42
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored resources inside private bucket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
|
|
43
43
|
*/
|
|
44
|
-
getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.
|
|
44
|
+
getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
|
|
47
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
49
|
+
* @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
|
|
50
50
|
* @name proxy
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
51
|
+
* @summary: Access files through a proxy
|
|
52
|
+
* @description: It enables the communication between two entities by directing client requests to the correct server and sending responses back to the client. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
|
|
53
53
|
*/
|
|
54
|
-
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.
|
|
54
|
+
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.ProxyResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* @param {FileStoragePlatformValidator.StartUploadParam} arg - Arg object
|
|
57
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
59
|
+
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
60
60
|
* @name startUpload
|
|
61
|
-
* @summary: Start file upload
|
|
62
|
-
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
61
|
+
* @summary: Start file upload
|
|
62
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response at platform level. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
63
63
|
*/
|
|
64
|
-
startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.
|
|
64
|
+
startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
|
|
65
65
|
/**
|
|
66
66
|
* @param data
|
|
67
67
|
* @param {string} file_name
|
|
@@ -22,7 +22,7 @@ class FileStorage {
|
|
|
22
22
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
23
23
|
* @returns {Promise<Object>} - Success response
|
|
24
24
|
* @name browse
|
|
25
|
-
* @summary: Browse files
|
|
25
|
+
* @summary: Browse files
|
|
26
26
|
* @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browse/).
|
|
27
27
|
*/
|
|
28
28
|
async browse(
|
|
@@ -103,10 +103,10 @@ class FileStorage {
|
|
|
103
103
|
* @param {FileStoragePlatformValidator.CompleteUploadParam} arg - Arg object
|
|
104
104
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
105
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
106
|
+
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
107
107
|
* @name completeUpload
|
|
108
|
-
* @summary: Complete file upload
|
|
109
|
-
* @description:
|
|
108
|
+
* @summary: Complete file upload
|
|
109
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database at platform level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
|
|
110
110
|
*/
|
|
111
111
|
async completeUpload(
|
|
112
112
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -149,7 +149,7 @@ class FileStorage {
|
|
|
149
149
|
const response = await PlatformAPIClient.execute(
|
|
150
150
|
this.config,
|
|
151
151
|
"post",
|
|
152
|
-
`/service/platform/assets/
|
|
152
|
+
`/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/complete`,
|
|
153
153
|
query_params,
|
|
154
154
|
body,
|
|
155
155
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -163,7 +163,7 @@ class FileStorage {
|
|
|
163
163
|
|
|
164
164
|
const {
|
|
165
165
|
error: res_error,
|
|
166
|
-
} = FileStoragePlatformModel.
|
|
166
|
+
} = FileStoragePlatformModel.CompleteResponse().validate(responseData, {
|
|
167
167
|
abortEarly: false,
|
|
168
168
|
allowUnknown: true,
|
|
169
169
|
});
|
|
@@ -188,8 +188,8 @@ class FileStorage {
|
|
|
188
188
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
189
|
* @returns {Promise<Object>} - Success response
|
|
190
190
|
* @name copyFiles
|
|
191
|
-
* @summary: Copy files
|
|
192
|
-
* @description:
|
|
191
|
+
* @summary: Copy files
|
|
192
|
+
* @description: Handle multiple file uploads, updating progress and providing detailed status reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
|
|
193
193
|
*/
|
|
194
194
|
async copyFiles(
|
|
195
195
|
{ body, sync, requestHeaders } = { requestHeaders: {} },
|
|
@@ -266,10 +266,10 @@ class FileStorage {
|
|
|
266
266
|
* @param {FileStoragePlatformValidator.GetSignUrlsParam} arg - Arg object
|
|
267
267
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
268
268
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
269
|
+
* @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
|
|
270
270
|
* @name getSignUrls
|
|
271
|
-
* @summary: Get signed URLs
|
|
272
|
-
* @description:
|
|
271
|
+
* @summary: Get signed URLs
|
|
272
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored resources inside private bucket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
|
|
273
273
|
*/
|
|
274
274
|
async getSignUrls(
|
|
275
275
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -322,7 +322,7 @@ class FileStorage {
|
|
|
322
322
|
|
|
323
323
|
const {
|
|
324
324
|
error: res_error,
|
|
325
|
-
} = FileStoragePlatformModel.
|
|
325
|
+
} = FileStoragePlatformModel.SignUrlResponse().validate(responseData, {
|
|
326
326
|
abortEarly: false,
|
|
327
327
|
allowUnknown: true,
|
|
328
328
|
});
|
|
@@ -345,10 +345,10 @@ class FileStorage {
|
|
|
345
345
|
* @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
|
|
346
346
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
347
347
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
348
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
348
|
+
* @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
|
|
349
349
|
* @name proxy
|
|
350
|
-
* @summary:
|
|
351
|
-
* @description:
|
|
350
|
+
* @summary: Access files through a proxy
|
|
351
|
+
* @description: It enables the communication between two entities by directing client requests to the correct server and sending responses back to the client. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
|
|
352
352
|
*/
|
|
353
353
|
async proxy(
|
|
354
354
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -400,7 +400,7 @@ class FileStorage {
|
|
|
400
400
|
|
|
401
401
|
const {
|
|
402
402
|
error: res_error,
|
|
403
|
-
} = FileStoragePlatformModel.
|
|
403
|
+
} = FileStoragePlatformModel.ProxyResponse().validate(responseData, {
|
|
404
404
|
abortEarly: false,
|
|
405
405
|
allowUnknown: true,
|
|
406
406
|
});
|
|
@@ -423,10 +423,10 @@ class FileStorage {
|
|
|
423
423
|
* @param {FileStoragePlatformValidator.StartUploadParam} arg - Arg object
|
|
424
424
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
425
425
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
426
|
-
* @returns {Promise<FileStoragePlatformModel.
|
|
426
|
+
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
427
427
|
* @name startUpload
|
|
428
|
-
* @summary: Start file upload
|
|
429
|
-
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
428
|
+
* @summary: Start file upload
|
|
429
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response at platform level. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
430
430
|
*/
|
|
431
431
|
async startUpload(
|
|
432
432
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -469,7 +469,7 @@ class FileStorage {
|
|
|
469
469
|
const response = await PlatformAPIClient.execute(
|
|
470
470
|
this.config,
|
|
471
471
|
"post",
|
|
472
|
-
`/service/platform/assets/
|
|
472
|
+
`/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/start`,
|
|
473
473
|
query_params,
|
|
474
474
|
body,
|
|
475
475
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -483,7 +483,7 @@ class FileStorage {
|
|
|
483
483
|
|
|
484
484
|
const {
|
|
485
485
|
error: res_error,
|
|
486
|
-
} = FileStoragePlatformModel.
|
|
486
|
+
} = FileStoragePlatformModel.StartResponse().validate(responseData, {
|
|
487
487
|
abortEarly: false,
|
|
488
488
|
allowUnknown: true,
|
|
489
489
|
});
|