@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
|
@@ -179,7 +179,7 @@ class Lead {
|
|
|
179
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
180
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
181
181
|
* @name createNewHistory
|
|
182
|
-
* @summary: Create history
|
|
182
|
+
* @summary: Create ticket history interaction
|
|
183
183
|
* @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/).
|
|
184
184
|
*/
|
|
185
185
|
async createNewHistory(
|
|
@@ -339,8 +339,8 @@ class Lead {
|
|
|
339
339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
340
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
341
341
|
* @name editCustomForm
|
|
342
|
-
* @summary:
|
|
343
|
-
* @description: Modify the content and
|
|
342
|
+
* @summary: Update custom form
|
|
343
|
+
* @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/).
|
|
344
344
|
*/
|
|
345
345
|
async editCustomForm(
|
|
346
346
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -420,7 +420,7 @@ class Lead {
|
|
|
420
420
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
421
421
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
422
422
|
* @name editNewTicket
|
|
423
|
-
* @summary:
|
|
423
|
+
* @summary: Update Ticket Details
|
|
424
424
|
* @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/).
|
|
425
425
|
*/
|
|
426
426
|
async editNewTicket(
|
|
@@ -500,7 +500,7 @@ class Lead {
|
|
|
500
500
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
501
501
|
* @name getCustomForm
|
|
502
502
|
* @summary: Get custom form
|
|
503
|
-
* @description:
|
|
503
|
+
* @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/).
|
|
504
504
|
*/
|
|
505
505
|
async getCustomForm(
|
|
506
506
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -577,7 +577,7 @@ class Lead {
|
|
|
577
577
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
578
578
|
* @name getCustomForms
|
|
579
579
|
* @summary: Get custom forms
|
|
580
|
-
* @description:
|
|
580
|
+
* @description: List all available custom forms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
581
581
|
*/
|
|
582
582
|
async getCustomForms(
|
|
583
583
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -651,8 +651,8 @@ class Lead {
|
|
|
651
651
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
652
652
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
653
653
|
* @name getNewTicket
|
|
654
|
-
* @summary:
|
|
655
|
-
* @description:
|
|
654
|
+
* @summary: Get Ticket Details
|
|
655
|
+
* @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/).
|
|
656
656
|
*/
|
|
657
657
|
async getNewTicket(
|
|
658
658
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -728,7 +728,7 @@ class Lead {
|
|
|
728
728
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
729
729
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
730
730
|
* @name getNewTicketHistory
|
|
731
|
-
* @summary:
|
|
731
|
+
* @summary: Get ticket history interaction
|
|
732
732
|
* @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/).
|
|
733
733
|
*/
|
|
734
734
|
async getNewTicketHistory(
|
|
@@ -807,7 +807,7 @@ class Lead {
|
|
|
807
807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
808
808
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
809
809
|
* @name getNewTickets
|
|
810
|
-
* @summary:
|
|
810
|
+
* @summary: List sales channel tickets
|
|
811
811
|
* @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/).
|
|
812
812
|
*/
|
|
813
813
|
async getNewTickets(
|
|
@@ -905,7 +905,7 @@ class Lead {
|
|
|
905
905
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
906
906
|
* Success response
|
|
907
907
|
* @name getNewTokenForVideoRoom
|
|
908
|
-
* @summary: Get
|
|
908
|
+
* @summary: Get video Room Token
|
|
909
909
|
* @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/).
|
|
910
910
|
*/
|
|
911
911
|
async getNewTokenForVideoRoom(
|
|
@@ -988,7 +988,7 @@ class Lead {
|
|
|
988
988
|
* - Success response
|
|
989
989
|
*
|
|
990
990
|
* @name getNewVideoParticipants
|
|
991
|
-
* @summary:
|
|
991
|
+
* @summary: List video Room Participants
|
|
992
992
|
* @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/).
|
|
993
993
|
*/
|
|
994
994
|
async getNewVideoParticipants(
|
|
@@ -8,7 +8,7 @@ declare class Lead {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
10
10
|
* @name createPlatformTicketHistory
|
|
11
|
-
* @summary: Create
|
|
11
|
+
* @summary: Create ticket history
|
|
12
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://partners.fynd.com/help/docs/sdk/platform/lead/createPlatformTicketHistory/).
|
|
13
13
|
*/
|
|
14
14
|
createPlatformTicketHistory({ id, body, requestHeaders }?: LeadPlatformValidator.CreatePlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
@@ -28,7 +28,7 @@ declare class Lead {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
30
30
|
* @name editPlatformTicket
|
|
31
|
-
* @summary:
|
|
31
|
+
* @summary: Update a ticket
|
|
32
32
|
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editPlatformTicket/).
|
|
33
33
|
*/
|
|
34
34
|
editPlatformTicket({ id, body, requestHeaders }?: LeadPlatformValidator.EditPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
@@ -38,8 +38,8 @@ declare class Lead {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
40
40
|
* @name getFeedbacks
|
|
41
|
-
* @summary:
|
|
42
|
-
* @description:
|
|
41
|
+
* @summary: List feedbacks
|
|
42
|
+
* @description: Get feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/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.CloseVideoRoomResponse>} - Success response
|
|
50
50
|
* @name getGeneralConfig
|
|
51
51
|
* @summary: Get general configuration
|
|
52
|
-
* @description:
|
|
52
|
+
* @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
|
|
53
53
|
*/
|
|
54
54
|
getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
|
|
55
55
|
/**
|
|
@@ -58,8 +58,8 @@ declare class Lead {
|
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
60
60
|
* @name getPlatformTicket
|
|
61
|
-
* @summary: Get
|
|
62
|
-
* @description:
|
|
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://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
|
|
63
63
|
*/
|
|
64
64
|
getPlatformTicket({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
65
65
|
/**
|
|
@@ -68,8 +68,8 @@ declare class Lead {
|
|
|
68
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
70
70
|
* @name getPlatformTicketHistory
|
|
71
|
-
* @summary: Get
|
|
72
|
-
* @description:
|
|
71
|
+
* @summary: Get ticket history
|
|
72
|
+
* @description: List history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
|
|
73
73
|
*/
|
|
74
74
|
getPlatformTicketHistory({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
75
75
|
/**
|
|
@@ -78,8 +78,8 @@ declare class Lead {
|
|
|
78
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
80
80
|
* @name getPlatformTickets
|
|
81
|
-
* @summary:
|
|
82
|
-
* @description:
|
|
81
|
+
* @summary: List tickets
|
|
82
|
+
* @description: List all tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/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
|
/**
|
|
@@ -90,8 +90,8 @@ declare class Lead {
|
|
|
90
90
|
* - Success response
|
|
91
91
|
*
|
|
92
92
|
* @name getPlatformVideoParticipants
|
|
93
|
-
* @summary:
|
|
94
|
-
* @description:
|
|
93
|
+
* @summary: List video Room Participants
|
|
94
|
+
* @description: Get a list of participants in a platform video room - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
|
|
95
95
|
*/
|
|
96
96
|
getPlatformVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetPlatformVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
|
|
97
97
|
/**
|
|
@@ -101,8 +101,8 @@ declare class Lead {
|
|
|
101
101
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
102
102
|
* Success response
|
|
103
103
|
* @name getTokenForPlatformVideoRoom
|
|
104
|
-
* @summary: Get
|
|
105
|
-
* @description:
|
|
104
|
+
* @summary: Get video Room Token
|
|
105
|
+
* @description: Get an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
|
|
106
106
|
*/
|
|
107
107
|
getTokenForPlatformVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetTokenForPlatformVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
|
|
108
108
|
/**
|
|
@@ -20,7 +20,7 @@ class Lead {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
22
22
|
* @name createPlatformTicketHistory
|
|
23
|
-
* @summary: Create
|
|
23
|
+
* @summary: Create ticket history
|
|
24
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://partners.fynd.com/help/docs/sdk/platform/lead/createPlatformTicketHistory/).
|
|
25
25
|
*/
|
|
26
26
|
async createPlatformTicketHistory(
|
|
@@ -180,7 +180,7 @@ class Lead {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
182
182
|
* @name editPlatformTicket
|
|
183
|
-
* @summary:
|
|
183
|
+
* @summary: Update a ticket
|
|
184
184
|
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editPlatformTicket/).
|
|
185
185
|
*/
|
|
186
186
|
async editPlatformTicket(
|
|
@@ -261,8 +261,8 @@ class Lead {
|
|
|
261
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
262
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
263
263
|
* @name getFeedbacks
|
|
264
|
-
* @summary:
|
|
265
|
-
* @description:
|
|
264
|
+
* @summary: List feedbacks
|
|
265
|
+
* @description: Get feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/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.CloseVideoRoomResponse>} - Success response
|
|
340
340
|
* @name getGeneralConfig
|
|
341
341
|
* @summary: Get general configuration
|
|
342
|
-
* @description:
|
|
342
|
+
* @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
|
|
343
343
|
*/
|
|
344
344
|
async getGeneralConfig(
|
|
345
345
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -413,8 +413,8 @@ class Lead {
|
|
|
413
413
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
414
414
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
415
415
|
* @name getPlatformTicket
|
|
416
|
-
* @summary: Get
|
|
417
|
-
* @description:
|
|
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://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
|
|
418
418
|
*/
|
|
419
419
|
async getPlatformTicket(
|
|
420
420
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -492,8 +492,8 @@ class Lead {
|
|
|
492
492
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
493
493
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
494
494
|
* @name getPlatformTicketHistory
|
|
495
|
-
* @summary: Get
|
|
496
|
-
* @description:
|
|
495
|
+
* @summary: Get ticket history
|
|
496
|
+
* @description: List history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
|
|
497
497
|
*/
|
|
498
498
|
async getPlatformTicketHistory(
|
|
499
499
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -571,8 +571,8 @@ class Lead {
|
|
|
571
571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
572
572
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
573
573
|
* @name getPlatformTickets
|
|
574
|
-
* @summary:
|
|
575
|
-
* @description:
|
|
574
|
+
* @summary: List tickets
|
|
575
|
+
* @description: List all tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
|
|
576
576
|
*/
|
|
577
577
|
async getPlatformTickets(
|
|
578
578
|
{
|
|
@@ -684,8 +684,8 @@ class Lead {
|
|
|
684
684
|
* - Success response
|
|
685
685
|
*
|
|
686
686
|
* @name getPlatformVideoParticipants
|
|
687
|
-
* @summary:
|
|
688
|
-
* @description:
|
|
687
|
+
* @summary: List video Room Participants
|
|
688
|
+
* @description: Get a list of participants in a platform video room - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
|
|
689
689
|
*/
|
|
690
690
|
async getPlatformVideoParticipants(
|
|
691
691
|
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -766,8 +766,8 @@ class Lead {
|
|
|
766
766
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
767
767
|
* Success response
|
|
768
768
|
* @name getTokenForPlatformVideoRoom
|
|
769
|
-
* @summary: Get
|
|
770
|
-
* @description:
|
|
769
|
+
* @summary: Get video Room Token
|
|
770
|
+
* @description: Get an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
|
|
771
771
|
*/
|
|
772
772
|
async getTokenForPlatformVideoRoom(
|
|
773
773
|
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -9,8 +9,8 @@ declare class Order {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
11
11
|
* @name failedOrderLogs
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: List failed order logs
|
|
13
|
+
* @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
|
|
14
14
|
*/
|
|
15
15
|
failedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformApplicationValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
|
|
16
16
|
/**
|
|
@@ -23,8 +23,8 @@ declare class Order {
|
|
|
23
23
|
* - Success response
|
|
24
24
|
*
|
|
25
25
|
* @name getApplicationShipments
|
|
26
|
-
* @summary:
|
|
27
|
-
* @description: Get
|
|
26
|
+
* @summary: List sales channel shipments
|
|
27
|
+
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
|
|
28
28
|
*/
|
|
29
29
|
getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
30
30
|
/**
|
|
@@ -35,8 +35,8 @@ declare class Order {
|
|
|
35
35
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
36
|
* @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
|
|
37
37
|
* @name getPlatformShipmentReasons
|
|
38
|
-
* @summary:
|
|
39
|
-
* @description:
|
|
38
|
+
* @summary: List shipment cancellation reasons
|
|
39
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
|
|
40
40
|
*/
|
|
41
41
|
getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
|
|
42
42
|
/**
|
|
@@ -47,8 +47,8 @@ declare class Order {
|
|
|
47
47
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
48
|
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
49
49
|
* @name getShipmentBagReasons
|
|
50
|
-
* @summary:
|
|
51
|
-
* @description:
|
|
50
|
+
* @summary: List bag cancellation reasons
|
|
51
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
|
|
52
52
|
*/
|
|
53
53
|
getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
|
|
54
54
|
/**
|
|
@@ -59,8 +59,8 @@ declare class Order {
|
|
|
59
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
60
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
61
61
|
* @name trackShipmentPlatform
|
|
62
|
-
* @summary: Track shipment
|
|
63
|
-
* @description: Track shipment by
|
|
62
|
+
* @summary: Track shipment
|
|
63
|
+
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
|
|
64
64
|
*/
|
|
65
65
|
trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
|
|
66
66
|
}
|
|
@@ -21,8 +21,8 @@ class Order {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
23
23
|
* @name failedOrderLogs
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: List failed order logs
|
|
25
|
+
* @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
|
|
26
26
|
*/
|
|
27
27
|
async failedOrderLogs(
|
|
28
28
|
{ pageNo, pageSize, searchType, searchValue, requestHeaders } = {
|
|
@@ -117,8 +117,8 @@ class Order {
|
|
|
117
117
|
* - Success response
|
|
118
118
|
*
|
|
119
119
|
* @name getApplicationShipments
|
|
120
|
-
* @summary:
|
|
121
|
-
* @description: Get
|
|
120
|
+
* @summary: List sales channel shipments
|
|
121
|
+
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
|
|
122
122
|
*/
|
|
123
123
|
async getApplicationShipments(
|
|
124
124
|
{
|
|
@@ -258,8 +258,8 @@ class Order {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
|
|
260
260
|
* @name getPlatformShipmentReasons
|
|
261
|
-
* @summary:
|
|
262
|
-
* @description:
|
|
261
|
+
* @summary: List shipment cancellation reasons
|
|
262
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
|
|
263
263
|
*/
|
|
264
264
|
async getPlatformShipmentReasons(
|
|
265
265
|
{ action, requestHeaders } = { requestHeaders: {} },
|
|
@@ -339,8 +339,8 @@ class Order {
|
|
|
339
339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
340
|
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
341
341
|
* @name getShipmentBagReasons
|
|
342
|
-
* @summary:
|
|
343
|
-
* @description:
|
|
342
|
+
* @summary: List bag cancellation reasons
|
|
343
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
|
|
344
344
|
*/
|
|
345
345
|
async getShipmentBagReasons(
|
|
346
346
|
{ shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
|
|
@@ -422,8 +422,8 @@ class Order {
|
|
|
422
422
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
423
423
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
424
424
|
* @name trackShipmentPlatform
|
|
425
|
-
* @summary: Track shipment
|
|
426
|
-
* @description: Track shipment by
|
|
425
|
+
* @summary: Track shipment
|
|
426
|
+
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
|
|
427
427
|
*/
|
|
428
428
|
async trackShipmentPlatform(
|
|
429
429
|
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|