@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -234
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4111 -9093
- package/sdk/platform/Order/OrderPlatformModel.js +3202 -4230
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +22 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +91 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +223 -59
- package/sdk/platform/User/UserPlatformModel.js +204 -65
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +434 -758
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -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 platform 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,91 +255,14 @@ 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
|
-
|
|
335
258
|
/**
|
|
336
259
|
* @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
|
|
337
260
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
338
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
|
-
* @returns {Promise<LeadPlatformModel.
|
|
262
|
+
* @returns {Promise<LeadPlatformModel.GeneralConfigResponse>} - Success response
|
|
340
263
|
* @name getGeneralConfig
|
|
341
264
|
* @summary: Get general configuration
|
|
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/).
|
|
265
|
+
* @description: Get general configuration settings related to support system for company tickets. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
|
|
343
266
|
*/
|
|
344
267
|
async getGeneralConfig(
|
|
345
268
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -388,7 +311,7 @@ class Lead {
|
|
|
388
311
|
|
|
389
312
|
const {
|
|
390
313
|
error: res_error,
|
|
391
|
-
} = LeadPlatformModel.
|
|
314
|
+
} = LeadPlatformModel.GeneralConfigResponse().validate(responseData, {
|
|
392
315
|
abortEarly: false,
|
|
393
316
|
allowUnknown: true,
|
|
394
317
|
});
|
|
@@ -675,85 +598,6 @@ class Lead {
|
|
|
675
598
|
|
|
676
599
|
return response;
|
|
677
600
|
}
|
|
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
|
-
}
|
|
757
601
|
}
|
|
758
602
|
|
|
759
603
|
module.exports = Lead;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = LeadPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef GeneralConfigResponse
|
|
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} [
|
|
21
|
-
* @property {string} [title]
|
|
19
|
+
* @typedef SupportSchema
|
|
20
|
+
* @property {string} [value]
|
|
22
21
|
* @property {string} [description]
|
|
23
22
|
* @property {boolean} [enabled]
|
|
24
23
|
*/
|
|
25
24
|
/**
|
|
26
|
-
* @typedef
|
|
27
|
-
* @property {string} [
|
|
25
|
+
* @typedef SupportCommunicationSchema
|
|
26
|
+
* @property {string} [type]
|
|
27
|
+
* @property {string} [title]
|
|
28
28
|
* @property {string} [description]
|
|
29
29
|
* @property {boolean} [enabled]
|
|
30
30
|
*/
|
|
@@ -47,6 +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} [total] - Total number of items.
|
|
50
51
|
*/
|
|
51
52
|
/**
|
|
52
53
|
* @typedef TicketHistoryList
|
|
@@ -65,7 +66,7 @@ export = LeadPlatformModel;
|
|
|
65
66
|
* @property {Object[]} inputs - List of all the form components
|
|
66
67
|
* @property {string} [description] - Description of the form
|
|
67
68
|
* @property {string} [header_image] - Header image that is to be shown for the form
|
|
68
|
-
* @property {
|
|
69
|
+
* @property {string} priority
|
|
69
70
|
* @property {boolean} [should_notify] - Indicates if staff should be notified
|
|
70
71
|
* when a response is received
|
|
71
72
|
* @property {string} [success_message] - Success message that will be shown on submission
|
|
@@ -76,8 +77,7 @@ export = LeadPlatformModel;
|
|
|
76
77
|
* @property {string} title - Title for the form
|
|
77
78
|
* @property {Object[]} inputs - List of all the form components
|
|
78
79
|
* @property {string} [description] - Description of the form
|
|
79
|
-
* @property {
|
|
80
|
-
* @property {string} [header_image] - Header image that is to be shown for the form
|
|
80
|
+
* @property {string} priority
|
|
81
81
|
* @property {boolean} [should_notify] - Indicates if staff should be notified
|
|
82
82
|
* when a response is received
|
|
83
83
|
* @property {boolean} [login_required] - Denotes if login is required to make a
|
|
@@ -101,12 +101,19 @@ export = LeadPlatformModel;
|
|
|
101
101
|
* @typedef AgentChangePayload
|
|
102
102
|
* @property {string} agent_id - Agent's unique ID
|
|
103
103
|
*/
|
|
104
|
+
/**
|
|
105
|
+
* @typedef NotifyUser
|
|
106
|
+
* @property {string} country_code - Country code
|
|
107
|
+
* @property {string} phone_number - Phone number
|
|
108
|
+
*/
|
|
104
109
|
/**
|
|
105
110
|
* @typedef Filter
|
|
106
111
|
* @property {Priority[]} priorities - List of possible priorities for tickets
|
|
107
112
|
* @property {TicketCategory[]} [categories] - List of possible categories for tickets
|
|
108
113
|
* @property {Status[]} statuses - List of possible statuses for tickets
|
|
109
|
-
* @property {Object[]} assignees - List of support staff availble for tickets
|
|
114
|
+
* @property {Object[]} [assignees] - List of support staff availble for tickets
|
|
115
|
+
* assignment
|
|
116
|
+
* @property {Object} [all_categories]
|
|
110
117
|
*/
|
|
111
118
|
/**
|
|
112
119
|
* @typedef TicketHistoryPayload
|
|
@@ -121,6 +128,7 @@ export = LeadPlatformModel;
|
|
|
121
128
|
/**
|
|
122
129
|
* @typedef CreatedOn
|
|
123
130
|
* @property {string} user_agent - Useragent details
|
|
131
|
+
* @property {string} [platform]
|
|
124
132
|
*/
|
|
125
133
|
/**
|
|
126
134
|
* @typedef TicketAsset
|
|
@@ -134,18 +142,26 @@ export = LeadPlatformModel;
|
|
|
134
142
|
* @property {string} [description] - Long description of issue
|
|
135
143
|
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
136
144
|
*/
|
|
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
|
+
*/
|
|
137
151
|
/**
|
|
138
152
|
* @typedef AddTicketPayload
|
|
139
153
|
* @property {Object} [created_by] - Creator of the ticket
|
|
140
154
|
* @property {string} [status] - Status of the ticket
|
|
141
155
|
* @property {PriorityEnum} [priority]
|
|
142
156
|
* @property {string} category - Category of the ticket
|
|
157
|
+
* @property {AdditionalInfoSchema[]} [additional_info]
|
|
143
158
|
* @property {TicketContent} content
|
|
144
159
|
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
160
|
+
* @property {string[]} [subscribers]
|
|
145
161
|
*/
|
|
146
162
|
/**
|
|
147
163
|
* @typedef Priority
|
|
148
|
-
* @property {
|
|
164
|
+
* @property {string} key - Priority value of the ticket like urgent, low, medium, high.
|
|
149
165
|
* @property {string} display - Display text for priority
|
|
150
166
|
* @property {string} color - Color for priority
|
|
151
167
|
*/
|
|
@@ -188,7 +204,6 @@ export = LeadPlatformModel;
|
|
|
188
204
|
* @property {string} [header_image] - Form header image that will be shown to the user
|
|
189
205
|
* @property {string} title - Form title that will be shown to the user
|
|
190
206
|
* @property {string} [description] - Form description that will be shown to the user
|
|
191
|
-
* @property {Priority} priority
|
|
192
207
|
* @property {boolean} login_required - Denotes if login is required to make a
|
|
193
208
|
* form response submission
|
|
194
209
|
* @property {boolean} should_notify - Denotes if new response submission for
|
|
@@ -199,7 +214,12 @@ export = LeadPlatformModel;
|
|
|
199
214
|
* @property {Object[]} inputs - List of all the form fields
|
|
200
215
|
* @property {CreatedOn} [created_on]
|
|
201
216
|
* @property {PollForAssignment} [poll_for_assignment]
|
|
217
|
+
* @property {string[]} [available_assignees]
|
|
202
218
|
* @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]
|
|
203
223
|
*/
|
|
204
224
|
/**
|
|
205
225
|
* @typedef FeedbackForm
|
|
@@ -211,7 +231,7 @@ export = LeadPlatformModel;
|
|
|
211
231
|
* @typedef TicketCategory
|
|
212
232
|
* @property {string} display - Category display value identifier
|
|
213
233
|
* @property {string} key - Category key value identifier
|
|
214
|
-
* @property {TicketCategory} [sub_categories]
|
|
234
|
+
* @property {TicketCategory[]} [sub_categories]
|
|
215
235
|
* @property {number} [group_id] - Group id of category releted data
|
|
216
236
|
* @property {FeedbackForm} [feedback_form]
|
|
217
237
|
*/
|
|
@@ -219,7 +239,6 @@ export = LeadPlatformModel;
|
|
|
219
239
|
* @typedef FeedbackResponseItem
|
|
220
240
|
* @property {string} display - Question/Title of the form field
|
|
221
241
|
* @property {string} key - Key of the form field
|
|
222
|
-
* @property {string} value - User response value for the form field
|
|
223
242
|
*/
|
|
224
243
|
/**
|
|
225
244
|
* @typedef TicketFeedback
|
|
@@ -231,6 +250,7 @@ export = LeadPlatformModel;
|
|
|
231
250
|
* @property {Object} [user] - User who submitted the feedback
|
|
232
251
|
* @property {string} [updated_at] - Time when the feedback was last updated
|
|
233
252
|
* @property {string} [created_at] - Time when the feedback was created
|
|
253
|
+
* @property {number} [__v]
|
|
234
254
|
*/
|
|
235
255
|
/**
|
|
236
256
|
* @typedef TicketHistory
|
|
@@ -242,6 +262,7 @@ export = LeadPlatformModel;
|
|
|
242
262
|
* @property {string} _id - Unique identifier of the history event
|
|
243
263
|
* @property {string} [updated_at] - Time of last update of the history event
|
|
244
264
|
* @property {string} [created_at] - Time of creation of the history event
|
|
265
|
+
* @property {number} [__v]
|
|
245
266
|
*/
|
|
246
267
|
/**
|
|
247
268
|
* @typedef Ticket
|
|
@@ -266,13 +287,22 @@ export = LeadPlatformModel;
|
|
|
266
287
|
* @property {string} _id - Unique identifier for the ticket
|
|
267
288
|
* @property {string} [updated_at] - Time when the ticket was last updated
|
|
268
289
|
* @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]
|
|
269
301
|
*/
|
|
270
302
|
/**
|
|
271
|
-
* @typedef
|
|
303
|
+
* @typedef NotFoundError
|
|
272
304
|
* @property {string} [message]
|
|
273
305
|
*/
|
|
274
|
-
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
275
|
-
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
276
306
|
/**
|
|
277
307
|
* @typedef {| "image"
|
|
278
308
|
* | "video"
|
|
@@ -284,15 +314,17 @@ export = LeadPlatformModel;
|
|
|
284
314
|
* | "shipment"
|
|
285
315
|
* | "order"} TicketAssetTypeEnum
|
|
286
316
|
*/
|
|
287
|
-
/** @typedef {"
|
|
317
|
+
/** @typedef {"high" | "low" | "medium" | "urgent"} PriorityEnum */
|
|
318
|
+
/** @typedef {"rating" | "log" | "comment" | "diff" | "thread"} HistoryTypeEnum */
|
|
319
|
+
/** @typedef {"platform_panel" | "sales_channel" | "partner_panel"} TicketSourceEnum */
|
|
288
320
|
declare class LeadPlatformModel {
|
|
289
321
|
}
|
|
290
322
|
declare namespace LeadPlatformModel {
|
|
291
|
-
export {
|
|
323
|
+
export { GeneralConfigResponse, SupportSchema, SupportCommunicationSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, NotifyUser, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AdditionalInfoSchema, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, Error4XX, NotFoundError, TicketAssetTypeEnum, PriorityEnum, HistoryTypeEnum, TicketSourceEnum };
|
|
292
324
|
}
|
|
293
|
-
/** @returns {
|
|
294
|
-
declare function
|
|
295
|
-
type
|
|
325
|
+
/** @returns {GeneralConfigResponse} */
|
|
326
|
+
declare function GeneralConfigResponse(): GeneralConfigResponse;
|
|
327
|
+
type GeneralConfigResponse = {
|
|
296
328
|
_id?: string;
|
|
297
329
|
support_communication?: SupportCommunicationSchema[];
|
|
298
330
|
show_communication_info?: boolean;
|
|
@@ -307,6 +339,13 @@ type GeneralConfigDetails = {
|
|
|
307
339
|
support_phone?: SupportSchema;
|
|
308
340
|
support_faq?: SupportSchema;
|
|
309
341
|
};
|
|
342
|
+
/** @returns {SupportSchema} */
|
|
343
|
+
declare function SupportSchema(): SupportSchema;
|
|
344
|
+
type SupportSchema = {
|
|
345
|
+
value?: string;
|
|
346
|
+
description?: string;
|
|
347
|
+
enabled?: boolean;
|
|
348
|
+
};
|
|
310
349
|
/** @returns {SupportCommunicationSchema} */
|
|
311
350
|
declare function SupportCommunicationSchema(): SupportCommunicationSchema;
|
|
312
351
|
type SupportCommunicationSchema = {
|
|
@@ -315,13 +354,6 @@ type SupportCommunicationSchema = {
|
|
|
315
354
|
description?: string;
|
|
316
355
|
enabled?: boolean;
|
|
317
356
|
};
|
|
318
|
-
/** @returns {SupportSchema} */
|
|
319
|
-
declare function SupportSchema(): SupportSchema;
|
|
320
|
-
type SupportSchema = {
|
|
321
|
-
value?: string;
|
|
322
|
-
description?: string;
|
|
323
|
-
enabled?: boolean;
|
|
324
|
-
};
|
|
325
357
|
/** @returns {GeneralConfigIntegrationSchema} */
|
|
326
358
|
declare function GeneralConfigIntegrationSchema(): GeneralConfigIntegrationSchema;
|
|
327
359
|
type GeneralConfigIntegrationSchema = {
|
|
@@ -368,6 +400,10 @@ type Page = {
|
|
|
368
400
|
* - The number of items per page.
|
|
369
401
|
*/
|
|
370
402
|
size?: number;
|
|
403
|
+
/**
|
|
404
|
+
* - Total number of items.
|
|
405
|
+
*/
|
|
406
|
+
total?: number;
|
|
371
407
|
};
|
|
372
408
|
/** @returns {TicketHistoryList} */
|
|
373
409
|
declare function TicketHistoryList(): TicketHistoryList;
|
|
@@ -410,7 +446,7 @@ type CreateCustomFormPayload = {
|
|
|
410
446
|
* - Header image that is to be shown for the form
|
|
411
447
|
*/
|
|
412
448
|
header_image?: string;
|
|
413
|
-
priority:
|
|
449
|
+
priority: string;
|
|
414
450
|
/**
|
|
415
451
|
* - Indicates if staff should be notified
|
|
416
452
|
* when a response is received
|
|
@@ -437,11 +473,7 @@ type EditCustomFormPayload = {
|
|
|
437
473
|
* - Description of the form
|
|
438
474
|
*/
|
|
439
475
|
description?: string;
|
|
440
|
-
priority:
|
|
441
|
-
/**
|
|
442
|
-
* - Header image that is to be shown for the form
|
|
443
|
-
*/
|
|
444
|
-
header_image?: string;
|
|
476
|
+
priority: string;
|
|
445
477
|
/**
|
|
446
478
|
* - Indicates if staff should be notified
|
|
447
479
|
* when a response is received
|
|
@@ -494,6 +526,18 @@ type AgentChangePayload = {
|
|
|
494
526
|
*/
|
|
495
527
|
agent_id: string;
|
|
496
528
|
};
|
|
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
|
+
};
|
|
497
541
|
/** @returns {Filter} */
|
|
498
542
|
declare function Filter(): Filter;
|
|
499
543
|
type Filter = {
|
|
@@ -510,9 +554,11 @@ type Filter = {
|
|
|
510
554
|
*/
|
|
511
555
|
statuses: Status[];
|
|
512
556
|
/**
|
|
513
|
-
* - List of support staff availble for tickets
|
|
557
|
+
* - List of support staff availble for tickets
|
|
558
|
+
* assignment
|
|
514
559
|
*/
|
|
515
|
-
assignees
|
|
560
|
+
assignees?: any[];
|
|
561
|
+
all_categories?: any;
|
|
516
562
|
};
|
|
517
563
|
/** @returns {TicketHistoryPayload} */
|
|
518
564
|
declare function TicketHistoryPayload(): TicketHistoryPayload;
|
|
@@ -542,6 +588,7 @@ type CreatedOn = {
|
|
|
542
588
|
* - Useragent details
|
|
543
589
|
*/
|
|
544
590
|
user_agent: string;
|
|
591
|
+
platform?: string;
|
|
545
592
|
};
|
|
546
593
|
/** @returns {TicketAsset} */
|
|
547
594
|
declare function TicketAsset(): TicketAsset;
|
|
@@ -572,6 +619,22 @@ type TicketContent = {
|
|
|
572
619
|
*/
|
|
573
620
|
attachments?: TicketAsset[];
|
|
574
621
|
};
|
|
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
|
+
};
|
|
575
638
|
/** @returns {AddTicketPayload} */
|
|
576
639
|
declare function AddTicketPayload(): AddTicketPayload;
|
|
577
640
|
type AddTicketPayload = {
|
|
@@ -588,16 +651,21 @@ type AddTicketPayload = {
|
|
|
588
651
|
* - Category of the ticket
|
|
589
652
|
*/
|
|
590
653
|
category: string;
|
|
654
|
+
additional_info?: AdditionalInfoSchema[];
|
|
591
655
|
content: TicketContent;
|
|
592
656
|
/**
|
|
593
657
|
* - Optional custom data that needs to be sent
|
|
594
658
|
*/
|
|
595
659
|
_custom_json?: any;
|
|
660
|
+
subscribers?: string[];
|
|
596
661
|
};
|
|
597
662
|
/** @returns {Priority} */
|
|
598
663
|
declare function Priority(): Priority;
|
|
599
664
|
type Priority = {
|
|
600
|
-
|
|
665
|
+
/**
|
|
666
|
+
* - Priority value of the ticket like urgent, low, medium, high.
|
|
667
|
+
*/
|
|
668
|
+
key: string;
|
|
601
669
|
/**
|
|
602
670
|
* - Display text for priority
|
|
603
671
|
*/
|
|
@@ -704,7 +772,6 @@ type CustomForm = {
|
|
|
704
772
|
* - Form description that will be shown to the user
|
|
705
773
|
*/
|
|
706
774
|
description?: string;
|
|
707
|
-
priority: Priority;
|
|
708
775
|
/**
|
|
709
776
|
* - Denotes if login is required to make a
|
|
710
777
|
* form response submission
|
|
@@ -727,10 +794,15 @@ type CustomForm = {
|
|
|
727
794
|
inputs: any[];
|
|
728
795
|
created_on?: CreatedOn;
|
|
729
796
|
poll_for_assignment?: PollForAssignment;
|
|
797
|
+
available_assignees?: string[];
|
|
730
798
|
/**
|
|
731
799
|
* - Unique identifier for the form
|
|
732
800
|
*/
|
|
733
801
|
_id: string;
|
|
802
|
+
created_at?: string;
|
|
803
|
+
updated_at?: string;
|
|
804
|
+
__v?: number;
|
|
805
|
+
created_by?: string;
|
|
734
806
|
};
|
|
735
807
|
/** @returns {FeedbackForm} */
|
|
736
808
|
declare function FeedbackForm(): FeedbackForm;
|
|
@@ -759,7 +831,7 @@ type TicketCategory = {
|
|
|
759
831
|
* - Category key value identifier
|
|
760
832
|
*/
|
|
761
833
|
key: string;
|
|
762
|
-
sub_categories?: TicketCategory;
|
|
834
|
+
sub_categories?: TicketCategory[];
|
|
763
835
|
/**
|
|
764
836
|
* - Group id of category releted data
|
|
765
837
|
*/
|
|
@@ -777,10 +849,6 @@ type FeedbackResponseItem = {
|
|
|
777
849
|
* - Key of the form field
|
|
778
850
|
*/
|
|
779
851
|
key: string;
|
|
780
|
-
/**
|
|
781
|
-
* - User response value for the form field
|
|
782
|
-
*/
|
|
783
|
-
value: string;
|
|
784
852
|
};
|
|
785
853
|
/** @returns {TicketFeedback} */
|
|
786
854
|
declare function TicketFeedback(): TicketFeedback;
|
|
@@ -814,6 +882,7 @@ type TicketFeedback = {
|
|
|
814
882
|
* - Time when the feedback was created
|
|
815
883
|
*/
|
|
816
884
|
created_at?: string;
|
|
885
|
+
__v?: number;
|
|
817
886
|
};
|
|
818
887
|
/** @returns {TicketHistory} */
|
|
819
888
|
declare function TicketHistory(): TicketHistory;
|
|
@@ -847,6 +916,7 @@ type TicketHistory = {
|
|
|
847
916
|
* - Time of creation of the history event
|
|
848
917
|
*/
|
|
849
918
|
created_at?: string;
|
|
919
|
+
__v?: number;
|
|
850
920
|
};
|
|
851
921
|
/** @returns {Ticket} */
|
|
852
922
|
declare function Ticket(): Ticket;
|
|
@@ -905,37 +975,52 @@ type Ticket = {
|
|
|
905
975
|
* - Time when the ticket was created
|
|
906
976
|
*/
|
|
907
977
|
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;
|
|
908
993
|
};
|
|
909
|
-
/** @returns {
|
|
910
|
-
declare function
|
|
911
|
-
type
|
|
994
|
+
/** @returns {NotFoundError} */
|
|
995
|
+
declare function NotFoundError(): NotFoundError;
|
|
996
|
+
type NotFoundError = {
|
|
912
997
|
message?: string;
|
|
913
998
|
};
|
|
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";
|
|
914
1006
|
/**
|
|
915
1007
|
* Enum: PriorityEnum Used By: Lead
|
|
916
1008
|
*
|
|
917
1009
|
* @returns {PriorityEnum}
|
|
918
1010
|
*/
|
|
919
1011
|
declare function PriorityEnum(): PriorityEnum;
|
|
920
|
-
type PriorityEnum = "
|
|
1012
|
+
type PriorityEnum = "high" | "low" | "medium" | "urgent";
|
|
921
1013
|
/**
|
|
922
1014
|
* Enum: HistoryTypeEnum Used By: Lead
|
|
923
1015
|
*
|
|
924
1016
|
* @returns {HistoryTypeEnum}
|
|
925
1017
|
*/
|
|
926
1018
|
declare function HistoryTypeEnum(): HistoryTypeEnum;
|
|
927
|
-
type HistoryTypeEnum = "rating" | "log" | "comment" | "thread";
|
|
928
|
-
/**
|
|
929
|
-
* Enum: TicketAssetTypeEnum Used By: Lead
|
|
930
|
-
*
|
|
931
|
-
* @returns {TicketAssetTypeEnum}
|
|
932
|
-
*/
|
|
933
|
-
declare function TicketAssetTypeEnum(): TicketAssetTypeEnum;
|
|
934
|
-
type TicketAssetTypeEnum = "image" | "video" | "file" | "youtube" | "product" | "collection" | "brand" | "shipment" | "order";
|
|
1019
|
+
type HistoryTypeEnum = "rating" | "log" | "comment" | "diff" | "thread";
|
|
935
1020
|
/**
|
|
936
1021
|
* Enum: TicketSourceEnum Used By: Lead
|
|
937
1022
|
*
|
|
938
1023
|
* @returns {TicketSourceEnum}
|
|
939
1024
|
*/
|
|
940
1025
|
declare function TicketSourceEnum(): TicketSourceEnum;
|
|
941
|
-
type TicketSourceEnum = "platform_panel" | "sales_channel";
|
|
1026
|
+
type TicketSourceEnum = "platform_panel" | "sales_channel" | "partner_panel";
|