@gofynd/fdk-client-javascript 1.4.2-beta.4 → 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 +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -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 +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -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 +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- 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 +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -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 +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -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/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 +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- 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 +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- 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/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 +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- 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 +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- 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
|
@@ -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,8 +796,8 @@ 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
803
|
{ storeOs, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -918,8 +882,8 @@ class FileStorage {
|
|
|
918
882
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
919
883
|
* Success response
|
|
920
884
|
* @name saveHtmlTemplate
|
|
921
|
-
* @summary:
|
|
922
|
-
* @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/).
|
|
923
887
|
*/
|
|
924
888
|
async saveHtmlTemplate(
|
|
925
889
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1000,8 +964,8 @@ class FileStorage {
|
|
|
1000
964
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
1001
965
|
* Success response
|
|
1002
966
|
* @name updateHtmlTemplate
|
|
1003
|
-
* @summary: Update
|
|
1004
|
-
* @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/).
|
|
1005
969
|
*/
|
|
1006
970
|
async updateHtmlTemplate(
|
|
1007
971
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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,46 +38,28 @@ 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
|
/**
|
|
64
46
|
* @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
|
|
65
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
66
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
67
|
-
* @returns {Promise<
|
|
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
|
-
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<
|
|
54
|
+
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<string>;
|
|
73
55
|
/**
|
|
74
56
|
* @param {FileStoragePlatformValidator.StartUploadParam} arg - Arg object
|
|
75
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
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: {} },
|
|
@@ -363,10 +345,10 @@ class FileStorage {
|
|
|
363
345
|
* @param {FileStoragePlatformValidator.ProxyParam} arg - Arg object
|
|
364
346
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
365
347
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
366
|
-
* @returns {Promise<
|
|
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: {} },
|
|
@@ -416,12 +398,9 @@ class FileStorage {
|
|
|
416
398
|
responseData = response[0];
|
|
417
399
|
}
|
|
418
400
|
|
|
419
|
-
const {
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
abortEarly: false,
|
|
423
|
-
allowUnknown: true,
|
|
424
|
-
});
|
|
401
|
+
const { error: res_error } = Joi.string()
|
|
402
|
+
.allow("")
|
|
403
|
+
.validate(responseData, { abortEarly: false, allowUnknown: true });
|
|
425
404
|
|
|
426
405
|
if (res_error) {
|
|
427
406
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -443,26 +422,8 @@ class FileStorage {
|
|
|
443
422
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
444
423
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
445
424
|
* @name startUpload
|
|
446
|
-
* @summary:
|
|
447
|
-
* @description:
|
|
448
|
-
*
|
|
449
|
-
* It has three Major Steps:
|
|
450
|
-
* Start
|
|
451
|
-
* Upload
|
|
452
|
-
* Complete
|
|
453
|
-
*
|
|
454
|
-
* ### Start
|
|
455
|
-
* Initiates the assets upload using `startUpload`.
|
|
456
|
-
* It returns the storage link in response.
|
|
457
|
-
*
|
|
458
|
-
* ### Upload
|
|
459
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
460
|
-
* Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
|
|
461
|
-
*
|
|
462
|
-
* ### Complete
|
|
463
|
-
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
464
|
-
* This operation will return the url for the uploaded file.
|
|
465
|
-
* - 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/).
|
|
466
427
|
*/
|
|
467
428
|
async startUpload(
|
|
468
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
|
|
@@ -57,11 +61,6 @@ export = FileStoragePlatformModel;
|
|
|
57
61
|
* @property {string} modified_on
|
|
58
62
|
* @property {CreatedBy} [created_by]
|
|
59
63
|
*/
|
|
60
|
-
/**
|
|
61
|
-
* @typedef ProxyResponse
|
|
62
|
-
* @property {Object} [data]
|
|
63
|
-
* @property {Object} [support]
|
|
64
|
-
*/
|
|
65
64
|
/**
|
|
66
65
|
* @typedef DestinationNamespace
|
|
67
66
|
* @property {string} [namespace]
|
|
@@ -558,7 +557,7 @@ export = FileStoragePlatformModel;
|
|
|
558
557
|
declare class FileStoragePlatformModel {
|
|
559
558
|
}
|
|
560
559
|
declare namespace FileStoragePlatformModel {
|
|
561
|
-
export { FailedResponse, CDN, Upload, StartResponse, StartRequest, CreatedBy, CompleteResponse,
|
|
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 };
|
|
562
561
|
}
|
|
563
562
|
/** @returns {FailedResponse} */
|
|
564
563
|
declare function FailedResponse(): FailedResponse;
|
|
@@ -592,6 +591,14 @@ type StartResponse = {
|
|
|
592
591
|
cdn: CDN;
|
|
593
592
|
tags?: string[];
|
|
594
593
|
};
|
|
594
|
+
/** @returns {Params} */
|
|
595
|
+
declare function Params(): Params;
|
|
596
|
+
type Params = {
|
|
597
|
+
/**
|
|
598
|
+
* - The subpath for the file.
|
|
599
|
+
*/
|
|
600
|
+
subpath?: string;
|
|
601
|
+
};
|
|
595
602
|
/** @returns {StartRequest} */
|
|
596
603
|
declare function StartRequest(): StartRequest;
|
|
597
604
|
type StartRequest = {
|
|
@@ -625,12 +632,6 @@ type CompleteResponse = {
|
|
|
625
632
|
modified_on: string;
|
|
626
633
|
created_by?: CreatedBy;
|
|
627
634
|
};
|
|
628
|
-
/** @returns {ProxyResponse} */
|
|
629
|
-
declare function ProxyResponse(): ProxyResponse;
|
|
630
|
-
type ProxyResponse = {
|
|
631
|
-
data?: any;
|
|
632
|
-
support?: any;
|
|
633
|
-
};
|
|
634
635
|
/** @returns {DestinationNamespace} */
|
|
635
636
|
declare function DestinationNamespace(): DestinationNamespace;
|
|
636
637
|
type DestinationNamespace = {
|
|
@@ -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
|
|
@@ -65,12 +70,6 @@ const Joi = require("joi");
|
|
|
65
70
|
* @property {CreatedBy} [created_by]
|
|
66
71
|
*/
|
|
67
72
|
|
|
68
|
-
/**
|
|
69
|
-
* @typedef ProxyResponse
|
|
70
|
-
* @property {Object} [data]
|
|
71
|
-
* @property {Object} [support]
|
|
72
|
-
*/
|
|
73
|
-
|
|
74
73
|
/**
|
|
75
74
|
* @typedef DestinationNamespace
|
|
76
75
|
* @property {string} [namespace]
|
|
@@ -663,6 +662,13 @@ class FileStoragePlatformModel {
|
|
|
663
662
|
});
|
|
664
663
|
}
|
|
665
664
|
|
|
665
|
+
/** @returns {Params} */
|
|
666
|
+
static Params() {
|
|
667
|
+
return Joi.object({
|
|
668
|
+
subpath: Joi.string().allow(""),
|
|
669
|
+
});
|
|
670
|
+
}
|
|
671
|
+
|
|
666
672
|
/** @returns {StartRequest} */
|
|
667
673
|
static StartRequest() {
|
|
668
674
|
return Joi.object({
|
|
@@ -702,14 +708,6 @@ class FileStoragePlatformModel {
|
|
|
702
708
|
});
|
|
703
709
|
}
|
|
704
710
|
|
|
705
|
-
/** @returns {ProxyResponse} */
|
|
706
|
-
static ProxyResponse() {
|
|
707
|
-
return Joi.object({
|
|
708
|
-
data: Joi.object().pattern(/\S/, Joi.any()),
|
|
709
|
-
support: Joi.object().pattern(/\S/, Joi.any()),
|
|
710
|
-
});
|
|
711
|
-
}
|
|
712
|
-
|
|
713
711
|
/** @returns {DestinationNamespace} */
|
|
714
712
|
static DestinationNamespace() {
|
|
715
713
|
return Joi.object({
|