@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6

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.
Files changed (155) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -2
  3. package/sdk/application/ApplicationClient.js +20 -0
  4. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  5. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  6. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  7. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  8. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  9. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  10. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  11. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  12. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  13. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  15. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  16. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  17. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  19. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  20. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  21. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  22. package/sdk/application/Lead/LeadApplicationModel.js +1 -1
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  26. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  27. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  28. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  29. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  30. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  31. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  32. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  33. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  34. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  35. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  36. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  37. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  38. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  39. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  40. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  41. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
  42. package/sdk/application/Share/ShareApplicationModel.js +0 -4
  43. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  44. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  45. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  46. package/sdk/application/User/UserApplicationClient.js +64 -64
  47. package/sdk/common/Clickstream.d.ts +1 -0
  48. package/sdk/common/Clickstream.js +246 -0
  49. package/sdk/common/Utility.js +1 -4
  50. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  51. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  52. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  53. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  54. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  55. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  56. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  57. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  58. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  59. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  60. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  61. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  62. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  63. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  64. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  65. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  66. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  67. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  68. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  69. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  70. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  71. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  72. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  73. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  74. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  75. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  76. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  77. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  78. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  79. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  80. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  81. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  82. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  83. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  84. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  85. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  86. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  87. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  88. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  89. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  90. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  91. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  92. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  93. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  94. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  95. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
  96. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
  97. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
  98. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
  99. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  100. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  101. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
  102. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
  103. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  104. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  105. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  106. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  107. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  108. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  109. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  110. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  111. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  112. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  113. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  114. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  115. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  116. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  117. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  118. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  119. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  120. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  121. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  122. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  123. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  124. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  125. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  126. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  127. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  128. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
  131. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
  132. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  133. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  134. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  135. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  136. package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
  137. package/sdk/platform/Share/SharePlatformModel.js +0 -4
  138. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  139. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  140. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  141. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  142. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  143. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  144. package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
  145. package/sdk/platform/User/UserPlatformModel.js +4 -4
  146. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  147. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  148. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  149. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  150. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  151. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  152. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  153. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  154. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  155. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -20,9 +20,8 @@ class Webhook {
20
20
  * @param {import("../PlatformAPIClient").Options} - Options
21
21
  * @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
22
22
  * @name cancelJobByName
23
- * @summary: Cancel a report export.
24
- * @description: Cancel the export of a specific report for a company.
25
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
23
+ * @summary: Cancel job by name.
24
+ * @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
26
25
  */
27
26
  async cancelJobByName(
28
27
  { filename, requestHeaders } = { requestHeaders: {} },
@@ -100,9 +99,8 @@ class Webhook {
100
99
  * @param {import("../PlatformAPIClient").Options} - Options
101
100
  * @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
102
101
  * @name downloadDeliveryReport
103
- * @summary: Download processed events report for a company.
104
- * @description: Download reports for a specific company based on the provided filters.
105
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
102
+ * @summary: Download delivery report.
103
+ * @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
106
104
  */
107
105
  async downloadDeliveryReport(
108
106
  { body, requestHeaders } = { requestHeaders: {} },
@@ -182,9 +180,8 @@ class Webhook {
182
180
  * @param {import("../PlatformAPIClient").Options} - Options
183
181
  * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
184
182
  * @name fetchAllEventConfigurations
185
- * @summary: Get All Webhook Events.
186
- * @description: To fetch all webhook events.
187
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
183
+ * @summary: Fetch all event configurations.
184
+ * @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
188
185
  */
189
186
  async fetchAllEventConfigurations(
190
187
  { requestHeaders } = { requestHeaders: {} },
@@ -260,9 +257,8 @@ class Webhook {
260
257
  * @param {import("../PlatformAPIClient").Options} - Options
261
258
  * @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
262
259
  * @name getDeliveryReports
263
- * @summary: Get processed events report for a company.
264
- * @description: Retrieve a list of processed events for a specific company based on the provided filters.
265
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
260
+ * @summary: Get delivery reports.
261
+ * @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
266
262
  */
267
263
  async getDeliveryReports(
268
264
  { body, requestHeaders } = { requestHeaders: {} },
@@ -340,9 +336,8 @@ class Webhook {
340
336
  * @param {import("../PlatformAPIClient").Options} - Options
341
337
  * @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
342
338
  * @name getEventCounts
343
- * @summary: Get the count of failed events for a company within a specified date range.
344
- * @description: Retrieves the count of failed events for a specific company within the specified date range. The user can filter the count based on specific event types if provided.
345
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
339
+ * @summary: Get event counts.
340
+ * @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
346
341
  */
347
342
  async getEventCounts(
348
343
  { body, requestHeaders } = { requestHeaders: {} },
@@ -420,9 +415,8 @@ class Webhook {
420
415
  * @param {import("../PlatformAPIClient").Options} - Options
421
416
  * @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
422
417
  * @name getHistoricalReports
423
- * @summary: Get report download history.
424
- * @description: Retrieve history reports for a specific company based on the provided filters.
425
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
418
+ * @summary: Get historical reports.
419
+ * @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
426
420
  */
427
421
  async getHistoricalReports(
428
422
  { body, requestHeaders } = { requestHeaders: {} },
@@ -500,9 +494,8 @@ class Webhook {
500
494
  * @param {import("../PlatformAPIClient").Options} - Options
501
495
  * @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
502
496
  * @name getManualRetryStatus
503
- * @summary: Get the retry status for a company's failed events.
504
- * @description: Retrieves the status of retry for a specific company's failed events. This endpoint returns the total number of events, the count of successfully retried events, the count of failed retry attempts, and the overall status of the retry process.
505
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
497
+ * @summary: Get manual retry status.
498
+ * @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
506
499
  */
507
500
  async getManualRetryStatus(
508
501
  { requestHeaders } = { requestHeaders: {} },
@@ -576,9 +569,8 @@ class Webhook {
576
569
  * @param {import("../PlatformAPIClient").Options} - Options
577
570
  * @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
578
571
  * @name getReportFilters
579
- * @summary: Get filters for a company.
580
- * @description: Retrieve filters for a specific company based on the provided subscriber IDs.
581
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
572
+ * @summary: Get report filters.
573
+ * @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
582
574
  */
583
575
  async getReportFilters(
584
576
  { body, requestHeaders } = { requestHeaders: {} },
@@ -653,8 +645,8 @@ class Webhook {
653
645
  * @param {import("../PlatformAPIClient").Options} - Options
654
646
  * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
655
647
  * @name getSubscriberById
656
- * @summary: Get Subscriber By Subscriber ID
657
- * @description: Get Subscriber By Subscriber ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
648
+ * @summary: Get subscriber by ID.
649
+ * @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
658
650
  */
659
651
  async getSubscriberById(
660
652
  { subscriberId, requestHeaders } = { requestHeaders: {} },
@@ -732,9 +724,8 @@ class Webhook {
732
724
  * @param {import("../PlatformAPIClient").Options} - Options
733
725
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
734
726
  * @name getSubscribersByCompany
735
- * @summary: Get Subscribers By CompanyId.
736
- * @description: Get Subscribers By Company ID.
737
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
727
+ * @summary: Get subscribers by company.
728
+ * @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
738
729
  */
739
730
  async getSubscribersByCompany(
740
731
  { pageNo, pageSize, extensionId, requestHeaders } = { requestHeaders: {} },
@@ -821,8 +812,8 @@ class Webhook {
821
812
  * @param {import("../PlatformAPIClient").Options} - Options
822
813
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
823
814
  * @name getSubscribersByExtensionId
824
- * @summary: Get Subscribers By Extension ID
825
- * @description: Get Subscribers By ExtensionID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
815
+ * @summary: Get subscribers by extension ID.
816
+ * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
826
817
  */
827
818
  async getSubscribersByExtensionId(
828
819
  { extensionId, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -908,9 +899,8 @@ class Webhook {
908
899
  * @param {import("../PlatformAPIClient").Options} - Options
909
900
  * @returns {Promise<string>} - Success response
910
901
  * @name manualRetryCancel
911
- * @summary: Cancel the active manual retry for a company's failed events.
912
- * @description: Cancels the active manual retry for a specific company's failed events. If a manual retry is currently in progress, it will be cancelled.
913
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
902
+ * @summary: Manual retry cancellation.
903
+ * @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
914
904
  */
915
905
  async manualRetryCancel(
916
906
  { requestHeaders } = { requestHeaders: {} },
@@ -981,9 +971,8 @@ class Webhook {
981
971
  * @param {import("../PlatformAPIClient").Options} - Options
982
972
  * @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
983
973
  * @name manualRetryOfFailedEvent
984
- * @summary: Initiate a manual retry for event processing.
985
- * @description: Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.
986
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
974
+ * @summary: Manual retry of failed event.
975
+ * @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
987
976
  */
988
977
  async manualRetryOfFailedEvent(
989
978
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1063,9 +1052,8 @@ class Webhook {
1063
1052
  * @param {import("../PlatformAPIClient").Options} - Options
1064
1053
  * @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
1065
1054
  * @name pingWebhook
1066
- * @summary: Ping and validate webhook url.
1067
- * @description: Ping and validate webhook url.
1068
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
1055
+ * @summary: Ping webhook.
1056
+ * @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
1069
1057
  */
1070
1058
  async pingWebhook(
1071
1059
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1142,9 +1130,8 @@ class Webhook {
1142
1130
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
1143
1131
  * Success response
1144
1132
  * @name registerSubscriberToEvent
1145
- * @summary: Register Subscriber.
1146
- * @description: Register Subscriber.
1147
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
1133
+ * @summary: Register subscriber to event.
1134
+ * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
1148
1135
  */
1149
1136
  async registerSubscriberToEvent(
1150
1137
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1225,8 +1212,8 @@ class Webhook {
1225
1212
  * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
1226
1213
  * Success response
1227
1214
  * @name updateSubscriberConfig
1228
- * @summary: Update Subscriber
1229
- * @description: Update Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
1215
+ * @summary: Update subscriber config.
1216
+ * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
1230
1217
  */
1231
1218
  async updateSubscriberConfig(
1232
1219
  { body, requestHeaders } = { requestHeaders: {} },
@@ -203,6 +203,33 @@ export = WebhookPlatformModel;
203
203
  * @property {string} [type]
204
204
  * @property {string} [secret]
205
205
  */
206
+ /**
207
+ * @typedef SubscriberFailureResponse
208
+ * @property {string} [message]
209
+ * @property {string} [code]
210
+ * @property {string} [stack]
211
+ */
212
+ /**
213
+ * @typedef EventConfigs
214
+ * @property {number} [id]
215
+ * @property {string} [event_name]
216
+ * @property {string} [event_type]
217
+ * @property {string} [event_category]
218
+ * @property {Object} [event_schema]
219
+ * @property {string} [version]
220
+ * @property {string} [display_name]
221
+ * @property {string} [description]
222
+ * @property {string} [created_on]
223
+ * @property {string} [updated_on]
224
+ * @property {SubscriberEventMapping} [subscriber_event_mapping]
225
+ */
226
+ /**
227
+ * @typedef SubscriberEventMapping
228
+ * @property {number} [id]
229
+ * @property {number} [event_id]
230
+ * @property {number} [subscriber_id]
231
+ * @property {string} [created_on]
232
+ */
206
233
  /**
207
234
  * @typedef SubscriberResponse
208
235
  * @property {number} [id]
@@ -256,7 +283,7 @@ export = WebhookPlatformModel;
256
283
  declare class WebhookPlatformModel {
257
284
  }
258
285
  declare namespace WebhookPlatformModel {
259
- export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
286
+ export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberFailureResponse, EventConfigs, SubscriberEventMapping, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
260
287
  }
261
288
  /** @returns {Error} */
262
289
  declare function Error(): Error;
@@ -610,6 +637,36 @@ type AuthMeta = {
610
637
  type?: string;
611
638
  secret?: string;
612
639
  };
640
+ /** @returns {SubscriberFailureResponse} */
641
+ declare function SubscriberFailureResponse(): SubscriberFailureResponse;
642
+ type SubscriberFailureResponse = {
643
+ message?: string;
644
+ code?: string;
645
+ stack?: string;
646
+ };
647
+ /** @returns {EventConfigs} */
648
+ declare function EventConfigs(): EventConfigs;
649
+ type EventConfigs = {
650
+ id?: number;
651
+ event_name?: string;
652
+ event_type?: string;
653
+ event_category?: string;
654
+ event_schema?: any;
655
+ version?: string;
656
+ display_name?: string;
657
+ description?: string;
658
+ created_on?: string;
659
+ updated_on?: string;
660
+ subscriber_event_mapping?: SubscriberEventMapping;
661
+ };
662
+ /** @returns {SubscriberEventMapping} */
663
+ declare function SubscriberEventMapping(): SubscriberEventMapping;
664
+ type SubscriberEventMapping = {
665
+ id?: number;
666
+ event_id?: number;
667
+ subscriber_id?: number;
668
+ created_on?: string;
669
+ };
613
670
  /** @returns {SubscriberResponse} */
614
671
  declare function SubscriberResponse(): SubscriberResponse;
615
672
  type SubscriberResponse = {
@@ -235,6 +235,36 @@ const Joi = require("joi");
235
235
  * @property {string} [secret]
236
236
  */
237
237
 
238
+ /**
239
+ * @typedef SubscriberFailureResponse
240
+ * @property {string} [message]
241
+ * @property {string} [code]
242
+ * @property {string} [stack]
243
+ */
244
+
245
+ /**
246
+ * @typedef EventConfigs
247
+ * @property {number} [id]
248
+ * @property {string} [event_name]
249
+ * @property {string} [event_type]
250
+ * @property {string} [event_category]
251
+ * @property {Object} [event_schema]
252
+ * @property {string} [version]
253
+ * @property {string} [display_name]
254
+ * @property {string} [description]
255
+ * @property {string} [created_on]
256
+ * @property {string} [updated_on]
257
+ * @property {SubscriberEventMapping} [subscriber_event_mapping]
258
+ */
259
+
260
+ /**
261
+ * @typedef SubscriberEventMapping
262
+ * @property {number} [id]
263
+ * @property {number} [event_id]
264
+ * @property {number} [subscriber_id]
265
+ * @property {string} [created_on]
266
+ */
267
+
238
268
  /**
239
269
  * @typedef SubscriberResponse
240
270
  * @property {number} [id]
@@ -582,6 +612,42 @@ class WebhookPlatformModel {
582
612
  });
583
613
  }
584
614
 
615
+ /** @returns {SubscriberFailureResponse} */
616
+ static SubscriberFailureResponse() {
617
+ return Joi.object({
618
+ message: Joi.string().allow(""),
619
+ code: Joi.string().allow(""),
620
+ stack: Joi.string().allow(""),
621
+ });
622
+ }
623
+
624
+ /** @returns {EventConfigs} */
625
+ static EventConfigs() {
626
+ return Joi.object({
627
+ id: Joi.number(),
628
+ event_name: Joi.string().allow(""),
629
+ event_type: Joi.string().allow(""),
630
+ event_category: Joi.string().allow(""),
631
+ event_schema: Joi.object().pattern(/\S/, Joi.any()),
632
+ version: Joi.string().allow(""),
633
+ display_name: Joi.string().allow(""),
634
+ description: Joi.string().allow(""),
635
+ created_on: Joi.string().allow(""),
636
+ updated_on: Joi.string().allow(""),
637
+ subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
638
+ });
639
+ }
640
+
641
+ /** @returns {SubscriberEventMapping} */
642
+ static SubscriberEventMapping() {
643
+ return Joi.object({
644
+ id: Joi.number(),
645
+ event_id: Joi.number(),
646
+ subscriber_id: Joi.number(),
647
+ created_on: Joi.string().allow(""),
648
+ });
649
+ }
650
+
585
651
  /** @returns {SubscriberResponse} */
586
652
  static SubscriberResponse() {
587
653
  return Joi.object({
@@ -24,8 +24,8 @@ declare class Configuration {
24
24
  * @param {import("../PublicAPIClient").Options} - Options
25
25
  * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
26
26
  * @name searchApplication
27
- * @summary: Search Application
28
- * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
27
+ * @summary: Search application.
28
+ * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
29
29
  */
30
30
  searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponse>;
31
31
  }
@@ -120,8 +120,8 @@ class Configuration {
120
120
  * @param {import("../PublicAPIClient").Options} - Options
121
121
  * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
122
122
  * @name searchApplication
123
- * @summary: Search Application
124
- * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
123
+ * @summary: Search application.
124
+ * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
125
125
  */
126
126
  async searchApplication(
127
127
  { authorization, query, requestHeaders } = { requestHeaders: {} },
@@ -13,8 +13,8 @@ declare class Partner {
13
13
  * @param {import("../PublicAPIClient").Options} - Options
14
14
  * @returns {Promise<PartnerPublicModel.ExtensionUsingSlug>} - Success response
15
15
  * @name getPanelExtensionDetails
16
- * @summary: Get extension details
17
- * @description: Use this API to get extension details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
16
+ * @summary: Get panel extension details.
17
+ * @description: Retrieve detailed information about panel extensions in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
18
18
  */
19
19
  getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object): Promise<PartnerPublicModel.ExtensionUsingSlug>;
20
20
  }
@@ -39,8 +39,8 @@ class Partner {
39
39
  * @param {import("../PublicAPIClient").Options} - Options
40
40
  * @returns {Promise<PartnerPublicModel.ExtensionUsingSlug>} - Success response
41
41
  * @name getPanelExtensionDetails
42
- * @summary: Get extension details
43
- * @description: Use this API to get extension details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
42
+ * @summary: Get panel extension details.
43
+ * @description: Retrieve detailed information about panel extensions in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
44
44
  */
45
45
  async getPanelExtensionDetails(
46
46
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -17,8 +17,8 @@ declare class Webhook {
17
17
  * @param {import("../PublicAPIClient").Options} - Options
18
18
  * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
19
19
  * @name fetchAllWebhookEvents
20
- * @summary: Get All Webhook Events
21
- * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
20
+ * @summary: Fetch all webhook events.
21
+ * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
22
22
  */
23
23
  fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
24
24
  /**
@@ -37,8 +37,8 @@ declare class Webhook {
37
37
  * @param {import("../PublicAPIClient").Options} - Options
38
38
  * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
39
39
  * @name queryWebhookEventDetails
40
- * @summary: Send webhook event name, type, version, category in request body to get complete details of event from server
41
- * @description: Get Webhook Event Details for provided events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
40
+ * @summary: Query webhook event details.
41
+ * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
42
42
  */
43
43
  queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
44
44
  /**
@@ -46,8 +46,8 @@ class Webhook {
46
46
  * @param {import("../PublicAPIClient").Options} - Options
47
47
  * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
48
48
  * @name fetchAllWebhookEvents
49
- * @summary: Get All Webhook Events
50
- * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
49
+ * @summary: Fetch all webhook events.
50
+ * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
51
51
  */
52
52
  async fetchAllWebhookEvents(
53
53
  { requestHeaders } = { requestHeaders: {} },
@@ -202,8 +202,8 @@ class Webhook {
202
202
  * @param {import("../PublicAPIClient").Options} - Options
203
203
  * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
204
204
  * @name queryWebhookEventDetails
205
- * @summary: Send webhook event name, type, version, category in request body to get complete details of event from server
206
- * @description: Get Webhook Event Details for provided events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
205
+ * @summary: Query webhook event details.
206
+ * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
207
207
  */
208
208
  async queryWebhookEventDetails(
209
209
  { body, requestHeaders } = { requestHeaders: {} },