@sippulse/niva-sdk 0.1.0-rc.9 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,7 +4,7 @@
4
4
  */
5
5
  import type { NivaCall } from "../safe.js";
6
6
  import type { NivaRequestOptions, NivaStream } from "../types.js";
7
- import type { AiGetCallAnalysesInput, AiGetTranscriptionInput, AiListStructuredAnalysesInput, AiRunAnalysisInput, AiRunConfiguredAnalysesInput, AiRunSpeechAnalyticsInput, AiSearchTranscriptionsInput, AiTranscribeNowInput, ApiKeysCreateInput, ApiKeysFinishRotationInput, ApiKeysGetInput, ApiKeysListInput, ApiKeysRevokeInput, ApiKeysRotateInput, ApiKeysUpdateInput, ApiKeysUsageInput, ArchiveListDeletedInput, ArchivePurgeInput, ArchiveRestoreInput, AudioFilesContentInput, AudioFilesDeleteInput, AudioFilesGenerateTtsInput, AudioFilesGetByIdInput, AudioFilesListInput, AudioFilesPreviewUrlInput, AudioFilesRegenerateTtsInput, AudioFilesUpdateInput, AudioFilesUploadInput, AuditCountInput, AuditExportCsvInput, AuditListInput, CallRecordsCountInput, CallRecordsExportCsvInput, CallRecordsGetByIdInput, CallRecordsGetEventsInput, CallRecordsGetRecordingUrlInput, CallRecordsListInput, CallRecordsPurgeVoiceContentInput, CallRecordsRecordingContentInput, CallRecordsRetryRecordingInput, CallsHangupCallInput, CallsOriginateInput, ChannelsCreateInput, ChannelsDeleteInput, ChannelsGetByIdInput, ChannelsListInput, ChannelsTestConnectionInput, ChannelsToggleInput, ChannelsUpdateInput, ContactsGetByIdInput, ContactsListInput, ContactsUpdateInput, DestinationsCreateInput, DestinationsDeleteInput, DestinationsGetByIdInput, DestinationsListInput, DestinationsUpdateInput, DialerAttemptsListInput, DialerCampaignsControlInput, DialerCampaignsCreateInput, DialerCampaignsDeleteInput, DialerCampaignsGetInput, DialerCampaignsListInput, DialerCampaignsLiveStatsInput, DialerCampaignsStatsInput, DialerCampaignsUpdateInput, DialerContactsAddInput, DialerContactsBulkCancelInput, DialerContactsBulkRequeueInput, DialerContactsCancelInput, DialerContactsExportCsvInput, DialerContactsGetInput, DialerContactsListInput, DialerContactsRemoveInput, DialerContactsRequeueInput, DialerContactsRequeueAllInput, DialerContactsUpdateInput, DialerDncAddInput, DialerDncBulkImportInput, DialerDncBulkRemoveInput, DialerDncListInput, DialerDncRemoveInput, DialerImportsCreateInput, DialerImportsGetInput, DialerImportsInvalidRowsInput, DialerImportsProgressInput, HolidaysCreateInput, HolidaysDeleteInput, HolidaysGroupsCreateInput, HolidaysGroupsDeleteInput, HolidaysGroupsGetByIdInput, HolidaysGroupsListInput, HolidaysGroupsUpdateInput, HolidaysImportInput, HolidaysListInput, HolidaysPreviewImportInput, HolidaysUpdateInput, InsightsAggregateInput, NodesSchemaInput, OauthGrantsListInput, OauthGrantsRevokeInput, OauthGrantsUsageInput, OrgSettingsUpsertDialerInput, SchedulesCreateInput, SchedulesDeleteInput, SchedulesGetByIdInput, SchedulesListInput, SchedulesUpdateInput, SecretsListInput, SignalsCallSignalsInput, SignalsCreateInput, SignalsDeleteInput, SignalsGetInput, SignalsListInput, SignalsPresetsInput, SignalsTestInput, SignalsUpdateInput, SignalsUpsertBySlugInput, TtsListVoicesInput, TtsPreviewInput, UsersActivateMemberInput, UsersCreateMemberInput, UsersListMembersInput, UsersRemoveMemberInput, UsersResetSecondFactorInput, UsersRevokeMemberSessionsInput, UsersSuspendMemberInput, UsersUnlockMemberInput, UsersUpdateMyNotificationEmailInput, UsersUpdateMyNotificationToastInput, UsersUpdateRoleInput, VisualPlansCloneInput, VisualPlansCreateInput, VisualPlansDeleteInput, VisualPlansGetByIdInput, VisualPlansImportDraftInput, VisualPlansListInput, VisualPlansListVersionsInput, VisualPlansPublishInput, VisualPlansUpdateInput, VisualPlansValidateInput, WebhooksDeliveriesAggregatesGetInput, WebhooksDeliveriesAggregatesListInput, WebhooksDeliveriesCountInput, WebhooksDeliveriesGetByIdInput, WebhooksDeliveriesListInput, WebhooksDeliveriesRetryInput, WebhooksEndpointsCreateInput, WebhooksEndpointsDeleteInput, WebhooksEndpointsGetByIdInput, WebhooksEndpointsListInput, WebhooksEndpointsRotateSecretInput, WebhooksEndpointsUpdateInput, AiGetBudgetOutput, AiGetBudgetOverviewOutput, AiGetCallAnalysesOutput, AiGetTranscriptionOutput, AiGetUsageOutput, AiListAgentsOutput, AiListStructuredAnalysesOutput, AiRunAnalysisOutput, AiRunConfiguredAnalysesOutput, AiRunSpeechAnalyticsOutput, AiSearchTranscriptionsOutput, AiTranscribeNowOutput, ApiKeysCreateOutput, ApiKeysFinishRotationOutput, ApiKeysGetOutput, ApiKeysListOutput, ApiKeysRevokeOutput, ApiKeysRotateOutput, ApiKeysUpdateOutput, ApiKeysUsageOutput, ArchiveListDeletedOutput, ArchivePurgeOutput, ArchiveRestoreOutput, ArchiveSummaryOutput, AudioFilesDeleteOutput, AudioFilesGenerateTtsOutput, AudioFilesGetByIdOutput, AudioFilesListOutput, AudioFilesRegenerateTtsOutput, AudioFilesUpdateOutput, AudioFilesUploadOutput, AuditCountOutput, AuditListOutput, CallRecordsCountOutput, CallRecordsGetByIdOutput, CallRecordsGetEventsOutput, CallRecordsGetRecordingUrlOutput, CallRecordsListOutput, CallRecordsPurgeVoiceContentOutput, CallRecordsRetryRecordingOutput, CallsHangupCallOutput, CallsOriginateOutput, CapabilitiesGetOutput, ChannelsCreateOutput, ChannelsDeleteOutput, ChannelsGetByIdOutput, ChannelsListOutput, ChannelsTestConnectionOutput, ChannelsToggleOutput, ChannelsUpdateOutput, ContactsGetByIdOutput, ContactsListOutput, ContactsUpdateOutput, DashboardCapacityStatusOutput, DestinationsCreateOutput, DestinationsDeleteOutput, DestinationsGetByIdOutput, DestinationsListOutput, DestinationsUpdateOutput, DialerAttemptsListOutput, DialerCampaignsControlOutput, DialerCampaignsCreateOutput, DialerCampaignsDeleteOutput, DialerCampaignsGetOutput, DialerCampaignsListOutput, DialerCampaignsStatsOutput, DialerCampaignsSummaryOutput, DialerCampaignsUpdateOutput, DialerContactsAddOutput, DialerContactsBulkCancelOutput, DialerContactsBulkRequeueOutput, DialerContactsCancelOutput, DialerContactsGetOutput, DialerContactsListOutput, DialerContactsRemoveOutput, DialerContactsRequeueOutput, DialerContactsRequeueAllOutput, DialerContactsUpdateOutput, DialerDncAddOutput, DialerDncBulkImportOutput, DialerDncBulkRemoveOutput, DialerDncListOutput, DialerDncRemoveOutput, DialerImportsCreateOutput, DialerImportsGetOutput, DialerImportsInvalidRowsOutput, HolidaysCountriesOutput, HolidaysCreateOutput, HolidaysDeleteOutput, HolidaysGroupsCreateOutput, HolidaysGroupsDeleteOutput, HolidaysGroupsGetByIdOutput, HolidaysGroupsListOutput, HolidaysGroupsUpdateOutput, HolidaysImportOutput, HolidaysListOutput, HolidaysPreviewImportOutput, HolidaysUpdateOutput, InsightsAggregateOutput, LicenseModulesOutput, LicenseStatusOutput, NodesListOutput, NodesSchemaOutput, OauthGrantsListOutput, OauthGrantsRevokeOutput, OauthGrantsUsageOutput, OrgSettingsGetDialerOutput, OrgSettingsUpsertDialerOutput, SchedulesCreateOutput, SchedulesDeleteOutput, SchedulesGetByIdOutput, SchedulesListOutput, SchedulesUpdateOutput, SecretsListOutput, SecretsListNamesOutput, SignalsCallSignalsOutput, SignalsCreateOutput, SignalsDeleteOutput, SignalsGetOutput, SignalsListOutput, SignalsOverviewOutput, SignalsPresetsOutput, SignalsTestOutput, SignalsUpdateOutput, SignalsUpsertBySlugOutput, TtsListModelsOutput, TtsListVoicesOutput, UsersActivateMemberOutput, UsersCreateMemberOutput, UsersListMembersOutput, UsersMeOutput, UsersRemoveMemberOutput, UsersResetSecondFactorOutput, UsersRevokeMemberSessionsOutput, UsersSuspendMemberOutput, UsersUnlockMemberOutput, UsersUpdateMyNotificationEmailOutput, UsersUpdateMyNotificationToastOutput, UsersUpdateRoleOutput, VisualPlansCloneOutput, VisualPlansCreateOutput, VisualPlansDeleteOutput, VisualPlansGetByIdOutput, VisualPlansImportDraftOutput, VisualPlansListOutput, VisualPlansListVersionsOutput, VisualPlansPublishOutput, VisualPlansUpdateOutput, VisualPlansValidateOutput, WebhooksDeliveriesAggregatesGetOutput, WebhooksDeliveriesAggregatesListOutput, WebhooksDeliveriesCountOutput, WebhooksDeliveriesGetByIdOutput, WebhooksDeliveriesListOutput, WebhooksDeliveriesRetentionOutput, WebhooksDeliveriesRetryOutput, WebhooksEndpointsCreateOutput, WebhooksEndpointsDeleteOutput, WebhooksEndpointsGetByIdOutput, WebhooksEndpointsListOutput, WebhooksEndpointsRotateSecretOutput, WebhooksEndpointsUpdateOutput, WebhooksEventsListOutput, AuditExportCsvEvent, CallRecordsExportCsvEvent, DashboardWatchDashboardMetricsEvent, DialerCampaignsLiveStatsEvent, DialerCampaignsOrgLiveStatsEvent, DialerContactsExportCsvEvent, DialerImportsProgressEvent, AiGetBudgetErrorCode, AiGetBudgetOverviewErrorCode, AiGetCallAnalysesErrorCode, AiGetTranscriptionErrorCode, AiGetUsageErrorCode, AiListAgentsErrorCode, AiListStructuredAnalysesErrorCode, AiRunAnalysisErrorCode, AiRunConfiguredAnalysesErrorCode, AiRunSpeechAnalyticsErrorCode, AiSearchTranscriptionsErrorCode, AiTranscribeNowErrorCode, ApiKeysCreateErrorCode, ApiKeysFinishRotationErrorCode, ApiKeysGetErrorCode, ApiKeysListErrorCode, ApiKeysRevokeErrorCode, ApiKeysRotateErrorCode, ApiKeysUpdateErrorCode, ApiKeysUsageErrorCode, ArchiveListDeletedErrorCode, ArchivePurgeErrorCode, ArchiveRestoreErrorCode, ArchiveSummaryErrorCode, AudioFilesContentErrorCode, AudioFilesDeleteErrorCode, AudioFilesGenerateTtsErrorCode, AudioFilesGetByIdErrorCode, AudioFilesListErrorCode, AudioFilesPreviewUrlErrorCode, AudioFilesRegenerateTtsErrorCode, AudioFilesUpdateErrorCode, AudioFilesUploadErrorCode, AuditCountErrorCode, AuditListErrorCode, CallRecordsCountErrorCode, CallRecordsGetByIdErrorCode, CallRecordsGetEventsErrorCode, CallRecordsGetRecordingUrlErrorCode, CallRecordsListErrorCode, CallRecordsPurgeVoiceContentErrorCode, CallRecordsRecordingContentErrorCode, CallRecordsRetryRecordingErrorCode, CallsHangupCallErrorCode, CallsOriginateErrorCode, CapabilitiesGetErrorCode, ChannelsCreateErrorCode, ChannelsDeleteErrorCode, ChannelsGetByIdErrorCode, ChannelsListErrorCode, ChannelsTestConnectionErrorCode, ChannelsToggleErrorCode, ChannelsUpdateErrorCode, ContactsGetByIdErrorCode, ContactsListErrorCode, ContactsUpdateErrorCode, DashboardCapacityStatusErrorCode, DestinationsCreateErrorCode, DestinationsDeleteErrorCode, DestinationsGetByIdErrorCode, DestinationsListErrorCode, DestinationsUpdateErrorCode, DialerAttemptsListErrorCode, DialerCampaignsControlErrorCode, DialerCampaignsCreateErrorCode, DialerCampaignsDeleteErrorCode, DialerCampaignsGetErrorCode, DialerCampaignsListErrorCode, DialerCampaignsStatsErrorCode, DialerCampaignsSummaryErrorCode, DialerCampaignsUpdateErrorCode, DialerContactsAddErrorCode, DialerContactsBulkCancelErrorCode, DialerContactsBulkRequeueErrorCode, DialerContactsCancelErrorCode, DialerContactsGetErrorCode, DialerContactsListErrorCode, DialerContactsRemoveErrorCode, DialerContactsRequeueErrorCode, DialerContactsRequeueAllErrorCode, DialerContactsUpdateErrorCode, DialerDncAddErrorCode, DialerDncBulkImportErrorCode, DialerDncBulkRemoveErrorCode, DialerDncListErrorCode, DialerDncRemoveErrorCode, DialerImportsCreateErrorCode, DialerImportsGetErrorCode, DialerImportsInvalidRowsErrorCode, HolidaysCountriesErrorCode, HolidaysCreateErrorCode, HolidaysDeleteErrorCode, HolidaysGroupsCreateErrorCode, HolidaysGroupsDeleteErrorCode, HolidaysGroupsGetByIdErrorCode, HolidaysGroupsListErrorCode, HolidaysGroupsUpdateErrorCode, HolidaysImportErrorCode, HolidaysListErrorCode, HolidaysPreviewImportErrorCode, HolidaysUpdateErrorCode, InsightsAggregateErrorCode, LicenseModulesErrorCode, LicenseStatusErrorCode, NodesListErrorCode, NodesSchemaErrorCode, OauthGrantsListErrorCode, OauthGrantsRevokeErrorCode, OauthGrantsUsageErrorCode, OrgSettingsGetDialerErrorCode, OrgSettingsUpsertDialerErrorCode, SchedulesCreateErrorCode, SchedulesDeleteErrorCode, SchedulesGetByIdErrorCode, SchedulesListErrorCode, SchedulesUpdateErrorCode, SecretsListErrorCode, SecretsListNamesErrorCode, SignalsCallSignalsErrorCode, SignalsCreateErrorCode, SignalsDeleteErrorCode, SignalsGetErrorCode, SignalsListErrorCode, SignalsOverviewErrorCode, SignalsPresetsErrorCode, SignalsTestErrorCode, SignalsUpdateErrorCode, SignalsUpsertBySlugErrorCode, TtsListModelsErrorCode, TtsListVoicesErrorCode, TtsPreviewErrorCode, UsersActivateMemberErrorCode, UsersCreateMemberErrorCode, UsersListMembersErrorCode, UsersMeErrorCode, UsersRemoveMemberErrorCode, UsersResetSecondFactorErrorCode, UsersRevokeMemberSessionsErrorCode, UsersSuspendMemberErrorCode, UsersUnlockMemberErrorCode, UsersUpdateMyNotificationEmailErrorCode, UsersUpdateMyNotificationToastErrorCode, UsersUpdateRoleErrorCode, VisualPlansCloneErrorCode, VisualPlansCreateErrorCode, VisualPlansDeleteErrorCode, VisualPlansGetByIdErrorCode, VisualPlansImportDraftErrorCode, VisualPlansListErrorCode, VisualPlansListVersionsErrorCode, VisualPlansPublishErrorCode, VisualPlansUpdateErrorCode, VisualPlansValidateErrorCode, WebhooksDeliveriesAggregatesGetErrorCode, WebhooksDeliveriesAggregatesListErrorCode, WebhooksDeliveriesCountErrorCode, WebhooksDeliveriesGetByIdErrorCode, WebhooksDeliveriesListErrorCode, WebhooksDeliveriesRetentionErrorCode, WebhooksDeliveriesRetryErrorCode, WebhooksEndpointsCreateErrorCode, WebhooksEndpointsDeleteErrorCode, WebhooksEndpointsGetByIdErrorCode, WebhooksEndpointsListErrorCode, WebhooksEndpointsRotateSecretErrorCode, WebhooksEndpointsUpdateErrorCode, WebhooksEventsListErrorCode } from "./operations.js";
7
+ import type { AiGetCallAnalysesInput, AiGetTranscriptionInput, AiListStructuredAnalysesInput, AiRunAnalysisInput, AiRunConfiguredAnalysesInput, AiRunSpeechAnalyticsInput, AiSearchTranscriptionsInput, AiTranscribeNowInput, ApiKeysCreateInput, ApiKeysFinishRotationInput, ApiKeysGetInput, ApiKeysListInput, ApiKeysRevokeInput, ApiKeysRotateInput, ApiKeysUpdateInput, ApiKeysUsageInput, ArchiveListDeletedInput, ArchivePurgeInput, ArchiveRestoreInput, AttendantsCreateInput, AttendantsDeleteInput, AttendantsGetByIdInput, AttendantsListInput, AttendantsRotateSipCredentialInput, AttendantsSetStatusInput, AttendantsStatusLogInput, AttendantsUpdateInput, AudioFilesContentInput, AudioFilesDeleteInput, AudioFilesGenerateTtsInput, AudioFilesGetByIdInput, AudioFilesListInput, AudioFilesPreviewUrlInput, AudioFilesRegenerateTtsInput, AudioFilesUpdateInput, AudioFilesUploadInput, AuditCountInput, AuditExportCsvInput, AuditExportJobCancelInput, AuditExportJobCreateInput, AuditExportJobDownloadInput, AuditExportJobGetInput, AuditExportJobProgressInput, AuditListInput, BugReportsCreateInput, CallRecordsChatMediaContentInput, CallRecordsCountInput, CallRecordsExportCsvInput, CallRecordsExportJobCancelInput, CallRecordsExportJobCreateInput, CallRecordsExportJobDownloadInput, CallRecordsExportJobGetInput, CallRecordsExportJobProgressInput, CallRecordsGetByIdInput, CallRecordsGetEventsInput, CallRecordsGetRecordingUrlInput, CallRecordsListInput, CallRecordsPurgeVoiceContentInput, CallRecordsRecordingContentInput, CallRecordsRetryRecordingInput, CallsHangupCallInput, CallsOriginateInput, ChannelsCreateInput, ChannelsDeleteInput, ChannelsGetByIdInput, ChannelsListInput, ChannelsRotateWebchatKeyInput, ChannelsRotateWebchatSecretInput, ChannelsTestConnectionInput, ChannelsToggleInput, ChannelsUpdateInput, ChatCreateMediaInput, ChatCreateSessionInput, ChatEndSessionInput, ChatGetMediaInput, ContactsGetByIdInput, ContactsListInput, ContactsUpdateInput, ConversationsCountInput, ConversationsGetByIdInput, ConversationsListInput, ConversationsMediaContentInput, DeskCopilotStatsInput, DeskSettingsCreateDispositionInput, DeskSettingsCreatePauseReasonInput, DeskSettingsDeleteDispositionInput, DeskSettingsDeletePauseReasonInput, DeskSettingsListDispositionsInput, DeskSettingsListPauseReasonsInput, DeskSettingsReorderDispositionsInput, DeskSettingsReorderPauseReasonsInput, DeskSettingsUpdateInput, DeskSettingsUpdateDispositionInput, DeskSettingsUpdatePauseReasonInput, DestinationsCreateInput, DestinationsDeleteInput, DestinationsGetByIdInput, DestinationsListInput, DestinationsUpdateInput, DialerAttemptsListInput, DialerCampaignsControlInput, DialerCampaignsCreateInput, DialerCampaignsDeleteInput, DialerCampaignsGetInput, DialerCampaignsListInput, DialerCampaignsLiveStatsInput, DialerCampaignsStatsInput, DialerCampaignsUpdateInput, DialerContactsAddInput, DialerContactsBulkCancelInput, DialerContactsBulkRequeueInput, DialerContactsCancelInput, DialerContactsExportCsvInput, DialerContactsGetInput, DialerContactsListInput, DialerContactsRemoveInput, DialerContactsRequeueInput, DialerContactsRequeueAllInput, DialerContactsUpdateInput, DialerDncAddInput, DialerDncBulkImportInput, DialerDncBulkRemoveInput, DialerDncListInput, DialerDncRemoveInput, DialerImportsCreateInput, DialerImportsGetInput, DialerImportsInvalidRowsInput, DialerImportsProgressInput, HolidayCalendarsCreateInput, HolidayCalendarsDeleteInput, HolidayCalendarsEntriesCreateInput, HolidayCalendarsEntriesDeleteInput, HolidayCalendarsEntriesGetByIdInput, HolidayCalendarsEntriesListInput, HolidayCalendarsEntriesUpdateInput, HolidayCalendarsGetByIdInput, HolidayCalendarsImportIcsInput, HolidayCalendarsListInput, HolidayCalendarsPreviewRuleInput, HolidayCalendarsUpdateInput, HolidayCatalogHolidaysInput, HolidayCatalogRegionsInput, InsightsAggregateInput, LicenseActivateInput, NodesSchemaInput, OauthGrantsGetInput, OauthGrantsListInput, OauthGrantsRevokeInput, OauthGrantsUsageInput, OrgSettingsUpsertDialerInput, QueuesAddMembersInput, QueuesCreateInput, QueuesDeleteInput, QueuesGetByIdInput, QueuesListInput, QueuesListMembersInput, QueuesRemoveMemberInput, QueuesReplaceMembersInput, QueuesStatsInput, QueuesUpdateInput, QueuesUpdateMemberInput, SavedRepliesCreateInput, SavedRepliesDeleteInput, SavedRepliesGetInput, SavedRepliesListInput, SavedRepliesUpdateInput, ScheduleExceptionsCreateInput, ScheduleExceptionsDeleteInput, ScheduleExceptionsGetByIdInput, ScheduleExceptionsListInput, ScheduleExceptionsUpdateInput, SchedulesCalendarInput, SchedulesClearEmergencyInput, SchedulesCreateInput, SchedulesDeleteInput, SchedulesGetByIdInput, SchedulesHolidaysInput, SchedulesListInput, SchedulesPreviewHolidaysInput, SchedulesSetEmergencyInput, SchedulesSimulateInput, SchedulesUpcomingInput, SchedulesUpdateInput, SchedulesUsageInput, SecretsListInput, SignalsCallSignalsInput, SignalsCreateInput, SignalsDeleteInput, SignalsGetInput, SignalsListInput, SignalsPresetsInput, SignalsTestInput, SignalsUpdateInput, SignalsUpsertBySlugInput, TtsListVoicesInput, TtsPreviewInput, UsersActivateMemberInput, UsersCreateMemberInput, UsersListMembersInput, UsersRemoveMemberInput, UsersResetSecondFactorInput, UsersRevokeMemberSessionsInput, UsersSuspendMemberInput, UsersUnlockMemberInput, UsersUpdateMyDeskAlertsInput, UsersUpdateMyNotificationEmailInput, UsersUpdateMyNotificationToastInput, UsersUpdateRoleInput, VisualPlansCloneInput, VisualPlansCreateInput, VisualPlansDeleteInput, VisualPlansGetByIdInput, VisualPlansImportDraftInput, VisualPlansListInput, VisualPlansListVersionsInput, VisualPlansPublishInput, VisualPlansUpdateInput, VisualPlansValidateInput, WebhooksDeliveriesAggregatesGetInput, WebhooksDeliveriesAggregatesListInput, WebhooksDeliveriesCountInput, WebhooksDeliveriesGetByIdInput, WebhooksDeliveriesListInput, WebhooksDeliveriesRetryInput, WebhooksEndpointsCreateInput, WebhooksEndpointsDeleteInput, WebhooksEndpointsGetByIdInput, WebhooksEndpointsListInput, WebhooksEndpointsRotateSecretInput, WebhooksEndpointsTestInput, WebhooksEndpointsUpdateInput, AiGetBudgetOutput, AiGetBudgetOverviewOutput, AiGetCallAnalysesOutput, AiGetTranscriptionOutput, AiGetUsageOutput, AiListAgentsOutput, AiListStructuredAnalysesOutput, AiRunAnalysisOutput, AiRunConfiguredAnalysesOutput, AiRunSpeechAnalyticsOutput, AiSearchTranscriptionsOutput, AiTranscribeNowOutput, ApiKeysCreateOutput, ApiKeysFinishRotationOutput, ApiKeysGetOutput, ApiKeysListOutput, ApiKeysRevokeOutput, ApiKeysRotateOutput, ApiKeysUpdateOutput, ApiKeysUsageOutput, ArchiveListDeletedOutput, ArchivePurgeOutput, ArchiveRestoreOutput, ArchiveSummaryOutput, AttendantsCreateOutput, AttendantsDeleteOutput, AttendantsGetByIdOutput, AttendantsListOutput, AttendantsRotateSipCredentialOutput, AttendantsSetStatusOutput, AttendantsStatusLogOutput, AttendantsUpdateOutput, AudioFilesDeleteOutput, AudioFilesGenerateTtsOutput, AudioFilesGetByIdOutput, AudioFilesListOutput, AudioFilesRegenerateTtsOutput, AudioFilesUpdateOutput, AudioFilesUploadOutput, AuditCountOutput, AuditExportJobCancelOutput, AuditExportJobCreateOutput, AuditExportJobGetOutput, AuditExportJobListOutput, AuditListOutput, BugReportsCreateOutput, CallRecordsCountOutput, CallRecordsExportJobCancelOutput, CallRecordsExportJobCreateOutput, CallRecordsExportJobGetOutput, CallRecordsExportJobListOutput, CallRecordsGetByIdOutput, CallRecordsGetEventsOutput, CallRecordsGetRecordingUrlOutput, CallRecordsListOutput, CallRecordsPurgeVoiceContentOutput, CallRecordsRetryRecordingOutput, CallsHangupCallOutput, CallsOriginateOutput, CapabilitiesGetOutput, ChannelsCreateOutput, ChannelsDeleteOutput, ChannelsGetByIdOutput, ChannelsListOutput, ChannelsRotateWebchatKeyOutput, ChannelsRotateWebchatSecretOutput, ChannelsTestConnectionOutput, ChannelsToggleOutput, ChannelsUpdateOutput, ChatCreateMediaOutput, ChatCreateSessionOutput, ContactsGetByIdOutput, ContactsListOutput, ContactsUpdateOutput, ConversationsCountOutput, ConversationsGetByIdOutput, ConversationsListOutput, DashboardCapacityStatusOutput, DeskCopilotStatsOutput, DeskTransferQueuesOutput, DeskSettingsCopilotAgentsOutput, DeskSettingsCreateDefaultsOutput, DeskSettingsCreateDispositionOutput, DeskSettingsCreatePauseReasonOutput, DeskSettingsDeleteDispositionOutput, DeskSettingsDeletePauseReasonOutput, DeskSettingsGetOutput, DeskSettingsListDispositionsOutput, DeskSettingsListPauseReasonsOutput, DeskSettingsReorderDispositionsOutput, DeskSettingsReorderPauseReasonsOutput, DeskSettingsUpdateOutput, DeskSettingsUpdateDispositionOutput, DeskSettingsUpdatePauseReasonOutput, DestinationsCreateOutput, DestinationsDeleteOutput, DestinationsGetByIdOutput, DestinationsListOutput, DestinationsUpdateOutput, DialerAttemptsListOutput, DialerCampaignsControlOutput, DialerCampaignsCreateOutput, DialerCampaignsDeleteOutput, DialerCampaignsGetOutput, DialerCampaignsListOutput, DialerCampaignsStatsOutput, DialerCampaignsSummaryOutput, DialerCampaignsUpdateOutput, DialerContactsAddOutput, DialerContactsBulkCancelOutput, DialerContactsBulkRequeueOutput, DialerContactsCancelOutput, DialerContactsGetOutput, DialerContactsListOutput, DialerContactsRemoveOutput, DialerContactsRequeueOutput, DialerContactsRequeueAllOutput, DialerContactsUpdateOutput, DialerDncAddOutput, DialerDncBulkImportOutput, DialerDncBulkRemoveOutput, DialerDncListOutput, DialerDncRemoveOutput, DialerImportsCreateOutput, DialerImportsGetOutput, DialerImportsInvalidRowsOutput, HolidayCalendarsCreateOutput, HolidayCalendarsDeleteOutput, HolidayCalendarsEntriesCreateOutput, HolidayCalendarsEntriesDeleteOutput, HolidayCalendarsEntriesGetByIdOutput, HolidayCalendarsEntriesListOutput, HolidayCalendarsEntriesUpdateOutput, HolidayCalendarsGetByIdOutput, HolidayCalendarsImportIcsOutput, HolidayCalendarsListOutput, HolidayCalendarsPreviewRuleOutput, HolidayCalendarsUpdateOutput, HolidayCatalogCountriesOutput, HolidayCatalogHolidaysOutput, HolidayCatalogRegionsOutput, InsightsAggregateOutput, LicenseActivateOutput, LicenseActivationOutput, LicenseModulesOutput, LicenseOrgUsageOutput, LicenseRefreshOutput, LicenseStatusOutput, LicenseUsageOutput, NodesListOutput, NodesSchemaOutput, OauthGrantsGetOutput, OauthGrantsListOutput, OauthGrantsRevokeOutput, OauthGrantsUsageOutput, OrgSettingsGetDialerOutput, OrgSettingsUpsertDialerOutput, QueuesAddMembersOutput, QueuesCreateOutput, QueuesDeleteOutput, QueuesGetByIdOutput, QueuesListOutput, QueuesListMembersOutput, QueuesRemoveMemberOutput, QueuesReplaceMembersOutput, QueuesStatsOutput, QueuesUpdateOutput, QueuesUpdateMemberOutput, SavedRepliesCreateOutput, SavedRepliesDeleteOutput, SavedRepliesGetOutput, SavedRepliesListOutput, SavedRepliesUpdateOutput, ScheduleExceptionsCreateOutput, ScheduleExceptionsDeleteOutput, ScheduleExceptionsGetByIdOutput, ScheduleExceptionsListOutput, ScheduleExceptionsUpdateOutput, SchedulesCalendarOutput, SchedulesClearEmergencyOutput, SchedulesCreateOutput, SchedulesDeleteOutput, SchedulesGetByIdOutput, SchedulesHolidaysOutput, SchedulesListOutput, SchedulesPreviewHolidaysOutput, SchedulesSetEmergencyOutput, SchedulesSimulateOutput, SchedulesUpcomingOutput, SchedulesUpdateOutput, SchedulesUsageOutput, SecretsListOutput, SecretsListNamesOutput, SignalsCallSignalsOutput, SignalsCreateOutput, SignalsDeleteOutput, SignalsGetOutput, SignalsListOutput, SignalsOverviewOutput, SignalsPresetsOutput, SignalsTestOutput, SignalsUpdateOutput, SignalsUpsertBySlugOutput, TtsListModelsOutput, TtsListVoicesOutput, UsersActivateMemberOutput, UsersCreateMemberOutput, UsersListMembersOutput, UsersMeOutput, UsersRemoveMemberOutput, UsersResetSecondFactorOutput, UsersRevokeMemberSessionsOutput, UsersSuspendMemberOutput, UsersUnlockMemberOutput, UsersUpdateMyDeskAlertsOutput, UsersUpdateMyNotificationEmailOutput, UsersUpdateMyNotificationToastOutput, UsersUpdateRoleOutput, VisualPlansCloneOutput, VisualPlansCreateOutput, VisualPlansDeleteOutput, VisualPlansGetByIdOutput, VisualPlansImportDraftOutput, VisualPlansListOutput, VisualPlansListVersionsOutput, VisualPlansPublishOutput, VisualPlansUpdateOutput, VisualPlansValidateOutput, WebhooksDeliveriesAggregatesGetOutput, WebhooksDeliveriesAggregatesListOutput, WebhooksDeliveriesCountOutput, WebhooksDeliveriesGetByIdOutput, WebhooksDeliveriesListOutput, WebhooksDeliveriesRetentionOutput, WebhooksDeliveriesRetryOutput, WebhooksEndpointsCreateOutput, WebhooksEndpointsDeleteOutput, WebhooksEndpointsGetByIdOutput, WebhooksEndpointsListOutput, WebhooksEndpointsRotateSecretOutput, WebhooksEndpointsTestOutput, WebhooksEndpointsUpdateOutput, WebhooksEventsListOutput, AuditExportCsvEvent, AuditExportJobProgressEvent, CallRecordsExportCsvEvent, CallRecordsExportJobProgressEvent, DashboardWatchDashboardMetricsEvent, DialerCampaignsLiveStatsEvent, DialerCampaignsOrgLiveStatsEvent, DialerContactsExportCsvEvent, DialerImportsProgressEvent, AiGetBudgetErrorCode, AiGetBudgetOverviewErrorCode, AiGetCallAnalysesErrorCode, AiGetTranscriptionErrorCode, AiGetUsageErrorCode, AiListAgentsErrorCode, AiListStructuredAnalysesErrorCode, AiRunAnalysisErrorCode, AiRunConfiguredAnalysesErrorCode, AiRunSpeechAnalyticsErrorCode, AiSearchTranscriptionsErrorCode, AiTranscribeNowErrorCode, ApiKeysCreateErrorCode, ApiKeysFinishRotationErrorCode, ApiKeysGetErrorCode, ApiKeysListErrorCode, ApiKeysRevokeErrorCode, ApiKeysRotateErrorCode, ApiKeysUpdateErrorCode, ApiKeysUsageErrorCode, ArchiveListDeletedErrorCode, ArchivePurgeErrorCode, ArchiveRestoreErrorCode, ArchiveSummaryErrorCode, AttendantsCreateErrorCode, AttendantsDeleteErrorCode, AttendantsGetByIdErrorCode, AttendantsListErrorCode, AttendantsRotateSipCredentialErrorCode, AttendantsSetStatusErrorCode, AttendantsStatusLogErrorCode, AttendantsUpdateErrorCode, AudioFilesContentErrorCode, AudioFilesDeleteErrorCode, AudioFilesGenerateTtsErrorCode, AudioFilesGetByIdErrorCode, AudioFilesListErrorCode, AudioFilesPreviewUrlErrorCode, AudioFilesRegenerateTtsErrorCode, AudioFilesUpdateErrorCode, AudioFilesUploadErrorCode, AuditCountErrorCode, AuditExportJobCancelErrorCode, AuditExportJobCreateErrorCode, AuditExportJobDownloadErrorCode, AuditExportJobGetErrorCode, AuditExportJobListErrorCode, AuditListErrorCode, BugReportsCreateErrorCode, CallRecordsChatMediaContentErrorCode, CallRecordsCountErrorCode, CallRecordsExportJobCancelErrorCode, CallRecordsExportJobCreateErrorCode, CallRecordsExportJobDownloadErrorCode, CallRecordsExportJobGetErrorCode, CallRecordsExportJobListErrorCode, CallRecordsGetByIdErrorCode, CallRecordsGetEventsErrorCode, CallRecordsGetRecordingUrlErrorCode, CallRecordsListErrorCode, CallRecordsPurgeVoiceContentErrorCode, CallRecordsRecordingContentErrorCode, CallRecordsRetryRecordingErrorCode, CallsHangupCallErrorCode, CallsOriginateErrorCode, CapabilitiesGetErrorCode, ChannelsCreateErrorCode, ChannelsDeleteErrorCode, ChannelsGetByIdErrorCode, ChannelsListErrorCode, ChannelsRotateWebchatKeyErrorCode, ChannelsRotateWebchatSecretErrorCode, ChannelsTestConnectionErrorCode, ChannelsToggleErrorCode, ChannelsUpdateErrorCode, ChatCreateMediaErrorCode, ChatCreateSessionErrorCode, ChatEndSessionErrorCode, ChatGetMediaErrorCode, ContactsGetByIdErrorCode, ContactsListErrorCode, ContactsUpdateErrorCode, ConversationsCountErrorCode, ConversationsGetByIdErrorCode, ConversationsListErrorCode, ConversationsMediaContentErrorCode, DashboardCapacityStatusErrorCode, DeskCopilotStatsErrorCode, DeskTransferQueuesErrorCode, DeskSettingsCopilotAgentsErrorCode, DeskSettingsCreateDefaultsErrorCode, DeskSettingsCreateDispositionErrorCode, DeskSettingsCreatePauseReasonErrorCode, DeskSettingsDeleteDispositionErrorCode, DeskSettingsDeletePauseReasonErrorCode, DeskSettingsGetErrorCode, DeskSettingsListDispositionsErrorCode, DeskSettingsListPauseReasonsErrorCode, DeskSettingsReorderDispositionsErrorCode, DeskSettingsReorderPauseReasonsErrorCode, DeskSettingsUpdateErrorCode, DeskSettingsUpdateDispositionErrorCode, DeskSettingsUpdatePauseReasonErrorCode, DestinationsCreateErrorCode, DestinationsDeleteErrorCode, DestinationsGetByIdErrorCode, DestinationsListErrorCode, DestinationsUpdateErrorCode, DialerAttemptsListErrorCode, DialerCampaignsControlErrorCode, DialerCampaignsCreateErrorCode, DialerCampaignsDeleteErrorCode, DialerCampaignsGetErrorCode, DialerCampaignsListErrorCode, DialerCampaignsStatsErrorCode, DialerCampaignsSummaryErrorCode, DialerCampaignsUpdateErrorCode, DialerContactsAddErrorCode, DialerContactsBulkCancelErrorCode, DialerContactsBulkRequeueErrorCode, DialerContactsCancelErrorCode, DialerContactsGetErrorCode, DialerContactsListErrorCode, DialerContactsRemoveErrorCode, DialerContactsRequeueErrorCode, DialerContactsRequeueAllErrorCode, DialerContactsUpdateErrorCode, DialerDncAddErrorCode, DialerDncBulkImportErrorCode, DialerDncBulkRemoveErrorCode, DialerDncListErrorCode, DialerDncRemoveErrorCode, DialerImportsCreateErrorCode, DialerImportsGetErrorCode, DialerImportsInvalidRowsErrorCode, HolidayCalendarsCreateErrorCode, HolidayCalendarsDeleteErrorCode, HolidayCalendarsEntriesCreateErrorCode, HolidayCalendarsEntriesDeleteErrorCode, HolidayCalendarsEntriesGetByIdErrorCode, HolidayCalendarsEntriesListErrorCode, HolidayCalendarsEntriesUpdateErrorCode, HolidayCalendarsGetByIdErrorCode, HolidayCalendarsImportIcsErrorCode, HolidayCalendarsListErrorCode, HolidayCalendarsPreviewRuleErrorCode, HolidayCalendarsUpdateErrorCode, HolidayCatalogCountriesErrorCode, HolidayCatalogHolidaysErrorCode, HolidayCatalogRegionsErrorCode, InsightsAggregateErrorCode, LicenseActivateErrorCode, LicenseActivationErrorCode, LicenseModulesErrorCode, LicenseOrgUsageErrorCode, LicenseRefreshErrorCode, LicenseStatusErrorCode, LicenseUsageErrorCode, NodesListErrorCode, NodesSchemaErrorCode, OauthGrantsGetErrorCode, OauthGrantsListErrorCode, OauthGrantsRevokeErrorCode, OauthGrantsUsageErrorCode, OrgSettingsGetDialerErrorCode, OrgSettingsUpsertDialerErrorCode, QueuesAddMembersErrorCode, QueuesCreateErrorCode, QueuesDeleteErrorCode, QueuesGetByIdErrorCode, QueuesListErrorCode, QueuesListMembersErrorCode, QueuesRemoveMemberErrorCode, QueuesReplaceMembersErrorCode, QueuesStatsErrorCode, QueuesUpdateErrorCode, QueuesUpdateMemberErrorCode, SavedRepliesCreateErrorCode, SavedRepliesDeleteErrorCode, SavedRepliesGetErrorCode, SavedRepliesListErrorCode, SavedRepliesUpdateErrorCode, ScheduleExceptionsCreateErrorCode, ScheduleExceptionsDeleteErrorCode, ScheduleExceptionsGetByIdErrorCode, ScheduleExceptionsListErrorCode, ScheduleExceptionsUpdateErrorCode, SchedulesCalendarErrorCode, SchedulesClearEmergencyErrorCode, SchedulesCreateErrorCode, SchedulesDeleteErrorCode, SchedulesGetByIdErrorCode, SchedulesHolidaysErrorCode, SchedulesListErrorCode, SchedulesPreviewHolidaysErrorCode, SchedulesSetEmergencyErrorCode, SchedulesSimulateErrorCode, SchedulesUpcomingErrorCode, SchedulesUpdateErrorCode, SchedulesUsageErrorCode, SecretsListErrorCode, SecretsListNamesErrorCode, SignalsCallSignalsErrorCode, SignalsCreateErrorCode, SignalsDeleteErrorCode, SignalsGetErrorCode, SignalsListErrorCode, SignalsOverviewErrorCode, SignalsPresetsErrorCode, SignalsTestErrorCode, SignalsUpdateErrorCode, SignalsUpsertBySlugErrorCode, TtsListModelsErrorCode, TtsListVoicesErrorCode, TtsPreviewErrorCode, UsersActivateMemberErrorCode, UsersCreateMemberErrorCode, UsersListMembersErrorCode, UsersMeErrorCode, UsersRemoveMemberErrorCode, UsersResetSecondFactorErrorCode, UsersRevokeMemberSessionsErrorCode, UsersSuspendMemberErrorCode, UsersUnlockMemberErrorCode, UsersUpdateMyDeskAlertsErrorCode, UsersUpdateMyNotificationEmailErrorCode, UsersUpdateMyNotificationToastErrorCode, UsersUpdateRoleErrorCode, VisualPlansCloneErrorCode, VisualPlansCreateErrorCode, VisualPlansDeleteErrorCode, VisualPlansGetByIdErrorCode, VisualPlansImportDraftErrorCode, VisualPlansListErrorCode, VisualPlansListVersionsErrorCode, VisualPlansPublishErrorCode, VisualPlansUpdateErrorCode, VisualPlansValidateErrorCode, WebhooksDeliveriesAggregatesGetErrorCode, WebhooksDeliveriesAggregatesListErrorCode, WebhooksDeliveriesCountErrorCode, WebhooksDeliveriesGetByIdErrorCode, WebhooksDeliveriesListErrorCode, WebhooksDeliveriesRetentionErrorCode, WebhooksDeliveriesRetryErrorCode, WebhooksEndpointsCreateErrorCode, WebhooksEndpointsDeleteErrorCode, WebhooksEndpointsGetByIdErrorCode, WebhooksEndpointsListErrorCode, WebhooksEndpointsRotateSecretErrorCode, WebhooksEndpointsTestErrorCode, WebhooksEndpointsUpdateErrorCode, WebhooksEventsListErrorCode } from "./operations.js";
8
8
  /** Typed client of the frozen REST contract /api/v1. */
