@gofynd/fdk-client-javascript 1.2.0 → 1.3.0
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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -14,13 +14,17 @@ class Lead {
|
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
* @param {LeadPlatformApplicationValidator.CloseVideoRoomParam} arg - Arg object
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
17
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
18
19
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
19
20
|
* @name closeVideoRoom
|
|
20
21
|
* @summary: Close the video room and force all participants to leave.
|
|
21
22
|
* @description: Close the video room and force all participants to leave. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
|
|
22
23
|
*/
|
|
23
|
-
async closeVideoRoom(
|
|
24
|
+
async closeVideoRoom(
|
|
25
|
+
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
26
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
27
|
+
) {
|
|
24
28
|
const {
|
|
25
29
|
error,
|
|
26
30
|
} = LeadPlatformApplicationValidator.closeVideoRoom().validate(
|
|
@@ -57,12 +61,12 @@ class Lead {
|
|
|
57
61
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room/${uniqueName}`,
|
|
58
62
|
query_params,
|
|
59
63
|
undefined,
|
|
60
|
-
|
|
61
|
-
{
|
|
64
|
+
requestHeaders,
|
|
65
|
+
{ responseHeaders }
|
|
62
66
|
);
|
|
63
67
|
|
|
64
68
|
let responseData = response;
|
|
65
|
-
if (
|
|
69
|
+
if (responseHeaders) {
|
|
66
70
|
responseData = response[0];
|
|
67
71
|
}
|
|
68
72
|
|
|
@@ -85,13 +89,17 @@ class Lead {
|
|
|
85
89
|
|
|
86
90
|
/**
|
|
87
91
|
* @param {LeadPlatformApplicationValidator.CreateCustomFormParam} arg - Arg object
|
|
92
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
88
93
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
89
94
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
90
95
|
* @name createCustomForm
|
|
91
96
|
* @summary: Creates a new custom form
|
|
92
97
|
* @description: Creates a new custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
|
|
93
98
|
*/
|
|
94
|
-
async createCustomForm(
|
|
99
|
+
async createCustomForm(
|
|
100
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
101
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
102
|
+
) {
|
|
95
103
|
const {
|
|
96
104
|
error,
|
|
97
105
|
} = LeadPlatformApplicationValidator.createCustomForm().validate(
|
|
@@ -128,12 +136,12 @@ class Lead {
|
|
|
128
136
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form`,
|
|
129
137
|
query_params,
|
|
130
138
|
body,
|
|
131
|
-
|
|
132
|
-
{
|
|
139
|
+
requestHeaders,
|
|
140
|
+
{ responseHeaders }
|
|
133
141
|
);
|
|
134
142
|
|
|
135
143
|
let responseData = response;
|
|
136
|
-
if (
|
|
144
|
+
if (responseHeaders) {
|
|
137
145
|
responseData = response[0];
|
|
138
146
|
}
|
|
139
147
|
|
|
@@ -156,13 +164,17 @@ class Lead {
|
|
|
156
164
|
|
|
157
165
|
/**
|
|
158
166
|
* @param {LeadPlatformApplicationValidator.CreateHistoryParam} arg - Arg object
|
|
167
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
168
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
169
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
161
170
|
* @name createHistory
|
|
162
171
|
* @summary: Create history for specific application level ticket
|
|
163
172
|
* @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/createHistory/).
|
|
164
173
|
*/
|
|
165
|
-
async createHistory(
|
|
174
|
+
async createHistory(
|
|
175
|
+
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
176
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
177
|
+
) {
|
|
166
178
|
const { error } = LeadPlatformApplicationValidator.createHistory().validate(
|
|
167
179
|
{
|
|
168
180
|
id,
|
|
@@ -199,12 +211,12 @@ class Lead {
|
|
|
199
211
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}/history`,
|
|
200
212
|
query_params,
|
|
201
213
|
body,
|
|
202
|
-
|
|
203
|
-
{
|
|
214
|
+
requestHeaders,
|
|
215
|
+
{ responseHeaders }
|
|
204
216
|
);
|
|
205
217
|
|
|
206
218
|
let responseData = response;
|
|
207
|
-
if (
|
|
219
|
+
if (responseHeaders) {
|
|
208
220
|
responseData = response[0];
|
|
209
221
|
}
|
|
210
222
|
|
|
@@ -227,13 +239,17 @@ class Lead {
|
|
|
227
239
|
|
|
228
240
|
/**
|
|
229
241
|
* @param {LeadPlatformApplicationValidator.EditCustomFormParam} arg - Arg object
|
|
242
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
230
243
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
231
244
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
232
245
|
* @name editCustomForm
|
|
233
246
|
* @summary: Edit the given custom form
|
|
234
247
|
* @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
235
248
|
*/
|
|
236
|
-
async editCustomForm(
|
|
249
|
+
async editCustomForm(
|
|
250
|
+
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
251
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
252
|
+
) {
|
|
237
253
|
const {
|
|
238
254
|
error,
|
|
239
255
|
} = LeadPlatformApplicationValidator.editCustomForm().validate(
|
|
@@ -272,12 +288,12 @@ class Lead {
|
|
|
272
288
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form/${slug}`,
|
|
273
289
|
query_params,
|
|
274
290
|
body,
|
|
275
|
-
|
|
276
|
-
{
|
|
291
|
+
requestHeaders,
|
|
292
|
+
{ responseHeaders }
|
|
277
293
|
);
|
|
278
294
|
|
|
279
295
|
let responseData = response;
|
|
280
|
-
if (
|
|
296
|
+
if (responseHeaders) {
|
|
281
297
|
responseData = response[0];
|
|
282
298
|
}
|
|
283
299
|
|
|
@@ -300,13 +316,17 @@ class Lead {
|
|
|
300
316
|
|
|
301
317
|
/**
|
|
302
318
|
* @param {LeadPlatformApplicationValidator.EditTicketParam} arg - Arg object
|
|
319
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
320
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
321
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
305
322
|
* @name editTicket
|
|
306
323
|
* @summary: Edits ticket details of a application level ticket
|
|
307
324
|
* @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/editTicket/).
|
|
308
325
|
*/
|
|
309
|
-
async editTicket(
|
|
326
|
+
async editTicket(
|
|
327
|
+
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
328
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
329
|
+
) {
|
|
310
330
|
const { error } = LeadPlatformApplicationValidator.editTicket().validate(
|
|
311
331
|
{
|
|
312
332
|
id,
|
|
@@ -343,12 +363,12 @@ class Lead {
|
|
|
343
363
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}`,
|
|
344
364
|
query_params,
|
|
345
365
|
body,
|
|
346
|
-
|
|
347
|
-
{
|
|
366
|
+
requestHeaders,
|
|
367
|
+
{ responseHeaders }
|
|
348
368
|
);
|
|
349
369
|
|
|
350
370
|
let responseData = response;
|
|
351
|
-
if (
|
|
371
|
+
if (responseHeaders) {
|
|
352
372
|
responseData = response[0];
|
|
353
373
|
}
|
|
354
374
|
|
|
@@ -371,13 +391,17 @@ class Lead {
|
|
|
371
391
|
|
|
372
392
|
/**
|
|
373
393
|
* @param {LeadPlatformApplicationValidator.GetCustomFormParam} arg - Arg object
|
|
394
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
374
395
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
375
396
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
376
397
|
* @name getCustomForm
|
|
377
398
|
* @summary: Get specific custom form using it's slug
|
|
378
399
|
* @description: Get specific custom form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
379
400
|
*/
|
|
380
|
-
async getCustomForm(
|
|
401
|
+
async getCustomForm(
|
|
402
|
+
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
403
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
404
|
+
) {
|
|
381
405
|
const { error } = LeadPlatformApplicationValidator.getCustomForm().validate(
|
|
382
406
|
{
|
|
383
407
|
slug,
|
|
@@ -412,12 +436,12 @@ class Lead {
|
|
|
412
436
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form/${slug}`,
|
|
413
437
|
query_params,
|
|
414
438
|
undefined,
|
|
415
|
-
|
|
416
|
-
{
|
|
439
|
+
requestHeaders,
|
|
440
|
+
{ responseHeaders }
|
|
417
441
|
);
|
|
418
442
|
|
|
419
443
|
let responseData = response;
|
|
420
|
-
if (
|
|
444
|
+
if (responseHeaders) {
|
|
421
445
|
responseData = response[0];
|
|
422
446
|
}
|
|
423
447
|
|
|
@@ -439,13 +463,18 @@ class Lead {
|
|
|
439
463
|
}
|
|
440
464
|
|
|
441
465
|
/**
|
|
466
|
+
* @param {LeadPlatformApplicationValidator.GetCustomFormsParam} arg - Arg object
|
|
467
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
442
468
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
443
469
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
444
470
|
* @name getCustomForms
|
|
445
471
|
* @summary: Get list of custom form
|
|
446
472
|
* @description: Get list of custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
447
473
|
*/
|
|
448
|
-
async getCustomForms(
|
|
474
|
+
async getCustomForms(
|
|
475
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
476
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
477
|
+
) {
|
|
449
478
|
const {
|
|
450
479
|
error,
|
|
451
480
|
} = LeadPlatformApplicationValidator.getCustomForms().validate(
|
|
@@ -478,12 +507,12 @@ class Lead {
|
|
|
478
507
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form`,
|
|
479
508
|
query_params,
|
|
480
509
|
undefined,
|
|
481
|
-
|
|
482
|
-
{
|
|
510
|
+
requestHeaders,
|
|
511
|
+
{ responseHeaders }
|
|
483
512
|
);
|
|
484
513
|
|
|
485
514
|
let responseData = response;
|
|
486
|
-
if (
|
|
515
|
+
if (responseHeaders) {
|
|
487
516
|
responseData = response[0];
|
|
488
517
|
}
|
|
489
518
|
|
|
@@ -506,13 +535,17 @@ class Lead {
|
|
|
506
535
|
|
|
507
536
|
/**
|
|
508
537
|
* @param {LeadPlatformApplicationValidator.GetTicketParam} arg - Arg object
|
|
538
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
509
539
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
510
540
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
511
541
|
* @name getTicket
|
|
512
542
|
* @summary: Retreives ticket details of a application level ticket
|
|
513
543
|
* @description: Retreives ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicket/).
|
|
514
544
|
*/
|
|
515
|
-
async getTicket(
|
|
545
|
+
async getTicket(
|
|
546
|
+
{ id, requestHeaders } = { requestHeaders: {} },
|
|
547
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
548
|
+
) {
|
|
516
549
|
const { error } = LeadPlatformApplicationValidator.getTicket().validate(
|
|
517
550
|
{
|
|
518
551
|
id,
|
|
@@ -547,12 +580,12 @@ class Lead {
|
|
|
547
580
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}`,
|
|
548
581
|
query_params,
|
|
549
582
|
undefined,
|
|
550
|
-
|
|
551
|
-
{
|
|
583
|
+
requestHeaders,
|
|
584
|
+
{ responseHeaders }
|
|
552
585
|
);
|
|
553
586
|
|
|
554
587
|
let responseData = response;
|
|
555
|
-
if (
|
|
588
|
+
if (responseHeaders) {
|
|
556
589
|
responseData = response[0];
|
|
557
590
|
}
|
|
558
591
|
|
|
@@ -575,13 +608,17 @@ class Lead {
|
|
|
575
608
|
|
|
576
609
|
/**
|
|
577
610
|
* @param {LeadPlatformApplicationValidator.GetTicketHistoryParam} arg - Arg object
|
|
611
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
578
612
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
579
613
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
580
614
|
* @name getTicketHistory
|
|
581
615
|
* @summary: Gets history list for specific application level ticket
|
|
582
616
|
* @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/getTicketHistory/).
|
|
583
617
|
*/
|
|
584
|
-
async getTicketHistory(
|
|
618
|
+
async getTicketHistory(
|
|
619
|
+
{ id, requestHeaders } = { requestHeaders: {} },
|
|
620
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
621
|
+
) {
|
|
585
622
|
const {
|
|
586
623
|
error,
|
|
587
624
|
} = LeadPlatformApplicationValidator.getTicketHistory().validate(
|
|
@@ -618,12 +655,12 @@ class Lead {
|
|
|
618
655
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}/history`,
|
|
619
656
|
query_params,
|
|
620
657
|
undefined,
|
|
621
|
-
|
|
622
|
-
{
|
|
658
|
+
requestHeaders,
|
|
659
|
+
{ responseHeaders }
|
|
623
660
|
);
|
|
624
661
|
|
|
625
662
|
let responseData = response;
|
|
626
|
-
if (
|
|
663
|
+
if (responseHeaders) {
|
|
627
664
|
responseData = response[0];
|
|
628
665
|
}
|
|
629
666
|
|
|
@@ -646,6 +683,7 @@ class Lead {
|
|
|
646
683
|
|
|
647
684
|
/**
|
|
648
685
|
* @param {LeadPlatformApplicationValidator.GetTicketsParam} arg - Arg object
|
|
686
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
649
687
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
650
688
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
651
689
|
* @name getTickets
|
|
@@ -653,8 +691,10 @@ class Lead {
|
|
|
653
691
|
* @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/getTickets/).
|
|
654
692
|
*/
|
|
655
693
|
async getTickets(
|
|
656
|
-
{ items, filters, q, status, priority, category } = {
|
|
657
|
-
|
|
694
|
+
{ items, filters, q, status, priority, category, requestHeaders } = {
|
|
695
|
+
requestHeaders: {},
|
|
696
|
+
},
|
|
697
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
658
698
|
) {
|
|
659
699
|
const { error } = LeadPlatformApplicationValidator.getTickets().validate(
|
|
660
700
|
{
|
|
@@ -706,12 +746,12 @@ class Lead {
|
|
|
706
746
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket`,
|
|
707
747
|
query_params,
|
|
708
748
|
undefined,
|
|
709
|
-
|
|
710
|
-
{
|
|
749
|
+
requestHeaders,
|
|
750
|
+
{ responseHeaders }
|
|
711
751
|
);
|
|
712
752
|
|
|
713
753
|
let responseData = response;
|
|
714
|
-
if (
|
|
754
|
+
if (responseHeaders) {
|
|
715
755
|
responseData = response[0];
|
|
716
756
|
}
|
|
717
757
|
|
|
@@ -736,6 +776,7 @@ class Lead {
|
|
|
736
776
|
* @param {LeadPlatformApplicationValidator.GetTokenForVideoRoomParam} arg
|
|
737
777
|
* - Arg object
|
|
738
778
|
*
|
|
779
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
739
780
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
740
781
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
741
782
|
* Success response
|
|
@@ -744,8 +785,8 @@ class Lead {
|
|
|
744
785
|
* @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/getTokenForVideoRoom/).
|
|
745
786
|
*/
|
|
746
787
|
async getTokenForVideoRoom(
|
|
747
|
-
{ uniqueName } = {},
|
|
748
|
-
{
|
|
788
|
+
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
789
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
749
790
|
) {
|
|
750
791
|
const {
|
|
751
792
|
error,
|
|
@@ -783,12 +824,12 @@ class Lead {
|
|
|
783
824
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room/${uniqueName}/token`,
|
|
784
825
|
query_params,
|
|
785
826
|
undefined,
|
|
786
|
-
|
|
787
|
-
{
|
|
827
|
+
requestHeaders,
|
|
828
|
+
{ responseHeaders }
|
|
788
829
|
);
|
|
789
830
|
|
|
790
831
|
let responseData = response;
|
|
791
|
-
if (
|
|
832
|
+
if (responseHeaders) {
|
|
792
833
|
responseData = response[0];
|
|
793
834
|
}
|
|
794
835
|
|
|
@@ -813,6 +854,7 @@ class Lead {
|
|
|
813
854
|
* @param {LeadPlatformApplicationValidator.GetVideoParticipantsParam} arg
|
|
814
855
|
* - Arg object
|
|
815
856
|
*
|
|
857
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
816
858
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
817
859
|
* @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
|
|
818
860
|
* - Success response
|
|
@@ -822,8 +864,8 @@ class Lead {
|
|
|
822
864
|
* @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/getVideoParticipants/).
|
|
823
865
|
*/
|
|
824
866
|
async getVideoParticipants(
|
|
825
|
-
{ uniqueName } = {},
|
|
826
|
-
{
|
|
867
|
+
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
868
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
827
869
|
) {
|
|
828
870
|
const {
|
|
829
871
|
error,
|
|
@@ -861,12 +903,12 @@ class Lead {
|
|
|
861
903
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room/${uniqueName}/participants`,
|
|
862
904
|
query_params,
|
|
863
905
|
undefined,
|
|
864
|
-
|
|
865
|
-
{
|
|
906
|
+
requestHeaders,
|
|
907
|
+
{ responseHeaders }
|
|
866
908
|
);
|
|
867
909
|
|
|
868
910
|
let responseData = response;
|
|
869
|
-
if (
|
|
911
|
+
if (responseHeaders) {
|
|
870
912
|
responseData = response[0];
|
|
871
913
|
}
|
|
872
914
|
|
|
@@ -889,13 +931,17 @@ class Lead {
|
|
|
889
931
|
|
|
890
932
|
/**
|
|
891
933
|
* @param {LeadPlatformApplicationValidator.OpenVideoRoomParam} arg - Arg object
|
|
934
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
892
935
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
893
936
|
* @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
|
|
894
937
|
* @name openVideoRoom
|
|
895
938
|
* @summary: Open a video room.
|
|
896
939
|
* @description: Open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
|
|
897
940
|
*/
|
|
898
|
-
async openVideoRoom(
|
|
941
|
+
async openVideoRoom(
|
|
942
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
943
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
944
|
+
) {
|
|
899
945
|
const { error } = LeadPlatformApplicationValidator.openVideoRoom().validate(
|
|
900
946
|
{
|
|
901
947
|
body,
|
|
@@ -930,12 +976,12 @@ class Lead {
|
|
|
930
976
|
`/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room`,
|
|
931
977
|
query_params,
|
|
932
978
|
body,
|
|
933
|
-
|
|
934
|
-
{
|
|
979
|
+
requestHeaders,
|
|
980
|
+
{ responseHeaders }
|
|
935
981
|
);
|
|
936
982
|
|
|
937
983
|
let responseData = response;
|
|
938
|
-
if (
|
|
984
|
+
if (responseHeaders) {
|
|
939
985
|
responseData = response[0];
|
|
940
986
|
}
|
|
941
987
|
|
|
@@ -3,77 +3,85 @@ declare class Lead {
|
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
|
-
* @param {LeadPlatformValidator.
|
|
6
|
+
* @param {LeadPlatformValidator.CreatePlatformTicketHistoryParam} arg - Arg object
|
|
7
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
7
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
8
9
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
9
|
-
* @name
|
|
10
|
+
* @name createPlatformTicketHistory
|
|
10
11
|
* @summary: Create history for specific company level ticket
|
|
11
|
-
* @description: Create history for specific company 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/
|
|
12
|
+
* @description: Create history for specific company 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/createPlatformTicketHistory/).
|
|
12
13
|
*/
|
|
13
|
-
|
|
14
|
+
createPlatformTicketHistory({ id, body, requestHeaders }?: LeadPlatformValidator.CreatePlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
14
15
|
/**
|
|
15
16
|
* @param {LeadPlatformValidator.CreateTicketParam} arg - Arg object
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
16
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
17
19
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
18
20
|
* @name createTicket
|
|
19
21
|
* @summary: Creates a company level ticket
|
|
20
22
|
* @description: Creates a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createTicket/).
|
|
21
23
|
*/
|
|
22
|
-
createTicket({ body }?: LeadPlatformValidator.CreateTicketParam, {
|
|
24
|
+
createTicket({ body, requestHeaders }?: LeadPlatformValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
23
25
|
/**
|
|
24
|
-
* @param {LeadPlatformValidator.
|
|
26
|
+
* @param {LeadPlatformValidator.EditPlatformTicketParam} arg - Arg object
|
|
27
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
29
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
27
|
-
* @name
|
|
30
|
+
* @name editPlatformTicket
|
|
28
31
|
* @summary: Edits ticket details of a company level ticket
|
|
29
|
-
* @description: Edits ticket details of a company 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/
|
|
32
|
+
* @description: Edits ticket details of a company 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/editPlatformTicket/).
|
|
30
33
|
*/
|
|
31
|
-
|
|
34
|
+
editPlatformTicket({ id, body, requestHeaders }?: LeadPlatformValidator.EditPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
32
35
|
/**
|
|
33
36
|
* @param {LeadPlatformValidator.GetFeedbacksParam} arg - Arg object
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
34
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
35
39
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
36
40
|
* @name getFeedbacks
|
|
37
41
|
* @summary: Gets a list of feedback submitted against that ticket
|
|
38
42
|
* @description: Gets a list of feedback submitted against that ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
|
|
39
43
|
*/
|
|
40
|
-
getFeedbacks({ id }?: LeadPlatformValidator.GetFeedbacksParam, {
|
|
44
|
+
getFeedbacks({ id, requestHeaders }?: LeadPlatformValidator.GetFeedbacksParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedbackList>;
|
|
41
45
|
/**
|
|
42
46
|
* @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
|
|
47
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
43
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
49
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
45
50
|
* @name getGeneralConfig
|
|
46
51
|
* @summary: Get general support configuration.
|
|
47
52
|
* @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
|
|
48
53
|
*/
|
|
49
|
-
getGeneralConfig({
|
|
54
|
+
getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
|
|
50
55
|
/**
|
|
51
|
-
* @param {LeadPlatformValidator.
|
|
56
|
+
* @param {LeadPlatformValidator.GetPlatformTicketParam} arg - Arg object
|
|
57
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
59
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
54
|
-
* @name
|
|
60
|
+
* @name getPlatformTicket
|
|
55
61
|
* @summary: Retreives ticket details of a company level ticket with ticket ID
|
|
56
|
-
* @description: Retreives ticket details of a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/
|
|
62
|
+
* @description: Retreives ticket details of a company level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
|
|
57
63
|
*/
|
|
58
|
-
|
|
64
|
+
getPlatformTicket({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
59
65
|
/**
|
|
60
|
-
* @param {LeadPlatformValidator.
|
|
66
|
+
* @param {LeadPlatformValidator.GetPlatformTicketHistoryParam} arg - Arg object
|
|
67
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
61
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
69
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
63
|
-
* @name
|
|
70
|
+
* @name getPlatformTicketHistory
|
|
64
71
|
* @summary: Gets history list for specific company level ticket
|
|
65
|
-
* @description: Gets history list for specific company 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/
|
|
72
|
+
* @description: Gets history list for specific company 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/getPlatformTicketHistory/).
|
|
66
73
|
*/
|
|
67
|
-
|
|
74
|
+
getPlatformTicketHistory({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
68
75
|
/**
|
|
69
|
-
* @param {LeadPlatformValidator.
|
|
76
|
+
* @param {LeadPlatformValidator.GetPlatformTicketsParam} arg - Arg object
|
|
77
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
79
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
72
|
-
* @name
|
|
80
|
+
* @name getPlatformTickets
|
|
73
81
|
* @summary: Gets the list of company level tickets and/or ticket filters depending on query params
|
|
74
|
-
* @description: Gets the list of company level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/
|
|
82
|
+
* @description: Gets the list of company level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
|
|
75
83
|
*/
|
|
76
|
-
|
|
84
|
+
getPlatformTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPlatformValidator.GetPlatformTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
|
|
77
85
|
/**
|
|
78
86
|
* @param {Object} arg - Arg object.
|
|
79
87
|
* @param {boolean} [arg.items] - Decides that the reponse will contain the
|
|
@@ -90,7 +98,7 @@ declare class Lead {
|
|
|
90
98
|
* @summary: Gets the list of company level tickets and/or ticket filters depending on query params
|
|
91
99
|
* @description: Gets the list of company level tickets and/or ticket filters
|
|
92
100
|
*/
|
|
93
|
-
|
|
101
|
+
getPlatformTicketsPaginator({ items, filters, q, status, priority, category, pageSize, }?: {
|
|
94
102
|
items?: boolean;
|
|
95
103
|
filters?: boolean;
|
|
96
104
|
q?: string;
|
|
@@ -100,35 +108,38 @@ declare class Lead {
|
|
|
100
108
|
pageSize?: number;
|
|
101
109
|
}): Paginator<LeadPlatformModel.TicketList>;
|
|
102
110
|
/**
|
|
103
|
-
* @param {LeadPlatformValidator.
|
|
104
|
-
* @param {
|
|
105
|
-
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
106
|
-
* Success response
|
|
107
|
-
* @name getTokenForVideoRoom
|
|
108
|
-
* @summary: Get Token to join a specific Video Room using it's unqiue name
|
|
109
|
-
* @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/getTokenForVideoRoom/).
|
|
110
|
-
*/
|
|
111
|
-
getTokenForVideoRoom({ uniqueName }?: LeadPlatformValidator.GetTokenForVideoRoomParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
|
|
112
|
-
/**
|
|
113
|
-
* @param {LeadPlatformValidator.GetVideoParticipantsParam} arg - Arg object
|
|
111
|
+
* @param {LeadPlatformValidator.GetPlatformVideoParticipantsParam} arg - Arg object
|
|
112
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
114
113
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
115
114
|
* @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
|
|
116
115
|
* - Success response
|
|
117
116
|
*
|
|
118
|
-
* @name
|
|
117
|
+
* @name getPlatformVideoParticipants
|
|
119
118
|
* @summary: Get participants of a specific Video Room using it's unique name
|
|
120
|
-
* @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/
|
|
119
|
+
* @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/getPlatformVideoParticipants/).
|
|
120
|
+
*/
|
|
121
|
+
getPlatformVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetPlatformVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
|
|
122
|
+
/**
|
|
123
|
+
* @param {LeadPlatformValidator.GetTokenForPlatformVideoRoomParam} arg - Arg object
|
|
124
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
125
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
126
|
+
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
127
|
+
* Success response
|
|
128
|
+
* @name getTokenForPlatformVideoRoom
|
|
129
|
+
* @summary: Get Token to join a specific Video Room using it's unqiue name
|
|
130
|
+
* @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/getTokenForPlatformVideoRoom/).
|
|
121
131
|
*/
|
|
122
|
-
|
|
132
|
+
getTokenForPlatformVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetTokenForPlatformVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
|
|
123
133
|
/**
|
|
124
134
|
* @param {LeadPlatformValidator.SubmitFeedbackParam} arg - Arg object
|
|
135
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
125
136
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
126
137
|
* @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
|
|
127
138
|
* @name submitFeedback
|
|
128
139
|
* @summary: Submit a response for feeback form against that ticket
|
|
129
140
|
* @description: Submit a response for feeback form against that ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/submitFeedback/).
|
|
130
141
|
*/
|
|
131
|
-
submitFeedback({ id, body }?: LeadPlatformValidator.SubmitFeedbackParam, {
|
|
142
|
+
submitFeedback({ id, body, requestHeaders }?: LeadPlatformValidator.SubmitFeedbackParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedback>;
|
|
132
143
|
}
|
|
133
144
|
import LeadPlatformValidator = require("./LeadPlatformValidator");
|
|
134
145
|
import LeadPlatformModel = require("./LeadPlatformModel");
|