@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.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 +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -104,7 +104,7 @@ class Lead {
|
|
|
104
104
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
105
105
|
* @name createTicket
|
|
106
106
|
* @summary: Create ticket
|
|
107
|
-
* @description: Create a new ticket at
|
|
107
|
+
* @description: Create a new ticket at application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createTicket/).
|
|
108
108
|
*/
|
|
109
109
|
async createTicket(
|
|
110
110
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -255,14 +255,91 @@ class Lead {
|
|
|
255
255
|
return response;
|
|
256
256
|
}
|
|
257
257
|
|
|
258
|
+
/**
|
|
259
|
+
* @param {LeadPlatformValidator.GetFeedbacksParam} arg - Arg object
|
|
260
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
+
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
263
|
+
* @name getFeedbacks
|
|
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
|
+
*/
|
|
267
|
+
async getFeedbacks(
|
|
268
|
+
{ id, requestHeaders } = { requestHeaders: {} },
|
|
269
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
270
|
+
) {
|
|
271
|
+
const { error } = LeadPlatformValidator.getFeedbacks().validate(
|
|
272
|
+
{
|
|
273
|
+
id,
|
|
274
|
+
},
|
|
275
|
+
{ abortEarly: false, allowUnknown: true }
|
|
276
|
+
);
|
|
277
|
+
if (error) {
|
|
278
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
// Showing warrnings if extra unknown parameters are found
|
|
282
|
+
const { error: warrning } = LeadPlatformValidator.getFeedbacks().validate(
|
|
283
|
+
{
|
|
284
|
+
id,
|
|
285
|
+
},
|
|
286
|
+
{ abortEarly: false, allowUnknown: false }
|
|
287
|
+
);
|
|
288
|
+
if (warrning) {
|
|
289
|
+
Logger({
|
|
290
|
+
level: "WARN",
|
|
291
|
+
message: `Parameter Validation warrnings for platform > Lead > getFeedbacks \n ${warrning}`,
|
|
292
|
+
});
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
const query_params = {};
|
|
296
|
+
|
|
297
|
+
const xHeaders = {};
|
|
298
|
+
|
|
299
|
+
const response = await PlatformAPIClient.execute(
|
|
300
|
+
this.config,
|
|
301
|
+
"get",
|
|
302
|
+
`/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}/feedback`,
|
|
303
|
+
query_params,
|
|
304
|
+
undefined,
|
|
305
|
+
{ ...xHeaders, ...requestHeaders },
|
|
306
|
+
{ responseHeaders }
|
|
307
|
+
);
|
|
308
|
+
|
|
309
|
+
let responseData = response;
|
|
310
|
+
if (responseHeaders) {
|
|
311
|
+
responseData = response[0];
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
const {
|
|
315
|
+
error: res_error,
|
|
316
|
+
} = LeadPlatformModel.TicketFeedbackList().validate(responseData, {
|
|
317
|
+
abortEarly: false,
|
|
318
|
+
allowUnknown: true,
|
|
319
|
+
});
|
|
320
|
+
|
|
321
|
+
if (res_error) {
|
|
322
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
323
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
324
|
+
} else {
|
|
325
|
+
Logger({
|
|
326
|
+
level: "WARN",
|
|
327
|
+
message: `Response Validation Warnings for platform > Lead > getFeedbacks \n ${res_error}`,
|
|
328
|
+
});
|
|
329
|
+
}
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
return response;
|
|
333
|
+
}
|
|
334
|
+
|
|
258
335
|
/**
|
|
259
336
|
* @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
|
|
260
337
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
-
* @returns {Promise<LeadPlatformModel.
|
|
339
|
+
* @returns {Promise<LeadPlatformModel.GeneralConfigDetails>} - Success response
|
|
263
340
|
* @name getGeneralConfig
|
|
264
341
|
* @summary: Get general configuration
|
|
265
|
-
* @description: Get general configuration settings related to support system for company tickets
|
|
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/).
|
|
266
343
|
*/
|
|
267
344
|
async getGeneralConfig(
|
|
268
345
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -311,7 +388,7 @@ class Lead {
|
|
|
311
388
|
|
|
312
389
|
const {
|
|
313
390
|
error: res_error,
|
|
314
|
-
} = LeadPlatformModel.
|
|
391
|
+
} = LeadPlatformModel.GeneralConfigDetails().validate(responseData, {
|
|
315
392
|
abortEarly: false,
|
|
316
393
|
allowUnknown: true,
|
|
317
394
|
});
|
|
@@ -598,6 +675,85 @@ class Lead {
|
|
|
598
675
|
|
|
599
676
|
return response;
|
|
600
677
|
}
|
|
678
|
+
|
|
679
|
+
/**
|
|
680
|
+
* @param {LeadPlatformValidator.SubmitFeedbackParam} arg - Arg object
|
|
681
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
682
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
683
|
+
* @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
|
|
684
|
+
* @name submitFeedback
|
|
685
|
+
* @summary: Submit feedback
|
|
686
|
+
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/submitFeedback/).
|
|
687
|
+
*/
|
|
688
|
+
async submitFeedback(
|
|
689
|
+
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
690
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
691
|
+
) {
|
|
692
|
+
const { error } = LeadPlatformValidator.submitFeedback().validate(
|
|
693
|
+
{
|
|
694
|
+
id,
|
|
695
|
+
body,
|
|
696
|
+
},
|
|
697
|
+
{ abortEarly: false, allowUnknown: true }
|
|
698
|
+
);
|
|
699
|
+
if (error) {
|
|
700
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
// Showing warrnings if extra unknown parameters are found
|
|
704
|
+
const { error: warrning } = LeadPlatformValidator.submitFeedback().validate(
|
|
705
|
+
{
|
|
706
|
+
id,
|
|
707
|
+
body,
|
|
708
|
+
},
|
|
709
|
+
{ abortEarly: false, allowUnknown: false }
|
|
710
|
+
);
|
|
711
|
+
if (warrning) {
|
|
712
|
+
Logger({
|
|
713
|
+
level: "WARN",
|
|
714
|
+
message: `Parameter Validation warrnings for platform > Lead > submitFeedback \n ${warrning}`,
|
|
715
|
+
});
|
|
716
|
+
}
|
|
717
|
+
|
|
718
|
+
const query_params = {};
|
|
719
|
+
|
|
720
|
+
const xHeaders = {};
|
|
721
|
+
|
|
722
|
+
const response = await PlatformAPIClient.execute(
|
|
723
|
+
this.config,
|
|
724
|
+
"post",
|
|
725
|
+
`/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}/feedback`,
|
|
726
|
+
query_params,
|
|
727
|
+
body,
|
|
728
|
+
{ ...xHeaders, ...requestHeaders },
|
|
729
|
+
{ responseHeaders }
|
|
730
|
+
);
|
|
731
|
+
|
|
732
|
+
let responseData = response;
|
|
733
|
+
if (responseHeaders) {
|
|
734
|
+
responseData = response[0];
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
const {
|
|
738
|
+
error: res_error,
|
|
739
|
+
} = LeadPlatformModel.TicketFeedback().validate(responseData, {
|
|
740
|
+
abortEarly: false,
|
|
741
|
+
allowUnknown: true,
|
|
742
|
+
});
|
|
743
|
+
|
|
744
|
+
if (res_error) {
|
|
745
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
746
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
747
|
+
} else {
|
|
748
|
+
Logger({
|
|
749
|
+
level: "WARN",
|
|
750
|
+
message: `Response Validation Warnings for platform > Lead > submitFeedback \n ${res_error}`,
|
|
751
|
+
});
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
|
|
755
|
+
return response;
|
|
756
|
+
}
|
|
601
757
|
}
|
|
602
758
|
|
|
603
759
|
module.exports = Lead;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = LeadPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef GeneralConfigDetails
|
|
4
4
|
* @property {string} [_id]
|
|
5
5
|
* @property {SupportCommunicationSchema[]} [support_communication]
|
|
6
6
|
* @property {boolean} [show_communication_info]
|
|
@@ -16,15 +16,15 @@ export = LeadPlatformModel;
|
|
|
16
16
|
* @property {SupportSchema} [support_faq]
|
|
17
17
|
*/
|
|
18
18
|
/**
|
|
19
|
-
* @typedef
|
|
20
|
-
* @property {string} [
|
|
19
|
+
* @typedef SupportCommunicationSchema
|
|
20
|
+
* @property {string} [type]
|
|
21
|
+
* @property {string} [title]
|
|
21
22
|
* @property {string} [description]
|
|
22
23
|
* @property {boolean} [enabled]
|
|
23
24
|
*/
|
|
24
25
|
/**
|
|
25
|
-
* @typedef
|
|
26
|
-
* @property {string} [
|
|
27
|
-
* @property {string} [title]
|
|
26
|
+
* @typedef SupportSchema
|
|
27
|
+
* @property {string} [value]
|
|
28
28
|
* @property {string} [description]
|
|
29
29
|
* @property {boolean} [enabled]
|
|
30
30
|
*/
|
|
@@ -47,7 +47,7 @@ export = LeadPlatformModel;
|
|
|
47
47
|
* @property {number} [current] - The current page number.
|
|
48
48
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
49
49
|
* @property {number} [size] - The number of items per page.
|
|
50
|
-
* @property {number} [
|
|
50
|
+
* @property {number} [page_size] - The number of items per page.
|
|
51
51
|
*/
|
|
52
52
|
/**
|
|
53
53
|
* @typedef TicketHistoryList
|
|
@@ -66,7 +66,7 @@ export = LeadPlatformModel;
|
|
|
66
66
|
* @property {Object[]} inputs - List of all the form components
|
|
67
67
|
* @property {string} [description] - Description of the form
|
|
68
68
|
* @property {string} [header_image] - Header image that is to be shown for the form
|
|
69
|
-
* @property {
|
|
69
|
+
* @property {PriorityEnum} priority
|
|
70
70
|
* @property {boolean} [should_notify] - Indicates if staff should be notified
|
|
71
71
|
* when a response is received
|
|
72
72
|
* @property {string} [success_message] - Success message that will be shown on submission
|
|
@@ -77,7 +77,8 @@ export = LeadPlatformModel;
|
|
|
77
77
|
* @property {string} title - Title for the form
|
|
78
78
|
* @property {Object[]} inputs - List of all the form components
|
|
79
79
|
* @property {string} [description] - Description of the form
|
|
80
|
-
* @property {
|
|
80
|
+
* @property {PriorityEnum} priority
|
|
81
|
+
* @property {string} [header_image] - Header image that is to be shown for the form
|
|
81
82
|
* @property {boolean} [should_notify] - Indicates if staff should be notified
|
|
82
83
|
* when a response is received
|
|
83
84
|
* @property {boolean} [login_required] - Denotes if login is required to make a
|
|
@@ -101,19 +102,12 @@ export = LeadPlatformModel;
|
|
|
101
102
|
* @typedef AgentChangePayload
|
|
102
103
|
* @property {string} agent_id - Agent's unique ID
|
|
103
104
|
*/
|
|
104
|
-
/**
|
|
105
|
-
* @typedef NotifyUser
|
|
106
|
-
* @property {string} country_code - Country code
|
|
107
|
-
* @property {string} phone_number - Phone number
|
|
108
|
-
*/
|
|
109
105
|
/**
|
|
110
106
|
* @typedef Filter
|
|
111
107
|
* @property {Priority[]} priorities - List of possible priorities for tickets
|
|
112
108
|
* @property {TicketCategory[]} [categories] - List of possible categories for tickets
|
|
113
109
|
* @property {Status[]} statuses - List of possible statuses for tickets
|
|
114
|
-
* @property {Object[]}
|
|
115
|
-
* assignment
|
|
116
|
-
* @property {Object} [all_categories]
|
|
110
|
+
* @property {Object[]} assignees - List of support staff availble for tickets assignment
|
|
117
111
|
*/
|
|
118
112
|
/**
|
|
119
113
|
* @typedef TicketHistoryPayload
|
|
@@ -128,7 +122,6 @@ export = LeadPlatformModel;
|
|
|
128
122
|
/**
|
|
129
123
|
* @typedef CreatedOn
|
|
130
124
|
* @property {string} user_agent - Useragent details
|
|
131
|
-
* @property {string} [platform]
|
|
132
125
|
*/
|
|
133
126
|
/**
|
|
134
127
|
* @typedef TicketAsset
|
|
@@ -142,26 +135,18 @@ export = LeadPlatformModel;
|
|
|
142
135
|
* @property {string} [description] - Long description of issue
|
|
143
136
|
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
144
137
|
*/
|
|
145
|
-
/**
|
|
146
|
-
* @typedef AdditionalInfoSchema
|
|
147
|
-
* @property {string} [display_name] - Display name for additional info
|
|
148
|
-
* @property {string} [display_value] - Display value for additional info
|
|
149
|
-
* @property {number} [priority] - Priority for additional info
|
|
150
|
-
*/
|
|
151
138
|
/**
|
|
152
139
|
* @typedef AddTicketPayload
|
|
153
140
|
* @property {Object} [created_by] - Creator of the ticket
|
|
154
141
|
* @property {string} [status] - Status of the ticket
|
|
155
142
|
* @property {PriorityEnum} [priority]
|
|
156
143
|
* @property {string} category - Category of the ticket
|
|
157
|
-
* @property {AdditionalInfoSchema[]} [additional_info]
|
|
158
144
|
* @property {TicketContent} content
|
|
159
145
|
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
160
|
-
* @property {string[]} [subscribers]
|
|
161
146
|
*/
|
|
162
147
|
/**
|
|
163
148
|
* @typedef Priority
|
|
164
|
-
* @property {
|
|
149
|
+
* @property {PriorityEnum} key
|
|
165
150
|
* @property {string} display - Display text for priority
|
|
166
151
|
* @property {string} color - Color for priority
|
|
167
152
|
*/
|
|
@@ -204,6 +189,7 @@ export = LeadPlatformModel;
|
|
|
204
189
|
* @property {string} [header_image] - Form header image that will be shown to the user
|
|
205
190
|
* @property {string} title - Form title that will be shown to the user
|
|
206
191
|
* @property {string} [description] - Form description that will be shown to the user
|
|
192
|
+
* @property {Priority} priority
|
|
207
193
|
* @property {boolean} login_required - Denotes if login is required to make a
|
|
208
194
|
* form response submission
|
|
209
195
|
* @property {boolean} should_notify - Denotes if new response submission for
|
|
@@ -214,12 +200,7 @@ export = LeadPlatformModel;
|
|
|
214
200
|
* @property {Object[]} inputs - List of all the form fields
|
|
215
201
|
* @property {CreatedOn} [created_on]
|
|
216
202
|
* @property {PollForAssignment} [poll_for_assignment]
|
|
217
|
-
* @property {string[]} [available_assignees]
|
|
218
203
|
* @property {string} _id - Unique identifier for the form
|
|
219
|
-
* @property {string} [created_at]
|
|
220
|
-
* @property {string} [updated_at]
|
|
221
|
-
* @property {number} [__v]
|
|
222
|
-
* @property {string} [created_by]
|
|
223
204
|
*/
|
|
224
205
|
/**
|
|
225
206
|
* @typedef FeedbackForm
|
|
@@ -231,7 +212,7 @@ export = LeadPlatformModel;
|
|
|
231
212
|
* @typedef TicketCategory
|
|
232
213
|
* @property {string} display - Category display value identifier
|
|
233
214
|
* @property {string} key - Category key value identifier
|
|
234
|
-
* @property {TicketCategory
|
|
215
|
+
* @property {TicketCategory} [sub_categories]
|
|
235
216
|
* @property {number} [group_id] - Group id of category releted data
|
|
236
217
|
* @property {FeedbackForm} [feedback_form]
|
|
237
218
|
*/
|
|
@@ -239,6 +220,7 @@ export = LeadPlatformModel;
|
|
|
239
220
|
* @typedef FeedbackResponseItem
|
|
240
221
|
* @property {string} display - Question/Title of the form field
|
|
241
222
|
* @property {string} key - Key of the form field
|
|
223
|
+
* @property {string} value - User response value for the form field
|
|
242
224
|
*/
|
|
243
225
|
/**
|
|
244
226
|
* @typedef TicketFeedback
|
|
@@ -250,7 +232,6 @@ export = LeadPlatformModel;
|
|
|
250
232
|
* @property {Object} [user] - User who submitted the feedback
|
|
251
233
|
* @property {string} [updated_at] - Time when the feedback was last updated
|
|
252
234
|
* @property {string} [created_at] - Time when the feedback was created
|
|
253
|
-
* @property {number} [__v]
|
|
254
235
|
*/
|
|
255
236
|
/**
|
|
256
237
|
* @typedef TicketHistory
|
|
@@ -262,7 +243,6 @@ export = LeadPlatformModel;
|
|
|
262
243
|
* @property {string} _id - Unique identifier of the history event
|
|
263
244
|
* @property {string} [updated_at] - Time of last update of the history event
|
|
264
245
|
* @property {string} [created_at] - Time of creation of the history event
|
|
265
|
-
* @property {number} [__v]
|
|
266
246
|
*/
|
|
267
247
|
/**
|
|
268
248
|
* @typedef Ticket
|
|
@@ -287,22 +267,13 @@ export = LeadPlatformModel;
|
|
|
287
267
|
* @property {string} _id - Unique identifier for the ticket
|
|
288
268
|
* @property {string} [updated_at] - Time when the ticket was last updated
|
|
289
269
|
* @property {string} [created_at] - Time when the ticket was created
|
|
290
|
-
* @property {string} [video_room_id]
|
|
291
|
-
* @property {string[]} [subscribers]
|
|
292
|
-
* @property {AdditionalInfoSchema[]} [additional_info]
|
|
293
|
-
* @property {number} [__v]
|
|
294
|
-
* @property {TicketAsset[]} [attachments] - List of all attachments related to the form
|
|
295
|
-
*/
|
|
296
|
-
/**
|
|
297
|
-
* @typedef Error4XX
|
|
298
|
-
* @property {Object} [message]
|
|
299
|
-
* @property {string} [stack]
|
|
300
|
-
* @property {string} [sentry]
|
|
301
270
|
*/
|
|
302
271
|
/**
|
|
303
|
-
* @typedef
|
|
272
|
+
* @typedef ErrorMessage
|
|
304
273
|
* @property {string} [message]
|
|
305
274
|
*/
|
|
275
|
+
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
276
|
+
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
306
277
|
/**
|
|
307
278
|
* @typedef {| "image"
|
|
308
279
|
* | "video"
|
|
@@ -314,17 +285,15 @@ export = LeadPlatformModel;
|
|
|
314
285
|
* | "shipment"
|
|
315
286
|
* | "order"} TicketAssetTypeEnum
|
|
316
287
|
*/
|
|
317
|
-
/** @typedef {"
|
|
318
|
-
/** @typedef {"rating" | "log" | "comment" | "diff" | "thread"} HistoryTypeEnum */
|
|
319
|
-
/** @typedef {"platform_panel" | "sales_channel" | "partner_panel"} TicketSourceEnum */
|
|
288
|
+
/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
|
|
320
289
|
declare class LeadPlatformModel {
|
|
321
290
|
}
|
|
322
291
|
declare namespace LeadPlatformModel {
|
|
323
|
-
export {
|
|
292
|
+
export { GeneralConfigDetails, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
324
293
|
}
|
|
325
|
-
/** @returns {
|
|
326
|
-
declare function
|
|
327
|
-
type
|
|
294
|
+
/** @returns {GeneralConfigDetails} */
|
|
295
|
+
declare function GeneralConfigDetails(): GeneralConfigDetails;
|
|
296
|
+
type GeneralConfigDetails = {
|
|
328
297
|
_id?: string;
|
|
329
298
|
support_communication?: SupportCommunicationSchema[];
|
|
330
299
|
show_communication_info?: boolean;
|
|
@@ -339,13 +308,6 @@ type GeneralConfigResponse = {
|
|
|
339
308
|
support_phone?: SupportSchema;
|
|
340
309
|
support_faq?: SupportSchema;
|
|
341
310
|
};
|
|
342
|
-
/** @returns {SupportSchema} */
|
|
343
|
-
declare function SupportSchema(): SupportSchema;
|
|
344
|
-
type SupportSchema = {
|
|
345
|
-
value?: string;
|
|
346
|
-
description?: string;
|
|
347
|
-
enabled?: boolean;
|
|
348
|
-
};
|
|
349
311
|
/** @returns {SupportCommunicationSchema} */
|
|
350
312
|
declare function SupportCommunicationSchema(): SupportCommunicationSchema;
|
|
351
313
|
type SupportCommunicationSchema = {
|
|
@@ -354,6 +316,13 @@ type SupportCommunicationSchema = {
|
|
|
354
316
|
description?: string;
|
|
355
317
|
enabled?: boolean;
|
|
356
318
|
};
|
|
319
|
+
/** @returns {SupportSchema} */
|
|
320
|
+
declare function SupportSchema(): SupportSchema;
|
|
321
|
+
type SupportSchema = {
|
|
322
|
+
value?: string;
|
|
323
|
+
description?: string;
|
|
324
|
+
enabled?: boolean;
|
|
325
|
+
};
|
|
357
326
|
/** @returns {GeneralConfigIntegrationSchema} */
|
|
358
327
|
declare function GeneralConfigIntegrationSchema(): GeneralConfigIntegrationSchema;
|
|
359
328
|
type GeneralConfigIntegrationSchema = {
|
|
@@ -401,9 +370,9 @@ type Page = {
|
|
|
401
370
|
*/
|
|
402
371
|
size?: number;
|
|
403
372
|
/**
|
|
404
|
-
* -
|
|
373
|
+
* - The number of items per page.
|
|
405
374
|
*/
|
|
406
|
-
|
|
375
|
+
page_size?: number;
|
|
407
376
|
};
|
|
408
377
|
/** @returns {TicketHistoryList} */
|
|
409
378
|
declare function TicketHistoryList(): TicketHistoryList;
|
|
@@ -446,7 +415,7 @@ type CreateCustomFormPayload = {
|
|
|
446
415
|
* - Header image that is to be shown for the form
|
|
447
416
|
*/
|
|
448
417
|
header_image?: string;
|
|
449
|
-
priority:
|
|
418
|
+
priority: PriorityEnum;
|
|
450
419
|
/**
|
|
451
420
|
* - Indicates if staff should be notified
|
|
452
421
|
* when a response is received
|
|
@@ -473,7 +442,11 @@ type EditCustomFormPayload = {
|
|
|
473
442
|
* - Description of the form
|
|
474
443
|
*/
|
|
475
444
|
description?: string;
|
|
476
|
-
priority:
|
|
445
|
+
priority: PriorityEnum;
|
|
446
|
+
/**
|
|
447
|
+
* - Header image that is to be shown for the form
|
|
448
|
+
*/
|
|
449
|
+
header_image?: string;
|
|
477
450
|
/**
|
|
478
451
|
* - Indicates if staff should be notified
|
|
479
452
|
* when a response is received
|
|
@@ -526,18 +499,6 @@ type AgentChangePayload = {
|
|
|
526
499
|
*/
|
|
527
500
|
agent_id: string;
|
|
528
501
|
};
|
|
529
|
-
/** @returns {NotifyUser} */
|
|
530
|
-
declare function NotifyUser(): NotifyUser;
|
|
531
|
-
type NotifyUser = {
|
|
532
|
-
/**
|
|
533
|
-
* - Country code
|
|
534
|
-
*/
|
|
535
|
-
country_code: string;
|
|
536
|
-
/**
|
|
537
|
-
* - Phone number
|
|
538
|
-
*/
|
|
539
|
-
phone_number: string;
|
|
540
|
-
};
|
|
541
502
|
/** @returns {Filter} */
|
|
542
503
|
declare function Filter(): Filter;
|
|
543
504
|
type Filter = {
|
|
@@ -554,11 +515,9 @@ type Filter = {
|
|
|
554
515
|
*/
|
|
555
516
|
statuses: Status[];
|
|
556
517
|
/**
|
|
557
|
-
* - List of support staff availble for tickets
|
|
558
|
-
* assignment
|
|
518
|
+
* - List of support staff availble for tickets assignment
|
|
559
519
|
*/
|
|
560
|
-
assignees
|
|
561
|
-
all_categories?: any;
|
|
520
|
+
assignees: any[];
|
|
562
521
|
};
|
|
563
522
|
/** @returns {TicketHistoryPayload} */
|
|
564
523
|
declare function TicketHistoryPayload(): TicketHistoryPayload;
|
|
@@ -588,7 +547,6 @@ type CreatedOn = {
|
|
|
588
547
|
* - Useragent details
|
|
589
548
|
*/
|
|
590
549
|
user_agent: string;
|
|
591
|
-
platform?: string;
|
|
592
550
|
};
|
|
593
551
|
/** @returns {TicketAsset} */
|
|
594
552
|
declare function TicketAsset(): TicketAsset;
|
|
@@ -619,22 +577,6 @@ type TicketContent = {
|
|
|
619
577
|
*/
|
|
620
578
|
attachments?: TicketAsset[];
|
|
621
579
|
};
|
|
622
|
-
/** @returns {AdditionalInfoSchema} */
|
|
623
|
-
declare function AdditionalInfoSchema(): AdditionalInfoSchema;
|
|
624
|
-
type AdditionalInfoSchema = {
|
|
625
|
-
/**
|
|
626
|
-
* - Display name for additional info
|
|
627
|
-
*/
|
|
628
|
-
display_name?: string;
|
|
629
|
-
/**
|
|
630
|
-
* - Display value for additional info
|
|
631
|
-
*/
|
|
632
|
-
display_value?: string;
|
|
633
|
-
/**
|
|
634
|
-
* - Priority for additional info
|
|
635
|
-
*/
|
|
636
|
-
priority?: number;
|
|
637
|
-
};
|
|
638
580
|
/** @returns {AddTicketPayload} */
|
|
639
581
|
declare function AddTicketPayload(): AddTicketPayload;
|
|
640
582
|
type AddTicketPayload = {
|
|
@@ -651,21 +593,16 @@ type AddTicketPayload = {
|
|
|
651
593
|
* - Category of the ticket
|
|
652
594
|
*/
|
|
653
595
|
category: string;
|
|
654
|
-
additional_info?: AdditionalInfoSchema[];
|
|
655
596
|
content: TicketContent;
|
|
656
597
|
/**
|
|
657
598
|
* - Optional custom data that needs to be sent
|
|
658
599
|
*/
|
|
659
600
|
_custom_json?: any;
|
|
660
|
-
subscribers?: string[];
|
|
661
601
|
};
|
|
662
602
|
/** @returns {Priority} */
|
|
663
603
|
declare function Priority(): Priority;
|
|
664
604
|
type Priority = {
|
|
665
|
-
|
|
666
|
-
* - Priority value of the ticket like urgent, low, medium, high.
|
|
667
|
-
*/
|
|
668
|
-
key: string;
|
|
605
|
+
key: PriorityEnum;
|
|
669
606
|
/**
|
|
670
607
|
* - Display text for priority
|
|
671
608
|
*/
|
|
@@ -772,6 +709,7 @@ type CustomForm = {
|
|
|
772
709
|
* - Form description that will be shown to the user
|
|
773
710
|
*/
|
|
774
711
|
description?: string;
|
|
712
|
+
priority: Priority;
|
|
775
713
|
/**
|
|
776
714
|
* - Denotes if login is required to make a
|
|
777
715
|
* form response submission
|
|
@@ -794,15 +732,10 @@ type CustomForm = {
|
|
|
794
732
|
inputs: any[];
|
|
795
733
|
created_on?: CreatedOn;
|
|
796
734
|
poll_for_assignment?: PollForAssignment;
|
|
797
|
-
available_assignees?: string[];
|
|
798
735
|
/**
|
|
799
736
|
* - Unique identifier for the form
|
|
800
737
|
*/
|
|
801
738
|
_id: string;
|
|
802
|
-
created_at?: string;
|
|
803
|
-
updated_at?: string;
|
|
804
|
-
__v?: number;
|
|
805
|
-
created_by?: string;
|
|
806
739
|
};
|
|
807
740
|
/** @returns {FeedbackForm} */
|
|
808
741
|
declare function FeedbackForm(): FeedbackForm;
|
|
@@ -831,7 +764,7 @@ type TicketCategory = {
|
|
|
831
764
|
* - Category key value identifier
|
|
832
765
|
*/
|
|
833
766
|
key: string;
|
|
834
|
-
sub_categories?: TicketCategory
|
|
767
|
+
sub_categories?: TicketCategory;
|
|
835
768
|
/**
|
|
836
769
|
* - Group id of category releted data
|
|
837
770
|
*/
|
|
@@ -849,6 +782,10 @@ type FeedbackResponseItem = {
|
|
|
849
782
|
* - Key of the form field
|
|
850
783
|
*/
|
|
851
784
|
key: string;
|
|
785
|
+
/**
|
|
786
|
+
* - User response value for the form field
|
|
787
|
+
*/
|
|
788
|
+
value: string;
|
|
852
789
|
};
|
|
853
790
|
/** @returns {TicketFeedback} */
|
|
854
791
|
declare function TicketFeedback(): TicketFeedback;
|
|
@@ -882,7 +819,6 @@ type TicketFeedback = {
|
|
|
882
819
|
* - Time when the feedback was created
|
|
883
820
|
*/
|
|
884
821
|
created_at?: string;
|
|
885
|
-
__v?: number;
|
|
886
822
|
};
|
|
887
823
|
/** @returns {TicketHistory} */
|
|
888
824
|
declare function TicketHistory(): TicketHistory;
|
|
@@ -916,7 +852,6 @@ type TicketHistory = {
|
|
|
916
852
|
* - Time of creation of the history event
|
|
917
853
|
*/
|
|
918
854
|
created_at?: string;
|
|
919
|
-
__v?: number;
|
|
920
855
|
};
|
|
921
856
|
/** @returns {Ticket} */
|
|
922
857
|
declare function Ticket(): Ticket;
|
|
@@ -975,52 +910,37 @@ type Ticket = {
|
|
|
975
910
|
* - Time when the ticket was created
|
|
976
911
|
*/
|
|
977
912
|
created_at?: string;
|
|
978
|
-
video_room_id?: string;
|
|
979
|
-
subscribers?: string[];
|
|
980
|
-
additional_info?: AdditionalInfoSchema[];
|
|
981
|
-
__v?: number;
|
|
982
|
-
/**
|
|
983
|
-
* - List of all attachments related to the form
|
|
984
|
-
*/
|
|
985
|
-
attachments?: TicketAsset[];
|
|
986
|
-
};
|
|
987
|
-
/** @returns {Error4XX} */
|
|
988
|
-
declare function Error4XX(): Error4XX;
|
|
989
|
-
type Error4XX = {
|
|
990
|
-
message?: any;
|
|
991
|
-
stack?: string;
|
|
992
|
-
sentry?: string;
|
|
993
913
|
};
|
|
994
|
-
/** @returns {
|
|
995
|
-
declare function
|
|
996
|
-
type
|
|
914
|
+
/** @returns {ErrorMessage} */
|
|
915
|
+
declare function ErrorMessage(): ErrorMessage;
|
|
916
|
+
type ErrorMessage = {
|
|
997
917
|
message?: string;
|
|
998
918
|
};
|
|
999
|
-
/**
|
|
1000
|
-
* Enum: TicketAssetTypeEnum Used By: Lead
|
|
1001
|
-
*
|
|
1002
|
-
* @returns {TicketAssetTypeEnum}
|
|
1003
|
-
*/
|
|
1004
|
-
declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
|
|
1005
|
-
type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
|
|
1006
919
|
/**
|
|
1007
920
|
* Enum: PriorityEnum Used By: Lead
|
|
1008
921
|
*
|
|
1009
922
|
* @returns {PriorityEnum}
|
|
1010
923
|
*/
|
|
1011
924
|
declare function PriorityEnum(): PriorityEnum;
|
|
1012
|
-
type PriorityEnum = "
|
|
925
|
+
type PriorityEnum = "low" | "medium" | "high" | "urgent";
|
|
1013
926
|
/**
|
|
1014
927
|
* Enum: HistoryTypeEnum Used By: Lead
|
|
1015
928
|
*
|
|
1016
929
|
* @returns {HistoryTypeEnum}
|
|
1017
930
|
*/
|
|
1018
931
|
declare function HistoryTypeEnum(): HistoryTypeEnum;
|
|
1019
|
-
type HistoryTypeEnum = "rating" | "log" | "comment" | "
|
|
932
|
+
type HistoryTypeEnum = "rating" | "log" | "comment" | "thread";
|
|
933
|
+
/**
|
|
934
|
+
* Enum: TicketAssetTypeEnum Used By: Lead
|
|
935
|
+
*
|
|
936
|
+
* @returns {TicketAssetTypeEnum}
|
|
937
|
+
*/
|
|
938
|
+
declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
|
|
939
|
+
type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
|
|
1020
940
|
/**
|
|
1021
941
|
* Enum: TicketSourceEnum Used By: Lead
|
|
1022
942
|
*
|
|
1023
943
|
* @returns {TicketSourceEnum}
|
|
1024
944
|
*/
|
|
1025
945
|
declare function TicketSourceEnum(): TicketSourceEnum;
|
|
1026
|
-
type TicketSourceEnum = "platform_panel" | "sales_channel"
|
|
946
|
+
type TicketSourceEnum = "platform_panel" | "sales_channel";
|