@gofynd/fdk-client-javascript 3.3.5 → 3.3.6
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 +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +41 -3
- package/sdk/platform/Cart/CartPlatformModel.js +24 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +77 -77
- package/sdk/platform/Catalog/CatalogPlatformClient.js +77 -77
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +56 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +40 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -12,7 +12,7 @@ declare class FileStorage {
|
|
|
12
12
|
* @returns {Promise<FileStoragePlatformModel.FileUploadComplete>} - Success response
|
|
13
13
|
* @name appCompleteUpload
|
|
14
14
|
* @summary: Application complete upload.
|
|
15
|
-
* @description: Finish uploading a file from an application. - Check out [method documentation](https://
|
|
15
|
+
* @description: Finish uploading a file from an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/appCompleteUpload/).
|
|
16
16
|
*/
|
|
17
17
|
appCompleteUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUploadComplete>;
|
|
18
18
|
/**
|
|
@@ -24,7 +24,7 @@ declare class FileStorage {
|
|
|
24
24
|
* @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
|
|
25
25
|
* @name appStartUpload
|
|
26
26
|
* @summary: Application start upload.
|
|
27
|
-
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://
|
|
27
|
+
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/appStartUpload/).
|
|
28
28
|
*/
|
|
29
29
|
appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUpload>;
|
|
30
30
|
/**
|
|
@@ -34,7 +34,7 @@ declare class FileStorage {
|
|
|
34
34
|
* @returns {Promise<Object>} - Success response
|
|
35
35
|
* @name appbrowse
|
|
36
36
|
* @summary: Application browse files.
|
|
37
|
-
* @description: Browse files within an application. - Check out [method documentation](https://
|
|
37
|
+
* @description: Browse files within an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/appbrowse/).
|
|
38
38
|
*/
|
|
39
39
|
appbrowse({ namespace, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
40
40
|
/**
|
|
@@ -44,7 +44,7 @@ declare class FileStorage {
|
|
|
44
44
|
* @returns {Promise<Object>} - Success response
|
|
45
45
|
* @name browsefiles
|
|
46
46
|
* @summary: Browse Files
|
|
47
|
-
* @description: Browse Files - Check out [method documentation](https://
|
|
47
|
+
* @description: Browse Files - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/browsefiles/).
|
|
48
48
|
*/
|
|
49
49
|
browsefiles({ namespace, body, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.BrowsefilesParam, { responseHeaders }?: object): Promise<any>;
|
|
50
50
|
/**
|
|
@@ -26,7 +26,7 @@ class FileStorage {
|
|
|
26
26
|
* @returns {Promise<FileStoragePlatformModel.FileUploadComplete>} - Success response
|
|
27
27
|
* @name appCompleteUpload
|
|
28
28
|
* @summary: Application complete upload.
|
|
29
|
-
* @description: Finish uploading a file from an application. - Check out [method documentation](https://
|
|
29
|
+
* @description: Finish uploading a file from an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/appCompleteUpload/).
|
|
30
30
|
*/
|
|
31
31
|
async appCompleteUpload(
|
|
32
32
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -111,7 +111,7 @@ class FileStorage {
|
|
|
111
111
|
* @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
|
|
112
112
|
* @name appStartUpload
|
|
113
113
|
* @summary: Application start upload.
|
|
114
|
-
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://
|
|
114
|
+
* @description: Start uploading a file from an application and returns a storage link in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/appStartUpload/).
|
|
115
115
|
*/
|
|
116
116
|
async appStartUpload(
|
|
117
117
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -194,7 +194,7 @@ class FileStorage {
|
|
|
194
194
|
* @returns {Promise<Object>} - Success response
|
|
195
195
|
* @name appbrowse
|
|
196
196
|
* @summary: Application browse files.
|
|
197
|
-
* @description: Browse files within an application. - Check out [method documentation](https://
|
|
197
|
+
* @description: Browse files within an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/appbrowse/).
|
|
198
198
|
*/
|
|
199
199
|
async appbrowse(
|
|
200
200
|
{ namespace, page, limit, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -282,7 +282,7 @@ class FileStorage {
|
|
|
282
282
|
* @returns {Promise<Object>} - Success response
|
|
283
283
|
* @name browsefiles
|
|
284
284
|
* @summary: Browse Files
|
|
285
|
-
* @description: Browse Files - Check out [method documentation](https://
|
|
285
|
+
* @description: Browse Files - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/browsefiles/).
|
|
286
286
|
*/
|
|
287
287
|
async browsefiles(
|
|
288
288
|
{ namespace, body, page, limit, search, requestHeaders } = {
|
|
@@ -9,7 +9,7 @@ declare class FileStorage {
|
|
|
9
9
|
* @returns {Promise<Object>} - Success response
|
|
10
10
|
* @name browse
|
|
11
11
|
* @summary: Browse files.
|
|
12
|
-
* @description: View and navigate through available files. - Check out [method documentation](https://
|
|
12
|
+
* @description: View and navigate through available files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/browse/).
|
|
13
13
|
*/
|
|
14
14
|
browse({ namespace, page, limit, requestHeaders }?: FileStoragePlatformValidator.BrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
15
15
|
/**
|
|
@@ -19,7 +19,7 @@ declare class FileStorage {
|
|
|
19
19
|
* @returns {Promise<FileStoragePlatformModel.FileUploadComplete>} - Success response
|
|
20
20
|
* @name completeUpload
|
|
21
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://
|
|
22
|
+
* @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/completeUpload/).
|
|
23
23
|
*/
|
|
24
24
|
completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUploadComplete>;
|
|
25
25
|
/**
|
|
@@ -29,7 +29,7 @@ declare class FileStorage {
|
|
|
29
29
|
* @returns {Promise<Object>} - Success response
|
|
30
30
|
* @name copyFiles
|
|
31
31
|
* @summary: Copy files.
|
|
32
|
-
* @description: Duplicate files to another location. - Check out [method documentation](https://
|
|
32
|
+
* @description: Duplicate files to another location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/copyFiles/).
|
|
33
33
|
*/
|
|
34
34
|
copyFiles({ body, sync, requestHeaders }?: FileStoragePlatformValidator.CopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
35
35
|
/**
|
|
@@ -39,7 +39,7 @@ declare class FileStorage {
|
|
|
39
39
|
* @returns {Promise<FileStoragePlatformModel.SignUrlResult>} - Success response
|
|
40
40
|
* @name getSignUrls
|
|
41
41
|
* @summary: Get signed URLs.
|
|
42
|
-
* @description: Retrieve signed URLs for file access. - Check out [method documentation](https://
|
|
42
|
+
* @description: Retrieve signed URLs for file access. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/getSignUrls/).
|
|
43
43
|
*/
|
|
44
44
|
getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResult>;
|
|
45
45
|
/**
|
|
@@ -49,7 +49,7 @@ declare class FileStorage {
|
|
|
49
49
|
* @returns {Promise<FileStoragePlatformModel.ProxyFileAccess>} - Success response
|
|
50
50
|
* @name proxy
|
|
51
51
|
* @summary: Proxy file access.
|
|
52
|
-
* @description: Access files through a proxy. - Check out [method documentation](https://
|
|
52
|
+
* @description: Access files through a proxy. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/proxy/).
|
|
53
53
|
*/
|
|
54
54
|
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.ProxyFileAccess>;
|
|
55
55
|
/**
|
|
@@ -59,7 +59,7 @@ declare class FileStorage {
|
|
|
59
59
|
* @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
|
|
60
60
|
* @name startUpload
|
|
61
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://
|
|
62
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/startUpload/).
|
|
63
63
|
*/
|
|
64
64
|
startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.FileUpload>;
|
|
65
65
|
/**
|
|
@@ -23,7 +23,7 @@ class FileStorage {
|
|
|
23
23
|
* @returns {Promise<Object>} - Success response
|
|
24
24
|
* @name browse
|
|
25
25
|
* @summary: Browse files.
|
|
26
|
-
* @description: View and navigate through available files. - Check out [method documentation](https://
|
|
26
|
+
* @description: View and navigate through available files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/browse/).
|
|
27
27
|
*/
|
|
28
28
|
async browse(
|
|
29
29
|
{ namespace, page, limit, requestHeaders } = { requestHeaders: {} },
|
|
@@ -106,7 +106,7 @@ class FileStorage {
|
|
|
106
106
|
* @returns {Promise<FileStoragePlatformModel.FileUploadComplete>} - Success response
|
|
107
107
|
* @name completeUpload
|
|
108
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://
|
|
109
|
+
* @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/completeUpload/).
|
|
110
110
|
*/
|
|
111
111
|
async completeUpload(
|
|
112
112
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -189,7 +189,7 @@ class FileStorage {
|
|
|
189
189
|
* @returns {Promise<Object>} - Success response
|
|
190
190
|
* @name copyFiles
|
|
191
191
|
* @summary: Copy files.
|
|
192
|
-
* @description: Duplicate files to another location. - Check out [method documentation](https://
|
|
192
|
+
* @description: Duplicate files to another location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/copyFiles/).
|
|
193
193
|
*/
|
|
194
194
|
async copyFiles(
|
|
195
195
|
{ body, sync, requestHeaders } = { requestHeaders: {} },
|
|
@@ -269,7 +269,7 @@ class FileStorage {
|
|
|
269
269
|
* @returns {Promise<FileStoragePlatformModel.SignUrlResult>} - Success response
|
|
270
270
|
* @name getSignUrls
|
|
271
271
|
* @summary: Get signed URLs.
|
|
272
|
-
* @description: Retrieve signed URLs for file access. - Check out [method documentation](https://
|
|
272
|
+
* @description: Retrieve signed URLs for file access. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/getSignUrls/).
|
|
273
273
|
*/
|
|
274
274
|
async getSignUrls(
|
|
275
275
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -348,7 +348,7 @@ class FileStorage {
|
|
|
348
348
|
* @returns {Promise<FileStoragePlatformModel.ProxyFileAccess>} - Success response
|
|
349
349
|
* @name proxy
|
|
350
350
|
* @summary: Proxy file access.
|
|
351
|
-
* @description: Access files through a proxy. - Check out [method documentation](https://
|
|
351
|
+
* @description: Access files through a proxy. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/proxy/).
|
|
352
352
|
*/
|
|
353
353
|
async proxy(
|
|
354
354
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -426,7 +426,7 @@ class FileStorage {
|
|
|
426
426
|
* @returns {Promise<FileStoragePlatformModel.FileUpload>} - Success response
|
|
427
427
|
* @name startUpload
|
|
428
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://
|
|
429
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/filestorage/startUpload/).
|
|
430
430
|
*/
|
|
431
431
|
async startUpload(
|
|
432
432
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -10,7 +10,7 @@ declare class Lead {
|
|
|
10
10
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
11
11
|
* @name createCustomForm
|
|
12
12
|
* @summary: Create custom form
|
|
13
|
-
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://
|
|
13
|
+
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createCustomForm/).
|
|
14
14
|
*/
|
|
15
15
|
createCustomForm({ body, requestHeaders }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
16
16
|
/**
|
|
@@ -20,7 +20,7 @@ declare class Lead {
|
|
|
20
20
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
21
21
|
* @name createNewHistory
|
|
22
22
|
* @summary: Create ticket history interaction
|
|
23
|
-
* @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://
|
|
23
|
+
* @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createNewHistory/).
|
|
24
24
|
*/
|
|
25
25
|
createNewHistory({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.CreateNewHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
26
26
|
/**
|
|
@@ -30,7 +30,7 @@ declare class Lead {
|
|
|
30
30
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
31
31
|
* @name deleteCustomForm
|
|
32
32
|
* @summary: Delete a custom form
|
|
33
|
-
* @description: Delete a custom form using it's slug - Check out [method documentation](https://
|
|
33
|
+
* @description: Delete a custom form using it's slug - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/deleteCustomForm/).
|
|
34
34
|
*/
|
|
35
35
|
deleteCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.DeleteCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
36
36
|
/**
|
|
@@ -40,7 +40,7 @@ declare class Lead {
|
|
|
40
40
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
41
41
|
* @name editCustomForm
|
|
42
42
|
* @summary: Update custom form
|
|
43
|
-
* @description: Modify the content and associated settings of a custom form. - Check out [method documentation](https://
|
|
43
|
+
* @description: Modify the content and associated settings of a custom form. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/editCustomForm/).
|
|
44
44
|
*/
|
|
45
45
|
editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
46
46
|
/**
|
|
@@ -50,7 +50,7 @@ declare class Lead {
|
|
|
50
50
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
51
51
|
* @name editNewTicket
|
|
52
52
|
* @summary: Update Ticket Details
|
|
53
|
-
* @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://
|
|
53
|
+
* @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/editNewTicket/).
|
|
54
54
|
*/
|
|
55
55
|
editNewTicket({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.EditNewTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
56
56
|
/**
|
|
@@ -60,7 +60,7 @@ declare class Lead {
|
|
|
60
60
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
61
61
|
* @name getCustomForm
|
|
62
62
|
* @summary: Get custom form
|
|
63
|
-
* @description: Get information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://
|
|
63
|
+
* @description: Get information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getCustomForm/).
|
|
64
64
|
*/
|
|
65
65
|
getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
66
66
|
/**
|
|
@@ -70,7 +70,7 @@ declare class Lead {
|
|
|
70
70
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
71
71
|
* @name getCustomForms
|
|
72
72
|
* @summary: Get custom forms
|
|
73
|
-
* @description: List all available custom forms - Check out [method documentation](https://
|
|
73
|
+
* @description: List all available custom forms - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getCustomForms/).
|
|
74
74
|
*/
|
|
75
75
|
getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
|
|
76
76
|
/**
|
|
@@ -80,7 +80,7 @@ declare class Lead {
|
|
|
80
80
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
81
81
|
* @name getNewTicket
|
|
82
82
|
* @summary: Get Ticket Details
|
|
83
|
-
* @description: Get ticket details of a application level ticket with ticket ID - Check out [method documentation](https://
|
|
83
|
+
* @description: Get ticket details of a application level ticket with ticket ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getNewTicket/).
|
|
84
84
|
*/
|
|
85
85
|
getNewTicket({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
86
86
|
/**
|
|
@@ -90,7 +90,7 @@ declare class Lead {
|
|
|
90
90
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
91
91
|
* @name getNewTicketHistory
|
|
92
92
|
* @summary: Get ticket history interaction
|
|
93
|
-
* @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://
|
|
93
|
+
* @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getNewTicketHistory/).
|
|
94
94
|
*/
|
|
95
95
|
getNewTicketHistory({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
96
96
|
/**
|
|
@@ -100,7 +100,7 @@ declare class Lead {
|
|
|
100
100
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
101
101
|
* @name getNewTickets
|
|
102
102
|
* @summary: List sales channel tickets
|
|
103
|
-
* @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://
|
|
103
|
+
* @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getNewTickets/).
|
|
104
104
|
*/
|
|
105
105
|
getNewTickets({ items, filters, q, status, priority, category, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
|
|
106
106
|
}
|
|
@@ -22,7 +22,7 @@ class Lead {
|
|
|
22
22
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
23
23
|
* @name createCustomForm
|
|
24
24
|
* @summary: Create custom form
|
|
25
|
-
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://
|
|
25
|
+
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createCustomForm/).
|
|
26
26
|
*/
|
|
27
27
|
async createCustomForm(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -101,7 +101,7 @@ class Lead {
|
|
|
101
101
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
102
102
|
* @name createNewHistory
|
|
103
103
|
* @summary: Create ticket history interaction
|
|
104
|
-
* @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://
|
|
104
|
+
* @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createNewHistory/).
|
|
105
105
|
*/
|
|
106
106
|
async createNewHistory(
|
|
107
107
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -182,7 +182,7 @@ class Lead {
|
|
|
182
182
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
183
183
|
* @name deleteCustomForm
|
|
184
184
|
* @summary: Delete a custom form
|
|
185
|
-
* @description: Delete a custom form using it's slug - Check out [method documentation](https://
|
|
185
|
+
* @description: Delete a custom form using it's slug - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/deleteCustomForm/).
|
|
186
186
|
*/
|
|
187
187
|
async deleteCustomForm(
|
|
188
188
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -261,7 +261,7 @@ class Lead {
|
|
|
261
261
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
262
262
|
* @name editCustomForm
|
|
263
263
|
* @summary: Update custom form
|
|
264
|
-
* @description: Modify the content and associated settings of a custom form. - Check out [method documentation](https://
|
|
264
|
+
* @description: Modify the content and associated settings of a custom form. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/editCustomForm/).
|
|
265
265
|
*/
|
|
266
266
|
async editCustomForm(
|
|
267
267
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -342,7 +342,7 @@ class Lead {
|
|
|
342
342
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
343
343
|
* @name editNewTicket
|
|
344
344
|
* @summary: Update Ticket Details
|
|
345
|
-
* @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://
|
|
345
|
+
* @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/editNewTicket/).
|
|
346
346
|
*/
|
|
347
347
|
async editNewTicket(
|
|
348
348
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -421,7 +421,7 @@ class Lead {
|
|
|
421
421
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
422
422
|
* @name getCustomForm
|
|
423
423
|
* @summary: Get custom form
|
|
424
|
-
* @description: Get information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://
|
|
424
|
+
* @description: Get information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getCustomForm/).
|
|
425
425
|
*/
|
|
426
426
|
async getCustomForm(
|
|
427
427
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -498,7 +498,7 @@ class Lead {
|
|
|
498
498
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
499
499
|
* @name getCustomForms
|
|
500
500
|
* @summary: Get custom forms
|
|
501
|
-
* @description: List all available custom forms - Check out [method documentation](https://
|
|
501
|
+
* @description: List all available custom forms - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getCustomForms/).
|
|
502
502
|
*/
|
|
503
503
|
async getCustomForms(
|
|
504
504
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -573,7 +573,7 @@ class Lead {
|
|
|
573
573
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
574
574
|
* @name getNewTicket
|
|
575
575
|
* @summary: Get Ticket Details
|
|
576
|
-
* @description: Get ticket details of a application level ticket with ticket ID - Check out [method documentation](https://
|
|
576
|
+
* @description: Get ticket details of a application level ticket with ticket ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getNewTicket/).
|
|
577
577
|
*/
|
|
578
578
|
async getNewTicket(
|
|
579
579
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -650,7 +650,7 @@ class Lead {
|
|
|
650
650
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
651
651
|
* @name getNewTicketHistory
|
|
652
652
|
* @summary: Get ticket history interaction
|
|
653
|
-
* @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://
|
|
653
|
+
* @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getNewTicketHistory/).
|
|
654
654
|
*/
|
|
655
655
|
async getNewTicketHistory(
|
|
656
656
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -729,7 +729,7 @@ class Lead {
|
|
|
729
729
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
730
730
|
* @name getNewTickets
|
|
731
731
|
* @summary: List sales channel tickets
|
|
732
|
-
* @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://
|
|
732
|
+
* @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getNewTickets/).
|
|
733
733
|
*/
|
|
734
734
|
async getNewTickets(
|
|
735
735
|
{ items, filters, q, status, priority, category, requestHeaders } = {
|
|
@@ -9,7 +9,7 @@ declare class Lead {
|
|
|
9
9
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
10
10
|
* @name createPlatformTicketHistory
|
|
11
11
|
* @summary: Create ticket history
|
|
12
|
-
* @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://
|
|
12
|
+
* @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createPlatformTicketHistory/).
|
|
13
13
|
*/
|
|
14
14
|
createPlatformTicketHistory({ id, body, requestHeaders }?: LeadPlatformValidator.CreatePlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
15
15
|
/**
|
|
@@ -19,7 +19,7 @@ declare class Lead {
|
|
|
19
19
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
20
20
|
* @name createTicket
|
|
21
21
|
* @summary: Create ticket
|
|
22
|
-
* @description: Create a new ticket at application level - Check out [method documentation](https://
|
|
22
|
+
* @description: Create a new ticket at application level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createTicket/).
|
|
23
23
|
*/
|
|
24
24
|
createTicket({ body, requestHeaders }?: LeadPlatformValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
25
25
|
/**
|
|
@@ -29,7 +29,7 @@ declare class Lead {
|
|
|
29
29
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
30
30
|
* @name editPlatformTicket
|
|
31
31
|
* @summary: Update a ticket
|
|
32
|
-
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://
|
|
32
|
+
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/editPlatformTicket/).
|
|
33
33
|
*/
|
|
34
34
|
editPlatformTicket({ id, body, requestHeaders }?: LeadPlatformValidator.EditPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
35
35
|
/**
|
|
@@ -39,7 +39,7 @@ declare class Lead {
|
|
|
39
39
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
40
40
|
* @name getFeedbacks
|
|
41
41
|
* @summary: List feedbacks
|
|
42
|
-
* @description: Get feedback information related to a ticket. - Check out [method documentation](https://
|
|
42
|
+
* @description: Get feedback information related to a ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getFeedbacks/).
|
|
43
43
|
*/
|
|
44
44
|
getFeedbacks({ id, requestHeaders }?: LeadPlatformValidator.GetFeedbacksParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedbackList>;
|
|
45
45
|
/**
|
|
@@ -49,7 +49,7 @@ declare class Lead {
|
|
|
49
49
|
* @returns {Promise<LeadPlatformModel.GeneralConfigDetails>} - Success response
|
|
50
50
|
* @name getGeneralConfig
|
|
51
51
|
* @summary: Get general configuration
|
|
52
|
-
* @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://
|
|
52
|
+
* @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getGeneralConfig/).
|
|
53
53
|
*/
|
|
54
54
|
getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.GeneralConfigDetails>;
|
|
55
55
|
/**
|
|
@@ -59,7 +59,7 @@ declare class Lead {
|
|
|
59
59
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
60
60
|
* @name getPlatformTicket
|
|
61
61
|
* @summary: Get a ticket
|
|
62
|
-
* @description: Get detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://
|
|
62
|
+
* @description: Get detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getPlatformTicket/).
|
|
63
63
|
*/
|
|
64
64
|
getPlatformTicket({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
65
65
|
/**
|
|
@@ -69,7 +69,7 @@ declare class Lead {
|
|
|
69
69
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
70
70
|
* @name getPlatformTicketHistory
|
|
71
71
|
* @summary: Get ticket history
|
|
72
|
-
* @description: List history records for a company level ticket. - Check out [method documentation](https://
|
|
72
|
+
* @description: List history records for a company level ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getPlatformTicketHistory/).
|
|
73
73
|
*/
|
|
74
74
|
getPlatformTicketHistory({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
75
75
|
/**
|
|
@@ -79,7 +79,7 @@ declare class Lead {
|
|
|
79
79
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
80
80
|
* @name getPlatformTickets
|
|
81
81
|
* @summary: List tickets
|
|
82
|
-
* @description: List all tickets created within the platform at company level - Check out [method documentation](https://
|
|
82
|
+
* @description: List all tickets created within the platform at company level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getPlatformTickets/).
|
|
83
83
|
*/
|
|
84
84
|
getPlatformTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPlatformValidator.GetPlatformTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
|
|
85
85
|
/**
|
|
@@ -89,7 +89,7 @@ declare class Lead {
|
|
|
89
89
|
* @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
|
|
90
90
|
* @name submitFeedback
|
|
91
91
|
* @summary: Submit feedback
|
|
92
|
-
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://
|
|
92
|
+
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/submitFeedback/).
|
|
93
93
|
*/
|
|
94
94
|
submitFeedback({ id, body, requestHeaders }?: LeadPlatformValidator.SubmitFeedbackParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedback>;
|
|
95
95
|
}
|
|
@@ -21,7 +21,7 @@ class Lead {
|
|
|
21
21
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
22
22
|
* @name createPlatformTicketHistory
|
|
23
23
|
* @summary: Create ticket history
|
|
24
|
-
* @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://
|
|
24
|
+
* @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createPlatformTicketHistory/).
|
|
25
25
|
*/
|
|
26
26
|
async createPlatformTicketHistory(
|
|
27
27
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -104,7 +104,7 @@ class Lead {
|
|
|
104
104
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
105
105
|
* @name createTicket
|
|
106
106
|
* @summary: Create ticket
|
|
107
|
-
* @description: Create a new ticket at application level - Check out [method documentation](https://
|
|
107
|
+
* @description: Create a new ticket at application level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/createTicket/).
|
|
108
108
|
*/
|
|
109
109
|
async createTicket(
|
|
110
110
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,7 +181,7 @@ class Lead {
|
|
|
181
181
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
182
182
|
* @name editPlatformTicket
|
|
183
183
|
* @summary: Update a ticket
|
|
184
|
-
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://
|
|
184
|
+
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/editPlatformTicket/).
|
|
185
185
|
*/
|
|
186
186
|
async editPlatformTicket(
|
|
187
187
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -262,7 +262,7 @@ class Lead {
|
|
|
262
262
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
263
263
|
* @name getFeedbacks
|
|
264
264
|
* @summary: List feedbacks
|
|
265
|
-
* @description: Get feedback information related to a ticket. - Check out [method documentation](https://
|
|
265
|
+
* @description: Get feedback information related to a ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getFeedbacks/).
|
|
266
266
|
*/
|
|
267
267
|
async getFeedbacks(
|
|
268
268
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -339,7 +339,7 @@ class Lead {
|
|
|
339
339
|
* @returns {Promise<LeadPlatformModel.GeneralConfigDetails>} - Success response
|
|
340
340
|
* @name getGeneralConfig
|
|
341
341
|
* @summary: Get general configuration
|
|
342
|
-
* @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://
|
|
342
|
+
* @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getGeneralConfig/).
|
|
343
343
|
*/
|
|
344
344
|
async getGeneralConfig(
|
|
345
345
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -414,7 +414,7 @@ class Lead {
|
|
|
414
414
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
415
415
|
* @name getPlatformTicket
|
|
416
416
|
* @summary: Get a ticket
|
|
417
|
-
* @description: Get detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://
|
|
417
|
+
* @description: Get detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getPlatformTicket/).
|
|
418
418
|
*/
|
|
419
419
|
async getPlatformTicket(
|
|
420
420
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -493,7 +493,7 @@ class Lead {
|
|
|
493
493
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
494
494
|
* @name getPlatformTicketHistory
|
|
495
495
|
* @summary: Get ticket history
|
|
496
|
-
* @description: List history records for a company level ticket. - Check out [method documentation](https://
|
|
496
|
+
* @description: List history records for a company level ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getPlatformTicketHistory/).
|
|
497
497
|
*/
|
|
498
498
|
async getPlatformTicketHistory(
|
|
499
499
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -572,7 +572,7 @@ class Lead {
|
|
|
572
572
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
573
573
|
* @name getPlatformTickets
|
|
574
574
|
* @summary: List tickets
|
|
575
|
-
* @description: List all tickets created within the platform at company level - Check out [method documentation](https://
|
|
575
|
+
* @description: List all tickets created within the platform at company level - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/getPlatformTickets/).
|
|
576
576
|
*/
|
|
577
577
|
async getPlatformTickets(
|
|
578
578
|
{
|
|
@@ -683,7 +683,7 @@ class Lead {
|
|
|
683
683
|
* @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
|
|
684
684
|
* @name submitFeedback
|
|
685
685
|
* @summary: Submit feedback
|
|
686
|
-
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://
|
|
686
|
+
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/lead/submitFeedback/).
|
|
687
687
|
*/
|
|
688
688
|
async submitFeedback(
|
|
689
689
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -40,7 +40,7 @@ export = LeadPlatformModel;
|
|
|
40
40
|
*/
|
|
41
41
|
/**
|
|
42
42
|
* @typedef Page
|
|
43
|
-
* @property {number} [item_total] - The total number of items
|
|
43
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
44
44
|
* @property {string} [next_id] - The identifier for the next page.
|
|
45
45
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
46
46
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -342,7 +342,7 @@ type TicketList = {
|
|
|
342
342
|
declare function Page(): Page;
|
|
343
343
|
type Page = {
|
|
344
344
|
/**
|
|
345
|
-
* - The total number of items
|
|
345
|
+
* - The total number of all items across all pages.
|
|
346
346
|
*/
|
|
347
347
|
item_total?: number;
|
|
348
348
|
/**
|
|
@@ -46,7 +46,7 @@ const Joi = require("joi");
|
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
48
|
* @typedef Page
|
|
49
|
-
* @property {number} [item_total] - The total number of items
|
|
49
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
50
50
|
* @property {string} [next_id] - The identifier for the next page.
|
|
51
51
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
52
52
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -14,7 +14,7 @@ declare class Order {
|
|
|
14
14
|
*
|
|
15
15
|
* @name getApplicationShipments
|
|
16
16
|
* @summary: List sales channel shipments
|
|
17
|
-
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://
|
|
17
|
+
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getApplicationShipments/).
|
|
18
18
|
*/
|
|
19
19
|
getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
20
20
|
/**
|
|
@@ -27,7 +27,7 @@ declare class Order {
|
|
|
27
27
|
* Success response
|
|
28
28
|
* @name getPlatformShipmentReasons
|
|
29
29
|
* @summary: List shipment cancellation reasons
|
|
30
|
-
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://
|
|
30
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getPlatformShipmentReasons/).
|
|
31
31
|
*/
|
|
32
32
|
getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>;
|
|
33
33
|
/**
|
|
@@ -37,7 +37,7 @@ declare class Order {
|
|
|
37
37
|
* @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
|
|
38
38
|
* @name getRules
|
|
39
39
|
* @summary: List of RMA rules based on the given input conditions.
|
|
40
|
-
* @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://
|
|
40
|
+
* @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRules/).
|
|
41
41
|
*/
|
|
42
42
|
getRules({ body, requestHeaders }?: OrderPlatformApplicationValidator.GetRulesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponseSchema>;
|
|
43
43
|
/**
|
|
@@ -49,7 +49,7 @@ declare class Order {
|
|
|
49
49
|
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
50
50
|
* @name getShipmentBagReasons
|
|
51
51
|
* @summary: Retrieve Reasons for Cancellation and Return journey
|
|
52
|
-
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://
|
|
52
|
+
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentBagReasons/).
|
|
53
53
|
*/
|
|
54
54
|
getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
|
|
55
55
|
/**
|
|
@@ -61,7 +61,7 @@ declare class Order {
|
|
|
61
61
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
62
62
|
* @name trackShipmentPlatform
|
|
63
63
|
* @summary: Track shipment
|
|
64
|
-
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://
|
|
64
|
+
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipmentPlatform/).
|
|
65
65
|
*/
|
|
66
66
|
trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
|
|
67
67
|
}
|