@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-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/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +29 -1
- package/sdk/application/Order/OrderApplicationModel.js +34 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +524 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +335 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +66 -66
- package/sdk/application/User/UserApplicationClient.js +68 -71
- package/sdk/application/User/UserApplicationModel.d.ts +32 -27
- package/sdk/application/User/UserApplicationModel.js +22 -32
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +221 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +460 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +72 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +46 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +38 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +47 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
- package/sdk/platform/Content/ContentPlatformModel.js +20 -0
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +23 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -48
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +12 -48
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +15 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +42 -1
- package/sdk/platform/Order/OrderPlatformModel.js +44 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +10 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +11 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.js +29 -16
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +81 -11
- package/sdk/platform/User/UserPlatformModel.js +80 -10
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -11,26 +11,8 @@ declare class FileStorage {
|
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
12
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
13
13
|
* @name appCompleteUpload
|
|
14
|
-
* @summary:
|
|
15
|
-
* @description:
|
|
16
|
-
*
|
|
17
|
-
* It has three Major Steps:
|
|
18
|
-
* Start
|
|
19
|
-
* Upload
|
|
20
|
-
* Complete
|
|
21
|
-
*
|
|
22
|
-
* ### Start
|
|
23
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
24
|
-
* It returns the storage link in response.
|
|
25
|
-
*
|
|
26
|
-
* ### Upload
|
|
27
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
28
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
29
|
-
*
|
|
30
|
-
* ### Complete
|
|
31
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
32
|
-
* This operation will return the url for the uploaded file.
|
|
33
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
14
|
+
* @summary: Application complete upload.
|
|
15
|
+
* @description: Finish uploading a file from an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
34
16
|
*/
|
|
35
17
|
appCompleteUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
|
|
36
18
|
/**
|
|
@@ -39,8 +21,8 @@ declare class FileStorage {
|
|
|
39
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
22
|
* @returns {Promise<Object>} - Success response
|
|
41
23
|
* @name appCopyFiles
|
|
42
|
-
* @summary:
|
|
43
|
-
* @description: Copy
|
|
24
|
+
* @summary: Application copy files.
|
|
25
|
+
* @description: Copy files from an application to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
|
|
44
26
|
*/
|
|
45
27
|
appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
46
28
|
/**
|
|
@@ -51,26 +33,8 @@ declare class FileStorage {
|
|
|
51
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
34
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
53
35
|
* @name appStartUpload
|
|
54
|
-
* @summary:
|
|
55
|
-
* @description:
|
|
56
|
-
*
|
|
57
|
-
* It has three Major Steps:
|
|
58
|
-
* Start
|
|
59
|
-
* Upload
|
|
60
|
-
* Complete
|
|
61
|
-
*
|
|
62
|
-
* ### Start
|
|
63
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
64
|
-
* It returns the storage link in response.
|
|
65
|
-
*
|
|
66
|
-
* ### Upload
|
|
67
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
68
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
69
|
-
*
|
|
70
|
-
* ### Complete
|
|
71
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
72
|
-
* This operation will return the url for the uploaded file.
|
|
73
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
36
|
+
* @summary: Application start upload.
|
|
37
|
+
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
74
38
|
*/
|
|
75
39
|
appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
|
|
76
40
|
/**
|
|
@@ -79,8 +43,8 @@ declare class FileStorage {
|
|
|
79
43
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
44
|
* @returns {Promise<Object>} - Success response
|
|
81
45
|
* @name appbrowse
|
|
82
|
-
* @summary:
|
|
83
|
-
* @description: Browse
|
|
46
|
+
* @summary: Application browse files.
|
|
47
|
+
* @description: Browse files within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
|
|
84
48
|
*/
|
|
85
49
|
appbrowse({ namespace, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
86
50
|
/**
|
|
@@ -101,7 +65,7 @@ declare class FileStorage {
|
|
|
101
65
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
66
|
* @returns {Promise<Object>} - Success response
|
|
103
67
|
* @name generatePaymentReceipt
|
|
104
|
-
* @summary: Generate
|
|
68
|
+
* @summary: Generate payment receipt.
|
|
105
69
|
* @description: Generate Payment Receipt for Jiomart Digital - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/generatePaymentReceipt/).
|
|
106
70
|
*/
|
|
107
71
|
generatePaymentReceipt({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.GeneratePaymentReceiptParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -126,8 +90,8 @@ declare class FileStorage {
|
|
|
126
90
|
* @returns {Promise<FileStoragePlatformModel.DummyTemplateDataItems>} -
|
|
127
91
|
* Success response
|
|
128
92
|
* @name getDefaultPdfData
|
|
129
|
-
* @summary: Get
|
|
130
|
-
* @description:
|
|
93
|
+
* @summary: Get default PDF data.
|
|
94
|
+
* @description: Retrieve default data for PDF generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
|
|
131
95
|
*/
|
|
132
96
|
getDefaultPdfData({ pdfTypeId, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyTemplateDataItems>;
|
|
133
97
|
/**
|
|
@@ -139,8 +103,8 @@ declare class FileStorage {
|
|
|
139
103
|
* @returns {Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>} -
|
|
140
104
|
* Success response
|
|
141
105
|
* @name getDefaultPdfTemplate
|
|
142
|
-
* @summary:
|
|
143
|
-
* @description:
|
|
106
|
+
* @summary: Get default PDF template.
|
|
107
|
+
* @description: Retrieve the default PDF template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
|
|
144
108
|
*/
|
|
145
109
|
getDefaultPdfTemplate({ pdfTypeId, format, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>;
|
|
146
110
|
/**
|
|
@@ -150,10 +114,10 @@ declare class FileStorage {
|
|
|
150
114
|
* @returns {Promise<FileStoragePlatformModel.InvoiceTypesResponse>} -
|
|
151
115
|
* Success response
|
|
152
116
|
* @name getPdfTypes
|
|
153
|
-
* @summary: Get
|
|
154
|
-
* @description:
|
|
117
|
+
* @summary: Get PDF types.
|
|
118
|
+
* @description: Retrieve a list of available PDF types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
155
119
|
*/
|
|
156
|
-
getPdfTypes({ countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
120
|
+
getPdfTypes({ storeOs, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
157
121
|
/**
|
|
158
122
|
* @param {FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam} arg
|
|
159
123
|
* - Arg object
|
|
@@ -163,8 +127,8 @@ declare class FileStorage {
|
|
|
163
127
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
164
128
|
* Success response
|
|
165
129
|
* @name saveHtmlTemplate
|
|
166
|
-
* @summary:
|
|
167
|
-
* @description:
|
|
130
|
+
* @summary: Save HTML template.
|
|
131
|
+
* @description: Store an HTML template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
|
|
168
132
|
*/
|
|
169
133
|
saveHtmlTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
170
134
|
/**
|
|
@@ -176,8 +140,8 @@ declare class FileStorage {
|
|
|
176
140
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
177
141
|
* Success response
|
|
178
142
|
* @name updateHtmlTemplate
|
|
179
|
-
* @summary: Update
|
|
180
|
-
* @description: Update
|
|
143
|
+
* @summary: Update HTML Template
|
|
144
|
+
* @description: Update the HTML Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/updateHtmlTemplate/).
|
|
181
145
|
*/
|
|
182
146
|
updateHtmlTemplate({ id, body, requestHeaders }?: FileStoragePlatformApplicationValidator.UpdateHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
183
147
|
/**
|
|
@@ -25,26 +25,8 @@ class FileStorage {
|
|
|
25
25
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
26
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
27
27
|
* @name appCompleteUpload
|
|
28
|
-
* @summary:
|
|
29
|
-
* @description:
|
|
30
|
-
*
|
|
31
|
-
* It has three Major Steps:
|
|
32
|
-
* Start
|
|
33
|
-
* Upload
|
|
34
|
-
* Complete
|
|
35
|
-
*
|
|
36
|
-
* ### Start
|
|
37
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
38
|
-
* It returns the storage link in response.
|
|
39
|
-
*
|
|
40
|
-
* ### Upload
|
|
41
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
42
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
43
|
-
*
|
|
44
|
-
* ### Complete
|
|
45
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
46
|
-
* This operation will return the url for the uploaded file.
|
|
47
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
28
|
+
* @summary: Application complete upload.
|
|
29
|
+
* @description: Finish uploading a file from an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
48
30
|
*/
|
|
49
31
|
async appCompleteUpload(
|
|
50
32
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -126,8 +108,8 @@ class FileStorage {
|
|
|
126
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
127
109
|
* @returns {Promise<Object>} - Success response
|
|
128
110
|
* @name appCopyFiles
|
|
129
|
-
* @summary:
|
|
130
|
-
* @description: Copy
|
|
111
|
+
* @summary: Application copy files.
|
|
112
|
+
* @description: Copy files from an application to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
|
|
131
113
|
*/
|
|
132
114
|
async appCopyFiles(
|
|
133
115
|
{ body, sync, requestHeaders } = { requestHeaders: {} },
|
|
@@ -208,26 +190,8 @@ class FileStorage {
|
|
|
208
190
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
209
191
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
210
192
|
* @name appStartUpload
|
|
211
|
-
* @summary:
|
|
212
|
-
* @description:
|
|
213
|
-
*
|
|
214
|
-
* It has three Major Steps:
|
|
215
|
-
* Start
|
|
216
|
-
* Upload
|
|
217
|
-
* Complete
|
|
218
|
-
*
|
|
219
|
-
* ### Start
|
|
220
|
-
* Initiates the assets upload using `appStartUpload`.
|
|
221
|
-
* It returns the storage link in response.
|
|
222
|
-
*
|
|
223
|
-
* ### Upload
|
|
224
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
225
|
-
* Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
|
|
226
|
-
*
|
|
227
|
-
* ### Complete
|
|
228
|
-
* After successfully upload, call `appCompleteUpload` api to complete the upload process.
|
|
229
|
-
* This operation will return the url for the uploaded file.
|
|
230
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
193
|
+
* @summary: Application start upload.
|
|
194
|
+
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
231
195
|
*/
|
|
232
196
|
async appStartUpload(
|
|
233
197
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -309,8 +273,8 @@ class FileStorage {
|
|
|
309
273
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
310
274
|
* @returns {Promise<Object>} - Success response
|
|
311
275
|
* @name appbrowse
|
|
312
|
-
* @summary:
|
|
313
|
-
* @description: Browse
|
|
276
|
+
* @summary: Application browse files.
|
|
277
|
+
* @description: Browse files within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
|
|
314
278
|
*/
|
|
315
279
|
async appbrowse(
|
|
316
280
|
{ namespace, page, limit, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -491,7 +455,7 @@ class FileStorage {
|
|
|
491
455
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
456
|
* @returns {Promise<Object>} - Success response
|
|
493
457
|
* @name generatePaymentReceipt
|
|
494
|
-
* @summary: Generate
|
|
458
|
+
* @summary: Generate payment receipt.
|
|
495
459
|
* @description: Generate Payment Receipt for Jiomart Digital - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/generatePaymentReceipt/).
|
|
496
460
|
*/
|
|
497
461
|
async generatePaymentReceipt(
|
|
@@ -659,8 +623,8 @@ class FileStorage {
|
|
|
659
623
|
* @returns {Promise<FileStoragePlatformModel.DummyTemplateDataItems>} -
|
|
660
624
|
* Success response
|
|
661
625
|
* @name getDefaultPdfData
|
|
662
|
-
* @summary: Get
|
|
663
|
-
* @description:
|
|
626
|
+
* @summary: Get default PDF data.
|
|
627
|
+
* @description: Retrieve default data for PDF generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
|
|
664
628
|
*/
|
|
665
629
|
async getDefaultPdfData(
|
|
666
630
|
{ pdfTypeId, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -745,8 +709,8 @@ class FileStorage {
|
|
|
745
709
|
* @returns {Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>} -
|
|
746
710
|
* Success response
|
|
747
711
|
* @name getDefaultPdfTemplate
|
|
748
|
-
* @summary:
|
|
749
|
-
* @description:
|
|
712
|
+
* @summary: Get default PDF template.
|
|
713
|
+
* @description: Retrieve the default PDF template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
|
|
750
714
|
*/
|
|
751
715
|
async getDefaultPdfTemplate(
|
|
752
716
|
{ pdfTypeId, format, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -832,17 +796,18 @@ class FileStorage {
|
|
|
832
796
|
* @returns {Promise<FileStoragePlatformModel.InvoiceTypesResponse>} -
|
|
833
797
|
* Success response
|
|
834
798
|
* @name getPdfTypes
|
|
835
|
-
* @summary: Get
|
|
836
|
-
* @description:
|
|
799
|
+
* @summary: Get PDF types.
|
|
800
|
+
* @description: Retrieve a list of available PDF types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
837
801
|
*/
|
|
838
802
|
async getPdfTypes(
|
|
839
|
-
{ countryCode, requestHeaders } = { requestHeaders: {} },
|
|
803
|
+
{ storeOs, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
840
804
|
{ responseHeaders } = { responseHeaders: false }
|
|
841
805
|
) {
|
|
842
806
|
const {
|
|
843
807
|
error,
|
|
844
808
|
} = FileStoragePlatformApplicationValidator.getPdfTypes().validate(
|
|
845
809
|
{
|
|
810
|
+
storeOs,
|
|
846
811
|
countryCode,
|
|
847
812
|
},
|
|
848
813
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -856,6 +821,7 @@ class FileStorage {
|
|
|
856
821
|
error: warrning,
|
|
857
822
|
} = FileStoragePlatformApplicationValidator.getPdfTypes().validate(
|
|
858
823
|
{
|
|
824
|
+
storeOs,
|
|
859
825
|
countryCode,
|
|
860
826
|
},
|
|
861
827
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -869,6 +835,7 @@ class FileStorage {
|
|
|
869
835
|
|
|
870
836
|
const query_params = {};
|
|
871
837
|
query_params["country_code"] = countryCode;
|
|
838
|
+
query_params["store_os"] = storeOs;
|
|
872
839
|
|
|
873
840
|
const response = await PlatformAPIClient.execute(
|
|
874
841
|
this.config,
|
|
@@ -915,8 +882,8 @@ class FileStorage {
|
|
|
915
882
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
916
883
|
* Success response
|
|
917
884
|
* @name saveHtmlTemplate
|
|
918
|
-
* @summary:
|
|
919
|
-
* @description:
|
|
885
|
+
* @summary: Save HTML template.
|
|
886
|
+
* @description: Store an HTML template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
|
|
920
887
|
*/
|
|
921
888
|
async saveHtmlTemplate(
|
|
922
889
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -997,8 +964,8 @@ class FileStorage {
|
|
|
997
964
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
998
965
|
* Success response
|
|
999
966
|
* @name updateHtmlTemplate
|
|
1000
|
-
* @summary: Update
|
|
1001
|
-
* @description: Update
|
|
967
|
+
* @summary: Update HTML Template
|
|
968
|
+
* @description: Update the HTML Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/updateHtmlTemplate/).
|
|
1002
969
|
*/
|
|
1003
970
|
async updateHtmlTemplate(
|
|
1004
971
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -65,6 +65,7 @@ export = FileStoragePlatformApplicationValidator;
|
|
|
65
65
|
/**
|
|
66
66
|
* @typedef GetPdfTypesParam
|
|
67
67
|
* @property {string} [countryCode]
|
|
68
|
+
* @property {boolean} storeOs
|
|
68
69
|
*/
|
|
69
70
|
/**
|
|
70
71
|
* @typedef SaveHtmlTemplateParam
|
|
@@ -193,6 +194,7 @@ type GetDefaultPdfTemplateParam = {
|
|
|
193
194
|
};
|
|
194
195
|
type GetPdfTypesParam = {
|
|
195
196
|
countryCode?: string;
|
|
197
|
+
storeOs: boolean;
|
|
196
198
|
};
|
|
197
199
|
type SaveHtmlTemplateParam = {
|
|
198
200
|
body: FileStoragePlatformModel.PdfConfig;
|
|
@@ -77,6 +77,7 @@ const FileStoragePlatformModel = require("./FileStoragePlatformModel");
|
|
|
77
77
|
/**
|
|
78
78
|
* @typedef GetPdfTypesParam
|
|
79
79
|
* @property {string} [countryCode]
|
|
80
|
+
* @property {boolean} storeOs
|
|
80
81
|
*/
|
|
81
82
|
|
|
82
83
|
/**
|
|
@@ -178,6 +179,7 @@ class FileStoragePlatformApplicationValidator {
|
|
|
178
179
|
static getPdfTypes() {
|
|
179
180
|
return Joi.object({
|
|
180
181
|
countryCode: Joi.string().allow(""),
|
|
182
|
+
storeOs: Joi.boolean().required(),
|
|
181
183
|
}).required();
|
|
182
184
|
}
|
|
183
185
|
|
|
@@ -8,8 +8,8 @@ declare class FileStorage {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<Object>} - Success response
|
|
10
10
|
* @name browse
|
|
11
|
-
* @summary: Browse
|
|
12
|
-
* @description:
|
|
11
|
+
* @summary: Browse files.
|
|
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>;
|
|
15
15
|
/**
|
|
@@ -18,26 +18,8 @@ declare class FileStorage {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
20
20
|
* @name completeUpload
|
|
21
|
-
* @summary:
|
|
22
|
-
* @description:
|
|
23
|
-
*
|
|
24
|
-
* It has three Major Steps:
|
|
25
|
-
* Start
|
|
26
|
-
* Upload
|
|
27
|
-
* Complete
|
|
28
|
-
*
|
|
29
|
-
* ### Start
|
|
30
|
-
* Initiates the assets upload using `startUpload`.
|
|
31
|
-
* It returns the storage link in response.
|
|
32
|
-
*
|
|
33
|
-
* ### Upload
|
|
34
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
35
|
-
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
36
|
-
*
|
|
37
|
-
* ### Complete
|
|
38
|
-
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
39
|
-
* This operation will return the url for the uploaded file.
|
|
40
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
|
|
21
|
+
* @summary: Complete file upload.
|
|
22
|
+
* @description: Starts 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/completeUpload/).
|
|
41
23
|
*/
|
|
42
24
|
completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
|
|
43
25
|
/**
|
|
@@ -46,8 +28,8 @@ declare class FileStorage {
|
|
|
46
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
47
29
|
* @returns {Promise<Object>} - Success response
|
|
48
30
|
* @name copyFiles
|
|
49
|
-
* @summary: Copy
|
|
50
|
-
* @description:
|
|
31
|
+
* @summary: Copy files.
|
|
32
|
+
* @description: Duplicate files to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
|
|
51
33
|
*/
|
|
52
34
|
copyFiles({ body, sync, requestHeaders }?: FileStoragePlatformValidator.CopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
53
35
|
/**
|
|
@@ -56,8 +38,8 @@ declare class FileStorage {
|
|
|
56
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
57
39
|
* @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
|
|
58
40
|
* @name getSignUrls
|
|
59
|
-
* @summary:
|
|
60
|
-
* @description:
|
|
41
|
+
* @summary: Get signed URLs.
|
|
42
|
+
* @description: Retrieve signed URLs for file access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
|
|
61
43
|
*/
|
|
62
44
|
getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResponse>;
|
|
63
45
|
/**
|
|
@@ -66,8 +48,8 @@ declare class FileStorage {
|
|
|
66
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
67
49
|
* @returns {Promise<string>} - Success response
|
|
68
50
|
* @name proxy
|
|
69
|
-
* @summary: Proxy
|
|
70
|
-
* @description:
|
|
51
|
+
* @summary: Proxy file access.
|
|
52
|
+
* @description: Access files through a proxy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
|
|
71
53
|
*/
|
|
72
54
|
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<string>;
|
|
73
55
|
/**
|
|
@@ -76,26 +58,8 @@ declare class FileStorage {
|
|
|
76
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
77
59
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
78
60
|
* @name startUpload
|
|
79
|
-
* @summary:
|
|
80
|
-
* @description:
|
|
81
|
-
*
|
|
82
|
-
* It has three Major Steps:
|
|
83
|
-
* Start
|
|
84
|
-
* Upload
|
|
85
|
-
* Complete
|
|
86
|
-
*
|
|
87
|
-
* ### Start
|
|
88
|
-
* Initiates the assets upload using `startUpload`.
|
|
89
|
-
* It returns the storage link in response.
|
|
90
|
-
*
|
|
91
|
-
* ### Upload
|
|
92
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
93
|
-
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
94
|
-
*
|
|
95
|
-
* ### Complete
|
|
96
|
-
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
97
|
-
* This operation will return the url for the uploaded file.
|
|
98
|
-
* - 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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
99
63
|
*/
|
|
100
64
|
startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
|
|
101
65
|
/**
|
|
@@ -22,8 +22,8 @@ class FileStorage {
|
|
|
22
22
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
23
23
|
* @returns {Promise<Object>} - Success response
|
|
24
24
|
* @name browse
|
|
25
|
-
* @summary: Browse
|
|
26
|
-
* @description:
|
|
25
|
+
* @summary: Browse files.
|
|
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(
|
|
29
29
|
{ namespace, page, limit, requestHeaders } = { requestHeaders: {} },
|
|
@@ -105,26 +105,8 @@ class FileStorage {
|
|
|
105
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
107
107
|
* @name completeUpload
|
|
108
|
-
* @summary:
|
|
109
|
-
* @description:
|
|
110
|
-
*
|
|
111
|
-
* It has three Major Steps:
|
|
112
|
-
* Start
|
|
113
|
-
* Upload
|
|
114
|
-
* Complete
|
|
115
|
-
*
|
|
116
|
-
* ### Start
|
|
117
|
-
* Initiates the assets upload using `startUpload`.
|
|
118
|
-
* It returns the storage link in response.
|
|
119
|
-
*
|
|
120
|
-
* ### Upload
|
|
121
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
122
|
-
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
123
|
-
*
|
|
124
|
-
* ### Complete
|
|
125
|
-
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
126
|
-
* This operation will return the url for the uploaded file.
|
|
127
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
|
|
108
|
+
* @summary: Complete file upload.
|
|
109
|
+
* @description: Starts 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/completeUpload/).
|
|
128
110
|
*/
|
|
129
111
|
async completeUpload(
|
|
130
112
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -206,8 +188,8 @@ class FileStorage {
|
|
|
206
188
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
207
189
|
* @returns {Promise<Object>} - Success response
|
|
208
190
|
* @name copyFiles
|
|
209
|
-
* @summary: Copy
|
|
210
|
-
* @description:
|
|
191
|
+
* @summary: Copy files.
|
|
192
|
+
* @description: Duplicate files to another location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
|
|
211
193
|
*/
|
|
212
194
|
async copyFiles(
|
|
213
195
|
{ body, sync, requestHeaders } = { requestHeaders: {} },
|
|
@@ -286,8 +268,8 @@ class FileStorage {
|
|
|
286
268
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
287
269
|
* @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
|
|
288
270
|
* @name getSignUrls
|
|
289
|
-
* @summary:
|
|
290
|
-
* @description:
|
|
271
|
+
* @summary: Get signed URLs.
|
|
272
|
+
* @description: Retrieve signed URLs for file access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
|
|
291
273
|
*/
|
|
292
274
|
async getSignUrls(
|
|
293
275
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -365,8 +347,8 @@ class FileStorage {
|
|
|
365
347
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
366
348
|
* @returns {Promise<string>} - Success response
|
|
367
349
|
* @name proxy
|
|
368
|
-
* @summary: Proxy
|
|
369
|
-
* @description:
|
|
350
|
+
* @summary: Proxy file access.
|
|
351
|
+
* @description: Access files through a proxy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
|
|
370
352
|
*/
|
|
371
353
|
async proxy(
|
|
372
354
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -440,26 +422,8 @@ class FileStorage {
|
|
|
440
422
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
441
423
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
442
424
|
* @name startUpload
|
|
443
|
-
* @summary:
|
|
444
|
-
* @description:
|
|
445
|
-
*
|
|
446
|
-
* It has three Major Steps:
|
|
447
|
-
* Start
|
|
448
|
-
* Upload
|
|
449
|
-
* Complete
|
|
450
|
-
*
|
|
451
|
-
* ### Start
|
|
452
|
-
* Initiates the assets upload using `startUpload`.
|
|
453
|
-
* It returns the storage link in response.
|
|
454
|
-
*
|
|
455
|
-
* ### Upload
|
|
456
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
457
|
-
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
458
|
-
*
|
|
459
|
-
* ### Complete
|
|
460
|
-
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
461
|
-
* This operation will return the url for the uploaded file.
|
|
462
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
425
|
+
* @summary: Start file upload.
|
|
426
|
+
* @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/).
|
|
463
427
|
*/
|
|
464
428
|
async startUpload(
|
|
465
429
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -27,6 +27,10 @@ export = FileStoragePlatformModel;
|
|
|
27
27
|
* @property {CDN} cdn
|
|
28
28
|
* @property {string[]} [tags]
|
|
29
29
|
*/
|
|
30
|
+
/**
|
|
31
|
+
* @typedef Params
|
|
32
|
+
* @property {string} [subpath] - The subpath for the file.
|
|
33
|
+
*/
|
|
30
34
|
/**
|
|
31
35
|
* @typedef StartRequest
|
|
32
36
|
* @property {string} file_name
|
|
@@ -90,6 +94,7 @@ export = FileStoragePlatformModel;
|
|
|
90
94
|
* @property {string[]} format
|
|
91
95
|
* @property {number} __v
|
|
92
96
|
* @property {boolean} visibility
|
|
97
|
+
* @property {boolean} store_os
|
|
93
98
|
* @property {string} country_code
|
|
94
99
|
*/
|
|
95
100
|
/**
|
|
@@ -552,7 +557,7 @@ export = FileStoragePlatformModel;
|
|
|
552
557
|
declare class FileStoragePlatformModel {
|
|
553
558
|
}
|
|
554
559
|
declare namespace FileStoragePlatformModel {
|
|
555
|
-
export { FailedResponse, CDN, Upload, StartResponse, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
|
|
560
|
+
export { FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
|
|
556
561
|
}
|
|
557
562
|
/** @returns {FailedResponse} */
|
|
558
563
|
declare function FailedResponse(): FailedResponse;
|
|
@@ -586,6 +591,14 @@ type StartResponse = {
|
|
|
586
591
|
cdn: CDN;
|
|
587
592
|
tags?: string[];
|
|
588
593
|
};
|
|
594
|
+
/** @returns {Params} */
|
|
595
|
+
declare function Params(): Params;
|
|
596
|
+
type Params = {
|
|
597
|
+
/**
|
|
598
|
+
* - The subpath for the file.
|
|
599
|
+
*/
|
|
600
|
+
subpath?: string;
|
|
601
|
+
};
|
|
589
602
|
/** @returns {StartRequest} */
|
|
590
603
|
declare function StartRequest(): StartRequest;
|
|
591
604
|
type StartRequest = {
|
|
@@ -658,6 +671,7 @@ type InvoiceTypesDataResponse = {
|
|
|
658
671
|
format: string[];
|
|
659
672
|
__v: number;
|
|
660
673
|
visibility: boolean;
|
|
674
|
+
store_os: boolean;
|
|
661
675
|
country_code: string;
|
|
662
676
|
};
|
|
663
677
|
/** @returns {InvoiceTypesResponse} */
|
|
@@ -32,6 +32,11 @@ const Joi = require("joi");
|
|
|
32
32
|
* @property {string[]} [tags]
|
|
33
33
|
*/
|
|
34
34
|
|
|
35
|
+
/**
|
|
36
|
+
* @typedef Params
|
|
37
|
+
* @property {string} [subpath] - The subpath for the file.
|
|
38
|
+
*/
|
|
39
|
+
|
|
35
40
|
/**
|
|
36
41
|
* @typedef StartRequest
|
|
37
42
|
* @property {string} file_name
|
|
@@ -103,6 +108,7 @@ const Joi = require("joi");
|
|
|
103
108
|
* @property {string[]} format
|
|
104
109
|
* @property {number} __v
|
|
105
110
|
* @property {boolean} visibility
|
|
111
|
+
* @property {boolean} store_os
|
|
106
112
|
* @property {string} country_code
|
|
107
113
|
*/
|
|
108
114
|
|
|
@@ -656,6 +662,13 @@ class FileStoragePlatformModel {
|
|
|
656
662
|
});
|
|
657
663
|
}
|
|
658
664
|
|
|
665
|
+
/** @returns {Params} */
|
|
666
|
+
static Params() {
|
|
667
|
+
return Joi.object({
|
|
668
|
+
subpath: Joi.string().allow(""),
|
|
669
|
+
});
|
|
670
|
+
}
|
|
671
|
+
|
|
659
672
|
/** @returns {StartRequest} */
|
|
660
673
|
static StartRequest() {
|
|
661
674
|
return Joi.object({
|
|
@@ -744,6 +757,7 @@ class FileStoragePlatformModel {
|
|
|
744
757
|
format: Joi.array().items(Joi.string().allow("")).required(),
|
|
745
758
|
__v: Joi.number().required(),
|
|
746
759
|
visibility: Joi.boolean().required(),
|
|
760
|
+
store_os: Joi.boolean().required(),
|
|
747
761
|
country_code: Joi.string().allow("").required(),
|
|
748
762
|
});
|
|
749
763
|
}
|