@epilot/sdk 2.2.6 → 2.2.7

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 (114) hide show
  1. package/definitions/erp-integration-runtime.json +1 -1
  2. package/definitions/erp-integration.json +1257 -110
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/consent.cjs +6 -6
  22. package/dist/apis/consent.js +1 -1
  23. package/dist/apis/customer-portal.cjs +6 -6
  24. package/dist/apis/customer-portal.js +1 -1
  25. package/dist/apis/dashboard.cjs +6 -6
  26. package/dist/apis/dashboard.js +1 -1
  27. package/dist/apis/data-management.cjs +6 -6
  28. package/dist/apis/data-management.js +1 -1
  29. package/dist/apis/deduplication.cjs +6 -6
  30. package/dist/apis/deduplication.js +1 -1
  31. package/dist/apis/design.cjs +6 -6
  32. package/dist/apis/design.js +1 -1
  33. package/dist/apis/document.cjs +6 -6
  34. package/dist/apis/document.js +1 -1
  35. package/dist/apis/email-settings.cjs +6 -6
  36. package/dist/apis/email-settings.js +1 -1
  37. package/dist/apis/email-template.cjs +6 -6
  38. package/dist/apis/email-template.js +1 -1
  39. package/dist/apis/entity-mapping.cjs +6 -6
  40. package/dist/apis/entity-mapping.js +1 -1
  41. package/dist/apis/entity.cjs +6 -6
  42. package/dist/apis/entity.js +1 -1
  43. package/dist/apis/environments.cjs +6 -6
  44. package/dist/apis/environments.js +1 -1
  45. package/dist/apis/erp-integration.cjs +8 -8
  46. package/dist/apis/erp-integration.d.cts +2 -2
  47. package/dist/apis/erp-integration.d.ts +2 -2
  48. package/dist/apis/erp-integration.js +2 -2
  49. package/dist/apis/event-catalog.cjs +6 -6
  50. package/dist/apis/event-catalog.js +1 -1
  51. package/dist/apis/file.cjs +6 -6
  52. package/dist/apis/file.js +1 -1
  53. package/dist/apis/iban.cjs +6 -6
  54. package/dist/apis/iban.js +1 -1
  55. package/dist/apis/journey.cjs +6 -6
  56. package/dist/apis/journey.js +1 -1
  57. package/dist/apis/kanban.cjs +6 -6
  58. package/dist/apis/kanban.js +1 -1
  59. package/dist/apis/message.cjs +6 -6
  60. package/dist/apis/message.js +1 -1
  61. package/dist/apis/metering.cjs +6 -6
  62. package/dist/apis/metering.js +1 -1
  63. package/dist/apis/notes.cjs +6 -6
  64. package/dist/apis/notes.js +1 -1
  65. package/dist/apis/notification.cjs +6 -6
  66. package/dist/apis/notification.js +1 -1
  67. package/dist/apis/organization.cjs +6 -6
  68. package/dist/apis/organization.js +1 -1
  69. package/dist/apis/partner-directory.cjs +6 -6
  70. package/dist/apis/partner-directory.js +1 -1
  71. package/dist/apis/permissions.cjs +6 -6
  72. package/dist/apis/permissions.js +1 -1
  73. package/dist/apis/pricing-tier.cjs +6 -6
  74. package/dist/apis/pricing-tier.js +1 -1
  75. package/dist/apis/pricing.cjs +6 -6
  76. package/dist/apis/pricing.js +1 -1
  77. package/dist/apis/purpose.cjs +6 -6
  78. package/dist/apis/purpose.js +1 -1
  79. package/dist/apis/sandbox.cjs +6 -6
  80. package/dist/apis/sandbox.js +1 -1
  81. package/dist/apis/submission.cjs +6 -6
  82. package/dist/apis/submission.js +1 -1
  83. package/dist/apis/targeting.cjs +6 -6
  84. package/dist/apis/targeting.js +1 -1
  85. package/dist/apis/template-variables.cjs +6 -6
  86. package/dist/apis/template-variables.js +1 -1
  87. package/dist/apis/user.cjs +6 -6
  88. package/dist/apis/user.js +1 -1
  89. package/dist/apis/validation-rules.cjs +6 -6
  90. package/dist/apis/validation-rules.js +1 -1
  91. package/dist/apis/webhooks.cjs +6 -6
  92. package/dist/apis/webhooks.js +1 -1
  93. package/dist/apis/workflow-definition.cjs +6 -6
  94. package/dist/apis/workflow-definition.js +1 -1
  95. package/dist/apis/workflow.cjs +6 -6
  96. package/dist/apis/workflow.js +1 -1
  97. package/dist/{chunk-H2KTLW3Q.js → chunk-BN6EJPDC.js} +2 -2
  98. package/dist/{chunk-LHVRAAFH.js → chunk-MUNMUGB5.js} +1 -1
  99. package/dist/{chunk-ODD4JQVS.cjs → chunk-TLH6XOTL.cjs} +1 -1
  100. package/dist/{chunk-NF3MQHQS.cjs → chunk-VUVWHQMP.cjs} +2 -2
  101. package/dist/erp-integration-76K5HOGL.js +7 -0
  102. package/dist/erp-integration-A33WOGPF.cjs +7 -0
  103. package/dist/{erp-integration-runtime-6SBLYZ34.js → erp-integration-runtime-BHHWMG4O.js} +1 -1
  104. package/dist/{erp-integration-runtime-HZI2P4X7.cjs → erp-integration-runtime-Y6VWGQ3L.cjs} +2 -2
  105. package/dist/{erp-integration.d-BV3Rv9e6.d.cts → erp-integration.d-B4XPU_j-.d.cts} +753 -1
  106. package/dist/{erp-integration.d-BV3Rv9e6.d.ts → erp-integration.d-B4XPU_j-.d.ts} +753 -1
  107. package/dist/index.cjs +10 -10
  108. package/dist/index.d.cts +1 -1
  109. package/dist/index.d.ts +1 -1
  110. package/dist/index.js +2 -2
  111. package/docs/erp-integration.md +816 -19
  112. package/package.json +1 -1
  113. package/dist/erp-integration-6I4B4BIU.cjs +0 -7
  114. package/dist/erp-integration-G54BMGGE.js +0 -7