9
9
  export interface NivaClient {
10
10
  ai: {
@@ -41,7 +41,7 @@ export interface NivaClient {
41
41
  /**
42
42
  * ai.listAgents operation.
43
43
  *
44
- * Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
44
+ * Returns all of the org's SipPulse AI agents as a plain array. Each item carries sip_inbound_enabled, which tells whether that agent can answer a voice call — agents without it are listed but cannot be dialed yet. Errors with AI_NOT_CONFIGURED when the org has no usable SipPulse AI credentials, with AI_INVALID_API_KEY when SipPulse AI rejects the organization's key, and with AI_UNREACHABLE when the upstream listing fails. Requires the ai module and the ai:read scope.
45
45
  */
46
46
  listAgents(options?: NivaRequestOptions): NivaCall<AiListAgentsOutput, AiListAgentsErrorCode>;
47
47
  /**
@@ -135,9 +135,9 @@ export interface NivaClient {
135
135
  /**
136
136
  * archive.listDeleted operation.
137
137
  *
138
- * Lists archived (soft-deleted) items of a single `entity_type` in a paginated envelope.
138
+ * Lists archived (soft-deleted) items in a paginated envelope, newest deletion first. Without `entity_type` it lists every type the organization can see; with it, only that type (403 MODULE_DISABLED when the type's module is off).
139
139
  */
140
- listDeleted(input: ArchiveListDeletedInput, options?: NivaRequestOptions): NivaCall<ArchiveListDeletedOutput, ArchiveListDeletedErrorCode>;
140
+ listDeleted(input?: ArchiveListDeletedInput, options?: NivaRequestOptions): NivaCall<ArchiveListDeletedOutput, ArchiveListDeletedErrorCode>;
141
141
  /**
142
142
  * archive.purge operation.
143
143
  *
@@ -147,7 +147,7 @@ export interface NivaClient {
147
147
  /**
148
148
  * archive.restore operation.
149
149
  *
150
- * Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the restored channel is unavailable.
150
+ * Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
151
151
  */
152
152
  restore(input: ArchiveRestoreInput, options?: NivaRequestOptions): NivaCall<ArchiveRestoreOutput, ArchiveRestoreErrorCode>;
153
153
  /**
@@ -157,6 +157,56 @@ export interface NivaClient {
157
157
  */
158
158
  summary(options?: NivaRequestOptions): NivaCall<ArchiveSummaryOutput, ArchiveSummaryErrorCode>;
159
159
  };
160
+ attendants: {
161
+ /**
162
+ * attendants.create operation.
163
+ *
164
+ * Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
165
+ */
166
+ create(input?: AttendantsCreateInput, options?: NivaRequestOptions): NivaCall<AttendantsCreateOutput, AttendantsCreateErrorCode>;
167
+ /**
168
+ * attendants.delete operation.
169
+ *
170
+ * Soft-deletes an attendant (it can be restored from the archive) and ends its softphone credential. Returns 409 ATTENDANT_BUSY while the attendant is ringing or on a call. Requires the attendant:delete scope.
171
+ */
172
+ delete(input: AttendantsDeleteInput, options?: NivaRequestOptions): NivaCall<AttendantsDeleteOutput, AttendantsDeleteErrorCode>;
173
+ /**
174
+ * attendants.getById operation.
175
+ *
176
+ * Returns one attendant. Returns 404 ATTENDANT_NOT_FOUND when it does not exist or belongs to another organization. Requires the attendant:read scope.
177
+ */
178
+ getById(input: AttendantsGetByIdInput, options?: NivaRequestOptions): NivaCall<AttendantsGetByIdOutput, AttendantsGetByIdErrorCode>;
179
+ /**
180
+ * attendants.list operation.
181
+ *
182
+ * Returns a paginated list of the organization's attendants (the people who take calls on the Desk), with their current state and whether they have the Desk open. `search` matches the person's name or email. Requires the attendant:read scope.
183
+ */
184
+ list(input?: AttendantsListInput, options?: NivaRequestOptions): NivaCall<AttendantsListOutput, AttendantsListErrorCode>;
185
+ /**
186
+ * attendants.rotateSipCredential operation.
187
+ *
188
+ * Issues a new password for an attendant who takes calls on an external extension, drops the registration the old one held, and returns the credential (extension, password, domain, server host, port and transports) in `sip_credential` - the only moment it is readable. A `webrtc` attendant has no extension credential: the answer is 409 ATTENDANT_NOT_SIP_EXTENSION (their browser softphone credential is issued by the Desk itself). Returns 404 ATTENDANT_NOT_FOUND, 409 DESK_PUBLIC_URL_MISSING or 500 AI_ENCRYPTION_KEY_MISSING. Requires the attendant:update scope.
189
+ */
190
+ rotateSipCredential(input: AttendantsRotateSipCredentialInput, options?: NivaRequestOptions): NivaCall<AttendantsRotateSipCredentialOutput, AttendantsRotateSipCredentialErrorCode>;
191
+ /**
192
+ * attendants.setStatus operation.
193
+ *
194
+ * A supervisor puts an attendant in `available`, `paused` (with an optional `reason_id`) or `offline`. The change is recorded with source `supervisor`. A pause or an `offline` asked for while the attendant is ringing, on a call or wrapping up never interrupts that work: it waits for it to end, lands as `paused` and returns `pending: true`. Any other `offline` is immediate, open chats included: they stay with the attendant, and when the contact writes again to one that belongs to a queue it goes back to that queue. `available` and `paused` are immediate too, and are how an attendant leaves `not_responding`. Returns 404 ATTENDANT_NOT_FOUND or PAUSE_REASON_NOT_FOUND, and 409 WRAP_UP_PENDING when `available` is asked during a wrap-up that still lacks the disposition the organization requires. Requires the attendant:update or the desk_monitor:control scope.
195
+ */
196
+ setStatus(input: AttendantsSetStatusInput, options?: NivaRequestOptions): NivaCall<AttendantsSetStatusOutput, AttendantsSetStatusErrorCode>;
197
+ /**
198
+ * attendants.statusLog operation.
199
+ *
200
+ * Returns the states the attendant went through (available, paused with its reason, busy...), oldest first, each with who set it and when it started and ended. `date_from` and `date_to` filter on when a state started; a plain date is that day in the organization's timezone. Returns at most 1000 entries, the most recent of the window. Returns 404 ATTENDANT_NOT_FOUND when the attendant does not exist or belongs to another organization. Requires the attendant:read scope.
201
+ */
202
+ statusLog(input: AttendantsStatusLogInput, options?: NivaRequestOptions): NivaCall<AttendantsStatusLogOutput, AttendantsStatusLogErrorCode>;
203
+ /**
204
+ * attendants.update operation.
205
+ *
206
+ * Partially updates an attendant. Changing the endpoint away from `webrtc` ends the browser softphone credential at once. An attendant on `sip_extension` gains a managed SIP credential when it lands on the endpoint or its extension changes, returned once in `sip_credential`; any other update returns it as null. Returns 404 ATTENDANT_NOT_FOUND, 409 EXTENSION_IN_USE, 422 EXTENSION_REQUIRED, 409 DESK_PUBLIC_URL_MISSING when the install has no public URL to hand the phone, or 500 AI_ENCRYPTION_KEY_MISSING when the server cannot seal the password. Requires the attendant:update scope.
207
+ */
208
+ update(input: AttendantsUpdateInput, options?: NivaRequestOptions): NivaCall<AttendantsUpdateOutput, AttendantsUpdateErrorCode>;
209
+ };
160
210
  audioFiles: {
161
211
  /**
162
212
  * audioFiles.content operation.
@@ -230,6 +280,44 @@ export interface NivaClient {
230
280
  * Streams the matching audit-log entries as Server-Sent Events (`text/event-stream`), one flat JSON object per row - NOT a text/csv file; the caller joins the cells itself. Repeat the multi-valued filters with brackets (`?actions[]=create&actions[]=delete`); a single bracket-less occurrence is read as a string and rejected. Capped at the 100000 most recent entries, and the stream terminates with a done event { emitted, truncated }. Requires the enterprise module - callers without it receive 403 MODULE_DISABLED.
231
281
  */
232
282
  exportCsv(input?: AuditExportCsvInput, options?: NivaRequestOptions): NivaStream<AuditExportCsvEvent>;
283
+ /**
284
+ * audit.exportJobCancel operation.
285
+ *
286
+ * Cancels a queued, running or paused export and removes its files. Only the user who requested it may cancel (403 EXPORT_JOB_NOT_OWNER); a finished export returns 409 EXPORT_JOB_NOT_CANCELLABLE. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 entries like the synchronous export. The CSV holds the stored values (action, resource type, code and description as recorded), with the header text the caller sends in header_labels. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the enterprise module (callers without it receive 403 MODULE_DISABLED) and the audit:read permission.
287
+ */
288
+ exportJobCancel(input: AuditExportJobCancelInput, options?: NivaRequestOptions): NivaCall<AuditExportJobCancelOutput, AuditExportJobCancelErrorCode>;
289
+ /**
290
+ * audit.exportJobCreate operation.
291
+ *
292
+ * Queues an export of the matching audit-log entries and returns the job immediately; poll it, stream its progress or wait for the notification. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 entries like the synchronous export. The CSV holds the stored values (action, resource type, code and description as recorded), with the header text the caller sends in header_labels. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the enterprise module (callers without it receive 403 MODULE_DISABLED) and the audit:read permission. Takes the same filters as the synchronous export plus an optional header_labels map. An organization may hold at most 3 exports that are queued, running or paused, of any kind (409 EXPORT_JOB_LIMIT_REACHED).
293
+ */
294
+ exportJobCreate(input?: AuditExportJobCreateInput, options?: NivaRequestOptions): NivaCall<AuditExportJobCreateOutput, AuditExportJobCreateErrorCode>;
295
+ /**
296
+ * audit.exportJobDownload operation.
297
+ *
298
+ * Streams the finished .zip (application/zip; the bytes are never buffered server-side). 409 EXPORT_JOB_NOT_READY while the export is queued, running or paused; 410 EXPORT_JOB_EXPIRED once the 7-day retention passed; 404 EXPORT_JOB_NOT_FOUND for an unknown or hidden export. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 entries like the synchronous export. The CSV holds the stored values (action, resource type, code and description as recorded), with the header text the caller sends in header_labels. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the enterprise module (callers without it receive 403 MODULE_DISABLED) and the audit:read permission.
299
+ */
300
+ exportJobDownload(input: AuditExportJobDownloadInput, options?: NivaRequestOptions & {
301
+ range?: string;
302
+ }): NivaCall<Response, AuditExportJobDownloadErrorCode>;
303
+ /**
304
+ * audit.exportJobGet operation.
305
+ *
306
+ * Fetches one export with its status and progress. An unknown or cross-organization export - or the id of a call export - returns 404 EXPORT_JOB_NOT_FOUND. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 entries like the synchronous export. The CSV holds the stored values (action, resource type, code and description as recorded), with the header text the caller sends in header_labels. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the enterprise module (callers without it receive 403 MODULE_DISABLED) and the audit:read permission.
307
+ */
308
+ exportJobGet(input: AuditExportJobGetInput, options?: NivaRequestOptions): NivaCall<AuditExportJobGetOutput, AuditExportJobGetErrorCode>;
309
+ /**
310
+ * audit.exportJobList operation.
311
+ *
312
+ * Returns the organization's audit exports from the last 7 days, newest first, at most 100 (not paginated). Cancelled exports are omitted. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 entries like the synchronous export. The CSV holds the stored values (action, resource type, code and description as recorded), with the header text the caller sends in header_labels. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the enterprise module (callers without it receive 403 MODULE_DISABLED) and the audit:read permission.
313
+ */
314
+ exportJobList(options?: NivaRequestOptions): NivaCall<AuditExportJobListOutput, AuditExportJobListErrorCode>;
315
+ /**
316
+ * audit.exportJobProgress operation.
317
+ *
318
+ * Server-Sent Events stream of an export's progress. The first event is always a full snapshot of the current state and every later event carries the whole state too rather than a delta, so reconnecting is safe. The response advertises a 5s reconnect delay; the stream closes once the export is ready, failed, cancelled or expired. An unknown or hidden export returns 404 EXPORT_JOB_NOT_FOUND before the stream opens. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 entries like the synchronous export. The CSV holds the stored values (action, resource type, code and description as recorded), with the header text the caller sends in header_labels. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the enterprise module (callers without it receive 403 MODULE_DISABLED) and the audit:read permission.
319
+ */
320
+ exportJobProgress(input: AuditExportJobProgressInput, options?: NivaRequestOptions): NivaStream<AuditExportJobProgressEvent>;
233
321
  /**
234
322
  * audit.list operation.
235
323
  *
@@ -237,7 +325,23 @@ export interface NivaClient {
237
325
  */
238
326
  list(input?: AuditListInput, options?: NivaRequestOptions): NivaCall<AuditListOutput, AuditListErrorCode>;
239
327
  };
328
+ bugReports: {
329
+ /**
330
+ * bugReports.create operation.
331
+ *
332
+ * Files a structured problem report. Any member of the organization may report, with no extra permission. The report is rendered as markdown and delivered to the configured sink; the response `reference` identifies the stored record (today the Sentry event id). Answers 409 BUG_REPORTING_DISABLED and sends nothing when error reporting is turned off for the installation.
333
+ */
334
+ create(input: BugReportsCreateInput, options?: NivaRequestOptions): NivaCall<BugReportsCreateOutput, BugReportsCreateErrorCode>;
335
+ };
240
336
  callRecords: {
337
+ /**
338
+ * callRecords.chatMediaContent operation.
339
+ *
340
+ * Streams a file the contact sent during a chat call, typed by the content NIVA sniffed on arrival and served as an attachment with `X-Content-Type-Options: nosniff`. The bytes are never buffered server-side. Returns 404 CALL_NOT_FOUND when the call is unknown or belongs to another organization, and 404 CHAT_MEDIA_NOT_FOUND when the attachment does not belong to that call, was removed by retention, or its bytes are gone from storage. Requires the call_content:read scope.
341
+ */
342
+ chatMediaContent(input: CallRecordsChatMediaContentInput, options?: NivaRequestOptions & {
343
+ range?: string;
344
+ }): NivaCall<Response, CallRecordsChatMediaContentErrorCode>;
241
345
  /**
242
346
  * callRecords.count operation.
243
347
  *
@@ -250,6 +354,44 @@ export interface NivaClient {
250
354
  * Streams the matching call records as Server-Sent Events (`text/event-stream`), one JSON object per row - NOT a text/csv file; the separator only tells the UI how to join the cells when it builds the file client-side. Each row carries exactly the requested `columns` keys, plus the per-node event columns when `includeEvents` is true (one row per node visited). Repeat `columns` with brackets to select more than one (`?columns[]=started_at&columns[]=status`); omitting it yields the basic column set. `date_from` and `date_to` are always required and at most 90 days apart, and the scan stops at the 100000 most recent matching calls. The stream terminates with a done event { emitted, truncated }. Metadata filters use exact JSON containment and REST clients send them as `metadata[key]=value`; all supplied pairs must match. Setting `apply_table_filters=false` ignores every other filter and keeps only that window. The SIP transport fields (`sip_call_id`, `remote_addr`, `user_agent`) are not selectable here, matching the omission on `GET /call-records/{call_record_id}`. Requires the call_record:export permission (call_record:read API-key scope).
251
355
  */
252
356
  exportCsv(input: CallRecordsExportCsvInput, options?: NivaRequestOptions): NivaStream<CallRecordsExportCsvEvent>;
357
+ /**
358
+ * callRecords.exportJobCancel operation.
359
+ *
360
+ * Cancels a queued, running or paused export and removes its files. Only the user who requested it may cancel (403 EXPORT_JOB_NOT_OWNER); a finished export returns 409 EXPORT_JOB_NOT_CANCELLABLE. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 calls like the synchronous export. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the call_record:export permission (call_record:read API-key scope); an export that includes the transcription column also needs call_content:read, and is invisible to users without it.
361
+ */
362
+ exportJobCancel(input: CallRecordsExportJobCancelInput, options?: NivaRequestOptions): NivaCall<CallRecordsExportJobCancelOutput, CallRecordsExportJobCancelErrorCode>;
363
+ /**
364
+ * callRecords.exportJobCreate operation.
365
+ *
366
+ * Queues an export of the matching calls and returns the job immediately; poll it, stream its progress or wait for the notification. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 calls like the synchronous export. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the call_record:export permission (call_record:read API-key scope); an export that includes the transcription column also needs call_content:read, and is invisible to users without it. Takes the same filters and columns as the synchronous export plus an optional header_labels map. An organization may hold at most 3 exports that are queued, running or paused (409 EXPORT_JOB_LIMIT_REACHED).
367
+ */
368
+ exportJobCreate(input: CallRecordsExportJobCreateInput, options?: NivaRequestOptions): NivaCall<CallRecordsExportJobCreateOutput, CallRecordsExportJobCreateErrorCode>;
369
+ /**
370
+ * callRecords.exportJobDownload operation.
371
+ *
372
+ * Streams the finished .zip (application/zip; the bytes are never buffered server-side). 409 EXPORT_JOB_NOT_READY while the export is queued, running or paused; 410 EXPORT_JOB_EXPIRED once the 7-day retention passed; 404 EXPORT_JOB_NOT_FOUND for an unknown or hidden export. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 calls like the synchronous export. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the call_record:export permission (call_record:read API-key scope); an export that includes the transcription column also needs call_content:read, and is invisible to users without it.
373
+ */
374
+ exportJobDownload(input: CallRecordsExportJobDownloadInput, options?: NivaRequestOptions & {
375
+ range?: string;
376
+ }): NivaCall<Response, CallRecordsExportJobDownloadErrorCode>;
377
+ /**
378
+ * callRecords.exportJobGet operation.
379
+ *
380
+ * Fetches one export with its status and progress. An unknown, cross-organization or (without call_content:read) transcription export returns 404 EXPORT_JOB_NOT_FOUND. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 calls like the synchronous export. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the call_record:export permission (call_record:read API-key scope); an export that includes the transcription column also needs call_content:read, and is invisible to users without it.
381
+ */
382
+ exportJobGet(input: CallRecordsExportJobGetInput, options?: NivaRequestOptions): NivaCall<CallRecordsExportJobGetOutput, CallRecordsExportJobGetErrorCode>;
383
+ /**
384
+ * callRecords.exportJobList operation.
385
+ *
386
+ * Returns the organization's exports from the last 7 days, newest first, at most 100 (not paginated). Cancelled exports are omitted. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 calls like the synchronous export. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the call_record:export permission (call_record:read API-key scope); an export that includes the transcription column also needs call_content:read, and is invisible to users without it.
387
+ */
388
+ exportJobList(options?: NivaRequestOptions): NivaCall<CallRecordsExportJobListOutput, CallRecordsExportJobListErrorCode>;
389
+ /**
390
+ * callRecords.exportJobProgress operation.
391
+ *
392
+ * Server-Sent Events stream of an export's progress. The first event is always a full snapshot of the current state and every later event carries the whole state too rather than a delta, so reconnecting is safe. The response advertises a 5s reconnect delay; the stream closes once the export is ready, failed, cancelled or expired. An unknown or hidden export returns 404 EXPORT_JOB_NOT_FOUND before the stream opens. Exports run in the background and produce a .zip with one CSV per million rows, so they are not capped at 100000 calls like the synchronous export. Only one export runs at a time on the installation and a running export pauses while the organization's voice channels are above 80% of their limit. A finished file stays available for 7 days. Requires the call_record:export permission (call_record:read API-key scope); an export that includes the transcription column also needs call_content:read, and is invisible to users without it.
393
+ */
394
+ exportJobProgress(input: CallRecordsExportJobProgressInput, options?: NivaRequestOptions): NivaStream<CallRecordsExportJobProgressEvent>;
253
395
  /**
254
396
  * callRecords.getById operation.
255
397
  *
@@ -342,6 +484,18 @@ export interface NivaClient {
342
484
  * Returns a paginated list of the organization's channels, optionally filtered by `channel_type`, `is_active` and `alert` (`true` returns only channels with an alert: active channels with no plan, a never-published plan, or a failed WhatsApp webhook sync). `search` also matches the linked plan name. Every item carries `calls_7d` (14 daily buckets plus the 7-day total, null without the call_record:read permission), `last_call_at` (same permission rule), `visual_plan_published_version` (null while never published or unlinked) and `visual_plan_has_unpublished_changes`. The response adds `counts` (`all` plus one entry per channel type with rows, under the current search, ignoring the type/status/alert filters), `active_count` and `alert_count` (same search rule). `sort_by` accepts `calls_7d` (busiest first on desc) and `last_call_at` (most recent first on desc, quiet channels last) whenever calls are visible, otherwise both fall back to `updated_at`. When the omnichannel module is disabled the result is restricted to SIP channels, and requesting a non-SIP `channel_type` returns 403 MODULE_DISABLED.
343
485
  */
344
486
  list(input?: ChannelsListInput, options?: NivaRequestOptions): NivaCall<ChannelsListOutput, ChannelsListErrorCode>;
487
+ /**
488
+ * channels.rotateWebchatKey operation.
489
+ *
490
+ * Replaces the webchat channel's public key (`wc_pk_...`) and returns the new one. The old key stops resolving at once and visitor sessions already open are closed on their next frame. Embedded snippets and direct links with the old key must be updated. Only webchat channels qualify; any other channel, or one of another organization, returns 404 CHANNEL_NOT_FOUND. Requires the omnichannel module.
491
+ */
492
+ rotateWebchatKey(input: ChannelsRotateWebchatKeyInput, options?: NivaRequestOptions): NivaCall<ChannelsRotateWebchatKeyOutput, ChannelsRotateWebchatKeyErrorCode>;
493
+ /**
494
+ * channels.rotateWebchatSecret operation.
495
+ *
496
+ * Generates a new identity secret (`wcs_...`) for the webchat channel and returns it in clear exactly once; afterwards only its last 4 characters are readable. The previous secret keeps verifying identity tokens for 24 hours. Fails with 500 AI_ENCRYPTION_KEY_MISSING when the server has no encryption key. Only webchat channels qualify; any other channel, or one of another organization, returns 404 CHANNEL_NOT_FOUND. Requires the omnichannel module.
497
+ */
498
+ rotateWebchatSecret(input: ChannelsRotateWebchatSecretInput, options?: NivaRequestOptions): NivaCall<ChannelsRotateWebchatSecretOutput, ChannelsRotateWebchatSecretErrorCode>;
345
499
  /**
346
500
  * channels.testConnection operation.
347
501
  *
@@ -361,6 +515,34 @@ export interface NivaClient {
361
515
  */
362
516
  update(input: ChannelsUpdateInput, options?: NivaRequestOptions): NivaCall<ChannelsUpdateOutput, ChannelsUpdateErrorCode>;
363
517
  };
518
+ chat: {
519
+ /**
520
+ * chat.createMedia operation.
521
+ *
522
+ * Stages one file (multipart/form-data, part `file`) for a live web chat session, to be sent afterwards as a WebSocket message `{"type":"media","media_id":"<id>","caption":"..."}`. The credential is the session_id (a chs_ TypeID) as `Authorization: Bearer <session_id>`, which is what `POST /chat/sessions` returned: no API key goes to the browser. The request must carry a Content-Length header (any HTTP client sending a multipart body does), because the size is checked before the body is read. The kind and type of the file are decided by its content: images up to 10 MiB, audio and video up to 16 MiB, documents up to 20 MiB (PDF, Office, plain text and CSV). A staged file can only be sent by the session that uploaded it, once. Errors: 411 LENGTH_REQUIRED without Content-Length; 401 WEBCHAT_SESSION_INVALID for a missing, unknown, expired or revoked session; 403 WEBCHAT_ORIGIN_DENIED when the request carries an Origin the channel does not allow; 413 CHAT_MEDIA_TOO_LARGE; 415 CHAT_MEDIA_UNSUPPORTED. 20 uploads per minute per IP.
523
+ */
524
+ createMedia(input: ChatCreateMediaInput, options?: NivaRequestOptions): NivaCall<ChatCreateMediaOutput, ChatCreateMediaErrorCode>;
525
+ /**
526
+ * chat.createSession operation.
527
+ *
528
+ * Creates a live chat session that runs a published visual plan, for a browser to join over WebSocket. Call it from your backend: the API key never goes to the browser. Hand only ws_url to the page: it is a path relative to the server root (/ws?session=<session_id>, where session_id is a chs_ TypeID), and @sippulse/niva-sdk returns it absolute (ws:// or wss://, from the client baseUrl). The page must open the WebSocket within expires_in seconds (300); once connected the session lives 24 hours. Errors: 403 MODULE_DISABLED when the organization lacks the omnichannel module, 404 PLAN_NOT_FOUND when the plan does not exist in the organization, 422 PLAN_NOT_PUBLISHED when the plan exists but has no published version. Requires the chat:create permission and chat:write scope.
529
+ */
530
+ createSession(input: ChatCreateSessionInput, options?: NivaRequestOptions): NivaCall<ChatCreateSessionOutput, ChatCreateSessionErrorCode>;
531
+ /**
532
+ * chat.endSession operation.
533
+ *
534
+ * Ends the conversation of a web chat session, as the visitor leaving: the call record closes with the contact as the one who hung up, the session leaves the live list, and the agent of a SIP transfer is told. The credential is the session_id (a chs_ TypeID) as `Authorization: Bearer <session_id>`, exactly as for `POST /chat/media`, and the path must name that same session. Safe to repeat: a conversation that already ended or never started also answers 204. Closing the page or losing the connection does NOT end the conversation; only this call does. Errors: 401 WEBCHAT_SESSION_INVALID for a missing, unknown, expired or revoked session; 403 WEBCHAT_ORIGIN_DENIED when the request carries an Origin the channel does not allow; 404 CHAT_SESSION_NOT_FOUND when the path names another session than the credential. 60 requests per minute per IP.
535
+ */
536
+ endSession(input: ChatEndSessionInput, options?: NivaRequestOptions): NivaCall<void, ChatEndSessionErrorCode>;
537
+ /**
538
+ * chat.getMedia operation.
539
+ *
540
+ * Streams back a file the same web chat session uploaded with `POST /chat/media`, typed by the content NIVA sniffed on arrival and served as an attachment with `X-Content-Type-Options: nosniff` and `Cache-Control: private, no-store`. The credential is the session_id (a chs_ TypeID) as `Authorization: Bearer <session_id>`, exactly as for the upload, and a file is only ever returned to the session that uploaded it. Errors: 401 WEBCHAT_SESSION_INVALID for a missing, unknown, expired or revoked session; 403 WEBCHAT_ORIGIN_DENIED when the request carries an Origin the channel does not allow; 404 CHAT_MEDIA_NOT_FOUND for a file that is unknown, belongs to another session or organization, was removed by retention or whose bytes are gone from storage, all answered alike. 120 downloads per minute per IP.
541
+ */
542
+ getMedia(input: ChatGetMediaInput, options?: NivaRequestOptions & {
543
+ range?: string;
544
+ }): NivaCall<Response, ChatGetMediaErrorCode>;
545
+ };
364
546
  contacts: {
365
547
  /**
366
548
  * contacts.getById operation.
@@ -381,6 +563,34 @@ export interface NivaClient {
381
563
  */
382
564
  update(input: ContactsUpdateInput, options?: NivaRequestOptions): NivaCall<ContactsUpdateOutput, ContactsUpdateErrorCode>;
383
565
  };
566
+ conversations: {
567
+ /**
568
+ * conversations.count operation.
569
+ *
570
+ * Returns the number of conversations matching the same filters GET /desk/conversations accepts, within the caller's scope (the whole organization with the conversation:read scope, the caller's own with desk access alone), without paging any of them. It exists so a cursor-paginated listing can show a total without paying for count(*) on every page.
571
+ */
572
+ count(input?: ConversationsCountInput, options?: NivaRequestOptions): NivaCall<ConversationsCountOutput, ConversationsCountErrorCode>;
573
+ /**
574
+ * conversations.getById operation.
575
+ *
576
+ * Returns one conversation. Returns 404 CONVERSATION_NOT_FOUND when it does not exist, belongs to another organization, or belongs to another attendant and the caller only has desk access.
577
+ */
578
+ getById(input: ConversationsGetByIdInput, options?: NivaRequestOptions): NivaCall<ConversationsGetByIdOutput, ConversationsGetByIdErrorCode>;
579
+ /**
580
+ * conversations.list operation.
581
+ *
582
+ * Returns a paginated list of conversations: the requests for human work over a call or a chat session, with their times, disposition and outcome, newest first by default. With the conversation:read scope it lists the whole organization; an attendant with only desk access lists their own. `date_from` and `date_to` filter on the creation time; `queue_id` and `disposition_id` narrow by the queue it came from and the disposition it was closed with. Deep pages should use keyset pagination: feed next_cursor back as cursor, which ignores page and returns null total/total_pages - ask GET /desk/conversations/count for the number.
583
+ */
584
+ list(input?: ConversationsListInput, options?: NivaRequestOptions): NivaCall<ConversationsListOutput, ConversationsListErrorCode>;
585
+ /**
586
+ * conversations.mediaContent operation.
587
+ *
588
+ * Streams a file a chat message carries, typed by the content NIVA sniffed on arrival and served as an attachment with `X-Content-Type-Options: nosniff`. With the conversation:read scope it serves any conversation of the organization; an attendant with only desk access gets their own. Returns 404 CONVERSATION_NOT_FOUND when the conversation is unknown, belongs to another organization, or belongs to another attendant, and 404 CHAT_MEDIA_NOT_FOUND when the file does not belong to that conversation, was removed by retention, or its bytes are gone.
589
+ */
590
+ mediaContent(input: ConversationsMediaContentInput, options?: NivaRequestOptions & {
591
+ range?: string;
592
+ }): NivaCall<Response, ConversationsMediaContentErrorCode>;
593
+ };
384
594
  dashboard: {
385
595
  /**
386
596
  * dashboard.capacityStatus operation.
@@ -395,6 +605,103 @@ export interface NivaClient {
395
605
  */
396
606
  watchDashboardMetrics(options?: NivaRequestOptions): NivaStream<DashboardWatchDashboardMetricsEvent>;
397
607
  };
608
+ desk: {
609
+ /**
610
+ * desk.transferQueues operation.
611
+ *
612
+ * Returns the organization's queues, by name, for an attendant choosing where to transfer a conversation. Only the id, the name and the channels the queue takes: no members and no numbers. Requires the desk:use scope.
613
+ */
614
+ transferQueues(options?: NivaRequestOptions): NivaCall<DeskTransferQueuesOutput, DeskTransferQueuesErrorCode>;
615
+ copilot: {
616
+ /**
617
+ * desk.copilot.stats operation.
618
+ *
619
+ * Returns what the copilot's suggestions amounted to in `[from, to)`, optionally of one queue: replies shown, used, edited, discarded and ignored; answers asked and rated; wrap-ups shown, with the disposition kept and the note edited; summaries; latency (median and 95th percentile) and tokens. The window is at most 93 days; a longer one is 422 WINDOW_TOO_LONG. Requires the desk_monitor:read scope and the copilot module.
620
+ */
621
+ stats(input: DeskCopilotStatsInput, options?: NivaRequestOptions): NivaCall<DeskCopilotStatsOutput, DeskCopilotStatsErrorCode>;
622
+ };
623
+ };
624
+ deskSettings: {
625
+ copilotAgents(options?: NivaRequestOptions): NivaCall<DeskSettingsCopilotAgentsOutput, DeskSettingsCopilotAgentsErrorCode>;
626
+ /**
627
+ * deskSettings.createDefaults operation.
628
+ *
629
+ * Creates the standard pause reasons (Lanche, Banheiro, Treinamento, Feedback) and dispositions (Resolvido, Não resolvido, Retornar depois, Engano). Each kind is created only when the organization has none of it, so calling it again changes nothing. Requires the desk_settings:update scope.
630
+ */
631
+ createDefaults(options?: NivaRequestOptions): NivaCall<DeskSettingsCreateDefaultsOutput, DeskSettingsCreateDefaultsErrorCode>;
632
+ /**
633
+ * deskSettings.createDisposition operation.
634
+ *
635
+ * Creates a disposition, last in the display order. `requires_note` makes the attendant write a note to use it. `color` (a name from the organization palette) tells it apart in tables; null or absent is neutral. `queue_id` limits it to one queue's conversations; without it the disposition serves the whole organization. Returns 409 DISPOSITION_DUPLICATE when a live disposition has the same `code` and 404 QUEUE_NOT_FOUND for an unknown queue. Requires the desk_settings:update scope.
636
+ */
637
+ createDisposition(input: DeskSettingsCreateDispositionInput, options?: NivaRequestOptions): NivaCall<DeskSettingsCreateDispositionOutput, DeskSettingsCreateDispositionErrorCode>;
638
+ /**
639
+ * deskSettings.createPauseReason operation.
640
+ *
641
+ * Creates a pause reason, last in the display order. `max_minutes` is the time limit (empty means none). Returns 409 PAUSE_REASON_DUPLICATE when a live reason has the same name. Requires the desk_settings:update scope.
642
+ */
643
+ createPauseReason(input: DeskSettingsCreatePauseReasonInput, options?: NivaRequestOptions): NivaCall<DeskSettingsCreatePauseReasonOutput, DeskSettingsCreatePauseReasonErrorCode>;
644
+ /**
645
+ * deskSettings.deleteDisposition operation.
646
+ *
647
+ * Soft-deletes a disposition; closed conversations keep it. Returns 404 DISPOSITION_NOT_FOUND. Requires the desk_settings:update scope.
648
+ */
649
+ deleteDisposition(input: DeskSettingsDeleteDispositionInput, options?: NivaRequestOptions): NivaCall<DeskSettingsDeleteDispositionOutput, DeskSettingsDeleteDispositionErrorCode>;
650
+ /**
651
+ * deskSettings.deletePauseReason operation.
652
+ *
653
+ * Soft-deletes a pause reason; past pauses keep their history. Returns 404 PAUSE_REASON_NOT_FOUND. Requires the desk_settings:update scope.
654
+ */
655
+ deletePauseReason(input: DeskSettingsDeletePauseReasonInput, options?: NivaRequestOptions): NivaCall<DeskSettingsDeletePauseReasonOutput, DeskSettingsDeletePauseReasonErrorCode>;
656
+ /**
657
+ * deskSettings.get operation.
658
+ *
659
+ * Returns the organization's Desk settings: whether leaving wrap-up requires a disposition, and how many offers in a row an attendant may miss before the automatic pause. Requires the desk_settings:read scope.
660
+ */
661
+ get(options?: NivaRequestOptions): NivaCall<DeskSettingsGetOutput, DeskSettingsGetErrorCode>;
662
+ /**
663
+ * deskSettings.listDispositions operation.
664
+ *
665
+ * Returns the dispositions an attendant can close a conversation with, in display order. With `queue_id`, only the ones usable on that queue: the organization-wide ones plus the queue's own. Requires the desk_settings:read scope.
666
+ */
667
+ listDispositions(input?: DeskSettingsListDispositionsInput, options?: NivaRequestOptions): NivaCall<DeskSettingsListDispositionsOutput, DeskSettingsListDispositionsErrorCode>;
668
+ /**
669
+ * deskSettings.listPauseReasons operation.
670
+ *
671
+ * Returns the reasons an attendant can pause for, in display order. Requires the desk_settings:read scope.
672
+ */
673
+ listPauseReasons(input?: DeskSettingsListPauseReasonsInput, options?: NivaRequestOptions): NivaCall<DeskSettingsListPauseReasonsOutput, DeskSettingsListPauseReasonsErrorCode>;
674
+ /**
675
+ * deskSettings.reorderDispositions operation.
676
+ *
677
+ * Sets the display order from the list of ids, first to last. Returns 404 DISPOSITION_NOT_FOUND when an id is not a live disposition of the organization. Requires the desk_settings:update scope.
678
+ */
679
+ reorderDispositions(input: DeskSettingsReorderDispositionsInput, options?: NivaRequestOptions): NivaCall<DeskSettingsReorderDispositionsOutput, DeskSettingsReorderDispositionsErrorCode>;
680
+ /**
681
+ * deskSettings.reorderPauseReasons operation.
682
+ *
683
+ * Sets the display order from the list of ids, first to last. Returns 404 PAUSE_REASON_NOT_FOUND when an id is not a live reason of the organization. Requires the desk_settings:update scope.
684
+ */
685
+ reorderPauseReasons(input: DeskSettingsReorderPauseReasonsInput, options?: NivaRequestOptions): NivaCall<DeskSettingsReorderPauseReasonsOutput, DeskSettingsReorderPauseReasonsErrorCode>;
686
+ /**
687
+ * deskSettings.update operation.
688
+ *
689
+ * Partially updates the Desk settings. Requires the desk_settings:update scope.
690
+ */
691
+ update(input?: DeskSettingsUpdateInput, options?: NivaRequestOptions): NivaCall<DeskSettingsUpdateOutput, DeskSettingsUpdateErrorCode>;
692
+ /**
693
+ * deskSettings.updateDisposition operation.
694
+ *
695
+ * Partially updates a disposition; `queue_id` null makes it organization-wide, `color` null makes it neutral. Returns 404 DISPOSITION_NOT_FOUND or QUEUE_NOT_FOUND, or 409 DISPOSITION_DUPLICATE. Requires the desk_settings:update scope.
696
+ */
697
+ updateDisposition(input: DeskSettingsUpdateDispositionInput, options?: NivaRequestOptions): NivaCall<DeskSettingsUpdateDispositionOutput, DeskSettingsUpdateDispositionErrorCode>;
698
+ /**
699
+ * deskSettings.updatePauseReason operation.
700
+ *
701
+ * Partially updates a pause reason. Returns 404 PAUSE_REASON_NOT_FOUND or 409 PAUSE_REASON_DUPLICATE. Requires the desk_settings:update scope.
702
+ */
703
+ updatePauseReason(input: DeskSettingsUpdatePauseReasonInput, options?: NivaRequestOptions): NivaCall<DeskSettingsUpdatePauseReasonOutput, DeskSettingsUpdatePauseReasonErrorCode>;
704
+ };
398
705
  destinations: {
399
706
  /**
400
707
  * destinations.create operation.
@@ -623,82 +930,102 @@ export interface NivaClient {
623
930
  */
624
931
  progress(input: DialerImportsProgressInput, options?: NivaRequestOptions): NivaStream<DialerImportsProgressEvent>;
625
932
  };
626
- holidays: {
933
+ holidayCalendars: {
627
934
  /**
628
- * holidays.countries operation.
935
+ * holidayCalendars.create operation.
629
936
  *
630
- * Returns the countries supported by the external holiday provider (Nager.Date). Returns 502 NAGER_API_ERROR when the provider cannot be reached.
937
+ * Creates an empty own calendar. Add entries, or import an .ics file, then subscribe schedules to it.
631
938
  */
632
- countries(options?: NivaRequestOptions): NivaCall<HolidaysCountriesOutput, HolidaysCountriesErrorCode>;
939
+ create(input: HolidayCalendarsCreateInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsCreateOutput, HolidayCalendarsCreateErrorCode>;
633
940
  /**
634
- * holidays.create operation.
941
+ * holidayCalendars.delete operation.
635
942
  *
636
- * Adds a single holiday (a single day or a date range) to the given group. Set `recurring` to repeat it every year on the same date.
943
+ * Deletes the calendar and its entries. Returns 409 HOLIDAY_CALENDAR_IN_USE while a live schedule is subscribed to it, and 404 HOLIDAY_CALENDAR_NOT_FOUND when it does not exist.
637
944
  */
638
- create(input: HolidaysCreateInput, options?: NivaRequestOptions): NivaCall<HolidaysCreateOutput, HolidaysCreateErrorCode>;
945
+ delete(input: HolidayCalendarsDeleteInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsDeleteOutput, HolidayCalendarsDeleteErrorCode>;
639
946
  /**
640
- * holidays.delete operation.
947
+ * holidayCalendars.getById operation.
641
948
  *
642
- * Deletes a single holiday. Returns 404 HOLIDAY_NOT_FOUND when it does not exist, and `{ success: true }` on success.
949
+ * Returns 404 HOLIDAY_CALENDAR_NOT_FOUND when it does not exist or belongs to another organization.
643
950
  */
644
- delete(input: HolidaysDeleteInput, options?: NivaRequestOptions): NivaCall<HolidaysDeleteOutput, HolidaysDeleteErrorCode>;
951
+ getById(input: HolidayCalendarsGetByIdInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsGetByIdOutput, HolidayCalendarsGetByIdErrorCode>;
645
952
  /**
646
- * holidays.import operation.
953
+ * holidayCalendars.importIcs operation.
647
954
  *
648
- * Imports the public holidays for a country and year from the external provider (Nager.Date) into the given group and returns how many were imported. Returns 404 HOLIDAY_GROUP_NOT_FOUND when the group does not exist and 502 NAGER_API_ERROR when the provider cannot be reached.
955
+ * Reads the VEVENTs of an iCalendar file (DTSTART, DTEND, SUMMARY, all-day or timed) and adds them as entries. A yearly RRULE becomes a fixed date. Events it cannot express (other recurrences, UTC times, timed events across days) are skipped and counted in `skipped`.
649
956
  */
650
- import(input: HolidaysImportInput, options?: NivaRequestOptions): NivaCall<HolidaysImportOutput, HolidaysImportErrorCode>;
957
+ importIcs(input: HolidayCalendarsImportIcsInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsImportIcsOutput, HolidayCalendarsImportIcsErrorCode>;
651
958
  /**
652
- * holidays.list operation.
959
+ * holidayCalendars.list operation.
653
960
  *
654
- * Returns a paginated list of the holidays belonging to the given group.
961
+ * Returns a paginated list of the organization's own holiday calendars with the number of live schedules subscribed to each. The built-in catalog is read through `/holiday-catalog`.
655
962
  */
656
- list(input: HolidaysListInput, options?: NivaRequestOptions): NivaCall<HolidaysListOutput, HolidaysListErrorCode>;
963
+ list(input?: HolidayCalendarsListInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsListOutput, HolidayCalendarsListErrorCode>;
657
964
  /**
658
- * holidays.previewImport operation.
965
+ * holidayCalendars.previewRule operation.
659
966
  *
660
- * Fetches the public holidays for a country and year from the external provider without persisting anything, so the result can be reviewed before import. Returns 502 NAGER_API_ERROR when the provider cannot be reached.
967
+ * Returns the next occurrences of a rule from now, in the organization timezone, computed with the same evaluator the engine uses. Nothing is saved. Returns 400 INVALID_HOLIDAY_WINDOW when only one of `start_time` and `end_time` is sent.
661
968
  */
662
- previewImport(input: HolidaysPreviewImportInput, options?: NivaRequestOptions): NivaCall<HolidaysPreviewImportOutput, HolidaysPreviewImportErrorCode>;
969
+ previewRule(input: HolidayCalendarsPreviewRuleInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsPreviewRuleOutput, HolidayCalendarsPreviewRuleErrorCode>;
663
970
  /**
664
- * holidays.update operation.
971
+ * holidayCalendars.update operation.
665
972
  *
666
- * Partially updates a single holiday. Returns 404 HOLIDAY_NOT_FOUND when it does not exist.
973
+ * Partially updates the name and description. Returns 404 HOLIDAY_CALENDAR_NOT_FOUND when it does not exist.
667
974
  */
668
- update(input: HolidaysUpdateInput, options?: NivaRequestOptions): NivaCall<HolidaysUpdateOutput, HolidaysUpdateErrorCode>;
669
- groups: {
975
+ update(input: HolidayCalendarsUpdateInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsUpdateOutput, HolidayCalendarsUpdateErrorCode>;
976
+ entries: {
670
977
  /**
671
- * holidays.groups.create operation.
978
+ * holidayCalendars.entries.create operation.
672
979
  *
673
- * Creates an empty holiday group. Holidays can then be added individually or imported from an external provider.
980
+ * Adds a holiday by rule: a fixed yearly date, a single date or period, Easter plus or minus days, or the nth weekday of a month. Whole day by default; send `start_time` and `end_time` together for a partial day. Returns 400 INVALID_HOLIDAY_WINDOW when only one of them is sent.
674
981
  */
675
- create(input: HolidaysGroupsCreateInput, options?: NivaRequestOptions): NivaCall<HolidaysGroupsCreateOutput, HolidaysGroupsCreateErrorCode>;
982
+ create(input: HolidayCalendarsEntriesCreateInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsEntriesCreateOutput, HolidayCalendarsEntriesCreateErrorCode>;
676
983
  /**
677
- * holidays.groups.delete operation.
984
+ * holidayCalendars.entries.delete operation.
678
985
  *
679
- * Deletes a holiday group and the holidays it contains. Returns 404 HOLIDAY_GROUP_NOT_FOUND when it does not exist, and `{ success: true }` on success.
986
+ * Returns 404 HOLIDAY_CALENDAR_ENTRY_NOT_FOUND when the entry does not exist under that calendar.
680
987
  */
681
- delete(input: HolidaysGroupsDeleteInput, options?: NivaRequestOptions): NivaCall<HolidaysGroupsDeleteOutput, HolidaysGroupsDeleteErrorCode>;
988
+ delete(input: HolidayCalendarsEntriesDeleteInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsEntriesDeleteOutput, HolidayCalendarsEntriesDeleteErrorCode>;
682
989
  /**
683
- * holidays.groups.getById operation.
990
+ * holidayCalendars.entries.getById operation.
684
991
  *
685
- * Returns the holiday group, or `null` (HTTP 200) when it does not exist or belongs to another organization.
992
+ * Returns 404 HOLIDAY_CALENDAR_ENTRY_NOT_FOUND when the entry does not exist under that calendar.
686
993
  */
687
- getById(input: HolidaysGroupsGetByIdInput, options?: NivaRequestOptions): NivaCall<HolidaysGroupsGetByIdOutput, HolidaysGroupsGetByIdErrorCode>;
994
+ getById(input: HolidayCalendarsEntriesGetByIdInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsEntriesGetByIdOutput, HolidayCalendarsEntriesGetByIdErrorCode>;
688
995
  /**
689
- * holidays.groups.list operation.
996
+ * holidayCalendars.entries.list operation.
690
997
  *
691
- * Returns a paginated list of the organization's holiday groups (named collections of holidays that schedules can reference).
998
+ * Returns a paginated list of the calendar's dated entries. Returns 404 HOLIDAY_CALENDAR_NOT_FOUND when the calendar does not exist.
692
999
  */
693
- list(input?: HolidaysGroupsListInput, options?: NivaRequestOptions): NivaCall<HolidaysGroupsListOutput, HolidaysGroupsListErrorCode>;
1000
+ list(input: HolidayCalendarsEntriesListInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsEntriesListOutput, HolidayCalendarsEntriesListErrorCode>;
694
1001
  /**
695
- * holidays.groups.update operation.
1002
+ * holidayCalendars.entries.update operation.
696
1003
  *
697
- * Partially updates a holiday group's metadata. Returns 404 HOLIDAY_GROUP_NOT_FOUND when it does not exist or belongs to another organization.
1004
+ * Partially updates the entry. The partial-day window is validated on the merged entry, so clearing only one of `start_time` and `end_time` is 400 INVALID_HOLIDAY_WINDOW.
698
1005
  */
699
- update(input: HolidaysGroupsUpdateInput, options?: NivaRequestOptions): NivaCall<HolidaysGroupsUpdateOutput, HolidaysGroupsUpdateErrorCode>;
1006
+ update(input: HolidayCalendarsEntriesUpdateInput, options?: NivaRequestOptions): NivaCall<HolidayCalendarsEntriesUpdateOutput, HolidayCalendarsEntriesUpdateErrorCode>;
700
1007
  };
701
1008
  };
1009
+ holidayCatalog: {
1010
+ /**
1011
+ * holidayCatalog.countries operation.
1012
+ *
1013
+ * Returns the countries of the embedded holiday catalog, named in the organization's language. The catalog is offline and the same for every organization.
1014
+ */
1015
+ countries(options?: NivaRequestOptions): NivaCall<HolidayCatalogCountriesOutput, HolidayCatalogCountriesErrorCode>;
1016
+ /**
1017
+ * holidayCatalog.holidays operation.
1018
+ *
1019
+ * Returns the holidays of one catalog level for a year: a state calendar lists only what the country does not already have, and a city calendar only what neither has. Returns 400 INVALID_CATALOG_CODE for an unknown code.
1020
+ */
1021
+ holidays(input: HolidayCatalogHolidaysInput, options?: NivaRequestOptions): NivaCall<HolidayCatalogHolidaysOutput, HolidayCatalogHolidaysErrorCode>;
1022
+ /**
1023
+ * holidayCatalog.regions operation.
1024
+ *
1025
+ * Returns the states of a country with the timezone suggested for each and the cities the catalog covers. Returns 400 INVALID_CATALOG_CODE for an unknown country.
1026
+ */
1027
+ regions(input: HolidayCatalogRegionsInput, options?: NivaRequestOptions): NivaCall<HolidayCatalogRegionsOutput, HolidayCatalogRegionsErrorCode>;
1028
+ };
702
1029
  insights: {
703
1030
  /**
704
1031
  * insights.aggregate operation.
@@ -708,18 +1035,48 @@ export interface NivaClient {
708
1035
  aggregate(input: InsightsAggregateInput, options?: NivaRequestOptions): NivaCall<InsightsAggregateOutput, InsightsAggregateErrorCode>;
709
1036
  };
710
1037
  license: {
1038
+ /**
1039
+ * license.activate operation.
1040
+ *
1041
+ * Trades the activation code for this installation's license. The Suite's error code is in `data.suite_code` when it refuses.
1042
+ */
1043
+ activate(input: LicenseActivateInput, options?: NivaRequestOptions): NivaCall<LicenseActivateOutput, LicenseActivateErrorCode>;
1044
+ /**
1045
+ * license.activation operation.
1046
+ *
1047
+ * Returns where the installation stands with the Suite: whether it is activated, until when the current grant holds and the last failure. `unavailable` when the license does not come from the Suite's v3 protocol.
1048
+ */
1049
+ activation(options?: NivaRequestOptions): NivaCall<LicenseActivationOutput, LicenseActivationErrorCode>;
711
1050
  /**
712
1051
  * license.modules operation.
713
1052
  *
714
1053
  * Returns enabled modules and service availability without exposing deployment license details.
715
1054
  */
716
1055
  modules(options?: NivaRequestOptions): NivaCall<LicenseModulesOutput, LicenseModulesErrorCode>;
1056
+ /**
1057
+ * license.orgUsage operation.
1058
+ *
1059
+ * Returns the caller's organization voice channels and chat sessions in use against its limit (its own cap, else the installation's) and, with the desk module, its attendants against its own cap. Nothing of the installation crosses.
1060
+ */
1061
+ orgUsage(options?: NivaRequestOptions): NivaCall<LicenseOrgUsageOutput, LicenseOrgUsageErrorCode>;
1062
+ /**
1063
+ * license.refresh operation.
1064
+ *
1065
+ * Sends the heartbeat now instead of waiting for the next one, so a plan change, a block or a renewal made in the Suite reaches the installation at once. A contact in the last 10 seconds, answered or failed, is the answer already and no new heartbeat goes out. A failed heartbeat is not an error here: it comes back in `last_error`, as the scheduled one would leave it.
1066
+ */
1067
+ refresh(options?: NivaRequestOptions): NivaCall<LicenseRefreshOutput, LicenseRefreshErrorCode>;
717
1068
  /**
718
1069
  * license.status operation.
719
1070
  *
720
1071
  * Returns deployment-wide license status and installation details. Available only to platform administrators.
721
1072
  */
722
1073
  status(options?: NivaRequestOptions): NivaCall<LicenseStatusOutput, LicenseStatusErrorCode>;
1074
+ /**
1075
+ * license.usage operation.
1076
+ *
1077
+ * Returns the plan, each licensed limit with what is in use now and the month's peak, the calls classified in the month and the month's AI credit. Available only to platform administrators.
1078
+ */
1079
+ usage(options?: NivaRequestOptions): NivaCall<LicenseUsageOutput, LicenseUsageErrorCode>;
723
1080
  };
724
1081
  nodes: {
725
1082
  /**
@@ -736,6 +1093,12 @@ export interface NivaClient {
736
1093
  schema(input: NodesSchemaInput, options?: NivaRequestOptions): NivaCall<NodesSchemaOutput, NodesSchemaErrorCode>;
737
1094
  };
738
1095
  oauthGrants: {
1096
+ /**
1097
+ * oauthGrants.get operation.
1098
+ *
1099
+ * Returns one live OAuth grant (connected app) with the same fields as the list: client, user, scopes, IP and last use. A member can read only their own grants; oauth_grant:revoke (org admin) reads anyone's in the organization. An unknown, revoked or cross-org id returns 404 OAUTH_GRANT_NOT_FOUND; another member's grant returns 403 OAUTH_GRANT_FORBIDDEN. Requires the oauth_grant:read scope.
1100
+ */
1101
+ get(input: OauthGrantsGetInput, options?: NivaRequestOptions): NivaCall<OauthGrantsGetOutput, OauthGrantsGetErrorCode>;
739
1102
  /**
740
1103
  * oauthGrants.list operation.
741
1104
  *
@@ -759,7 +1122,7 @@ export interface NivaClient {
759
1122
  /**
760
1123
  * orgSettings.getDialer operation.
761
1124
  *
762
- * Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country and the answering-machine detection defaults. Returns null when no settings row exists yet.
1125
+ * Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
763
1126
  */
764
1127
  getDialer(options?: NivaRequestOptions): NivaCall<OrgSettingsGetDialerOutput, OrgSettingsGetDialerErrorCode>;
765
1128
  /**
@@ -769,11 +1132,155 @@ export interface NivaClient {
769
1132
  */
770
1133
  upsertDialer(input?: OrgSettingsUpsertDialerInput, options?: NivaRequestOptions): NivaCall<OrgSettingsUpsertDialerOutput, OrgSettingsUpsertDialerErrorCode>;
771
1134
  };
1135
+ queues: {
1136
+ /**
1137
+ * queues.addMembers operation.
1138
+ *
1139
+ * Adds up to 100 attendants with the given `priority` (higher is offered first). Idempotent: an attendant already in the queue is left as it is, priority included, and is not counted in `added`. Unlike PUT /queues/{queue_id}/members it never removes anyone. Returns 404 QUEUE_NOT_FOUND, or ATTENDANT_NOT_FOUND when an attendant does not exist in the organization (nobody is added then). Requires the queue:update scope.
1140
+ */
1141
+ addMembers(input: QueuesAddMembersInput, options?: NivaRequestOptions): NivaCall<QueuesAddMembersOutput, QueuesAddMembersErrorCode>;
1142
+ /**
1143
+ * queues.create operation.
1144
+ *
1145
+ * Creates a queue. `strategy` is `longest_idle` (default), `ring_all`, `round_robin`, `fewest_calls` or `random`; `max_wait_s` and `max_size` of 0 mean no limit; `wrap_s` and `max_refusals` left null follow the attendant's and the organization's settings. `moh_audio_id` is the waiting music (null: the house music). `copilot_agent_id` is the SipPulse AI agent that answers the Mesa copilot for this queue (null: the organization's default agent). Returns 409 QUEUE_NAME_TAKEN when a live queue has the name and 404 AUDIO_FILE_NOT_FOUND for an unknown audio. Requires the queue:create scope.
1146
+ */
1147
+ create(input: QueuesCreateInput, options?: NivaRequestOptions): NivaCall<QueuesCreateOutput, QueuesCreateErrorCode>;
1148
+ /**
1149
+ * queues.delete operation.
1150
+ *
1151
+ * Soft-deletes a queue (it can be restored from the archive). Returns 409 QUEUE_IN_USE while callers are waiting or being offered, and 404 QUEUE_NOT_FOUND. Requires the queue:delete scope.
1152
+ */
1153
+ delete(input: QueuesDeleteInput, options?: NivaRequestOptions): NivaCall<QueuesDeleteOutput, QueuesDeleteErrorCode>;
1154
+ /**
1155
+ * queues.getById operation.
1156
+ *
1157
+ * Returns one queue with its members (highest priority first), its live state and the day's numbers. Returns 404 QUEUE_NOT_FOUND when it does not exist or belongs to another organization. Requires the queue:read scope.
1158
+ */
1159
+ getById(input: QueuesGetByIdInput, options?: NivaRequestOptions): NivaCall<QueuesGetByIdOutput, QueuesGetByIdErrorCode>;
1160
+ /**
1161
+ * queues.list operation.
1162
+ *
1163
+ * Returns a paginated list of the organization's queues, each with its live counters: `waiting` callers, `available` members and the `longest_wait_s`. `search` matches the queue name. Requires the queue:read scope.
1164
+ */
1165
+ list(input?: QueuesListInput, options?: NivaRequestOptions): NivaCall<QueuesListOutput, QueuesListErrorCode>;
1166
+ /**
1167
+ * queues.listMembers operation.
1168
+ *
1169
+ * Returns one page of the queue's members with their priority and current state. `search` matches the attendant's name or e-mail; `sort_by` is `priority` (higher is offered first, the default) or `name`. Returns 404 QUEUE_NOT_FOUND. Requires the queue:read scope.
1170
+ */
1171
+ listMembers(input: QueuesListMembersInput, options?: NivaRequestOptions): NivaCall<QueuesListMembersOutput, QueuesListMembersErrorCode>;
1172
+ /**
1173
+ * queues.removeMember operation.
1174
+ *
1175
+ * A supervisor takes one attendant out of the queue; the attendant's state is untouched. Returns 404 QUEUE_NOT_FOUND, or ATTENDANT_NOT_FOUND when the attendant is not a member. Requires the queue_monitor:control or the queue:update scope.
1176
+ */
1177
+ removeMember(input: QueuesRemoveMemberInput, options?: NivaRequestOptions): NivaCall<QueuesRemoveMemberOutput, QueuesRemoveMemberErrorCode>;
1178
+ /**
1179
+ * queues.replaceMembers operation.
1180
+ *
1181
+ * Replaces the whole member set: whoever is not listed leaves the queue, and `priority` (higher is offered first) is set for the ones listed. An attendant listed twice is a validation error. Returns 404 QUEUE_NOT_FOUND, or ATTENDANT_NOT_FOUND when an attendant does not exist in the organization. Requires the queue:update scope.
1182
+ */
1183
+ replaceMembers(input: QueuesReplaceMembersInput, options?: NivaRequestOptions): NivaCall<QueuesReplaceMembersOutput, QueuesReplaceMembersErrorCode>;
1184
+ /**
1185
+ * queues.stats operation.
1186
+ *
1187
+ * Returns the queue's `live` state (waiting, offered, in service, members logged in and available) and its `day` numbers since the organization's local midnight: offered, answered, abandoned, SLA and abandon percentages, average wait and talk. Returns 404 QUEUE_NOT_FOUND. Requires the queue:read scope.
1188
+ */
1189
+ stats(input: QueuesStatsInput, options?: NivaRequestOptions): NivaCall<QueuesStatsOutput, QueuesStatsErrorCode>;
1190
+ /**
1191
+ * queues.update operation.
1192
+ *
1193
+ * Partially updates a queue; a nullable field sent as null is cleared (`copilot_agent_id` included: null follows the organization's default copilot agent). The change applies to the callers already waiting. Returns 404 QUEUE_NOT_FOUND or AUDIO_FILE_NOT_FOUND, and 409 QUEUE_NAME_TAKEN. Requires the queue:update scope.
1194
+ */
1195
+ update(input: QueuesUpdateInput, options?: NivaRequestOptions): NivaCall<QueuesUpdateOutput, QueuesUpdateErrorCode>;
1196
+ /**
1197
+ * queues.updateMember operation.
1198
+ *
1199
+ * Changes the priority of one member (higher is offered first) and returns the member. Returns 404 QUEUE_NOT_FOUND, or ATTENDANT_NOT_FOUND when the attendant is not a member. Requires the queue:update scope.
1200
+ */
1201
+ updateMember(input: QueuesUpdateMemberInput, options?: NivaRequestOptions): NivaCall<QueuesUpdateMemberOutput, QueuesUpdateMemberErrorCode>;
1202
+ };
1203
+ savedReplies: {
1204
+ /**
1205
+ * savedReplies.create operation.
1206
+ *
1207
+ * Creates a personal reply (scope `personal`, owned by the caller, needs desk:use) or an organization reply (scope `org`, needs saved_reply:manage). The shortcut is unique among the org's replies and, for personal ones, among the owner's, ignoring case: a taken one is 409 SAVED_REPLY_SHORTCUT_TAKEN.
1208
+ */
1209
+ create(input: SavedRepliesCreateInput, options?: NivaRequestOptions): NivaCall<SavedRepliesCreateOutput, SavedRepliesCreateErrorCode>;
1210
+ /**
1211
+ * savedReplies.delete operation.
1212
+ *
1213
+ * Soft-deletes a saved reply and frees its shortcut. An organization reply needs saved_reply:manage; another user's personal reply is 404 SAVED_REPLY_NOT_FOUND.
1214
+ */
1215
+ delete(input: SavedRepliesDeleteInput, options?: NivaRequestOptions): NivaCall<SavedRepliesDeleteOutput, SavedRepliesDeleteErrorCode>;
1216
+ /**
1217
+ * savedReplies.get operation.
1218
+ *
1219
+ * Returns one saved reply. Another user's personal reply is 404 SAVED_REPLY_NOT_FOUND, never 403.
1220
+ */
1221
+ get(input: SavedRepliesGetInput, options?: NivaRequestOptions): NivaCall<SavedRepliesGetOutput, SavedRepliesGetErrorCode>;
1222
+ /**
1223
+ * savedReplies.list operation.
1224
+ *
1225
+ * Lists the organization's saved replies (with saved_reply:read) and the caller's own personal ones (with desk:use). `channel` keeps the replies that fit that channel type - a reply with no channels fits every channel - and `q` searches the shortcut and the title.
1226
+ */
1227
+ list(input?: SavedRepliesListInput, options?: NivaRequestOptions): NivaCall<SavedRepliesListOutput, SavedRepliesListErrorCode>;
1228
+ /**
1229
+ * savedReplies.update operation.
1230
+ *
1231
+ * Partially updates a saved reply. An organization reply needs saved_reply:manage; a personal one is its owner's alone and another user's is 404 SAVED_REPLY_NOT_FOUND. Returns 409 SAVED_REPLY_SHORTCUT_TAKEN when the new shortcut is in use.
1232
+ */
1233
+ update(input: SavedRepliesUpdateInput, options?: NivaRequestOptions): NivaCall<SavedRepliesUpdateOutput, SavedRepliesUpdateErrorCode>;
1234
+ };
1235
+ scheduleExceptions: {
1236
+ /**
1237
+ * scheduleExceptions.create operation.
1238
+ *
1239
+ * Creates an exception shared by the schedules in `schedule_ids`. Empty `intervals` closes the whole day. Returns 404 SCHEDULE_NOT_FOUND when any schedule belongs to another organization; nothing is created then.
1240
+ */
1241
+ create(input: ScheduleExceptionsCreateInput, options?: NivaRequestOptions): NivaCall<ScheduleExceptionsCreateOutput, ScheduleExceptionsCreateErrorCode>;
1242
+ /**
1243
+ * scheduleExceptions.delete operation.
1244
+ *
1245
+ * Deletes the exception for every schedule it was linked to. Returns 404 SCHEDULE_EXCEPTION_NOT_FOUND when it does not exist.
1246
+ */
1247
+ delete(input: ScheduleExceptionsDeleteInput, options?: NivaRequestOptions): NivaCall<ScheduleExceptionsDeleteOutput, ScheduleExceptionsDeleteErrorCode>;
1248
+ /**
1249
+ * scheduleExceptions.getById operation.
1250
+ *
1251
+ * Returns 404 SCHEDULE_EXCEPTION_NOT_FOUND when it does not exist or belongs to another organization.
1252
+ */
1253
+ getById(input: ScheduleExceptionsGetByIdInput, options?: NivaRequestOptions): NivaCall<ScheduleExceptionsGetByIdOutput, ScheduleExceptionsGetByIdErrorCode>;
1254
+ /**
1255
+ * scheduleExceptions.list operation.
1256
+ *
1257
+ * Returns a paginated list of the organization's exceptions: dates or periods that override the weekly hours and holidays, once or every year, closed or with their own intervals. Each lists the schedules it applies to.
1258
+ */
1259
+ list(input?: ScheduleExceptionsListInput, options?: NivaRequestOptions): NivaCall<ScheduleExceptionsListOutput, ScheduleExceptionsListErrorCode>;
1260
+ /**
1261
+ * scheduleExceptions.update operation.
1262
+ *
1263
+ * Partially updates the exception. `schedule_ids`, when sent, replaces the links (an empty list unlinks every schedule). Returns 404 SCHEDULE_EXCEPTION_NOT_FOUND when it does not exist and 404 SCHEDULE_NOT_FOUND for a schedule of another organization.
1264
+ */
1265
+ update(input: ScheduleExceptionsUpdateInput, options?: NivaRequestOptions): NivaCall<ScheduleExceptionsUpdateOutput, ScheduleExceptionsUpdateErrorCode>;
1266
+ };
772
1267
  schedules: {
1268
+ /**
1269
+ * schedules.calendar operation.
1270
+ *
1271
+ * Returns every day of `month` (YYYY-MM) classified as open, partial, closed, holiday or exception, with the effective open intervals and the holiday or exception name.
1272
+ */
1273
+ calendar(input: SchedulesCalendarInput, options?: NivaRequestOptions): NivaCall<SchedulesCalendarOutput, SchedulesCalendarErrorCode>;
1274
+ /**
1275
+ * schedules.clearEmergency operation.
1276
+ *
1277
+ * Ends the emergency closure and returns the updated schedule. Clearing a schedule that is not in emergency is a no-op. Returns 404 SCHEDULE_NOT_FOUND when it does not exist.
1278
+ */
1279
+ clearEmergency(input: SchedulesClearEmergencyInput, options?: NivaRequestOptions): NivaCall<SchedulesClearEmergencyOutput, SchedulesClearEmergencyErrorCode>;
773
1280
  /**
774
1281
  * schedules.create operation.
775
1282
  *
776
- * Creates a schedule from a set of time-based rules and optional holiday country calendars.
1283
+ * Creates a schedule from weekly time rules, an optional location and timezone, subscribed holiday calendars (catalog or own), the holiday types that close it and per-holiday overrides. Returns 400 INVALID_CATALOG_CODE for an unknown catalog code and 404 HOLIDAY_CALENDAR_NOT_FOUND for an own calendar of another organization.
777
1284
  */
778
1285
  create(input: SchedulesCreateInput, options?: NivaRequestOptions): NivaCall<SchedulesCreateOutput, SchedulesCreateErrorCode>;
779
1286
  /**
@@ -788,18 +1295,54 @@ export interface NivaClient {
788
1295
  * Returns the schedule, or `null` (HTTP 200) when it does not exist or belongs to another organization.
789
1296
  */
790
1297
  getById(input: SchedulesGetByIdInput, options?: NivaRequestOptions): NivaCall<SchedulesGetByIdOutput, SchedulesGetByIdErrorCode>;
1298
+ /**
1299
+ * schedules.holidays operation.
1300
+ *
1301
+ * Returns every holiday occurrence of the schedule's calendars between `from` and `to` with the effective mode (closed, reduced or open) and whether it comes from a per-holiday override.
1302
+ */
1303
+ holidays(input: SchedulesHolidaysInput, options?: NivaRequestOptions): NivaCall<SchedulesHolidaysOutput, SchedulesHolidaysErrorCode>;
791
1304
  /**
792
1305
  * schedules.list operation.
793
1306
  *
794
1307
  * Returns a paginated list of the organization's schedules (business-hours rule sets used to gate when plans answer).
795
1308
  */
796
1309
  list(input?: SchedulesListInput, options?: NivaRequestOptions): NivaCall<SchedulesListOutput, SchedulesListErrorCode>;
1310
+ /**
1311
+ * schedules.previewHolidays operation.
1312
+ *
1313
+ * Same listing as the schedule's holidays endpoint, for holiday_calendars, holiday_close_types and holiday_overrides that are not saved yet, evaluated in `timezone` (the schedule's own) or, when omitted, the organization timezone. Read-only: nothing is stored. Returns 404 HOLIDAY_CALENDAR_NOT_FOUND for an own calendar of another organization, 400 INVALID_CATALOG_CODE for an unknown catalog code and 400 INVALID_SCHEDULE_INPUT for a bad window.
1314
+ */
1315
+ previewHolidays(input: SchedulesPreviewHolidaysInput, options?: NivaRequestOptions): NivaCall<SchedulesPreviewHolidaysOutput, SchedulesPreviewHolidaysErrorCode>;
1316
+ /**
1317
+ * schedules.setEmergency operation.
1318
+ *
1319
+ * Starts an emergency closure: the schedule is closed from now until `until` (an ISO 8601 timestamp with offset) or, when omitted, until the closure is cleared. Returns the updated schedule. Returns 404 SCHEDULE_NOT_FOUND when it does not exist and 400 INVALID_SCHEDULE_INPUT when `until` is malformed or not in the future.
1320
+ */
1321
+ setEmergency(input: SchedulesSetEmergencyInput, options?: NivaRequestOptions): NivaCall<SchedulesSetEmergencyOutput, SchedulesSetEmergencyErrorCode>;
1322
+ /**
1323
+ * schedules.simulate operation.
1324
+ *
1325
+ * Evaluates the schedule at `at` and returns the status, the deciding layer, the evaluation chain (`steps`) and the Agenda node `output` that instant takes. Read-only: nothing is stored. Returns 400 INVALID_SCHEDULE_INPUT when `at` is not an ISO 8601 timestamp with offset.
1326
+ */
1327
+ simulate(input: SchedulesSimulateInput, options?: NivaRequestOptions): NivaCall<SchedulesSimulateOutput, SchedulesSimulateErrorCode>;
1328
+ /**
1329
+ * schedules.upcoming operation.
1330
+ *
1331
+ * Returns, across every schedule of the organization and in date order, the holidays that close or change the hours and the exceptions of the next `days` days.
1332
+ */
1333
+ upcoming(input?: SchedulesUpcomingInput, options?: NivaRequestOptions): NivaCall<SchedulesUpcomingOutput, SchedulesUpcomingErrorCode>;
797
1334
  /**
798
1335
  * schedules.update operation.
799
1336
  *
800
- * Partially updates a schedule. Returns 404 SCHEDULE_NOT_FOUND when it does not exist or belongs to another organization.
1337
+ * Partially updates a schedule. Returns 404 SCHEDULE_NOT_FOUND when it does not exist or belongs to another organization, 400 INVALID_CATALOG_CODE for an unknown catalog code and 404 HOLIDAY_CALENDAR_NOT_FOUND for an own calendar of another organization.
801
1338
  */
802
1339
  update(input: SchedulesUpdateInput, options?: NivaRequestOptions): NivaCall<SchedulesUpdateOutput, SchedulesUpdateErrorCode>;
1340
+ /**
1341
+ * schedules.usage operation.
1342
+ *
1343
+ * Returns the plans (directly or through an Agenda node of a draft or published version) and the channels that reference the schedule.
1344
+ */
1345
+ usage(input: SchedulesUsageInput, options?: NivaRequestOptions): NivaCall<SchedulesUsageOutput, SchedulesUsageErrorCode>;
803
1346
  };
804
1347
  secrets: {
805
1348
  /**
@@ -915,7 +1458,7 @@ export interface NivaClient {
915
1458
  /**
916
1459
  * users.listMembers operation.
917
1460
  *
918
- * Returns a paginated list of the organization's members, optionally filtered by membership `status`.
1461
+ * Returns a paginated list of the organization's members, optionally filtered by membership `status` and by `role_id`.
919
1462
  */
920
1463
  listMembers(input?: UsersListMembersInput, options?: NivaRequestOptions): NivaCall<UsersListMembersOutput, UsersListMembersErrorCode>;
921
1464
  /**
@@ -954,6 +1497,12 @@ export interface NivaClient {
954
1497
  * Resets the installation-wide password lockout. Does not change membership status.
955
1498
  */
956
1499
  unlockMember(input: UsersUnlockMemberInput, options?: NivaRequestOptions): NivaCall<UsersUnlockMemberOutput, UsersUnlockMemberErrorCode>;
1500
+ /**
1501
+ * users.updateMyDeskAlerts operation.
1502
+ *
1503
+ * Sets whether the calling user hears the Mesa's chime (`desk_alert_sound`) and is alerted to a customer's message while the Mesa is in the background (`desk_alert_customer_message`). A ringing call always rings. Only the fields sent change; at least one is required.
1504
+ */
1505
+ updateMyDeskAlerts(input?: UsersUpdateMyDeskAlertsInput, options?: NivaRequestOptions): NivaCall<UsersUpdateMyDeskAlertsOutput, UsersUpdateMyDeskAlertsErrorCode>;
957
1506
  /**
958
1507
  * users.updateMyNotificationEmail operation.
959
1508
  *
@@ -969,7 +1518,7 @@ export interface NivaClient {
969
1518
  /**
970
1519
  * users.updateRole operation.
971
1520
  *
972
- * Assigns a new role to a member. Returns 422 ROLE_SCOPE_MISMATCH when the role cannot be assigned in this organization context, 404 ROLE_NOT_FOUND when the role does not exist, and 404 MEMBER_NOT_FOUND when the member does not exist.
1521
+ * Assigns a new role to a member. Returns 409 CANNOT_MANAGE_OWN_ACCOUNT when the caller targets their own membership, 422 ROLE_SCOPE_MISMATCH when the role cannot be assigned in this organization context, 404 ROLE_NOT_FOUND when the role does not exist, and 404 MEMBER_NOT_FOUND when the member does not exist.
973
1522
  */
974
1523
  updateRole(input: UsersUpdateRoleInput, options?: NivaRequestOptions): NivaCall<UsersUpdateRoleOutput, UsersUpdateRoleErrorCode>;
975
1524
  };
@@ -1113,6 +1662,12 @@ export interface NivaClient {
1113
1662
  * Generates a new signing secret for the endpoint, invalidating the previous one, and returns the new plaintext secret (shown only in this response). An unknown id returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
1114
1663
  */
1115
1664
  rotateSecret(input: WebhooksEndpointsRotateSecretInput, options?: NivaRequestOptions): NivaCall<WebhooksEndpointsRotateSecretOutput, WebhooksEndpointsRotateSecretErrorCode>;
1665
+ /**
1666
+ * webhooks.endpoints.test operation.
1667
+ *
1668
+ * Synchronously sends one signed webhook.test delivery, even to an inactive endpoint, and records the outcome in the delivery log. Returns the delivery id, status, HTTP response status, request duration in milliseconds, and failure reason. Test deliveries are never automatically retried or subscribable. A missing, deleted, or cross-org endpoint returns 404 WEBHOOK_ENDPOINT_NOT_FOUND. Requires the webhook:update scope.
1669
+ */
1670
+ test(input: WebhooksEndpointsTestInput, options?: NivaRequestOptions): NivaCall<WebhooksEndpointsTestOutput, WebhooksEndpointsTestErrorCode>;
1116
1671
  /**
1117
1672
  * webhooks.endpoints.update operation.
1118
1673
  *