@gofynd/fdk-client-javascript 1.4.3 → 1.4.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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- 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 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -20,8 +20,8 @@ class Discount {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
|
|
22
22
|
* @name cancelDownloadJob
|
|
23
|
-
* @summary:
|
|
24
|
-
* @description: Cancel download
|
|
23
|
+
* @summary: delete discount download job
|
|
24
|
+
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
|
|
25
25
|
*/
|
|
26
26
|
async cancelDownloadJob(
|
|
27
27
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -99,8 +99,8 @@ class Discount {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
|
|
101
101
|
* @name cancelValidationJob
|
|
102
|
-
* @summary:
|
|
103
|
-
* @description:
|
|
102
|
+
* @summary: deletel validation job discount
|
|
103
|
+
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
|
|
104
104
|
*/
|
|
105
105
|
async cancelValidationJob(
|
|
106
106
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -179,7 +179,7 @@ class Discount {
|
|
|
179
179
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
180
180
|
* @name createDiscount
|
|
181
181
|
* @summary: Create discount
|
|
182
|
-
* @description:
|
|
182
|
+
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
|
|
183
183
|
*/
|
|
184
184
|
async createDiscount(
|
|
185
185
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -257,8 +257,8 @@ class Discount {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
259
259
|
* @name downloadDiscountFile
|
|
260
|
-
* @summary:
|
|
261
|
-
* @description:
|
|
260
|
+
* @summary: Get discount file
|
|
261
|
+
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
|
|
262
262
|
*/
|
|
263
263
|
async downloadDiscountFile(
|
|
264
264
|
{ type, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -338,8 +338,8 @@ class Discount {
|
|
|
338
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
339
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
340
340
|
* @name getDiscount
|
|
341
|
-
* @summary: Get discount
|
|
342
|
-
* @description: Retrieve
|
|
341
|
+
* @summary: Get discount
|
|
342
|
+
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
|
|
343
343
|
*/
|
|
344
344
|
async getDiscount(
|
|
345
345
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -417,8 +417,8 @@ class Discount {
|
|
|
417
417
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
418
418
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
419
419
|
* @name getDiscounts
|
|
420
|
-
* @summary:
|
|
421
|
-
* @description: Retrieve a list of
|
|
420
|
+
* @summary: List discounts
|
|
421
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
|
|
422
422
|
*/
|
|
423
423
|
async getDiscounts(
|
|
424
424
|
{
|
|
@@ -532,8 +532,8 @@ class Discount {
|
|
|
532
532
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
533
533
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
534
534
|
* @name getDownloadJob
|
|
535
|
-
* @summary:
|
|
536
|
-
* @description:
|
|
535
|
+
* @summary: List discount download job
|
|
536
|
+
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
|
|
537
537
|
*/
|
|
538
538
|
async getDownloadJob(
|
|
539
539
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -611,8 +611,8 @@ class Discount {
|
|
|
611
611
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
612
612
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
613
613
|
* @name getValidationJob
|
|
614
|
-
* @summary:
|
|
615
|
-
* @description:
|
|
614
|
+
* @summary: List validation job discount
|
|
615
|
+
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
|
|
616
616
|
*/
|
|
617
617
|
async getValidationJob(
|
|
618
618
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -691,7 +691,7 @@ class Discount {
|
|
|
691
691
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
692
692
|
* @name updateDiscount
|
|
693
693
|
* @summary: Update discount
|
|
694
|
-
* @description:
|
|
694
|
+
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
|
|
695
695
|
*/
|
|
696
696
|
async updateDiscount(
|
|
697
697
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -772,7 +772,7 @@ class Discount {
|
|
|
772
772
|
* @returns {Promise<Object>} - Success response
|
|
773
773
|
* @name upsertDiscountItems
|
|
774
774
|
* @summary: Upsert discount items
|
|
775
|
-
* @description:
|
|
775
|
+
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
|
|
776
776
|
*/
|
|
777
777
|
async upsertDiscountItems(
|
|
778
778
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -851,7 +851,7 @@ class Discount {
|
|
|
851
851
|
* @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
|
|
852
852
|
* @name validateDiscountFile
|
|
853
853
|
* @summary: Validate discount file
|
|
854
|
-
* @description:
|
|
854
|
+
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
|
|
855
855
|
*/
|
|
856
856
|
async validateDiscountFile(
|
|
857
857
|
{ body, discount, requestHeaders } = { requestHeaders: {} },
|
|
@@ -11,8 +11,8 @@ declare class FileStorage {
|
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
12
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
13
13
|
* @name appCompleteUpload
|
|
14
|
-
* @summary:
|
|
15
|
-
* @description:
|
|
14
|
+
* @summary: Complete file upload for Application
|
|
15
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database on platform at application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
16
16
|
*/
|
|
17
17
|
appCompleteUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
|
|
18
18
|
/**
|
|
@@ -21,8 +21,8 @@ declare class FileStorage {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<Object>} - Success response
|
|
23
23
|
* @name appCopyFiles
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Copy files for Application
|
|
25
|
+
* @description: Handle multiple file uploads, updating progress and providing detailed status reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
|
|
26
26
|
*/
|
|
27
27
|
appCopyFiles({ body, sync, requestHeaders }?: FileStoragePlatformApplicationValidator.AppCopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
28
28
|
/**
|
|
@@ -33,8 +33,8 @@ declare class FileStorage {
|
|
|
33
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
34
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
35
35
|
* @name appStartUpload
|
|
36
|
-
* @summary:
|
|
37
|
-
* @description:
|
|
36
|
+
* @summary: Initiates file upload for Application
|
|
37
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response on platofrm at application level. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
38
38
|
*/
|
|
39
39
|
appStartUpload({ namespace, body, requestHeaders }?: FileStoragePlatformApplicationValidator.AppStartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
|
|
40
40
|
/**
|
|
@@ -43,8 +43,8 @@ declare class FileStorage {
|
|
|
43
43
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
44
|
* @returns {Promise<Object>} - Success response
|
|
45
45
|
* @name appbrowse
|
|
46
|
-
* @summary:
|
|
47
|
-
* @description:
|
|
46
|
+
* @summary: Browse files for Application
|
|
47
|
+
* @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
|
|
48
48
|
*/
|
|
49
49
|
appbrowse({ namespace, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.AppbrowseParam, { responseHeaders }?: object): Promise<any>;
|
|
50
50
|
/**
|
|
@@ -53,8 +53,8 @@ declare class FileStorage {
|
|
|
53
53
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<Object>} - Success response
|
|
55
55
|
* @name browsefiles
|
|
56
|
-
* @summary: Browse
|
|
57
|
-
* @description:
|
|
56
|
+
* @summary: Browse files for Application
|
|
57
|
+
* @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browsefiles/).
|
|
58
58
|
*/
|
|
59
59
|
browsefiles({ namespace, body, page, limit, search, requestHeaders }?: FileStoragePlatformApplicationValidator.BrowsefilesParam, { responseHeaders }?: object): Promise<any>;
|
|
60
60
|
/**
|
|
@@ -77,8 +77,9 @@ declare class FileStorage {
|
|
|
77
77
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
78
78
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSuccess>} - Success response
|
|
79
79
|
* @name getDefaultHtmlTemplate
|
|
80
|
-
* @summary: Get html template for
|
|
81
|
-
* @description: Get
|
|
80
|
+
* @summary: Get html template for Application
|
|
81
|
+
* @description: Get the saved html template for provided sales channel
|
|
82
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultHtmlTemplate/).
|
|
82
83
|
*/
|
|
83
84
|
getDefaultHtmlTemplate({ pdfTypeId, format, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSuccess>;
|
|
84
85
|
/**
|
|
@@ -91,7 +92,7 @@ declare class FileStorage {
|
|
|
91
92
|
* Success response
|
|
92
93
|
* @name getDefaultPdfData
|
|
93
94
|
* @summary: Get default PDF data
|
|
94
|
-
* @description: Retrieve default data for
|
|
95
|
+
* @description: Retrieve default pdf payload data for invoice generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
|
|
95
96
|
*/
|
|
96
97
|
getDefaultPdfData({ pdfTypeId, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfDataParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.DummyTemplateDataItems>;
|
|
97
98
|
/**
|
|
@@ -104,7 +105,7 @@ declare class FileStorage {
|
|
|
104
105
|
* Success response
|
|
105
106
|
* @name getDefaultPdfTemplate
|
|
106
107
|
* @summary: Get default PDF template
|
|
107
|
-
* @description: Retrieve the default
|
|
108
|
+
* @description: Retrieve to get the default Invoice template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
|
|
108
109
|
*/
|
|
109
110
|
getDefaultPdfTemplate({ pdfTypeId, format, countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetDefaultPdfTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfDefaultTemplateSuccess>;
|
|
110
111
|
/**
|
|
@@ -115,7 +116,7 @@ declare class FileStorage {
|
|
|
115
116
|
* Success response
|
|
116
117
|
* @name getPdfTypes
|
|
117
118
|
* @summary: Get PDF types
|
|
118
|
-
* @description: Retrieve a list of available
|
|
119
|
+
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
119
120
|
*/
|
|
120
121
|
getPdfTypes({ countryCode, requestHeaders }?: FileStoragePlatformApplicationValidator.GetPdfTypesParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.InvoiceTypesResponse>;
|
|
121
122
|
/**
|
|
@@ -127,8 +128,8 @@ declare class FileStorage {
|
|
|
127
128
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
128
129
|
* Success response
|
|
129
130
|
* @name saveHtmlTemplate
|
|
130
|
-
* @summary: Save
|
|
131
|
-
* @description:
|
|
131
|
+
* @summary: Save PDF template
|
|
132
|
+
* @description: Save html template for provided sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
|
|
132
133
|
*/
|
|
133
134
|
saveHtmlTemplate({ body, requestHeaders }?: FileStoragePlatformApplicationValidator.SaveHtmlTemplateParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>;
|
|
134
135
|
/**
|
|
@@ -25,8 +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:
|
|
28
|
+
* @summary: Complete file upload for Application
|
|
29
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database on platform at application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCompleteUpload/).
|
|
30
30
|
*/
|
|
31
31
|
async appCompleteUpload(
|
|
32
32
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -108,8 +108,8 @@ class FileStorage {
|
|
|
108
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<Object>} - Success response
|
|
110
110
|
* @name appCopyFiles
|
|
111
|
-
* @summary:
|
|
112
|
-
* @description:
|
|
111
|
+
* @summary: Copy files for Application
|
|
112
|
+
* @description: Handle multiple file uploads, updating progress and providing detailed status reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appCopyFiles/).
|
|
113
113
|
*/
|
|
114
114
|
async appCopyFiles(
|
|
115
115
|
{ body, sync, requestHeaders } = { requestHeaders: {} },
|
|
@@ -190,8 +190,8 @@ class FileStorage {
|
|
|
190
190
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
191
191
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - Success response
|
|
192
192
|
* @name appStartUpload
|
|
193
|
-
* @summary:
|
|
194
|
-
* @description:
|
|
193
|
+
* @summary: Initiates file upload for Application
|
|
194
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response on platofrm at application level. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appStartUpload/).
|
|
195
195
|
*/
|
|
196
196
|
async appStartUpload(
|
|
197
197
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -273,8 +273,8 @@ class FileStorage {
|
|
|
273
273
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
274
274
|
* @returns {Promise<Object>} - Success response
|
|
275
275
|
* @name appbrowse
|
|
276
|
-
* @summary:
|
|
277
|
-
* @description:
|
|
276
|
+
* @summary: Browse files for Application
|
|
277
|
+
* @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/appbrowse/).
|
|
278
278
|
*/
|
|
279
279
|
async appbrowse(
|
|
280
280
|
{ namespace, page, limit, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -361,8 +361,8 @@ class FileStorage {
|
|
|
361
361
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
362
362
|
* @returns {Promise<Object>} - Success response
|
|
363
363
|
* @name browsefiles
|
|
364
|
-
* @summary: Browse
|
|
365
|
-
* @description:
|
|
364
|
+
* @summary: Browse files for Application
|
|
365
|
+
* @description: View and navigate through available files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/browsefiles/).
|
|
366
366
|
*/
|
|
367
367
|
async browsefiles(
|
|
368
368
|
{ namespace, body, page, limit, search, requestHeaders } = {
|
|
@@ -534,8 +534,9 @@ class FileStorage {
|
|
|
534
534
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
535
535
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSuccess>} - Success response
|
|
536
536
|
* @name getDefaultHtmlTemplate
|
|
537
|
-
* @summary: Get html template for
|
|
538
|
-
* @description: Get
|
|
537
|
+
* @summary: Get html template for Application
|
|
538
|
+
* @description: Get the saved html template for provided sales channel
|
|
539
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultHtmlTemplate/).
|
|
539
540
|
*/
|
|
540
541
|
async getDefaultHtmlTemplate(
|
|
541
542
|
{ pdfTypeId, format, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -624,7 +625,7 @@ class FileStorage {
|
|
|
624
625
|
* Success response
|
|
625
626
|
* @name getDefaultPdfData
|
|
626
627
|
* @summary: Get default PDF data
|
|
627
|
-
* @description: Retrieve default data for
|
|
628
|
+
* @description: Retrieve default pdf payload data for invoice generation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfData/).
|
|
628
629
|
*/
|
|
629
630
|
async getDefaultPdfData(
|
|
630
631
|
{ pdfTypeId, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -710,7 +711,7 @@ class FileStorage {
|
|
|
710
711
|
* Success response
|
|
711
712
|
* @name getDefaultPdfTemplate
|
|
712
713
|
* @summary: Get default PDF template
|
|
713
|
-
* @description: Retrieve the default
|
|
714
|
+
* @description: Retrieve to get the default Invoice template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getDefaultPdfTemplate/).
|
|
714
715
|
*/
|
|
715
716
|
async getDefaultPdfTemplate(
|
|
716
717
|
{ pdfTypeId, format, countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -797,7 +798,7 @@ class FileStorage {
|
|
|
797
798
|
* Success response
|
|
798
799
|
* @name getPdfTypes
|
|
799
800
|
* @summary: Get PDF types
|
|
800
|
-
* @description: Retrieve a list of available
|
|
801
|
+
* @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getPdfTypes/).
|
|
801
802
|
*/
|
|
802
803
|
async getPdfTypes(
|
|
803
804
|
{ countryCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -879,8 +880,8 @@ class FileStorage {
|
|
|
879
880
|
* @returns {Promise<FileStoragePlatformModel.PdfConfigSaveSuccess>} -
|
|
880
881
|
* Success response
|
|
881
882
|
* @name saveHtmlTemplate
|
|
882
|
-
* @summary: Save
|
|
883
|
-
* @description:
|
|
883
|
+
* @summary: Save PDF template
|
|
884
|
+
* @description: Save html template for provided sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/saveHtmlTemplate/).
|
|
884
885
|
*/
|
|
885
886
|
async saveHtmlTemplate(
|
|
886
887
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -19,7 +19,7 @@ declare class FileStorage {
|
|
|
19
19
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
20
20
|
* @name completeUpload
|
|
21
21
|
* @summary: Complete file upload
|
|
22
|
-
* @description:
|
|
22
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database at platform level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
|
|
23
23
|
*/
|
|
24
24
|
completeUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.CompleteResponse>;
|
|
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:
|
|
32
|
+
* @description: Handle multiple file uploads, updating progress and providing detailed status reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
|
|
33
33
|
*/
|
|
34
34
|
copyFiles({ body, sync, requestHeaders }?: FileStoragePlatformValidator.CopyFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
35
35
|
/**
|
|
@@ -39,7 +39,7 @@ declare class FileStorage {
|
|
|
39
39
|
* @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
|
|
40
40
|
* @name getSignUrls
|
|
41
41
|
* @summary: Get signed URLs
|
|
42
|
-
* @description:
|
|
42
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored resources inside private bucket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
|
|
43
43
|
*/
|
|
44
44
|
getSignUrls({ body, requestHeaders }?: FileStoragePlatformValidator.GetSignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.SignUrlResponse>;
|
|
45
45
|
/**
|
|
@@ -48,8 +48,8 @@ declare class FileStorage {
|
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
|
|
50
50
|
* @name proxy
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
51
|
+
* @summary: Access files through a proxy
|
|
52
|
+
* @description: It enables the communication between two entities by directing client requests to the correct server and sending responses back to the client. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
|
|
53
53
|
*/
|
|
54
54
|
proxy({ url, requestHeaders }?: FileStoragePlatformValidator.ProxyParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.ProxyResponse>;
|
|
55
55
|
/**
|
|
@@ -59,7 +59,7 @@ declare class FileStorage {
|
|
|
59
59
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - 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://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
62
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response at platform level. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
63
63
|
*/
|
|
64
64
|
startUpload({ namespace, body, requestHeaders }?: FileStoragePlatformValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePlatformModel.StartResponse>;
|
|
65
65
|
/**
|
|
@@ -106,7 +106,7 @@ class FileStorage {
|
|
|
106
106
|
* @returns {Promise<FileStoragePlatformModel.CompleteResponse>} - Success response
|
|
107
107
|
* @name completeUpload
|
|
108
108
|
* @summary: Complete file upload
|
|
109
|
-
* @description:
|
|
109
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database at platform level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/completeUpload/).
|
|
110
110
|
*/
|
|
111
111
|
async completeUpload(
|
|
112
112
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -189,7 +189,7 @@ class FileStorage {
|
|
|
189
189
|
* @returns {Promise<Object>} - Success response
|
|
190
190
|
* @name copyFiles
|
|
191
191
|
* @summary: Copy files
|
|
192
|
-
* @description:
|
|
192
|
+
* @description: Handle multiple file uploads, updating progress and providing detailed status reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/copyFiles/).
|
|
193
193
|
*/
|
|
194
194
|
async copyFiles(
|
|
195
195
|
{ body, sync, requestHeaders } = { requestHeaders: {} },
|
|
@@ -269,7 +269,7 @@ class FileStorage {
|
|
|
269
269
|
* @returns {Promise<FileStoragePlatformModel.SignUrlResponse>} - Success response
|
|
270
270
|
* @name getSignUrls
|
|
271
271
|
* @summary: Get signed URLs
|
|
272
|
-
* @description:
|
|
272
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored resources inside private bucket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/getSignUrls/).
|
|
273
273
|
*/
|
|
274
274
|
async getSignUrls(
|
|
275
275
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -347,8 +347,8 @@ class FileStorage {
|
|
|
347
347
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
348
348
|
* @returns {Promise<FileStoragePlatformModel.ProxyResponse>} - Success response
|
|
349
349
|
* @name proxy
|
|
350
|
-
* @summary:
|
|
351
|
-
* @description:
|
|
350
|
+
* @summary: Access files through a proxy
|
|
351
|
+
* @description: It enables the communication between two entities by directing client requests to the correct server and sending responses back to the client. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/proxy/).
|
|
352
352
|
*/
|
|
353
353
|
async proxy(
|
|
354
354
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -426,7 +426,7 @@ class FileStorage {
|
|
|
426
426
|
* @returns {Promise<FileStoragePlatformModel.StartResponse>} - 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://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
429
|
+
* @description: Inititates the process of uploading a file to storage location, and returns a storage link in response at platform level. Please refer group description for more details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/filestorage/startUpload/).
|
|
430
430
|
*/
|
|
431
431
|
async startUpload(
|
|
432
432
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -854,9 +854,9 @@ class FileStoragePlatformModel {
|
|
|
854
854
|
zip_code: Joi.number(),
|
|
855
855
|
state_code: Joi.string().allow(""),
|
|
856
856
|
country_code: Joi.string().allow(""),
|
|
857
|
-
gstin: Joi.string().allow(""),
|
|
857
|
+
gstin: Joi.string().allow("").allow(null),
|
|
858
858
|
pan: Joi.string().allow("").allow(null),
|
|
859
|
-
phone_no: Joi.string().allow(""),
|
|
859
|
+
phone_no: Joi.string().allow("").allow(null),
|
|
860
860
|
cin: Joi.string().allow(""),
|
|
861
861
|
website_url: Joi.string().allow(""),
|
|
862
862
|
email: Joi.string().allow(""),
|
|
@@ -216,8 +216,8 @@ declare class Finance {
|
|
|
216
216
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
217
217
|
* @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
|
|
218
218
|
* @name invoiceListing
|
|
219
|
-
* @summary:
|
|
220
|
-
* @description:
|
|
219
|
+
* @summary: List invoices
|
|
220
|
+
* @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
|
|
221
221
|
*/
|
|
222
222
|
invoiceListing({ body, requestHeaders }?: FinancePlatformValidator.InvoiceListingParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceListingResponse>;
|
|
223
223
|
/**
|
|
@@ -258,7 +258,7 @@ declare class Finance {
|
|
|
258
258
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
259
259
|
* Success response
|
|
260
260
|
* @name isCnRefundMethod
|
|
261
|
-
* @summary: Check
|
|
261
|
+
* @summary: Check refund method
|
|
262
262
|
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
263
263
|
*/
|
|
264
264
|
isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
|
|
@@ -290,7 +290,7 @@ declare class Finance {
|
|
|
290
290
|
* @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
|
|
291
291
|
* Success response
|
|
292
292
|
* @name unlockCreditNote
|
|
293
|
-
* @summary:
|
|
293
|
+
* @summary: Unlock credit notes
|
|
294
294
|
* @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
|
|
295
295
|
*/
|
|
296
296
|
unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;
|
|
@@ -1550,8 +1550,8 @@ class Finance {
|
|
|
1550
1550
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1551
1551
|
* @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
|
|
1552
1552
|
* @name invoiceListing
|
|
1553
|
-
* @summary:
|
|
1554
|
-
* @description:
|
|
1553
|
+
* @summary: List invoices
|
|
1554
|
+
* @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
|
|
1555
1555
|
*/
|
|
1556
1556
|
async invoiceListing(
|
|
1557
1557
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1864,7 +1864,7 @@ class Finance {
|
|
|
1864
1864
|
* @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
|
|
1865
1865
|
* Success response
|
|
1866
1866
|
* @name isCnRefundMethod
|
|
1867
|
-
* @summary: Check
|
|
1867
|
+
* @summary: Check refund method
|
|
1868
1868
|
* @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
|
|
1869
1869
|
*/
|
|
1870
1870
|
async isCnRefundMethod(
|
|
@@ -2103,7 +2103,7 @@ class Finance {
|
|
|
2103
2103
|
* @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
|
|
2104
2104
|
* Success response
|
|
2105
2105
|
* @name unlockCreditNote
|
|
2106
|
-
* @summary:
|
|
2106
|
+
* @summary: Unlock credit notes
|
|
2107
2107
|
* @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
|
|
2108
2108
|
*/
|
|
2109
2109
|
async unlockCreditNote(
|
|
@@ -29,7 +29,7 @@ declare class Lead {
|
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
31
31
|
* @name createNewHistory
|
|
32
|
-
* @summary: Create history
|
|
32
|
+
* @summary: Create ticket history interaction
|
|
33
33
|
* @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://partners.fynd.com/help/docs/sdk/platform/lead/createNewHistory/).
|
|
34
34
|
*/
|
|
35
35
|
createNewHistory({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.CreateNewHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
@@ -49,8 +49,8 @@ declare class Lead {
|
|
|
49
49
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
50
50
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
51
51
|
* @name editCustomForm
|
|
52
|
-
* @summary:
|
|
53
|
-
* @description: Modify the content and
|
|
52
|
+
* @summary: Update custom form
|
|
53
|
+
* @description: Modify the content and associated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
54
54
|
*/
|
|
55
55
|
editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
56
56
|
/**
|
|
@@ -59,7 +59,7 @@ declare class Lead {
|
|
|
59
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
60
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
61
61
|
* @name editNewTicket
|
|
62
|
-
* @summary:
|
|
62
|
+
* @summary: Update Ticket Details
|
|
63
63
|
* @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://partners.fynd.com/help/docs/sdk/platform/lead/editNewTicket/).
|
|
64
64
|
*/
|
|
65
65
|
editNewTicket({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.EditNewTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
@@ -70,7 +70,7 @@ declare class Lead {
|
|
|
70
70
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
71
71
|
* @name getCustomForm
|
|
72
72
|
* @summary: Get custom form
|
|
73
|
-
* @description:
|
|
73
|
+
* @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://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
74
74
|
*/
|
|
75
75
|
getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
76
76
|
/**
|
|
@@ -80,7 +80,7 @@ declare class Lead {
|
|
|
80
80
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
81
81
|
* @name getCustomForms
|
|
82
82
|
* @summary: Get custom forms
|
|
83
|
-
* @description:
|
|
83
|
+
* @description: List all available custom forms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
84
84
|
*/
|
|
85
85
|
getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
|
|
86
86
|
/**
|
|
@@ -89,8 +89,8 @@ declare class Lead {
|
|
|
89
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
90
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
91
91
|
* @name getNewTicket
|
|
92
|
-
* @summary:
|
|
93
|
-
* @description:
|
|
92
|
+
* @summary: Get Ticket Details
|
|
93
|
+
* @description: Get ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTicket/).
|
|
94
94
|
*/
|
|
95
95
|
getNewTicket({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
96
96
|
/**
|
|
@@ -99,7 +99,7 @@ declare class Lead {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
101
101
|
* @name getNewTicketHistory
|
|
102
|
-
* @summary:
|
|
102
|
+
* @summary: Get ticket history interaction
|
|
103
103
|
* @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://partners.fynd.com/help/docs/sdk/platform/lead/getNewTicketHistory/).
|
|
104
104
|
*/
|
|
105
105
|
getNewTicketHistory({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
@@ -109,7 +109,7 @@ declare class Lead {
|
|
|
109
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
110
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
111
111
|
* @name getNewTickets
|
|
112
|
-
* @summary:
|
|
112
|
+
* @summary: List sales channel tickets
|
|
113
113
|
* @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTickets/).
|
|
114
114
|
*/
|
|
115
115
|
getNewTickets({ items, filters, q, status, priority, category, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
|
|
@@ -122,7 +122,7 @@ declare class Lead {
|
|
|
122
122
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
123
123
|
* Success response
|
|
124
124
|
* @name getNewTokenForVideoRoom
|
|
125
|
-
* @summary: Get
|
|
125
|
+
* @summary: Get video Room Token
|
|
126
126
|
* @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTokenForVideoRoom/).
|
|
127
127
|
*/
|
|
128
128
|
getNewTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
|
|
@@ -136,7 +136,7 @@ declare class Lead {
|
|
|
136
136
|
* - Success response
|
|
137
137
|
*
|
|
138
138
|
* @name getNewVideoParticipants
|
|
139
|
-
* @summary:
|
|
139
|
+
* @summary: List video Room Participants
|
|
140
140
|
* @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewVideoParticipants/).
|
|
141
141
|
*/
|
|
142
142
|
getNewVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetNewVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
|