@@ -54,6 +54,9 @@ const { data } = await erpIntegrationClient.acknowledgeTracking(...)
54
54
  - [`deleteIntegrationAppMapping`](#deleteintegrationappmapping)
55
55
  - [`getOutboundStatus`](#getoutboundstatus)
56
56
  - [`listSecureProxies`](#listsecureproxies)
57
+ - [`generateTypesPreview`](#generatetypespreview)
58
+ - [`generateTypes`](#generatetypes)
59
+ - [`commitTypes`](#committypes)
57
60
 
58
61
  **monitoring**
59
62
  - [`queryInboundMonitoringEvents`](#queryinboundmonitoringevents)
@@ -61,6 +64,10 @@ const { data } = await erpIntegrationClient.acknowledgeTracking(...)
61
64
  - [`getMonitoringTimeSeries`](#getmonitoringtimeseries)
62
65
  - [`queryAccessLogs`](#queryaccesslogs)
63
66
  - [`queryOutboundMonitoringEvents`](#queryoutboundmonitoringevents)
67
+ - [`queryMonitoringEventsV2`](#querymonitoringeventsv2)
68
+ - [`getMonitoringStatsV2`](#getmonitoringstatsv2)
69
+ - [`getMonitoringTimeSeriesV2`](#getmonitoringtimeseriesv2)
70
+ - [`getAssociatedMonitoringEvents`](#getassociatedmonitoringevents)
64
71
 
65
72
  **proxy**
66
73
  - [`secureProxy`](#secureproxy)
@@ -145,6 +152,14 @@ const { data } = await erpIntegrationClient.acknowledgeTracking(...)
145
152
  - [`ManagedCallExecuteRequest`](#managedcallexecuterequest)
146
153
  - [`ManagedCallExecuteResponse`](#managedcallexecuteresponse)
147
154
  - [`ManagedCallErrorResponse`](#managedcallerrorresponse)
155
+ - [`TypeAnnotations`](#typeannotations)
156
+ - [`TypeDescriptor`](#typedescriptor)
157
+ - [`UseCaseTypePreview`](#usecasetypepreview)
158
+ - [`GenerateTypesPreviewResponse`](#generatetypespreviewresponse)
159
+ - [`GenerateTypesRequest`](#generatetypesrequest)
160
+ - [`GenerateTypesResponse`](#generatetypesresponse)
161
+ - [`CommitTypesRequest`](#committypesrequest)
162
+ - [`CommitTypesResponse`](#committypesresponse)
148
163
  - [`FileProxyUseCaseConfiguration`](#fileproxyusecaseconfiguration)
149
164
  - [`FileProxySecureProxyAttachment`](#fileproxysecureproxyattachment)
150
165
  - [`FileProxyAuth`](#fileproxyauth)
@@ -186,6 +201,12 @@ const { data } = await erpIntegrationClient.acknowledgeTracking(...)
186
201
  - [`OutboundMonitoringEvent`](#outboundmonitoringevent)
187
202
  - [`MonitoringStats`](#monitoringstats)
188
203
  - [`InboundMonitoringEvent`](#inboundmonitoringevent)
204
+ - [`QueryMonitoringEventsV2Request`](#querymonitoringeventsv2request)
205
+ - [`MonitoringEventV2`](#monitoringeventv2)
206
+ - [`GetMonitoringStatsV2Request`](#getmonitoringstatsv2request)
207
+ - [`MonitoringStatsV2`](#monitoringstatsv2)
208
+ - [`GetMonitoringTimeSeriesV2Request`](#getmonitoringtimeseriesv2request)
209
+ - [`TimeSeriesBucketV2`](#timeseriesbucketv2)
189
210
 
190
211
  ### `acknowledgeTracking`
191
212
 
@@ -479,7 +500,18 @@ const { data } = await client.listIntegrations()
479
500
  "api_key_header": "string",
480
501
  "api_key": "string",
481
502
  "token": "string"
482
- }
503
+ },
504
+ "types_versions": [
505
+ {
506
+ "version": "string",
507
+ "package_name": "string",
508
+ "generated_at": "1970-01-01T00:00:00.000Z",
509
+ "generated_by": "string",
510
+ "status": "active"
511
+ }
512
+ ],
513
+ "latest_types_version": "string",
514
+ "latest_types_package_name": "string"
483
515
  },
484
516
  "protected": true
485
517
  }
@@ -538,7 +570,18 @@ const { data } = await client.createIntegration(
538
570
  api_key_header: 'string',
539
571
  api_key: 'string',
540
572
  token: 'string'
541
- }
573
+ },
574
+ types_versions: [
575
+ {
576
+ version: 'string',
577
+ package_name: 'string',
578
+ generated_at: '1970-01-01T00:00:00.000Z',
579
+ generated_by: 'string',
580
+ status: 'active'
581
+ }
582
+ ],
583
+ latest_types_version: 'string',
584
+ latest_types_package_name: 'string'
542
585
  },
543
586
  protected: true
544
587
  },
@@ -591,7 +634,18 @@ const { data } = await client.createIntegration(
591
634
  "api_key_header": "string",
592
635
  "api_key": "string",
593
636
  "token": "string"
594
- }
637
+ },
638
+ "types_versions": [
639
+ {
640
+ "version": "string",
641
+ "package_name": "string",
642
+ "generated_at": "1970-01-01T00:00:00.000Z",
643
+ "generated_by": "string",
644
+ "status": "active"
645
+ }
646
+ ],
647
+ "latest_types_version": "string",
648
+ "latest_types_package_name": "string"
595
649
  },
596
650
  "protected": true
597
651
  }
@@ -659,7 +713,18 @@ const { data } = await client.getIntegration({
659
713
  "api_key_header": "string",
660
714
  "api_key": "string",
661
715
  "token": "string"
662
- }
716
+ },
717
+ "types_versions": [
718
+ {
719
+ "version": "string",
720
+ "package_name": "string",
721
+ "generated_at": "1970-01-01T00:00:00.000Z",
722
+ "generated_by": "string",
723
+ "status": "active"
724
+ }
725
+ ],
726
+ "latest_types_version": "string",
727
+ "latest_types_package_name": "string"
663
728
  },
664
729
  "protected": true
665
730
  }
@@ -730,7 +795,18 @@ const { data } = await client.updateIntegration(
730
795
  "api_key_header": "string",
731
796
  "api_key": "string",
732
797
  "token": "string"
733
- }
798
+ },
799
+ "types_versions": [
800
+ {
801
+ "version": "string",
802
+ "package_name": "string",
803
+ "generated_at": "1970-01-01T00:00:00.000Z",
804
+ "generated_by": "string",
805
+ "status": "active"
806
+ }
807
+ ],
808
+ "latest_types_version": "string",
809
+ "latest_types_package_name": "string"
734
810
  },
735
811
  "protected": true
736
812
  }
@@ -1202,7 +1278,12 @@ const { data } = await client.createIntegrationV2(
1202
1278
  api_key_header: 'string',
1203
1279
  api_key: 'string',
1204
1280
  token: 'string'
1205
- }
1281
+ },
1282
+ types_versions: [
1283
+ { /* ... */ }
1284
+ ],
1285
+ latest_types_version: 'string',
1286
+ latest_types_package_name: 'string'
1206
1287
  },
1207
1288
  protected: true,
1208
1289
  use_cases: [
@@ -1266,7 +1347,12 @@ const { data } = await client.createIntegrationV2(
1266
1347
  "api_key_header": "string",
1267
1348
  "api_key": "string",
1268
1349
  "token": "string"
1269
- }
1350
+ },
1351
+ "types_versions": [
1352
+ {}
1353
+ ],
1354
+ "latest_types_version": "string",
1355
+ "latest_types_package_name": "string"
1270
1356
  },
1271
1357
  "protected": true,
1272
1358
  "use_cases": [
@@ -1348,7 +1434,12 @@ const { data } = await client.getIntegrationV2({
1348
1434
  "api_key_header": "string",
1349
1435
  "api_key": "string",
1350
1436
  "token": "string"
1351
- }
1437
+ },
1438
+ "types_versions": [
1439
+ {}
1440
+ ],
1441
+ "latest_types_version": "string",
1442
+ "latest_types_package_name": "string"
1352
1443
  },
1353
1444
  "protected": true,
1354
1445
  "use_cases": [
@@ -1425,7 +1516,12 @@ const { data } = await client.updateIntegrationV2(
1425
1516
  api_key_header: 'string',
1426
1517
  api_key: 'string',
1427
1518
  token: 'string'
1428
- }
1519
+ },
1520
+ types_versions: [
1521
+ { /* ... */ }
1522
+ ],
1523
+ latest_types_version: 'string',
1524
+ latest_types_package_name: 'string'
1429
1525
  },
1430
1526
  protected: true,
1431
1527
  use_cases: [
@@ -1489,7 +1585,12 @@ const { data } = await client.updateIntegrationV2(
1489
1585
  "api_key_header": "string",
1490
1586
  "api_key": "string",
1491
1587
  "token": "string"
1492
- }
1588
+ },
1589
+ "types_versions": [
1590
+ {}
1591
+ ],
1592
+ "latest_types_version": "string",
1593
+ "latest_types_package_name": "string"
1493
1594
  },
1494
1595
  "protected": true,
1495
1596
  "use_cases": [
@@ -1961,6 +2062,204 @@ const { data } = await client.queryOutboundMonitoringEvents(
1961
2062
 
1962
2063
  ---
1963
2064
 
2065
+ ### `queryMonitoringEventsV2`
2066
+
2067
+ Query monitoring events from the unified erp_monitoring_v2 table.
2068
+ Returns all event types (inbound, outbound, file_proxy, etc.) in a single list.
2069
+ Replaces the separate v1 inbound-events and outbound-e
2070
+
2071
+ `POST /v2/integrations/{integrationId}/monitoring/events`
2072
+
2073
+ ```ts
2074
+ const { data } = await client.queryMonitoringEventsV2(
2075
+ {
2076
+ integrationId: 'example',
2077
+ },
2078
+ {
2079
+ use_case_id: 'string',
2080
+ use_case_type: 'inbound',
2081
+ level: 'success',
2082
+ code: 'string',
2083
+ event_id: 'string',
2084
+ correlation_id: 'string',
2085
+ from_date: '2025-01-01T00:00:00Z',
2086
+ to_date: '2025-01-31T23:59:59Z',
2087
+ limit: 50,
2088
+ cursor: {
2089
+ created_at: '1970-01-01T00:00:00.000Z',
2090
+ id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
2091
+ }
2092
+ },
2093
+ )
2094
+ ```
2095
+
2096
+ <details>
2097
+ <summary>Response</summary>
2098
+
2099
+ ```json
2100
+ {
2101
+ "data": [
2102
+ {
2103
+ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2104
+ "org_id": "string",
2105
+ "integration_id": "string",
2106
+ "event_id": "string",
2107
+ "correlation_id": "string",
2108
+ "use_case_id": "string",
2109
+ "use_case_type": "inbound",
2110
+ "level": "success",
2111
+ "code": "string",
2112
+ "message": "string",
2113
+ "detail": {},
2114
+ "created_at": "1970-01-01T00:00:00.000Z"
2115
+ }
2116
+ ],
2117
+ "next_cursor": {
2118
+ "created_at": "1970-01-01T00:00:00.000Z",
2119
+ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2120
+ },
2121
+ "has_more": true
2122
+ }
2123
+ ```
2124
+
2125
+ </details>
2126
+
2127
+ ---
2128
+
2129
+ ### `getMonitoringStatsV2`
2130
+
2131
+ Get aggregated statistics from the unified erp_monitoring_v2 table.
2132
+ Returns combined metrics for all event types with optional breakdowns.
2133
+
2134
+ `POST /v2/integrations/{integrationId}/monitoring/stats`
2135
+
2136
+ ```ts
2137
+ const { data } = await client.getMonitoringStatsV2(
2138
+ {
2139
+ integrationId: 'example',
2140
+ },
2141
+ {
2142
+ from_date: '2025-01-01T00:00:00Z',
2143
+ to_date: '2025-01-31T23:59:59Z',
2144
+ use_case_type: 'inbound',
2145
+ group_by: 'use_case_id'
2146
+ },
2147
+ )
2148
+ ```
2149
+
2150
+ <details>
2151
+ <summary>Response</summary>
2152
+
2153
+ ```json
2154
+ {
2155
+ "total_events": 0,
2156
+ "success_count": 0,
2157
+ "error_count": 0,
2158
+ "warning_count": 0,
2159
+ "skipped_count": 0,
2160
+ "ack_timeout_count": 0,
2161
+ "success_rate": 0,
2162
+ "last_error_at": "1970-01-01T00:00:00.000Z",
2163
+ "breakdown": [
2164
+ {}
2165
+ ]
2166
+ }
2167
+ ```
2168
+
2169
+ </details>
2170
+
2171
+ ---
2172
+
2173
+ ### `getMonitoringTimeSeriesV2`
2174
+
2175
+ Get time-series aggregated event counts from the unified erp_monitoring_v2 table.
2176
+ Returns bucketed counts for chart rendering.
2177
+
2178
+ `POST /v2/integrations/{integrationId}/monitoring/time-series`
2179
+
2180
+ ```ts
2181
+ const { data } = await client.getMonitoringTimeSeriesV2(
2182
+ {
2183
+ integrationId: 'example',
2184
+ },
2185
+ {
2186
+ from_date: '2025-01-01T00:00:00Z',
2187
+ to_date: '2025-01-31T23:59:59Z',
2188
+ interval: '5m',
2189
+ use_case_type: 'inbound'
2190
+ },
2191
+ )
2192
+ ```
2193
+
2194
+ <details>
2195
+ <summary>Response</summary>
2196
+
2197
+ ```json
2198
+ {
2199
+ "interval": "5m",
2200
+ "from_date": "1970-01-01T00:00:00.000Z",
2201
+ "to_date": "1970-01-01T00:00:00.000Z",
2202
+ "buckets": [
2203
+ {
2204
+ "timestamp": "1970-01-01T00:00:00.000Z",
2205
+ "success_count": 0,
2206
+ "error_count": 0,
2207
+ "warning_count": 0,
2208
+ "skipped_count": 0,
2209
+ "total_count": 0
2210
+ }
2211
+ ]
2212
+ }
2213
+ ```
2214
+
2215
+ </details>
2216
+
2217
+ ---
2218
+
2219
+ ### `getAssociatedMonitoringEvents`
2220
+
2221
+ Returns all monitoring events sharing the same event_id, ordered chronologically.
2222
+ Also includes the original inbound event payload from erp_incoming_events if available.
2223
+ Used to display a full event t
2224
+
2225
+ `GET /v2/integrations/{integrationId}/monitoring/events/{eventId}/associated`
2226
+
2227
+ ```ts
2228
+ const { data } = await client.getAssociatedMonitoringEvents({
2229
+ integrationId: 'example',
2230
+ eventId: 'example',
2231
+ })
2232
+ ```
2233
+
2234
+ <details>
2235
+ <summary>Response</summary>
2236
+
2237
+ ```json
2238
+ {
2239
+ "monitoring_events": [
2240
+ {
2241
+ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2242
+ "org_id": "string",
2243
+ "integration_id": "string",
2244
+ "event_id": "string",
2245
+ "correlation_id": "string",
2246
+ "use_case_id": "string",
2247
+ "use_case_type": "inbound",
2248
+ "level": "success",
2249
+ "code": "string",
2250
+ "message": "string",
2251
+ "detail": {},
2252
+ "created_at": "1970-01-01T00:00:00.000Z"
2253
+ }
2254
+ ],
2255
+ "inbound_event": {}
2256
+ }
2257
+ ```
2258
+
2259
+ </details>
2260
+
2261
+ ---
2262
+
1964
2263
  ### `listSecureProxies`
1965
2264
 
1966
2265
  List all secure proxy use cases
@@ -1984,6 +2283,7 @@ const { data } = await client.listSecureProxies()
1984
2283
  "enabled": true,
1985
2284
  "vpc_mode": "static_ip",
1986
2285
  "allowed_domains": ["string"],
2286
+ "allowed_ips": ["string"],
1987
2287
  "integration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1988
2288
  "integration_name": "string"
1989
2289
  }
@@ -2062,6 +2362,91 @@ const { data } = await client.managedCallExecute(
2062
2362
 
2063
2363
  ---
2064
2364
 
2365
+ ### `generateTypesPreview`
2366
+
2367
+ Preview scaffolded types for a connector integration
2368
+
2369
+ `POST /v1/integrations/{integrationId}/generate-types-preview`
2370
+
2371
+ ```ts
2372
+ const { data } = await client.generateTypesPreview({
2373
+ integrationId: 'example',
2374
+ })
2375
+ ```
2376
+
2377
+ ---
2378
+
2379
+ ### `generateTypes`
2380
+
2381
+ Generate a TypeScript npm package for a connector integration
2382
+
2383
+ `POST /v1/integrations/{integrationId}/generate-types`
2384
+
2385
+ ```ts
2386
+ const { data } = await client.generateTypes(
2387
+ {
2388
+ integrationId: 'example',
2389
+ },
2390
+ {
2391
+ package_name: '@epilot/hems-cleverpv',
2392
+ version: '1.0.0',
2393
+ description: 'string',
2394
+ domain_package: '@epilot/hems',
2395
+ domain_map_name: 'HemsUseCaseMap',
2396
+ annotations: {}
2397
+ },
2398
+ )
2399
+ ```
2400
+
2401
+ <details>
2402
+ <summary>Response</summary>
2403
+
2404
+ ```json
2405
+ {
2406
+ "package_name": "string",
2407
+ "version": "string",
2408
+ "files": {},
2409
+ "warnings": ["string"]
2410
+ }
2411
+ ```
2412
+
2413
+ </details>
2414
+
2415
+ ---
2416
+
2417
+ ### `commitTypes`
2418
+
2419
+ Commit generated types and lock use case configurations
2420
+
2421
+ `POST /v1/integrations/{integrationId}/commit-types`
2422
+
2423
+ ```ts
2424
+ const { data } = await client.commitTypes(
2425
+ {
2426
+ integrationId: 'example',
2427
+ },
2428
+ {
2429
+ package_name: '@epilot/hems-cleverpv',
2430
+ version: '1.0.0',
2431
+ annotations: {}
2432
+ },
2433
+ )
2434
+ ```
2435
+
2436
+ <details>
2437
+ <summary>Response</summary>
2438
+
2439
+ ```json
2440
+ {
2441
+ "committed": true,
2442
+ "warnings": ["string"]
2443
+ }
2444
+ ```
2445
+
2446
+ </details>
2447
+
2448
+ ---
2449
+
2065
2450
  ## Schemas
2066
2451
 
2067
2452
  ### `ErrorResponseBase`
@@ -2191,6 +2576,15 @@ type IntegrationEditableFields = {
2191
2576
  api_key?: { ... }
2192
2577
  token?: { ... }
2193
2578
  }
2579
+ types_versions?: Array<{
2580
+ version: { ... }
2581
+ package_name: { ... }
2582
+ generated_at: { ... }
2583
+ generated_by: { ... }
2584
+ status: { ... }
2585
+ }>
2586
+ latest_types_version?: string
2587
+ latest_types_package_name?: string
2194
2588
  }
2195
2589
  protected?: boolean
2196
2590
  }
@@ -2218,6 +2612,15 @@ type ConnectorConfig = {
2218
2612
  api_key?: string
2219
2613
  token?: string
2220
2614
  }
2615
+ types_versions?: Array<{
2616
+ version: string
2617
+ package_name: string
2618
+ generated_at: string // date-time
2619
+ generated_by: string
2620
+ status: "active" | "deprecated"
2621
+ }>
2622
+ latest_types_version?: string
2623
+ latest_types_package_name?: string
2221
2624
  }
2222
2625
  ```
2223
2626
 
@@ -2287,6 +2690,15 @@ type Integration = {
2287
2690
  api_key?: { ... }
2288
2691
  token?: { ... }
2289
2692
  }
2693
+ types_versions?: Array<{
2694
+ version: { ... }
2695
+ package_name: { ... }
2696
+ generated_at: { ... }
2697
+ generated_by: { ... }
2698
+ status: { ... }
2699
+ }>
2700
+ latest_types_version?: string
2701
+ latest_types_package_name?: string
2290
2702
  }
2291
2703
  protected?: boolean
2292
2704
  }
@@ -2332,6 +2744,15 @@ type CreateIntegrationRequest = {
2332
2744
  api_key?: { ... }
2333
2745
  token?: { ... }
2334
2746
  }
2747
+ types_versions?: Array<{
2748
+ version: { ... }
2749
+ package_name: { ... }
2750
+ generated_at: { ... }
2751
+ generated_by: { ... }
2752
+ status: { ... }
2753
+ }>
2754
+ latest_types_version?: string
2755
+ latest_types_package_name?: string
2335
2756
  }
2336
2757
  protected?: boolean
2337
2758
  }
@@ -2377,6 +2798,15 @@ type UpdateIntegrationRequest = {
2377
2798
  api_key?: { ... }
2378
2799
  token?: { ... }
2379
2800
  }
2801
+ types_versions?: Array<{
2802
+ version: { ... }
2803
+ package_name: { ... }
2804
+ generated_at: { ... }
2805
+ generated_by: { ... }
2806
+ status: { ... }
2807
+ }>
2808
+ latest_types_version?: string
2809
+ latest_types_package_name?: string
2380
2810
  }
2381
2811
  protected?: boolean
2382
2812
  }
@@ -2511,6 +2941,11 @@ type IntegrationWithUseCases = {
2511
2941
  response_mapping?: { ... }
2512
2942
  inbound_use_case_slug?: { ... }
2513
2943
  }
2944
+ type_annotations?: {
2945
+ request?: { ... }
2946
+ response?: { ... }
2947
+ }
2948
+ types_locked?: boolean
2514
2949
  } | {
2515
2950
  id: string // uuid
2516
2951
  integrationId: string // uuid
@@ -2524,6 +2959,7 @@ type IntegrationWithUseCases = {
2524
2959
  configuration?: {
2525
2960
  vpc_mode: { ... }
2526
2961
  allowed_domains?: { ... }
2962
+ allowed_ips?: { ... }
2527
2963
  }
2528
2964
  }>
2529
2965
  }
@@ -2569,6 +3005,15 @@ type UpsertIntegrationWithUseCasesRequest = {
2569
3005
  api_key?: { ... }
2570
3006
  token?: { ... }
2571
3007
  }
3008
+ types_versions?: Array<{
3009
+ version: { ... }
3010
+ package_name: { ... }
3011
+ generated_at: { ... }
3012
+ generated_by: { ... }
3013
+ status: { ... }
3014
+ }>
3015
+ latest_types_version?: string
3016
+ latest_types_package_name?: string
2572
3017
  }
2573
3018
  protected?: boolean
2574
3019
  use_cases?: Array<{
@@ -2623,15 +3068,6 @@ type UpsertIntegrationWithUseCasesRequest = {
2623
3068
  } | {
2624
3069
  id?: string // uuid
2625
3070
  name: string
2626
- slug?: string
2627
- enabled: boolean
2628
- change_description?: string
2629
- type: "secure_proxy"
2630
- configuration?: {
2631
- vpc_mode: { ... }
2632
- allowed_domains?: { ... }
2633
- }
2634
- }>
2635
3071
  // ...
2636
3072
  }
2637
3073
  ```
@@ -3253,6 +3689,7 @@ type EmbeddedSecureProxyUseCaseRequest = {
3253
3689
  configuration?: {
3254
3690
  vpc_mode: "static_ip" | "secure_link"
3255
3691
  allowed_domains?: string[]
3692
+ allowed_ips?: string[]
3256
3693
  }
3257
3694
  }
3258
3695
  ```
@@ -3414,6 +3851,11 @@ type ManagedCallUseCase = {
3414
3851
  response_mapping?: string
3415
3852
  inbound_use_case_slug?: string
3416
3853
  }
3854
+ type_annotations?: {
3855
+ request?: Record<string, string>
3856
+ response?: Record<string, string>
3857
+ }
3858
+ types_locked?: boolean
3417
3859
  }
3418
3860
  ```
3419
3861
 
@@ -3433,6 +3875,7 @@ type SecureProxyUseCase = {
3433
3875
  configuration?: {
3434
3876
  vpc_mode: "static_ip" | "secure_link"
3435
3877
  allowed_domains?: string[]
3878
+ allowed_ips?: string[]
3436
3879
  }
3437
3880
  }
3438
3881
  ```
@@ -3796,6 +4239,7 @@ type CreateSecureProxyUseCaseRequest = {
3796
4239
  configuration?: {
3797
4240
  vpc_mode: "static_ip" | "secure_link"
3798
4241
  allowed_domains?: string[]
4242
+ allowed_ips?: string[]
3799
4243
  }
3800
4244
  }
3801
4245
  ```
@@ -4043,6 +4487,10 @@ type UpdateManagedCallUseCaseRequest = {
4043
4487
  response_mapping?: string
4044
4488
  inbound_use_case_slug?: string
4045
4489
  }
4490
+ type_annotations?: {
4491
+ request?: Record<string, string>
4492
+ response?: Record<string, string>
4493
+ }
4046
4494
  }
4047
4495
  ```
4048
4496
 
@@ -4058,6 +4506,7 @@ type UpdateSecureProxyUseCaseRequest = {
4058
4506
  configuration?: {
4059
4507
  vpc_mode: "static_ip" | "secure_link"
4060
4508
  allowed_domains?: string[]
4509
+ allowed_ips?: string[]
4061
4510
  }
4062
4511
  }
4063
4512
  ```
@@ -4335,6 +4784,11 @@ type ManagedCallUseCaseHistoryEntry = {
4335
4784
  response_mapping?: string
4336
4785
  inbound_use_case_slug?: string
4337
4786
  }
4787
+ type_annotations?: {
4788
+ request?: Record<string, string>
4789
+ response?: Record<string, string>
4790
+ }
4791
+ types_locked?: boolean
4338
4792
  }
4339
4793
  ```
4340
4794
 
@@ -4356,6 +4810,7 @@ type SecureProxyUseCaseHistoryEntry = {
4356
4810
  configuration?: {
4357
4811
  vpc_mode: "static_ip" | "secure_link"
4358
4812
  allowed_domains?: string[]
4813
+ allowed_ips?: string[]
4359
4814
  }
4360
4815
  }
4361
4816
  ```
@@ -4369,6 +4824,7 @@ Configuration for secure_proxy use cases. Defines how to route requests through
4369
4824
  type SecureProxyUseCaseConfiguration = {
4370
4825
  vpc_mode: "static_ip" | "secure_link"
4371
4826
  allowed_domains?: string[]
4827
+ allowed_ips?: string[]
4372
4828
  }
4373
4829
  ```
4374
4830
 
@@ -4382,6 +4838,7 @@ type SecureProxySummary = {
4382
4838
  enabled: boolean
4383
4839
  vpc_mode: "static_ip" | "secure_link"
4384
4840
  allowed_domains?: string[]
4841
+ allowed_ips?: string[]
4385
4842
  integration_id: string // uuid
4386
4843
  integration_name: string
4387
4844
  }
@@ -4477,6 +4934,256 @@ type ManagedCallErrorResponse = {
4477
4934
  }
4478
4935
  ```
4479
4936
 
4937
+ ### `TypeAnnotations`
4938
+
4939
+ Developer-provided type annotations for a use case's request and response fields
4940
+
4941
+ ```ts
4942
+ type TypeAnnotations = {
4943
+ request?: Record<string, string>
4944
+ response?: Record<string, string>
4945
+ }
4946
+ ```
4947
+
4948
+ ### `TypeDescriptor`
4949
+
4950
+ Describes the inferred type shape of a JSONata expression
4951
+
4952
+ ```ts
4953
+ type TypeDescriptor = {
4954
+ kind: "object" | "array" | "string" | "number" | "boolean" | "null" | "unknown" | "union"
4955
+ properties?: Record<string, {
4956
+ kind: "object" | "array" | "string" | "number" | "boolean" | "null" | "unknown" | "union"
4957
+ properties?: Record<string, {
4958
+ kind: { ... }
4959
+ properties?: { ... }
4960
+ items?: { ... }
4961
+ source?: { ... }
4962
+ variants?: { ... }
4963
+ }>
4964
+ items?: {
4965
+ kind: { ... }
4966
+ properties?: { ... }
4967
+ items?: { ... }
4968
+ source?: { ... }
4969
+ variants?: { ... }
4970
+ }
4971
+ source?: string
4972
+ variants?: Array<{
4973
+ kind: { ... }
4974
+ properties?: { ... }
4975
+ items?: { ... }
4976
+ source?: { ... }
4977
+ variants?: { ... }
4978
+ }>
4979
+ }>
4980
+ items?: {
4981
+ kind: "object" | "array" | "string" | "number" | "boolean" | "null" | "unknown" | "union"
4982
+ properties?: Record<string, {
4983
+ kind: { ... }
4984
+ properties?: { ... }
4985
+ items?: { ... }
4986
+ source?: { ... }
4987
+ variants?: { ... }
4988
+ }>
4989
+ items?: {
4990
+ kind: { ... }
4991
+ properties?: { ... }
4992
+ items?: { ... }
4993
+ source?: { ... }
4994
+ variants?: { ... }
4995
+ }
4996
+ source?: string
4997
+ variants?: Array<{
4998
+ kind: { ... }
4999
+ properties?: { ... }
5000
+ items?: { ... }
5001
+ source?: { ... }
5002
+ variants?: { ... }
5003
+ }>
5004
+ }
5005
+ source?: string
5006
+ variants?: Array<{
5007
+ kind: "object" | "array" | "string" | "number" | "boolean" | "null" | "unknown" | "union"
5008
+ properties?: Record<string, {
5009
+ kind: { ... }
5010
+ properties?: { ... }
5011
+ items?: { ... }
5012
+ source?: { ... }
5013
+ variants?: { ... }
5014
+ }>
5015
+ items?: {
5016
+ kind: { ... }
5017
+ properties?: { ... }
5018
+ items?: { ... }
5019
+ source?: { ... }
5020
+ variants?: { ... }
5021
+ }
5022
+ source?: string
5023
+ variants?: Array<{
5024
+ kind: { ... }
5025
+ properties?: { ... }
5026
+ items?: { ... }
5027
+ source?: { ... }
5028
+ variants?: { ... }
5029
+ }>
5030
+ }>
5031
+ }
5032
+ ```
5033
+
5034
+ ### `UseCaseTypePreview`
5035
+
5036
+ Scaffolded type descriptors for a single use case
5037
+
5038
+ ```ts
5039
+ type UseCaseTypePreview = {
5040
+ slug: string
5041
+ name?: string
5042
+ request_shape: {
5043
+ kind: "object" | "array" | "string" | "number" | "boolean" | "null" | "unknown" | "union"
5044
+ properties?: Record<string, {
5045
+ kind: { ... }
5046
+ properties?: { ... }
5047
+ items?: { ... }
5048
+ source?: { ... }
5049
+ variants?: { ... }
5050
+ }>
5051
+ items?: {
5052
+ kind: { ... }
5053
+ properties?: { ... }
5054
+ items?: { ... }
5055
+ source?: { ... }
5056
+ variants?: { ... }
5057
+ }
5058
+ source?: string
5059
+ variants?: Array<{
5060
+ kind: { ... }
5061
+ properties?: { ... }
5062
+ items?: { ... }
5063
+ source?: { ... }
5064
+ variants?: { ... }
5065
+ }>
5066
+ }
5067
+ response_shape: {
5068
+ kind: "object" | "array" | "string" | "number" | "boolean" | "null" | "unknown" | "union"
5069
+ properties?: Record<string, {
5070
+ kind: { ... }
5071
+ properties?: { ... }
5072
+ items?: { ... }
5073
+ source?: { ... }
5074
+ variants?: { ... }
5075
+ }>
5076
+ items?: {
5077
+ kind: { ... }
5078
+ properties?: { ... }
5079
+ items?: { ... }
5080
+ source?: { ... }
5081
+ variants?: { ... }
5082
+ }
5083
+ source?: string
5084
+ variants?: Array<{
5085
+ kind: { ... }
5086
+ properties?: { ... }
5087
+ items?: { ... }
5088
+ source?: { ... }
5089
+ variants?: { ... }
5090
+ }>
5091
+ }
5092
+ existing_annotations?: {
5093
+ request?: Record<string, string>
5094
+ response?: Record<string, string>
5095
+ }
5096
+ }
5097
+ ```
5098
+
5099
+ ### `GenerateTypesPreviewResponse`
5100
+
5101
+ ```ts
5102
+ type GenerateTypesPreviewResponse = {
5103
+ integration_name?: string
5104
+ use_cases: Array<{
5105
+ slug: string
5106
+ name?: string
5107
+ request_shape: {
5108
+ kind: { ... }
5109
+ properties?: { ... }
5110
+ items?: { ... }
5111
+ source?: { ... }
5112
+ variants?: { ... }
5113
+ }
5114
+ response_shape: {
5115
+ kind: { ... }
5116
+ properties?: { ... }
5117
+ items?: { ... }
5118
+ source?: { ... }
5119
+ variants?: { ... }
5120
+ }
5121
+ existing_annotations?: {
5122
+ request?: { ... }
5123
+ response?: { ... }
5124
+ }
5125
+ }>
5126
+ previous_version?: string
5127
+ suggested_version?: string
5128
+ suggested_bump?: "major" | "minor"
5129
+ detected_changes?: Array<{
5130
+ slug: string
5131
+ field: string
5132
+ type: "breaking" | "non-breaking"
5133
+ description: string
5134
+ }>
5135
+ }
5136
+ ```
5137
+
5138
+ ### `GenerateTypesRequest`
5139
+
5140
+ ```ts
5141
+ type GenerateTypesRequest = {
5142
+ package_name: string
5143
+ version: string
5144
+ description?: string
5145
+ domain_package?: string
5146
+ domain_map_name?: string
5147
+ annotations?: Record<string, {
5148
+ request?: Record<string, string>
5149
+ response?: Record<string, string>
5150
+ }>
5151
+ }
5152
+ ```
5153
+
5154
+ ### `GenerateTypesResponse`
5155
+
5156
+ ```ts
5157
+ type GenerateTypesResponse = {
5158
+ package_name: string
5159
+ version: string
5160
+ files: Record<string, string>
5161
+ warnings?: string[]
5162
+ }
5163
+ ```
5164
+
5165
+ ### `CommitTypesRequest`
5166
+
5167
+ ```ts
5168
+ type CommitTypesRequest = {
5169
+ package_name: string
5170
+ version: string
5171
+ annotations?: Record<string, {
5172
+ request?: Record<string, string>
5173
+ response?: Record<string, string>
5174
+ }>
5175
+ }
5176
+ ```
5177
+
5178
+ ### `CommitTypesResponse`
5179
+
5180
+ ```ts
5181
+ type CommitTypesResponse = {
5182
+ committed: boolean
5183
+ warnings?: string[]
5184
+ }
5185
+ ```
5186
+
4480
5187
  ### `FileProxyUseCaseConfiguration`
4481
5188
 
4482
5189
  Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
@@ -5197,3 +5904,93 @@ type InboundMonitoringEvent = {
5197
5904
  completed_at: string // date-time
5198
5905
  }
5199
5906
  ```
5907
+
5908
+ ### `QueryMonitoringEventsV2Request`
5909
+
5910
+ ```ts
5911
+ type QueryMonitoringEventsV2Request = {
5912
+ use_case_id?: string
5913
+ use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
5914
+ level?: "success" | "error" | "skipped" | "warning"
5915
+ code?: string
5916
+ event_id?: string
5917
+ correlation_id?: string
5918
+ from_date?: string // date-time
5919
+ to_date?: string // date-time
5920
+ limit?: number
5921
+ cursor?: {
5922
+ created_at?: string // date-time
5923
+ id?: string // uuid
5924
+ }
5925
+ }
5926
+ ```
5927
+
5928
+ ### `MonitoringEventV2`
5929
+
5930
+ ```ts
5931
+ type MonitoringEventV2 = {
5932
+ id: string // uuid
5933
+ org_id: string
5934
+ integration_id: string
5935
+ event_id: string
5936
+ correlation_id?: string
5937
+ use_case_id?: string
5938
+ use_case_type: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy" | ""
5939
+ level: "success" | "error" | "skipped" | "warning"
5940
+ code?: string
5941
+ message?: string
5942
+ detail?: Record<string, unknown>
5943
+ created_at: string // date-time
5944
+ }
5945
+ ```
5946
+
5947
+ ### `GetMonitoringStatsV2Request`
5948
+
5949
+ ```ts
5950
+ type GetMonitoringStatsV2Request = {
5951
+ from_date?: string // date-time
5952
+ to_date?: string // date-time
5953
+ use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
5954
+ group_by?: "use_case_id" | "use_case_type" | "level" | "code" | "date"
5955
+ }
5956
+ ```
5957
+
5958
+ ### `MonitoringStatsV2`
5959
+
5960
+ ```ts
5961
+ type MonitoringStatsV2 = {
5962
+ total_events: number
5963
+ success_count: number
5964
+ error_count: number
5965
+ warning_count: number
5966
+ skipped_count: number
5967
+ ack_timeout_count?: number
5968
+ success_rate?: number
5969
+ last_error_at?: string // date-time
5970
+ breakdown?: Record<string, unknown>[]
5971
+ }
5972
+ ```
5973
+
5974
+ ### `GetMonitoringTimeSeriesV2Request`
5975
+
5976
+ ```ts
5977
+ type GetMonitoringTimeSeriesV2Request = {
5978
+ from_date: string // date-time
5979
+ to_date?: string // date-time
5980
+ interval: "5m" | "10m" | "30m" | "1h" | "3h" | "1d"
5981
+ use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
5982
+ }
5983
+ ```
5984
+
5985
+ ### `TimeSeriesBucketV2`
5986
+
5987
+ ```ts
5988
+ type TimeSeriesBucketV2 = {
5989
+ timestamp: string // date-time
5990
+ success_count?: number
5991
+ error_count?: number
5992
+ warning_count?: number
5993
+ skipped_count?: number
5994
+ total_count: number
5995
+ }
5996
+ ```