@coval/sdk 0.4.1 → 0.4.3
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/dist/CovalClient.d.ts +8 -5
- package/dist/CovalClient.d.ts.map +1 -1
- package/dist/CovalClient.js +53 -9
- package/dist/CovalClient.js.map +1 -1
- package/dist/generated/apis/AlertEventsApi.d.ts +84 -0
- package/dist/generated/apis/AlertEventsApi.d.ts.map +1 -0
- package/dist/generated/apis/AlertEventsApi.js +77 -0
- package/dist/generated/apis/AlertEventsApi.js.map +1 -0
- package/dist/generated/apis/AlertsApi.d.ts +281 -0
- package/dist/generated/apis/AlertsApi.d.ts.map +1 -0
- package/dist/generated/apis/AlertsApi.js +277 -0
- package/dist/generated/apis/AlertsApi.js.map +1 -0
- package/dist/generated/apis/ConversationsApi.d.ts +8 -8
- package/dist/generated/apis/ConversationsApi.js +4 -4
- package/dist/generated/apis/MetricsApi.d.ts +38 -0
- package/dist/generated/apis/MetricsApi.d.ts.map +1 -1
- package/dist/generated/apis/MetricsApi.js +38 -0
- package/dist/generated/apis/MetricsApi.js.map +1 -1
- package/dist/generated/apis/ReportsApi.d.ts +17 -14
- package/dist/generated/apis/ReportsApi.d.ts.map +1 -1
- package/dist/generated/apis/ReportsApi.js +9 -6
- package/dist/generated/apis/ReportsApi.js.map +1 -1
- package/dist/generated/apis/TracesApi.d.ts +40 -0
- package/dist/generated/apis/TracesApi.d.ts.map +1 -1
- package/dist/generated/apis/TracesApi.js +38 -0
- package/dist/generated/apis/TracesApi.js.map +1 -1
- package/dist/generated/apis/index.d.ts +2 -0
- package/dist/generated/apis/index.d.ts.map +1 -1
- package/dist/generated/apis/index.js +2 -0
- package/dist/generated/apis/index.js.map +1 -1
- package/dist/generated/models/CovalAgentsAPICreateAgentRequest.d.ts +33 -4
- package/dist/generated/models/CovalAgentsAPICreateAgentRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalAgentsAPICreateAgentRequest.js.map +1 -1
- package/dist/generated/models/CovalAgentsAPISimulatorType.d.ts +4 -0
- package/dist/generated/models/CovalAgentsAPISimulatorType.d.ts.map +1 -1
- package/dist/generated/models/CovalAgentsAPISimulatorType.js +4 -0
- package/dist/generated/models/CovalAgentsAPISimulatorType.js.map +1 -1
- package/dist/generated/models/CovalAlertsAPIAlertChannel.d.ts +55 -0
- package/dist/generated/models/CovalAlertsAPIAlertChannel.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertChannel.js +53 -0
- package/dist/generated/models/CovalAlertsAPIAlertChannel.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertCondition.d.ts +98 -0
- package/dist/generated/models/CovalAlertsAPIAlertCondition.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertCondition.js +78 -0
- package/dist/generated/models/CovalAlertsAPIAlertCondition.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEvaluationType.d.ts +25 -0
- package/dist/generated/models/CovalAlertsAPIAlertEvaluationType.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEvaluationType.js +43 -0
- package/dist/generated/models/CovalAlertsAPIAlertEvaluationType.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventOutcome.d.ts +28 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventOutcome.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventOutcome.js +46 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventOutcome.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResource.d.ts +78 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResource.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResource.js +69 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResource.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInner.d.ts +70 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInner.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInner.js +55 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInner.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInnerComputedValue.d.ts +22 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInnerComputedValue.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInnerComputedValue.js +44 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInnerComputedValue.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceDispatchedChannelsInner.d.ts +51 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceDispatchedChannelsInner.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceDispatchedChannelsInner.js +48 -0
- package/dist/generated/models/CovalAlertsAPIAlertEventResourceDispatchedChannelsInner.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertMatchMode.d.ts +26 -0
- package/dist/generated/models/CovalAlertsAPIAlertMatchMode.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertMatchMode.js +44 -0
- package/dist/generated/models/CovalAlertsAPIAlertMatchMode.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertResource.d.ts +148 -0
- package/dist/generated/models/CovalAlertsAPIAlertResource.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertResource.js +112 -0
- package/dist/generated/models/CovalAlertsAPIAlertResource.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertScope.d.ts +27 -0
- package/dist/generated/models/CovalAlertsAPIAlertScope.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIAlertScope.js +45 -0
- package/dist/generated/models/CovalAlertsAPIAlertScope.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIChannelInput.d.ts +40 -0
- package/dist/generated/models/CovalAlertsAPIChannelInput.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIChannelInput.js +49 -0
- package/dist/generated/models/CovalAlertsAPIChannelInput.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIChannelType.d.ts +28 -0
- package/dist/generated/models/CovalAlertsAPIChannelType.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIChannelType.js +46 -0
- package/dist/generated/models/CovalAlertsAPIChannelType.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIConditionAggregation.d.ts +31 -0
- package/dist/generated/models/CovalAlertsAPIConditionAggregation.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIConditionAggregation.js +49 -0
- package/dist/generated/models/CovalAlertsAPIConditionAggregation.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIConditionInput.d.ts +92 -0
- package/dist/generated/models/CovalAlertsAPIConditionInput.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIConditionInput.js +74 -0
- package/dist/generated/models/CovalAlertsAPIConditionInput.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIConditionOperator.d.ts +30 -0
- package/dist/generated/models/CovalAlertsAPIConditionOperator.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIConditionOperator.js +48 -0
- package/dist/generated/models/CovalAlertsAPIConditionOperator.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPICreateAlertRequest.d.ts +104 -0
- package/dist/generated/models/CovalAlertsAPICreateAlertRequest.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPICreateAlertRequest.js +75 -0
- package/dist/generated/models/CovalAlertsAPICreateAlertRequest.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponse.d.ts +34 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponse.js +45 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponse.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseError.d.ts +58 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseError.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseError.js +64 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseError.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseErrorDetailsInner.d.ts +39 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseErrorDetailsInner.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseErrorDetailsInner.js +44 -0
- package/dist/generated/models/CovalAlertsAPIErrorResponseErrorDetailsInner.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIListAlertEventsResponse.d.ts +46 -0
- package/dist/generated/models/CovalAlertsAPIListAlertEventsResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIListAlertEventsResponse.js +51 -0
- package/dist/generated/models/CovalAlertsAPIListAlertEventsResponse.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIListAlertsResponse.d.ts +46 -0
- package/dist/generated/models/CovalAlertsAPIListAlertsResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIListAlertsResponse.js +51 -0
- package/dist/generated/models/CovalAlertsAPIListAlertsResponse.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertRequest.d.ts +33 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertRequest.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertRequest.js +44 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertRequest.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertResponse.d.ts +69 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertResponse.js +60 -0
- package/dist/generated/models/CovalAlertsAPITestEvaluateAlertResponse.js.map +1 -0
- package/dist/generated/models/CovalAlertsAPIUpdateAlertRequest.d.ts +104 -0
- package/dist/generated/models/CovalAlertsAPIUpdateAlertRequest.d.ts.map +1 -0
- package/dist/generated/models/CovalAlertsAPIUpdateAlertRequest.js +69 -0
- package/dist/generated/models/CovalAlertsAPIUpdateAlertRequest.js.map +1 -0
- package/dist/generated/models/CovalConversationsAPIPatchConversationRequest.d.ts +27 -4
- package/dist/generated/models/CovalConversationsAPIPatchConversationRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalConversationsAPIPatchConversationRequest.js +2 -0
- package/dist/generated/models/CovalConversationsAPIPatchConversationRequest.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPIErrorResponseError.d.ts +3 -3
- package/dist/generated/models/CovalMetricsAPIErrorResponseError.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPIErrorResponseError.js +3 -3
- package/dist/generated/models/CovalMetricsAPIErrorResponseError.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPIErrorResponseErrorDetailsInner.d.ts +3 -38
- package/dist/generated/models/CovalMetricsAPIErrorResponseErrorDetailsInner.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPIErrorResponseErrorDetailsInner.js +1 -43
- package/dist/generated/models/CovalMetricsAPIErrorResponseErrorDetailsInner.js.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIErrorResponse.d.ts +3 -3
- package/dist/generated/models/CovalMonitorsAPIErrorResponse.d.ts.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIErrorResponse.js +3 -3
- package/dist/generated/models/CovalMonitorsAPIErrorResponse.js.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIErrorResponseError.d.ts +3 -57
- package/dist/generated/models/CovalMonitorsAPIErrorResponseError.d.ts.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIErrorResponseError.js +1 -63
- package/dist/generated/models/CovalMonitorsAPIErrorResponseError.js.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResource.d.ts +6 -6
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResource.d.ts.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResource.js +6 -6
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResource.js.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInner.d.ts +3 -69
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInner.d.ts.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInner.js +1 -54
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInner.js.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInnerComputedValue.d.ts +3 -21
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInnerComputedValue.d.ts.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInnerComputedValue.js +1 -43
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInnerComputedValue.js.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceDispatchedChannelsInner.d.ts +3 -50
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceDispatchedChannelsInner.d.ts.map +1 -1
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceDispatchedChannelsInner.js +1 -47
- package/dist/generated/models/CovalMonitorsAPIMonitorEventResourceDispatchedChannelsInner.js.map +1 -1
- package/dist/generated/models/CovalOrganizationAPIConversationMetricRule.d.ts +2 -1
- package/dist/generated/models/CovalOrganizationAPIConversationMetricRule.d.ts.map +1 -1
- package/dist/generated/models/CovalOrganizationAPIConversationMetricRule.js +2 -1
- package/dist/generated/models/CovalOrganizationAPIConversationMetricRule.js.map +1 -1
- package/dist/generated/models/CovalOrganizationAPIConversationMetricRuleMetadataValue.d.ts +1 -1
- package/dist/generated/models/CovalReportsAPICompareBy.d.ts +4 -1
- package/dist/generated/models/CovalReportsAPICompareBy.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPICompareBy.js +5 -2
- package/dist/generated/models/CovalReportsAPICompareBy.js.map +1 -1
- package/dist/generated/models/CovalReportsAPICreateReportRequest.d.ts +33 -0
- package/dist/generated/models/CovalReportsAPICreateReportRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPICreateReportRequest.js +14 -0
- package/dist/generated/models/CovalReportsAPICreateReportRequest.js.map +1 -1
- package/dist/generated/models/CovalReportsAPIError.d.ts +1 -0
- package/dist/generated/models/CovalReportsAPIError.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIError.js +1 -0
- package/dist/generated/models/CovalReportsAPIError.js.map +1 -1
- package/dist/generated/models/CovalReportsAPIGetReportResponse.d.ts +3 -3
- package/dist/generated/models/CovalReportsAPIGetReportResponse.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIGetReportResponse.js +3 -3
- package/dist/generated/models/CovalReportsAPIGetReportResponse.js.map +1 -1
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersConfiguration.d.ts +45 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersConfiguration.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersConfiguration.js +52 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersConfiguration.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersPatch.d.ts +45 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersPatch.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersPatch.js +46 -0
- package/dist/generated/models/CovalReportsAPIMonitoringFiltersPatch.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIReport.d.ts +6 -0
- package/dist/generated/models/CovalReportsAPIReport.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIReport.js +2 -0
- package/dist/generated/models/CovalReportsAPIReport.js.map +1 -1
- package/dist/generated/models/CovalReportsAPIReportCustomDimension.d.ts +54 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimension.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimension.js +55 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimension.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimensionGroup.d.ts +45 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimensionGroup.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimensionGroup.js +50 -0
- package/dist/generated/models/CovalReportsAPIReportCustomDimensionGroup.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportDetail.d.ts +133 -0
- package/dist/generated/models/CovalReportsAPIReportDetail.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportDetail.js +107 -0
- package/dist/generated/models/CovalReportsAPIReportDetail.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportMetricConfigurationEntry.d.ts +40 -0
- package/dist/generated/models/CovalReportsAPIReportMetricConfigurationEntry.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportMetricConfigurationEntry.js +46 -0
- package/dist/generated/models/CovalReportsAPIReportMetricConfigurationEntry.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportMetricOutput.d.ts +1 -1
- package/dist/generated/models/CovalReportsAPIReportMetricOutput.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIReportMetricOutputValue.d.ts +3 -8
- package/dist/generated/models/CovalReportsAPIReportMetricOutputValue.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIReportMetricOutputValue.js +30 -8
- package/dist/generated/models/CovalReportsAPIReportMetricOutputValue.js.map +1 -1
- package/dist/generated/models/CovalReportsAPIReportViewConfiguration.d.ts +125 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfiguration.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfiguration.js +115 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfiguration.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfigurationPatch.d.ts +133 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfigurationPatch.d.ts.map +1 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfigurationPatch.js +93 -0
- package/dist/generated/models/CovalReportsAPIReportViewConfigurationPatch.js.map +1 -0
- package/dist/generated/models/CovalReportsAPIUpdateReportRequest.d.ts +10 -0
- package/dist/generated/models/CovalReportsAPIUpdateReportRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIUpdateReportRequest.js +3 -0
- package/dist/generated/models/CovalReportsAPIUpdateReportRequest.js.map +1 -1
- package/dist/generated/models/CovalReportsAPIUpdateReportResponse.d.ts +3 -3
- package/dist/generated/models/CovalReportsAPIUpdateReportResponse.d.ts.map +1 -1
- package/dist/generated/models/CovalReportsAPIUpdateReportResponse.js +3 -3
- package/dist/generated/models/CovalReportsAPIUpdateReportResponse.js.map +1 -1
- package/dist/generated/models/CovalSlackIntegrationAPIErrorResponseError.d.ts +3 -3
- package/dist/generated/models/CovalSlackIntegrationAPIErrorResponseError.d.ts.map +1 -1
- package/dist/generated/models/CovalSlackIntegrationAPIErrorResponseError.js +3 -3
- package/dist/generated/models/CovalSlackIntegrationAPIErrorResponseError.js.map +1 -1
- package/dist/generated/models/TracesAPITraceSearchAggregateStats.d.ts +39 -0
- package/dist/generated/models/TracesAPITraceSearchAggregateStats.d.ts.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchAggregateStats.js +48 -0
- package/dist/generated/models/TracesAPITraceSearchAggregateStats.js.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchAttributeFilter.d.ts +58 -0
- package/dist/generated/models/TracesAPITraceSearchAttributeFilter.d.ts.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchAttributeFilter.js +60 -0
- package/dist/generated/models/TracesAPITraceSearchAttributeFilter.js.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchCallResult.d.ts +120 -0
- package/dist/generated/models/TracesAPITraceSearchCallResult.d.ts.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchCallResult.js +96 -0
- package/dist/generated/models/TracesAPITraceSearchCallResult.js.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchFilters.d.ts +113 -0
- package/dist/generated/models/TracesAPITraceSearchFilters.d.ts.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchFilters.js +80 -0
- package/dist/generated/models/TracesAPITraceSearchFilters.js.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchRequest.d.ts +46 -0
- package/dist/generated/models/TracesAPITraceSearchRequest.d.ts.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchRequest.js +47 -0
- package/dist/generated/models/TracesAPITraceSearchRequest.js.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchResponse.d.ts +53 -0
- package/dist/generated/models/TracesAPITraceSearchResponse.d.ts.map +1 -0
- package/dist/generated/models/TracesAPITraceSearchResponse.js +56 -0
- package/dist/generated/models/TracesAPITraceSearchResponse.js.map +1 -0
- package/dist/generated/models/index.d.ts +44 -5
- package/dist/generated/models/index.d.ts.map +1 -1
- package/dist/generated/models/index.js +44 -5
- package/dist/generated/models/index.js.map +1 -1
- package/package.json +1 -1
- package/src/CovalClient.ts +58 -13
- package/src/generated/apis/AlertEventsApi.ts +152 -0
- package/src/generated/apis/AlertsApi.ts +587 -0
- package/src/generated/apis/ConversationsApi.ts +8 -8
- package/src/generated/apis/MetricsApi.ts +79 -0
- package/src/generated/apis/ReportsApi.ts +21 -14
- package/src/generated/apis/TracesApi.ts +84 -0
- package/src/generated/apis/index.ts +2 -0
- package/src/generated/models/CovalAgentsAPICreateAgentRequest.ts +33 -4
- package/src/generated/models/CovalAgentsAPISimulatorType.ts +4 -0
- package/src/generated/models/CovalAlertsAPIAlertChannel.ts +103 -0
- package/src/generated/models/CovalAlertsAPIAlertCondition.ts +168 -0
- package/src/generated/models/CovalAlertsAPIAlertEvaluationType.ts +52 -0
- package/src/generated/models/CovalAlertsAPIAlertEventOutcome.ts +55 -0
- package/src/generated/models/CovalAlertsAPIAlertEventResource.ts +150 -0
- package/src/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInner.ts +121 -0
- package/src/generated/models/CovalAlertsAPIAlertEventResourceConditionResultsInnerComputedValue.ts +55 -0
- package/src/generated/models/CovalAlertsAPIAlertEventResourceDispatchedChannelsInner.ts +89 -0
- package/src/generated/models/CovalAlertsAPIAlertMatchMode.ts +53 -0
- package/src/generated/models/CovalAlertsAPIAlertResource.ts +260 -0
- package/src/generated/models/CovalAlertsAPIAlertScope.ts +54 -0
- package/src/generated/models/CovalAlertsAPIChannelInput.ts +85 -0
- package/src/generated/models/CovalAlertsAPIChannelType.ts +55 -0
- package/src/generated/models/CovalAlertsAPIConditionAggregation.ts +58 -0
- package/src/generated/models/CovalAlertsAPIConditionInput.ts +159 -0
- package/src/generated/models/CovalAlertsAPIConditionOperator.ts +57 -0
- package/src/generated/models/CovalAlertsAPICreateAlertRequest.ts +194 -0
- package/src/generated/models/CovalAlertsAPIErrorResponse.ts +74 -0
- package/src/generated/models/CovalAlertsAPIErrorResponseError.ts +107 -0
- package/src/generated/models/CovalAlertsAPIErrorResponseErrorDetailsInner.ts +73 -0
- package/src/generated/models/CovalAlertsAPIListAlertEventsResponse.ts +91 -0
- package/src/generated/models/CovalAlertsAPIListAlertsResponse.ts +91 -0
- package/src/generated/models/CovalAlertsAPITestEvaluateAlertRequest.ts +66 -0
- package/src/generated/models/CovalAlertsAPITestEvaluateAlertResponse.ts +116 -0
- package/src/generated/models/CovalAlertsAPIUpdateAlertRequest.ts +191 -0
- package/src/generated/models/CovalConversationsAPIPatchConversationRequest.ts +27 -4
- package/src/generated/models/CovalMetricsAPIErrorResponseError.ts +10 -10
- package/src/generated/models/CovalMetricsAPIErrorResponseErrorDetailsInner.ts +11 -71
- package/src/generated/models/CovalMonitorsAPIErrorResponse.ts +10 -10
- package/src/generated/models/CovalMonitorsAPIErrorResponseError.ts +12 -105
- package/src/generated/models/CovalMonitorsAPIMonitorEventResource.ts +20 -20
- package/src/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInner.ts +11 -119
- package/src/generated/models/CovalMonitorsAPIMonitorEventResourceConditionResultsInnerComputedValue.ts +10 -53
- package/src/generated/models/CovalMonitorsAPIMonitorEventResourceDispatchedChannelsInner.ts +11 -87
- package/src/generated/models/CovalOrganizationAPIConversationMetricRule.ts +3 -2
- package/src/generated/models/CovalOrganizationAPIConversationMetricRuleMetadataValue.ts +1 -1
- package/src/generated/models/CovalReportsAPICompareBy.ts +5 -2
- package/src/generated/models/CovalReportsAPICreateReportRequest.ts +46 -0
- package/src/generated/models/CovalReportsAPIError.ts +1 -0
- package/src/generated/models/CovalReportsAPIGetReportResponse.ts +10 -10
- package/src/generated/models/CovalReportsAPIMonitoringFiltersConfiguration.ts +84 -0
- package/src/generated/models/CovalReportsAPIMonitoringFiltersPatch.ts +81 -0
- package/src/generated/models/CovalReportsAPIReport.ts +8 -0
- package/src/generated/models/CovalReportsAPIReportCustomDimension.ts +102 -0
- package/src/generated/models/CovalReportsAPIReportCustomDimensionGroup.ts +83 -0
- package/src/generated/models/CovalReportsAPIReportDetail.ts +213 -0
- package/src/generated/models/CovalReportsAPIReportMetricConfigurationEntry.ts +76 -0
- package/src/generated/models/CovalReportsAPIReportMetricOutput.ts +1 -1
- package/src/generated/models/CovalReportsAPIReportMetricOutputValue.ts +33 -14
- package/src/generated/models/CovalReportsAPIReportViewConfiguration.ts +203 -0
- package/src/generated/models/CovalReportsAPIReportViewConfigurationPatch.ts +199 -0
- package/src/generated/models/CovalReportsAPIUpdateReportRequest.ts +18 -0
- package/src/generated/models/CovalReportsAPIUpdateReportResponse.ts +10 -10
- package/src/generated/models/CovalSlackIntegrationAPIErrorResponseError.ts +10 -10
- package/src/generated/models/TracesAPITraceSearchAggregateStats.ts +75 -0
- package/src/generated/models/TracesAPITraceSearchAttributeFilter.ts +98 -0
- package/src/generated/models/TracesAPITraceSearchCallResult.ts +191 -0
- package/src/generated/models/TracesAPITraceSearchFilters.ts +176 -0
- package/src/generated/models/TracesAPITraceSearchRequest.ts +89 -0
- package/src/generated/models/TracesAPITraceSearchResponse.ts +107 -0
- package/src/generated/models/index.ts +44 -5
|
@@ -0,0 +1,587 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Coval Agents API
|
|
5
|
+
* Manage configurations for simulations and evaluations.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@coval.dev
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import * as runtime from '../runtime.js';
|
|
16
|
+
import {
|
|
17
|
+
type CovalAlertsAPIAlertResource,
|
|
18
|
+
CovalAlertsAPIAlertResourceFromJSON,
|
|
19
|
+
CovalAlertsAPIAlertResourceToJSON,
|
|
20
|
+
} from '../models/CovalAlertsAPIAlertResource.js';
|
|
21
|
+
import {
|
|
22
|
+
type CovalAlertsAPICreateAlertRequest,
|
|
23
|
+
CovalAlertsAPICreateAlertRequestFromJSON,
|
|
24
|
+
CovalAlertsAPICreateAlertRequestToJSON,
|
|
25
|
+
} from '../models/CovalAlertsAPICreateAlertRequest.js';
|
|
26
|
+
import {
|
|
27
|
+
type CovalAlertsAPIErrorResponse,
|
|
28
|
+
CovalAlertsAPIErrorResponseFromJSON,
|
|
29
|
+
CovalAlertsAPIErrorResponseToJSON,
|
|
30
|
+
} from '../models/CovalAlertsAPIErrorResponse.js';
|
|
31
|
+
import {
|
|
32
|
+
type CovalAlertsAPIListAlertsResponse,
|
|
33
|
+
CovalAlertsAPIListAlertsResponseFromJSON,
|
|
34
|
+
CovalAlertsAPIListAlertsResponseToJSON,
|
|
35
|
+
} from '../models/CovalAlertsAPIListAlertsResponse.js';
|
|
36
|
+
import {
|
|
37
|
+
type CovalAlertsAPITestEvaluateAlertRequest,
|
|
38
|
+
CovalAlertsAPITestEvaluateAlertRequestFromJSON,
|
|
39
|
+
CovalAlertsAPITestEvaluateAlertRequestToJSON,
|
|
40
|
+
} from '../models/CovalAlertsAPITestEvaluateAlertRequest.js';
|
|
41
|
+
import {
|
|
42
|
+
type CovalAlertsAPITestEvaluateAlertResponse,
|
|
43
|
+
CovalAlertsAPITestEvaluateAlertResponseFromJSON,
|
|
44
|
+
CovalAlertsAPITestEvaluateAlertResponseToJSON,
|
|
45
|
+
} from '../models/CovalAlertsAPITestEvaluateAlertResponse.js';
|
|
46
|
+
import {
|
|
47
|
+
type CovalAlertsAPIUpdateAlertRequest,
|
|
48
|
+
CovalAlertsAPIUpdateAlertRequestFromJSON,
|
|
49
|
+
CovalAlertsAPIUpdateAlertRequestToJSON,
|
|
50
|
+
} from '../models/CovalAlertsAPIUpdateAlertRequest.js';
|
|
51
|
+
|
|
52
|
+
export interface CreateAlertRequest {
|
|
53
|
+
covalAlertsAPICreateAlertRequest: CovalAlertsAPICreateAlertRequest;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export interface DeleteAlertRequest {
|
|
57
|
+
alertId: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export interface GetAlertRequest {
|
|
61
|
+
alertId: string;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface ListAlertsRequest {
|
|
65
|
+
scope?: ListAlertsScopeEnum;
|
|
66
|
+
pageSize?: number;
|
|
67
|
+
pageToken?: string;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export interface TestEvaluateAlertRequest {
|
|
71
|
+
alertId: string;
|
|
72
|
+
covalAlertsAPITestEvaluateAlertRequest: CovalAlertsAPITestEvaluateAlertRequest;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export interface UpdateAlertRequest {
|
|
76
|
+
alertId: string;
|
|
77
|
+
covalAlertsAPIUpdateAlertRequest: CovalAlertsAPIUpdateAlertRequest;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* AlertsApi - interface
|
|
82
|
+
*
|
|
83
|
+
* @export
|
|
84
|
+
* @interface AlertsApiInterface
|
|
85
|
+
*/
|
|
86
|
+
export interface AlertsApiInterface {
|
|
87
|
+
/**
|
|
88
|
+
* Creates request options for createAlert without sending the request
|
|
89
|
+
* @param {CovalAlertsAPICreateAlertRequest} covalAlertsAPICreateAlertRequest
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
* @memberof AlertsApiInterface
|
|
92
|
+
*/
|
|
93
|
+
createAlertRequestOpts(requestParameters: CreateAlertRequest): Promise<runtime.RequestOpts>;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Creates a new alert with conditions and notification channels. At least one condition is required. Channels are optional — an alert without channels will still evaluate and log events but won\'t dispatch notifications.
|
|
97
|
+
* @summary Create an alert
|
|
98
|
+
* @param {CovalAlertsAPICreateAlertRequest} covalAlertsAPICreateAlertRequest
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
* @memberof AlertsApiInterface
|
|
102
|
+
*/
|
|
103
|
+
createAlertRaw(requestParameters: CreateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIAlertResource>>;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Creates a new alert with conditions and notification channels. At least one condition is required. Channels are optional — an alert without channels will still evaluate and log events but won\'t dispatch notifications.
|
|
107
|
+
* Create an alert
|
|
108
|
+
*/
|
|
109
|
+
createAlert(requestParameters: CreateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIAlertResource>;
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Creates request options for deleteAlert without sending the request
|
|
113
|
+
* @param {string} alertId Alert ULID
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
* @memberof AlertsApiInterface
|
|
116
|
+
*/
|
|
117
|
+
deleteAlertRequestOpts(requestParameters: DeleteAlertRequest): Promise<runtime.RequestOpts>;
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Soft-deletes an alert by setting its status to DELETED. The alert and its channels are deactivated but retained for audit.
|
|
121
|
+
* @summary Delete an alert
|
|
122
|
+
* @param {string} alertId Alert ULID
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
* @memberof AlertsApiInterface
|
|
126
|
+
*/
|
|
127
|
+
deleteAlertRaw(requestParameters: DeleteAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Soft-deletes an alert by setting its status to DELETED. The alert and its channels are deactivated but retained for audit.
|
|
131
|
+
* Delete an alert
|
|
132
|
+
*/
|
|
133
|
+
deleteAlert(requestParameters: DeleteAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Creates request options for getAlert without sending the request
|
|
137
|
+
* @param {string} alertId Alert ULID
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
* @memberof AlertsApiInterface
|
|
140
|
+
*/
|
|
141
|
+
getAlertRequestOpts(requestParameters: GetAlertRequest): Promise<runtime.RequestOpts>;
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Returns a single alert with its conditions and channels.
|
|
145
|
+
* @summary Get an alert
|
|
146
|
+
* @param {string} alertId Alert ULID
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
* @memberof AlertsApiInterface
|
|
150
|
+
*/
|
|
151
|
+
getAlertRaw(requestParameters: GetAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIAlertResource>>;
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Returns a single alert with its conditions and channels.
|
|
155
|
+
* Get an alert
|
|
156
|
+
*/
|
|
157
|
+
getAlert(requestParameters: GetAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIAlertResource>;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* Creates request options for listAlerts without sending the request
|
|
161
|
+
* @param {'ALL' | 'MONITORING' | 'SIMULATION'} [scope] Filter alerts by scope
|
|
162
|
+
* @param {number} [pageSize] Number of results per page
|
|
163
|
+
* @param {string} [pageToken] Token for fetching the next page of results
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
* @memberof AlertsApiInterface
|
|
166
|
+
*/
|
|
167
|
+
listAlertsRequestOpts(requestParameters: ListAlertsRequest): Promise<runtime.RequestOpts>;
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Returns all active alerts for the authenticated organization. Supports optional filtering by scope and pagination.
|
|
171
|
+
* @summary List alerts
|
|
172
|
+
* @param {'ALL' | 'MONITORING' | 'SIMULATION'} [scope] Filter alerts by scope
|
|
173
|
+
* @param {number} [pageSize] Number of results per page
|
|
174
|
+
* @param {string} [pageToken] Token for fetching the next page of results
|
|
175
|
+
* @param {*} [options] Override http request option.
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
* @memberof AlertsApiInterface
|
|
178
|
+
*/
|
|
179
|
+
listAlertsRaw(requestParameters: ListAlertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIListAlertsResponse>>;
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Returns all active alerts for the authenticated organization. Supports optional filtering by scope and pagination.
|
|
183
|
+
* List alerts
|
|
184
|
+
*/
|
|
185
|
+
listAlerts(requestParameters: ListAlertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIListAlertsResponse>;
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Creates request options for testEvaluateAlert without sending the request
|
|
189
|
+
* @param {string} alertId Alert ULID
|
|
190
|
+
* @param {CovalAlertsAPITestEvaluateAlertRequest} covalAlertsAPITestEvaluateAlertRequest
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
* @memberof AlertsApiInterface
|
|
193
|
+
*/
|
|
194
|
+
testEvaluateAlertRequestOpts(requestParameters: TestEvaluateAlertRequest): Promise<runtime.RequestOpts>;
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Dry-run evaluation of an alert against a specific run. Evaluates all conditions and builds the notification message, but does **not** dispatch notifications or write an event record. Use this to preview what would happen if the alert evaluated against a given run.
|
|
198
|
+
* @summary Test evaluate an alert
|
|
199
|
+
* @param {string} alertId Alert ULID
|
|
200
|
+
* @param {CovalAlertsAPITestEvaluateAlertRequest} covalAlertsAPITestEvaluateAlertRequest
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
* @memberof AlertsApiInterface
|
|
204
|
+
*/
|
|
205
|
+
testEvaluateAlertRaw(requestParameters: TestEvaluateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPITestEvaluateAlertResponse>>;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Dry-run evaluation of an alert against a specific run. Evaluates all conditions and builds the notification message, but does **not** dispatch notifications or write an event record. Use this to preview what would happen if the alert evaluated against a given run.
|
|
209
|
+
* Test evaluate an alert
|
|
210
|
+
*/
|
|
211
|
+
testEvaluateAlert(requestParameters: TestEvaluateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPITestEvaluateAlertResponse>;
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Creates request options for updateAlert without sending the request
|
|
215
|
+
* @param {string} alertId Alert ULID
|
|
216
|
+
* @param {CovalAlertsAPIUpdateAlertRequest} covalAlertsAPIUpdateAlertRequest
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
* @memberof AlertsApiInterface
|
|
219
|
+
*/
|
|
220
|
+
updateAlertRequestOpts(requestParameters: UpdateAlertRequest): Promise<runtime.RequestOpts>;
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Partially updates an alert. All fields are optional; omitted fields retain their current values (PATCH semantics). When `conditions` or `channels` are provided, they **replace** the existing set atomically (delete old, create new).
|
|
224
|
+
* @summary Update an alert
|
|
225
|
+
* @param {string} alertId Alert ULID
|
|
226
|
+
* @param {CovalAlertsAPIUpdateAlertRequest} covalAlertsAPIUpdateAlertRequest
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
* @memberof AlertsApiInterface
|
|
230
|
+
*/
|
|
231
|
+
updateAlertRaw(requestParameters: UpdateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIAlertResource>>;
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Partially updates an alert. All fields are optional; omitted fields retain their current values (PATCH semantics). When `conditions` or `channels` are provided, they **replace** the existing set atomically (delete old, create new).
|
|
235
|
+
* Update an alert
|
|
236
|
+
*/
|
|
237
|
+
updateAlert(requestParameters: UpdateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIAlertResource>;
|
|
238
|
+
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
*
|
|
243
|
+
*/
|
|
244
|
+
export class AlertsApi extends runtime.BaseAPI implements AlertsApiInterface {
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Creates request options for createAlert without sending the request
|
|
248
|
+
*/
|
|
249
|
+
async createAlertRequestOpts(requestParameters: CreateAlertRequest): Promise<runtime.RequestOpts> {
|
|
250
|
+
if (requestParameters['covalAlertsAPICreateAlertRequest'] == null) {
|
|
251
|
+
throw new runtime.RequiredError(
|
|
252
|
+
'covalAlertsAPICreateAlertRequest',
|
|
253
|
+
'Required parameter "covalAlertsAPICreateAlertRequest" was null or undefined when calling createAlert().'
|
|
254
|
+
);
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
const queryParameters: any = {};
|
|
258
|
+
|
|
259
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
260
|
+
|
|
261
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
262
|
+
|
|
263
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
264
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
let urlPath = `/alerts`;
|
|
269
|
+
|
|
270
|
+
return {
|
|
271
|
+
path: urlPath,
|
|
272
|
+
method: 'POST',
|
|
273
|
+
headers: headerParameters,
|
|
274
|
+
query: queryParameters,
|
|
275
|
+
body: CovalAlertsAPICreateAlertRequestToJSON(requestParameters['covalAlertsAPICreateAlertRequest']),
|
|
276
|
+
};
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* Creates a new alert with conditions and notification channels. At least one condition is required. Channels are optional — an alert without channels will still evaluate and log events but won\'t dispatch notifications.
|
|
281
|
+
* Create an alert
|
|
282
|
+
*/
|
|
283
|
+
async createAlertRaw(requestParameters: CreateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIAlertResource>> {
|
|
284
|
+
const requestOptions = await this.createAlertRequestOpts(requestParameters);
|
|
285
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
286
|
+
|
|
287
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalAlertsAPIAlertResourceFromJSON(jsonValue));
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Creates a new alert with conditions and notification channels. At least one condition is required. Channels are optional — an alert without channels will still evaluate and log events but won\'t dispatch notifications.
|
|
292
|
+
* Create an alert
|
|
293
|
+
*/
|
|
294
|
+
async createAlert(requestParameters: CreateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIAlertResource> {
|
|
295
|
+
const response = await this.createAlertRaw(requestParameters, initOverrides);
|
|
296
|
+
return await response.value();
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* Creates request options for deleteAlert without sending the request
|
|
301
|
+
*/
|
|
302
|
+
async deleteAlertRequestOpts(requestParameters: DeleteAlertRequest): Promise<runtime.RequestOpts> {
|
|
303
|
+
if (requestParameters['alertId'] == null) {
|
|
304
|
+
throw new runtime.RequiredError(
|
|
305
|
+
'alertId',
|
|
306
|
+
'Required parameter "alertId" was null or undefined when calling deleteAlert().'
|
|
307
|
+
);
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
const queryParameters: any = {};
|
|
311
|
+
|
|
312
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
313
|
+
|
|
314
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
315
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
let urlPath = `/alerts/{alert_id}`;
|
|
320
|
+
urlPath = urlPath.replace('{alert_id}', encodeURIComponent(String(requestParameters['alertId'])));
|
|
321
|
+
|
|
322
|
+
return {
|
|
323
|
+
path: urlPath,
|
|
324
|
+
method: 'DELETE',
|
|
325
|
+
headers: headerParameters,
|
|
326
|
+
query: queryParameters,
|
|
327
|
+
};
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* Soft-deletes an alert by setting its status to DELETED. The alert and its channels are deactivated but retained for audit.
|
|
332
|
+
* Delete an alert
|
|
333
|
+
*/
|
|
334
|
+
async deleteAlertRaw(requestParameters: DeleteAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
335
|
+
const requestOptions = await this.deleteAlertRequestOpts(requestParameters);
|
|
336
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
337
|
+
|
|
338
|
+
return new runtime.VoidApiResponse(response);
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* Soft-deletes an alert by setting its status to DELETED. The alert and its channels are deactivated but retained for audit.
|
|
343
|
+
* Delete an alert
|
|
344
|
+
*/
|
|
345
|
+
async deleteAlert(requestParameters: DeleteAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
346
|
+
await this.deleteAlertRaw(requestParameters, initOverrides);
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* Creates request options for getAlert without sending the request
|
|
351
|
+
*/
|
|
352
|
+
async getAlertRequestOpts(requestParameters: GetAlertRequest): Promise<runtime.RequestOpts> {
|
|
353
|
+
if (requestParameters['alertId'] == null) {
|
|
354
|
+
throw new runtime.RequiredError(
|
|
355
|
+
'alertId',
|
|
356
|
+
'Required parameter "alertId" was null or undefined when calling getAlert().'
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
const queryParameters: any = {};
|
|
361
|
+
|
|
362
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
363
|
+
|
|
364
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
365
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
let urlPath = `/alerts/{alert_id}`;
|
|
370
|
+
urlPath = urlPath.replace('{alert_id}', encodeURIComponent(String(requestParameters['alertId'])));
|
|
371
|
+
|
|
372
|
+
return {
|
|
373
|
+
path: urlPath,
|
|
374
|
+
method: 'GET',
|
|
375
|
+
headers: headerParameters,
|
|
376
|
+
query: queryParameters,
|
|
377
|
+
};
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Returns a single alert with its conditions and channels.
|
|
382
|
+
* Get an alert
|
|
383
|
+
*/
|
|
384
|
+
async getAlertRaw(requestParameters: GetAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIAlertResource>> {
|
|
385
|
+
const requestOptions = await this.getAlertRequestOpts(requestParameters);
|
|
386
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
387
|
+
|
|
388
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalAlertsAPIAlertResourceFromJSON(jsonValue));
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
/**
|
|
392
|
+
* Returns a single alert with its conditions and channels.
|
|
393
|
+
* Get an alert
|
|
394
|
+
*/
|
|
395
|
+
async getAlert(requestParameters: GetAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIAlertResource> {
|
|
396
|
+
const response = await this.getAlertRaw(requestParameters, initOverrides);
|
|
397
|
+
return await response.value();
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
/**
|
|
401
|
+
* Creates request options for listAlerts without sending the request
|
|
402
|
+
*/
|
|
403
|
+
async listAlertsRequestOpts(requestParameters: ListAlertsRequest): Promise<runtime.RequestOpts> {
|
|
404
|
+
const queryParameters: any = {};
|
|
405
|
+
|
|
406
|
+
if (requestParameters['scope'] != null) {
|
|
407
|
+
queryParameters['scope'] = requestParameters['scope'];
|
|
408
|
+
}
|
|
409
|
+
|
|
410
|
+
if (requestParameters['pageSize'] != null) {
|
|
411
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
if (requestParameters['pageToken'] != null) {
|
|
415
|
+
queryParameters['page_token'] = requestParameters['pageToken'];
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
419
|
+
|
|
420
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
421
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
let urlPath = `/alerts`;
|
|
426
|
+
|
|
427
|
+
return {
|
|
428
|
+
path: urlPath,
|
|
429
|
+
method: 'GET',
|
|
430
|
+
headers: headerParameters,
|
|
431
|
+
query: queryParameters,
|
|
432
|
+
};
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
/**
|
|
436
|
+
* Returns all active alerts for the authenticated organization. Supports optional filtering by scope and pagination.
|
|
437
|
+
* List alerts
|
|
438
|
+
*/
|
|
439
|
+
async listAlertsRaw(requestParameters: ListAlertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIListAlertsResponse>> {
|
|
440
|
+
const requestOptions = await this.listAlertsRequestOpts(requestParameters);
|
|
441
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
442
|
+
|
|
443
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalAlertsAPIListAlertsResponseFromJSON(jsonValue));
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Returns all active alerts for the authenticated organization. Supports optional filtering by scope and pagination.
|
|
448
|
+
* List alerts
|
|
449
|
+
*/
|
|
450
|
+
async listAlerts(requestParameters: ListAlertsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIListAlertsResponse> {
|
|
451
|
+
const response = await this.listAlertsRaw(requestParameters, initOverrides);
|
|
452
|
+
return await response.value();
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Creates request options for testEvaluateAlert without sending the request
|
|
457
|
+
*/
|
|
458
|
+
async testEvaluateAlertRequestOpts(requestParameters: TestEvaluateAlertRequest): Promise<runtime.RequestOpts> {
|
|
459
|
+
if (requestParameters['alertId'] == null) {
|
|
460
|
+
throw new runtime.RequiredError(
|
|
461
|
+
'alertId',
|
|
462
|
+
'Required parameter "alertId" was null or undefined when calling testEvaluateAlert().'
|
|
463
|
+
);
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
if (requestParameters['covalAlertsAPITestEvaluateAlertRequest'] == null) {
|
|
467
|
+
throw new runtime.RequiredError(
|
|
468
|
+
'covalAlertsAPITestEvaluateAlertRequest',
|
|
469
|
+
'Required parameter "covalAlertsAPITestEvaluateAlertRequest" was null or undefined when calling testEvaluateAlert().'
|
|
470
|
+
);
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
const queryParameters: any = {};
|
|
474
|
+
|
|
475
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
476
|
+
|
|
477
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
478
|
+
|
|
479
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
480
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
let urlPath = `/alerts/{alert_id}/test-evaluate`;
|
|
485
|
+
urlPath = urlPath.replace('{alert_id}', encodeURIComponent(String(requestParameters['alertId'])));
|
|
486
|
+
|
|
487
|
+
return {
|
|
488
|
+
path: urlPath,
|
|
489
|
+
method: 'POST',
|
|
490
|
+
headers: headerParameters,
|
|
491
|
+
query: queryParameters,
|
|
492
|
+
body: CovalAlertsAPITestEvaluateAlertRequestToJSON(requestParameters['covalAlertsAPITestEvaluateAlertRequest']),
|
|
493
|
+
};
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* Dry-run evaluation of an alert against a specific run. Evaluates all conditions and builds the notification message, but does **not** dispatch notifications or write an event record. Use this to preview what would happen if the alert evaluated against a given run.
|
|
498
|
+
* Test evaluate an alert
|
|
499
|
+
*/
|
|
500
|
+
async testEvaluateAlertRaw(requestParameters: TestEvaluateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPITestEvaluateAlertResponse>> {
|
|
501
|
+
const requestOptions = await this.testEvaluateAlertRequestOpts(requestParameters);
|
|
502
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
503
|
+
|
|
504
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalAlertsAPITestEvaluateAlertResponseFromJSON(jsonValue));
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
/**
|
|
508
|
+
* Dry-run evaluation of an alert against a specific run. Evaluates all conditions and builds the notification message, but does **not** dispatch notifications or write an event record. Use this to preview what would happen if the alert evaluated against a given run.
|
|
509
|
+
* Test evaluate an alert
|
|
510
|
+
*/
|
|
511
|
+
async testEvaluateAlert(requestParameters: TestEvaluateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPITestEvaluateAlertResponse> {
|
|
512
|
+
const response = await this.testEvaluateAlertRaw(requestParameters, initOverrides);
|
|
513
|
+
return await response.value();
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* Creates request options for updateAlert without sending the request
|
|
518
|
+
*/
|
|
519
|
+
async updateAlertRequestOpts(requestParameters: UpdateAlertRequest): Promise<runtime.RequestOpts> {
|
|
520
|
+
if (requestParameters['alertId'] == null) {
|
|
521
|
+
throw new runtime.RequiredError(
|
|
522
|
+
'alertId',
|
|
523
|
+
'Required parameter "alertId" was null or undefined when calling updateAlert().'
|
|
524
|
+
);
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
if (requestParameters['covalAlertsAPIUpdateAlertRequest'] == null) {
|
|
528
|
+
throw new runtime.RequiredError(
|
|
529
|
+
'covalAlertsAPIUpdateAlertRequest',
|
|
530
|
+
'Required parameter "covalAlertsAPIUpdateAlertRequest" was null or undefined when calling updateAlert().'
|
|
531
|
+
);
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
const queryParameters: any = {};
|
|
535
|
+
|
|
536
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
537
|
+
|
|
538
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
539
|
+
|
|
540
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
541
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
let urlPath = `/alerts/{alert_id}`;
|
|
546
|
+
urlPath = urlPath.replace('{alert_id}', encodeURIComponent(String(requestParameters['alertId'])));
|
|
547
|
+
|
|
548
|
+
return {
|
|
549
|
+
path: urlPath,
|
|
550
|
+
method: 'PATCH',
|
|
551
|
+
headers: headerParameters,
|
|
552
|
+
query: queryParameters,
|
|
553
|
+
body: CovalAlertsAPIUpdateAlertRequestToJSON(requestParameters['covalAlertsAPIUpdateAlertRequest']),
|
|
554
|
+
};
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Partially updates an alert. All fields are optional; omitted fields retain their current values (PATCH semantics). When `conditions` or `channels` are provided, they **replace** the existing set atomically (delete old, create new).
|
|
559
|
+
* Update an alert
|
|
560
|
+
*/
|
|
561
|
+
async updateAlertRaw(requestParameters: UpdateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIAlertResource>> {
|
|
562
|
+
const requestOptions = await this.updateAlertRequestOpts(requestParameters);
|
|
563
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
564
|
+
|
|
565
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalAlertsAPIAlertResourceFromJSON(jsonValue));
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Partially updates an alert. All fields are optional; omitted fields retain their current values (PATCH semantics). When `conditions` or `channels` are provided, they **replace** the existing set atomically (delete old, create new).
|
|
570
|
+
* Update an alert
|
|
571
|
+
*/
|
|
572
|
+
async updateAlert(requestParameters: UpdateAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIAlertResource> {
|
|
573
|
+
const response = await this.updateAlertRaw(requestParameters, initOverrides);
|
|
574
|
+
return await response.value();
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
/**
|
|
580
|
+
* @export
|
|
581
|
+
*/
|
|
582
|
+
export const ListAlertsScopeEnum = {
|
|
583
|
+
All: 'ALL',
|
|
584
|
+
Monitoring: 'MONITORING',
|
|
585
|
+
Simulation: 'SIMULATION'
|
|
586
|
+
} as const;
|
|
587
|
+
export type ListAlertsScopeEnum = typeof ListAlertsScopeEnum[keyof typeof ListAlertsScopeEnum];
|
|
@@ -273,8 +273,8 @@ export interface ConversationsApiInterface {
|
|
|
273
273
|
patchConversationRequestOpts(requestParameters: PatchConversationRequest): Promise<runtime.RequestOpts>;
|
|
274
274
|
|
|
275
275
|
/**
|
|
276
|
-
* Attach an audio recording to a conversation previously submitted via `POST /v1/conversations:submit
|
|
277
|
-
* @summary Attach audio to a conversation
|
|
276
|
+
* Attach an audio recording, or add metadata keys, to a conversation previously submitted via `POST /v1/conversations:submit`. **When to attach audio** Use this endpoint when your recording URL is not available at the moment the call ends (for example, Twilio Programmable Voice recordings that are only fetchable after an asynchronous job completes ~60 seconds later). Submit the transcript immediately at call end to get a `conversation_id` for trace correlation, then PATCH the audio when the recording URL is ready. Attaching audio triggers audio-dependent metrics as a second wave. **When to add metadata** Use this endpoint when a value you want to filter or segment on is only known after the call was submitted (for example, an outcome produced by post-call analysis). Once added, the key is immediately available as a filter on the Conversations page and in the `filter` parameter of `GET /v1/conversations`. **Two-wave metric timing** - Text-only metrics fire immediately after `POST /v1/conversations:submit` and deliver their results via your configured webhook. - Audio-dependent metrics fire after an audio PATCH and deliver a separate, later webhook. Configure your consumer to expect both waves. Adding metadata does **not** run or re-run any metric. If a metric depends on a key you added, rerun it with `POST /v1/simulations:rerunMetrics`. **One-shot** Both patch targets are write-once. Audio can be attached only once per conversation; a second PATCH on a conversation that already has audio returns `409 ALREADY_EXISTS`. Metadata is additive only; patching a key that already has a value returns `409 ALREADY_EXISTS`. **Body** Exactly one of `audio`, `audio_url` or `metadata` is required.
|
|
277
|
+
* @summary Attach audio or add metadata to a conversation
|
|
278
278
|
* @param {string} conversationId Unique conversation identifier (22-26 characters)
|
|
279
279
|
* @param {CovalConversationsAPIPatchConversationRequest} covalConversationsAPIPatchConversationRequest
|
|
280
280
|
* @param {*} [options] Override http request option.
|
|
@@ -284,8 +284,8 @@ export interface ConversationsApiInterface {
|
|
|
284
284
|
patchConversationRaw(requestParameters: PatchConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalConversationsAPIGetConversationResponse>>;
|
|
285
285
|
|
|
286
286
|
/**
|
|
287
|
-
* Attach an audio recording to a conversation previously submitted via `POST /v1/conversations:submit
|
|
288
|
-
* Attach audio to a conversation
|
|
287
|
+
* Attach an audio recording, or add metadata keys, to a conversation previously submitted via `POST /v1/conversations:submit`. **When to attach audio** Use this endpoint when your recording URL is not available at the moment the call ends (for example, Twilio Programmable Voice recordings that are only fetchable after an asynchronous job completes ~60 seconds later). Submit the transcript immediately at call end to get a `conversation_id` for trace correlation, then PATCH the audio when the recording URL is ready. Attaching audio triggers audio-dependent metrics as a second wave. **When to add metadata** Use this endpoint when a value you want to filter or segment on is only known after the call was submitted (for example, an outcome produced by post-call analysis). Once added, the key is immediately available as a filter on the Conversations page and in the `filter` parameter of `GET /v1/conversations`. **Two-wave metric timing** - Text-only metrics fire immediately after `POST /v1/conversations:submit` and deliver their results via your configured webhook. - Audio-dependent metrics fire after an audio PATCH and deliver a separate, later webhook. Configure your consumer to expect both waves. Adding metadata does **not** run or re-run any metric. If a metric depends on a key you added, rerun it with `POST /v1/simulations:rerunMetrics`. **One-shot** Both patch targets are write-once. Audio can be attached only once per conversation; a second PATCH on a conversation that already has audio returns `409 ALREADY_EXISTS`. Metadata is additive only; patching a key that already has a value returns `409 ALREADY_EXISTS`. **Body** Exactly one of `audio`, `audio_url` or `metadata` is required.
|
|
288
|
+
* Attach audio or add metadata to a conversation
|
|
289
289
|
*/
|
|
290
290
|
patchConversation(requestParameters: PatchConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalConversationsAPIGetConversationResponse>;
|
|
291
291
|
|
|
@@ -681,8 +681,8 @@ export class ConversationsApi extends runtime.BaseAPI implements ConversationsAp
|
|
|
681
681
|
}
|
|
682
682
|
|
|
683
683
|
/**
|
|
684
|
-
* Attach an audio recording to a conversation previously submitted via `POST /v1/conversations:submit
|
|
685
|
-
* Attach audio to a conversation
|
|
684
|
+
* Attach an audio recording, or add metadata keys, to a conversation previously submitted via `POST /v1/conversations:submit`. **When to attach audio** Use this endpoint when your recording URL is not available at the moment the call ends (for example, Twilio Programmable Voice recordings that are only fetchable after an asynchronous job completes ~60 seconds later). Submit the transcript immediately at call end to get a `conversation_id` for trace correlation, then PATCH the audio when the recording URL is ready. Attaching audio triggers audio-dependent metrics as a second wave. **When to add metadata** Use this endpoint when a value you want to filter or segment on is only known after the call was submitted (for example, an outcome produced by post-call analysis). Once added, the key is immediately available as a filter on the Conversations page and in the `filter` parameter of `GET /v1/conversations`. **Two-wave metric timing** - Text-only metrics fire immediately after `POST /v1/conversations:submit` and deliver their results via your configured webhook. - Audio-dependent metrics fire after an audio PATCH and deliver a separate, later webhook. Configure your consumer to expect both waves. Adding metadata does **not** run or re-run any metric. If a metric depends on a key you added, rerun it with `POST /v1/simulations:rerunMetrics`. **One-shot** Both patch targets are write-once. Audio can be attached only once per conversation; a second PATCH on a conversation that already has audio returns `409 ALREADY_EXISTS`. Metadata is additive only; patching a key that already has a value returns `409 ALREADY_EXISTS`. **Body** Exactly one of `audio`, `audio_url` or `metadata` is required.
|
|
685
|
+
* Attach audio or add metadata to a conversation
|
|
686
686
|
*/
|
|
687
687
|
async patchConversationRaw(requestParameters: PatchConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalConversationsAPIGetConversationResponse>> {
|
|
688
688
|
const requestOptions = await this.patchConversationRequestOpts(requestParameters);
|
|
@@ -692,8 +692,8 @@ export class ConversationsApi extends runtime.BaseAPI implements ConversationsAp
|
|
|
692
692
|
}
|
|
693
693
|
|
|
694
694
|
/**
|
|
695
|
-
* Attach an audio recording to a conversation previously submitted via `POST /v1/conversations:submit
|
|
696
|
-
* Attach audio to a conversation
|
|
695
|
+
* Attach an audio recording, or add metadata keys, to a conversation previously submitted via `POST /v1/conversations:submit`. **When to attach audio** Use this endpoint when your recording URL is not available at the moment the call ends (for example, Twilio Programmable Voice recordings that are only fetchable after an asynchronous job completes ~60 seconds later). Submit the transcript immediately at call end to get a `conversation_id` for trace correlation, then PATCH the audio when the recording URL is ready. Attaching audio triggers audio-dependent metrics as a second wave. **When to add metadata** Use this endpoint when a value you want to filter or segment on is only known after the call was submitted (for example, an outcome produced by post-call analysis). Once added, the key is immediately available as a filter on the Conversations page and in the `filter` parameter of `GET /v1/conversations`. **Two-wave metric timing** - Text-only metrics fire immediately after `POST /v1/conversations:submit` and deliver their results via your configured webhook. - Audio-dependent metrics fire after an audio PATCH and deliver a separate, later webhook. Configure your consumer to expect both waves. Adding metadata does **not** run or re-run any metric. If a metric depends on a key you added, rerun it with `POST /v1/simulations:rerunMetrics`. **One-shot** Both patch targets are write-once. Audio can be attached only once per conversation; a second PATCH on a conversation that already has audio returns `409 ALREADY_EXISTS`. Metadata is additive only; patching a key that already has a value returns `409 ALREADY_EXISTS`. **Body** Exactly one of `audio`, `audio_url` or `metadata` is required.
|
|
696
|
+
* Attach audio or add metadata to a conversation
|
|
697
697
|
*/
|
|
698
698
|
async patchConversation(requestParameters: PatchConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalConversationsAPIGetConversationResponse> {
|
|
699
699
|
const response = await this.patchConversationRaw(requestParameters, initOverrides);
|