{ "components": { "schemas": { "AcknowledgeAdvisoryRequest": { "additionalProperties": false, "properties": { "disposition": { "nullable": true, "type": "string" } }, "type": "object" }, "AcknowledgeRequest": { "additionalProperties": false, "properties": { "referenceNumber": { "nullable": true, "type": "string" } }, "type": "object" }, "ArmTrustedContactRequest": { "additionalProperties": false, "properties": { "contact": { "nullable": true, "type": "string" } }, "type": "object" }, "BulkRetryRequest": { "additionalProperties": false, "properties": { "ids": { "items": { "format": "uuid", "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "CardCaptureNoticeRequestDto": { "additionalProperties": false, "properties": { "reviewUrl": { "nullable": true, "type": "string" }, "subjectRecipientId": { "format": "uuid", "type": "string" } }, "type": "object" }, "CardCaptureNoticeResultDto": { "additionalProperties": false, "properties": { "dispatchedCount": { "format": "int32", "type": "integer" }, "statusMessage": { "nullable": true, "type": "string" } }, "type": "object" }, "CardCaptureOutcomeRequestDto": { "additionalProperties": false, "properties": { "capturerOutcomeUrl": { "nullable": true, "type": "string" }, "capturerRecipientId": { "format": "uuid", "type": "string" }, "released": { "type": "boolean" }, "subjectOutcomeUrl": { "nullable": true, "type": "string" } }, "type": "object" }, "ChannelPreferences": { "additionalProperties": false, "properties": { "email": { "type": "boolean" }, "inApp": { "type": "boolean" }, "push": { "type": "boolean" }, "sms": { "type": "boolean" }, "teams": { "type": "boolean" }, "whatsApp": { "type": "boolean" } }, "type": "object" }, "ChannelProviderConfigSummary": { "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/NotificationChannel" }, "circuitBreakerState": { "nullable": true, "type": "string" }, "id": { "format": "uuid", "type": "string" }, "instanceId": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "lastHealthCheckAt": { "format": "date-time", "nullable": true, "type": "string" }, "providerType": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "format": "int32", "type": "integer" }, "senderIdentity": { "nullable": true, "type": "string" } }, "type": "object" }, "ConsentRevocationBatchStatusDto": { "additionalProperties": false, "properties": { "deliveredCount": { "format": "int32", "type": "integer" }, "failedCount": { "format": "int32", "type": "integer" }, "queuedCount": { "format": "int32", "type": "integer" }, "recipientCount": { "format": "int32", "type": "integer" }, "recipients": { "items": { "$ref": "#/components/schemas/ConsentRevocationRecipientStatusDto" }, "nullable": true, "type": "array" }, "revocationBatchId": { "format": "uuid", "type": "string" } }, "type": "object" }, "ConsentRevocationRecipientStatusDto": { "additionalProperties": false, "properties": { "recipientId": { "format": "uuid", "type": "string" }, "status": { "nullable": true, "type": "string" } }, "type": "object" }, "ContactUpdatedDeliveryLine": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "createdAtIso": { "nullable": true, "type": "string" }, "deliveredAtIso": { "nullable": true, "type": "string" }, "disclosureLevel": { "nullable": true, "type": "string" }, "notificationId": { "format": "uuid", "type": "string" }, "openedAtIso": { "nullable": true, "type": "string" }, "sentAtIso": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" } }, "type": "object" }, "ContactUpdatedDeliveryRecord": { "additionalProperties": false, "properties": { "changedFieldLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "deliveries": { "items": { "$ref": "#/components/schemas/ContactUpdatedDeliveryLine" }, "nullable": true, "type": "array" }, "deliveryRecordId": { "format": "uuid", "type": "string" }, "occurredAtIso": { "nullable": true, "type": "string" }, "senderDisplayName": { "nullable": true, "type": "string" } }, "type": "object" }, "ContactUpdatedDispatchRequest": { "additionalProperties": false, "properties": { "changedFieldLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "instanceId": { "format": "uuid", "type": "string" }, "pushId": { "format": "uuid", "type": "string" }, "recipients": { "items": { "$ref": "#/components/schemas/ContactUpdatedRecipient" }, "nullable": true, "type": "array" }, "subjectDisplayName": { "nullable": true, "type": "string" }, "subjectUserId": { "format": "uuid", "type": "string" } }, "type": "object" }, "ContactUpdatedDispatchResult": { "additionalProperties": false, "properties": { "deliveryRecordId": { "format": "uuid", "type": "string" }, "dispatched": { "items": { "$ref": "#/components/schemas/ContactUpdatedDispatchedNotice" }, "nullable": true, "type": "array" }, "rejectedDetail": { "nullable": true, "type": "string" }, "skipped": { "items": { "$ref": "#/components/schemas/ContactUpdatedSkippedRecipient" }, "nullable": true, "type": "array" } }, "type": "object" }, "ContactUpdatedDispatchedNotice": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "disclosureLevel": { "nullable": true, "type": "string" }, "notificationId": { "format": "uuid", "type": "string" }, "recipientId": { "format": "uuid", "type": "string" } }, "type": "object" }, "ContactUpdatedFieldDiff": { "additionalProperties": false, "properties": { "granularity": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" }, "newValue": { "nullable": true, "type": "string" }, "previousValue": { "nullable": true, "type": "string" } }, "type": "object" }, "ContactUpdatedNoticeDetail": { "additionalProperties": false, "properties": { "deliveryRecordId": { "format": "uuid", "type": "string" }, "diff": { "items": { "$ref": "#/components/schemas/ContactUpdatedFieldDiff" }, "nullable": true, "type": "array" }, "disclosureLevel": { "nullable": true, "type": "string" }, "notificationId": { "format": "uuid", "type": "string" }, "occurredAtIso": { "nullable": true, "type": "string" }, "readAtIso": { "nullable": true, "type": "string" }, "senderDisplayName": { "nullable": true, "type": "string" } }, "type": "object" }, "ContactUpdatedRecipient": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "type": "string" } }, "type": "object" }, "ContactUpdatedSkippedRecipient": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "reason": { "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "type": "string" } }, "type": "object" }, "CreateAdvisoryRecipientDto": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "noActionNeeded": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "tenantImpactSummary": { "nullable": true, "type": "string" } }, "type": "object" }, "CreateOrgSubscriptionRequest": { "additionalProperties": false, "properties": { "moduleId": { "nullable": true, "type": "string" }, "organisationId": { "format": "uuid", "type": "string" }, "scope": { "nullable": true, "type": "string" } }, "type": "object" }, "CreateSecurityAdvisoryRequest": { "additionalProperties": false, "properties": { "exposureWindowEnd": { "format": "date-time", "type": "string" }, "exposureWindowStart": { "format": "date-time", "type": "string" }, "incidentReference": { "nullable": true, "type": "string" }, "recipients": { "items": { "$ref": "#/components/schemas/CreateAdvisoryRecipientDto" }, "nullable": true, "type": "array" }, "requiredActions": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "severity": { "nullable": true, "type": "string" }, "whatHappened": { "nullable": true, "type": "string" } }, "type": "object" }, "CreateTemplateRequest": { "additionalProperties": false, "properties": { "bodyTemplate": { "nullable": true, "type": "string" }, "channel": { "nullable": true, "type": "string" }, "contributingModule": { "nullable": true, "type": "string" }, "eventType": { "nullable": true, "type": "string" }, "language": { "nullable": true, "type": "string" }, "ownerOrgId": { "format": "uuid", "nullable": true, "type": "string" }, "privacyLevel": { "nullable": true, "type": "string" }, "subject": { "nullable": true, "type": "string" } }, "type": "object" }, "CredentialCompromiseNotificationDto": { "additionalProperties": false, "properties": { "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "compromiseReason": { "nullable": true, "type": "string" }, "correlationId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "instanceId": { "format": "uuid", "type": "string" }, "notifiedCount": { "format": "int32", "type": "integer" }, "parties": { "items": { "$ref": "#/components/schemas/RelyingPartyDeliveryDto" }, "nullable": true, "type": "array" }, "status": { "nullable": true, "type": "string" }, "subjectUserId": { "format": "uuid", "type": "string" }, "totalParties": { "format": "int32", "type": "integer" }, "unreachableCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "DecideGateRequest": { "additionalProperties": false, "properties": { "decision": { "nullable": true, "type": "string" }, "reason": { "nullable": true, "type": "string" } }, "type": "object" }, "DelegateAssistInvitationAcceptedDto": { "additionalProperties": false, "properties": { "expiresAt": { "format": "date-time", "type": "string" }, "status": { "nullable": true, "type": "string" } }, "type": "object" }, "DelegateAssistInvitationRequestDto": { "additionalProperties": false, "properties": { "eventType": { "nullable": true, "type": "string" }, "inviteeUserId": { "format": "uuid", "nullable": true, "type": "string" }, "inviterDisplayName": { "nullable": true, "type": "string" }, "recipient": { "nullable": true, "type": "string" }, "sessionId": { "nullable": true, "type": "string" } }, "type": "object" }, "DeliveryStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "format": "int32", "type": "integer" }, "DirectSendOutcome": { "additionalProperties": false, "properties": { "delivered": { "type": "boolean" }, "error": { "nullable": true, "type": "string" }, "externalMessageId": { "nullable": true, "type": "string" }, "notificationId": { "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/DeliveryStatus" } }, "type": "object" }, "EscalationDecisionDto": { "additionalProperties": false, "properties": { "channels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "escalationTarget": { "nullable": true, "type": "string" }, "graceEndsAt": { "format": "date-time", "type": "string" }, "missPosture": { "nullable": true, "type": "string" }, "reason": { "nullable": true, "type": "string" }, "verdict": { "nullable": true, "type": "string" } }, "type": "object" }, "EscalationDecisionRequest": { "additionalProperties": false, "properties": { "dueAt": { "format": "date-time", "nullable": true, "type": "string" }, "outcome": { "nullable": true, "type": "string" } }, "type": "object" }, "EscalationPolicyDto": { "additionalProperties": false, "properties": { "channelOrder": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "conditionId": { "nullable": true, "type": "string" }, "escalationTarget": { "nullable": true, "type": "string" }, "graceHours": { "format": "int32", "type": "integer" }, "missPosture": { "nullable": true, "type": "string" }, "reminderLeadHours": { "items": { "format": "int32", "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "InternalDirectSendRequest": { "additionalProperties": false, "properties": { "body": { "nullable": true, "type": "string" }, "channel": { "nullable": true, "type": "string" }, "correlationId": { "nullable": true, "type": "string" }, "data": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "emailAddress": { "nullable": true, "type": "string" }, "eventType": { "nullable": true, "type": "string" }, "instanceId": { "format": "uuid", "nullable": true, "type": "string" }, "orgId": { "format": "uuid", "nullable": true, "type": "string" }, "phoneNumber": { "nullable": true, "type": "string" }, "priority": { "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "type": "string" }, "sourceEpic": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" } }, "type": "object" }, "InternalSendRequest": { "additionalProperties": false, "properties": { "correlationId": { "nullable": true, "type": "string" }, "data": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "deliveryMode": { "nullable": true, "type": "string" }, "eventType": { "nullable": true, "type": "string" }, "instanceId": { "format": "uuid", "nullable": true, "type": "string" }, "orgId": { "format": "uuid", "nullable": true, "type": "string" }, "priority": { "nullable": true, "type": "string" }, "recipientId": { "format": "uuid", "nullable": true, "type": "string" }, "recipientIds": { "items": { "format": "uuid", "type": "string" }, "nullable": true, "type": "array" }, "recipientType": { "nullable": true, "type": "string" }, "segmentFilter": { "nullable": true, "type": "string" }, "sourceEpic": { "nullable": true, "type": "string" }, "templateOverrides": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" } }, "type": "object" }, "MuteSenderRequest": { "additionalProperties": false, "properties": { "moduleId": { "nullable": true, "type": "string" }, "muteType": { "nullable": true, "type": "string" }, "muteUntil": { "format": "date-time", "nullable": true, "type": "string" }, "organisationId": { "format": "uuid", "nullable": true, "type": "string" } }, "type": "object" }, "NameChangeBroadcastPreviewDto": { "additionalProperties": false, "properties": { "changeId": { "format": "uuid", "type": "string" }, "notifiedCount": { "format": "int32", "type": "integer" }, "withheld": { "items": { "$ref": "#/components/schemas/WithheldContactDto" }, "nullable": true, "type": "array" }, "withheldCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "NameChangeBroadcastResultDto": { "additionalProperties": false, "properties": { "broadcastId": { "format": "uuid", "type": "string" }, "notifiedCount": { "format": "int32", "type": "integer" }, "withheldCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "NameChangeUndoResultDto": { "additionalProperties": false, "properties": { "broadcastId": { "format": "uuid", "type": "string" }, "retracted": { "type": "boolean" }, "suppressedCount": { "format": "int32", "type": "integer" }, "windowExpired": { "type": "boolean" } }, "type": "object" }, "NonSuppressibleCategoryDto": { "additionalProperties": false, "properties": { "code": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "lawfulBasis": { "nullable": true, "type": "string" }, "reason": { "nullable": true, "type": "string" }, "sourceEpic": { "nullable": true, "type": "string" } }, "type": "object" }, "NonSuppressibleRegisterDto": { "additionalProperties": false, "properties": { "categories": { "items": { "$ref": "#/components/schemas/NonSuppressibleCategoryDto" }, "nullable": true, "type": "array" }, "version": { "nullable": true, "type": "string" } }, "type": "object" }, "NotificationChannel": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "format": "int32", "type": "integer" }, "OrgBroadcastRequest": { "additionalProperties": false, "properties": { "data": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "deliveryMode": { "nullable": true, "type": "string" }, "eventType": { "nullable": true, "type": "string" }, "instanceId": { "format": "uuid", "type": "string" }, "recipientIds": { "items": { "format": "uuid", "type": "string" }, "nullable": true, "type": "array" }, "segmentFilter": { "nullable": true, "type": "string" } }, "type": "object" }, "PerTypePreferenceRow": { "additionalProperties": false, "properties": { "email": { "type": "boolean" }, "eventType": { "nullable": true, "type": "string" }, "inApp": { "type": "boolean" }, "push": { "type": "boolean" }, "sms": { "type": "boolean" }, "teams": { "type": "boolean" }, "whatsApp": { "type": "boolean" } }, "type": "object" }, "PortfolioTransferRecipientServiceDto": { "additionalProperties": false, "properties": { "acknowledgedAt": { "format": "date-time", "nullable": true, "type": "string" }, "channels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "lastFailedAt": { "format": "date-time", "nullable": true, "type": "string" }, "letterEscalationRequired": { "type": "boolean" }, "recipientId": { "format": "uuid", "type": "string" }, "servedAt": { "format": "date-time", "nullable": true, "type": "string" }, "statutoryServiceStatus": { "nullable": true, "type": "string" } }, "type": "object" }, "PortfolioTransferServiceEvidenceDto": { "additionalProperties": false, "properties": { "acknowledged": { "format": "int32", "type": "integer" }, "asOfUtc": { "format": "date-time", "type": "string" }, "attemptedUndelivered": { "format": "int32", "type": "integer" }, "corporateEventId": { "format": "uuid", "type": "string" }, "letterEscalationRequired": { "format": "int32", "type": "integer" }, "notYetServed": { "format": "int32", "type": "integer" }, "policyholdersInBook": { "format": "int32", "nullable": true, "type": "integer" }, "recipientLines": { "items": { "$ref": "#/components/schemas/PortfolioTransferRecipientServiceDto" }, "nullable": true, "type": "array" }, "recipients": { "format": "int32", "type": "integer" }, "reconciles": { "nullable": true, "type": "boolean" }, "reconciliationNote": { "nullable": true, "type": "string" }, "served": { "format": "int32", "type": "integer" } }, "type": "object" }, "PreviewRequest": { "additionalProperties": false, "properties": { "sampleData": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" } }, "type": "object" }, "PrivacyModeRequest": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "ProblemDetails": { "additionalProperties": {}, "properties": { "detail": { "nullable": true, "type": "string" }, "instance": { "nullable": true, "type": "string" }, "status": { "format": "int32", "nullable": true, "type": "integer" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" }, "PutSafeguardingScopeRequest": { "additionalProperties": false, "properties": { "safeChannels": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "ReadAllRequest": { "additionalProperties": false, "properties": { "before": { "format": "date-time", "nullable": true, "type": "string" }, "instance": { "format": "uuid", "nullable": true, "type": "string" }, "module": { "nullable": true, "type": "string" } }, "type": "object" }, "ReattestationRemindRequestDto": { "additionalProperties": false, "properties": { "pendingPartyRefs": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "ReattestationRemindResponseDto": { "additionalProperties": false, "properties": { "broadcastId": { "format": "uuid", "type": "string" }, "remindedAt": { "format": "date-time", "type": "string" }, "remindedCount": { "format": "int32", "type": "integer" }, "targetedPartyCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "ReengagementOptOutRequestDto": { "additionalProperties": false, "properties": { "token": { "nullable": true, "type": "string" } }, "type": "object" }, "ReengagementPreferenceDto": { "additionalProperties": false, "properties": { "status": { "nullable": true, "type": "string" }, "suppressedUntil": { "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" }, "ReengagementSnoozeRequestDto": { "additionalProperties": false, "properties": { "days": { "format": "int32", "nullable": true, "type": "integer" }, "token": { "nullable": true, "type": "string" } }, "type": "object" }, "RegisterDeviceRequestDto": { "additionalProperties": false, "properties": { "deviceFingerprint": { "nullable": true, "type": "string" }, "deviceName": { "nullable": true, "type": "string" }, "deviceType": { "nullable": true, "type": "string" }, "platform": { "nullable": true, "type": "string" }, "pushPlatform": { "nullable": true, "type": "string" }, "pushToken": { "nullable": true, "type": "string" } }, "type": "object" }, "RegisterInstitutionalEndpointRequest": { "additionalProperties": false, "properties": { "ackWindowHours": { "format": "int32", "nullable": true, "type": "integer" }, "apiKey": { "nullable": true, "type": "string" }, "deliveryMethod": { "nullable": true, "type": "string" }, "emailAddress": { "nullable": true, "type": "string" }, "institutionName": { "nullable": true, "type": "string" }, "requiresConfirmationGate": { "items": { "type": "boolean" }, "nullable": true, "type": "array" }, "subscribedEventTypes": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "webhookSecret": { "nullable": true, "type": "string" }, "webhookUrl": { "nullable": true, "type": "string" } }, "type": "object" }, "RelyingPartyDeliveryDto": { "additionalProperties": false, "properties": { "displayName": { "nullable": true, "type": "string" }, "failureReason": { "nullable": true, "type": "string" }, "fallback": { "nullable": true, "type": "string" }, "notifiedAt": { "format": "date-time", "nullable": true, "type": "string" }, "relyingPartyId": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" } }, "type": "object" }, "SafeguardingScopeDto": { "additionalProperties": false, "properties": { "consentGrantId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "criticalNoticesReach": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "safeChannels": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "SafeguardingScopeListDto": { "additionalProperties": false, "properties": { "scopes": { "items": { "$ref": "#/components/schemas/SafeguardingScopeDto" }, "nullable": true, "type": "array" } }, "type": "object" }, "SecurityAdvisoryDto": { "additionalProperties": false, "properties": { "composedByOperator": { "nullable": true, "type": "string" }, "exposureWindowEnd": { "format": "date-time", "type": "string" }, "exposureWindowStart": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incidentReference": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "recipients": { "items": { "$ref": "#/components/schemas/SecurityAdvisoryRecipientDto" }, "nullable": true, "type": "array" }, "requiredActions": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "sentAt": { "format": "date-time", "nullable": true, "type": "string" }, "severity": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "whatHappened": { "nullable": true, "type": "string" } }, "type": "object" }, "SecurityAdvisoryRecipientDto": { "additionalProperties": false, "properties": { "ackActor": { "nullable": true, "type": "string" }, "ackDisposition": { "nullable": true, "type": "string" }, "acknowledgedAt": { "format": "date-time", "nullable": true, "type": "string" }, "channel": { "nullable": true, "type": "string" }, "deliveredAt": { "format": "date-time", "nullable": true, "type": "string" }, "noActionNeeded": { "type": "boolean" }, "organizationId": { "format": "uuid", "type": "string" }, "sentAt": { "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" }, "SetCrossInstanceConsentRequest": { "additionalProperties": false, "properties": { "granted": { "type": "boolean" } }, "type": "object" }, "SetDigestFloorRequest": { "additionalProperties": false, "properties": { "mandatoryPrivacyFloor": { "nullable": true, "type": "string" } }, "type": "object" }, "SharedContactAcceptanceRequestDto": { "additionalProperties": false, "properties": { "manageShareUrl": { "nullable": true, "type": "string" }, "organisationName": { "nullable": true, "type": "string" }, "purposeLabel": { "nullable": true, "type": "string" }, "recipientEmail": { "nullable": true, "type": "string" }, "sharedFieldLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "SharedContactConsentResultDto": { "additionalProperties": false, "properties": { "dispatchedCount": { "format": "int32", "type": "integer" }, "statusMessage": { "nullable": true, "type": "string" } }, "type": "object" }, "SharedContactInvitationRequestDto": { "additionalProperties": false, "properties": { "acceptUrl": { "nullable": true, "type": "string" }, "designatorDisplayName": { "nullable": true, "type": "string" }, "expiryDays": { "format": "int32", "type": "integer" }, "organisationName": { "nullable": true, "type": "string" }, "privacyNoticeUrl": { "nullable": true, "type": "string" }, "purposeLabel": { "nullable": true, "type": "string" }, "recipientEmail": { "nullable": true, "type": "string" }, "requestedFieldLabels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "retentionSummary": { "nullable": true, "type": "string" }, "tokenReference": { "nullable": true, "type": "string" } }, "type": "object" }, "SharedContactRevocationRequestDto": { "additionalProperties": false, "properties": { "addAnotherUrl": { "nullable": true, "type": "string" }, "designatorDisplayName": { "nullable": true, "type": "string" }, "designatorRecipientId": { "format": "uuid", "type": "string" }, "recipientEmail": { "nullable": true, "type": "string" } }, "type": "object" }, "StatutoryServiceAttemptDto": { "additionalProperties": false, "properties": { "attemptId": { "format": "uuid", "type": "string" }, "attemptedAt": { "format": "date-time", "type": "string" }, "channel": { "nullable": true, "type": "string" }, "citation": { "nullable": true, "type": "string" }, "documentId": { "format": "uuid", "type": "string" }, "evidenced": { "type": "boolean" }, "failureReason": { "nullable": true, "type": "string" }, "notificationId": { "format": "uuid", "nullable": true, "type": "string" }, "outcome": { "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "receiptRef": { "nullable": true, "type": "string" }, "recipientUserId": { "format": "uuid", "type": "string" }, "retainUntil": { "format": "date-time", "type": "string" }, "serviceDueBy": { "format": "date-time", "type": "string" } }, "type": "object" }, "StatutoryServiceAttemptRequest": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "citation": { "nullable": true, "type": "string" }, "documentId": { "format": "uuid", "type": "string" }, "failureReason": { "nullable": true, "type": "string" }, "propertyId": { "format": "uuid", "nullable": true, "type": "string" }, "receiptRef": { "nullable": true, "type": "string" }, "recipientEmail": { "nullable": true, "type": "string" }, "recipientUserId": { "format": "uuid", "type": "string" }, "serviceDueBy": { "format": "date-time", "type": "string" } }, "type": "object" }, "StatutoryServiceAttemptResultDto": { "additionalProperties": false, "properties": { "attempt": { "$ref": "#/components/schemas/StatutoryServiceAttemptDto" }, "service": { "$ref": "#/components/schemas/StatutoryServiceEvidenceDto" } }, "type": "object" }, "StatutoryServiceEvidenceDto": { "additionalProperties": false, "properties": { "attempts": { "items": { "$ref": "#/components/schemas/StatutoryServiceAttemptDto" }, "nullable": true, "type": "array" }, "escalationNote": { "nullable": true, "type": "string" }, "evidencedByAttemptId": { "format": "uuid", "nullable": true, "type": "string" }, "nextChannel": { "nullable": true, "type": "string" }, "servedAt": { "format": "date-time", "nullable": true, "type": "string" }, "serviceDueBy": { "format": "date-time", "nullable": true, "type": "string" }, "serviceId": { "format": "uuid", "type": "string" }, "statutoryServiceStatus": { "nullable": true, "type": "string" }, "withinStatutoryWindow": { "nullable": true, "type": "boolean" } }, "type": "object" }, "TemplateGovernanceRequest": { "additionalProperties": false, "properties": { "reviewNotes": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" } }, "type": "object" }, "TemplateTestSendRequest": { "additionalProperties": false, "properties": { "channel": { "nullable": true, "type": "string" }, "recipientUserId": { "format": "uuid", "type": "string" }, "sampleData": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" } }, "type": "object" }, "TenantSecurityAdvisoryDto": { "additionalProperties": false, "properties": { "accessibleContent": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "ackDisposition": { "nullable": true, "type": "string" }, "acknowledgedAt": { "format": "date-time", "nullable": true, "type": "string" }, "exposureWindowEnd": { "format": "date-time", "type": "string" }, "exposureWindowStart": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "incidentReference": { "nullable": true, "type": "string" }, "noActionNeeded": { "type": "boolean" }, "requiredActions": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "sentAt": { "format": "date-time", "nullable": true, "type": "string" }, "severity": { "nullable": true, "type": "string" }, "tenantImpactSummary": { "nullable": true, "type": "string" }, "whatHappened": { "nullable": true, "type": "string" } }, "type": "object" }, "TrustedContactArmResponse": { "additionalProperties": false, "properties": { "acceptUrl": { "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" }, "withdrawUrl": { "nullable": true, "type": "string" } }, "type": "object" }, "TrustedContactConsentStatusResponse": { "additionalProperties": false, "properties": { "changed": { "type": "boolean" }, "lifecycle": { "nullable": true, "type": "string" }, "maskedContact": { "nullable": true, "type": "string" }, "since": { "format": "date-time", "type": "string" } }, "type": "object" }, "UpdateCategoryGovernanceRequest": { "additionalProperties": false, "properties": { "categoryAggregationOptIn": { "additionalProperties": { "type": "boolean" }, "nullable": true, "type": "object" }, "categoryPrivacyFloors": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "instanceId": { "format": "uuid", "type": "string" } }, "type": "object" }, "UpdateChannelProviderBody": { "additionalProperties": false, "properties": { "config": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" }, "isActive": { "nullable": true, "type": "boolean" }, "providerType": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "format": "int32", "nullable": true, "type": "integer" }, "senderIdentity": { "nullable": true, "type": "string" } }, "type": "object" }, "UpdateDigestRequest": { "additionalProperties": false, "properties": { "deliveryEmail": { "nullable": true, "type": "string" }, "deliveryTime": { "nullable": true, "type": "string" }, "mode": { "nullable": true, "type": "string" }, "privacyMode": { "nullable": true, "type": "boolean" }, "timeZone": { "nullable": true, "type": "string" } }, "type": "object" }, "UpdateInstitutionalEndpointRequest": { "additionalProperties": false, "properties": { "isActive": { "nullable": true, "type": "boolean" }, "requiresConfirmationGate": { "items": { "type": "boolean" }, "nullable": true, "type": "array" }, "subscribedEventTypes": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "UpdateOrgSettingsRequest": { "additionalProperties": false, "properties": { "broadcastEnabled": { "nullable": true, "type": "boolean" }, "broadcastRatePerSecond": { "format": "int32", "nullable": true, "type": "integer" }, "instanceId": { "format": "uuid", "type": "string" }, "mandatoryChannels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "mandatoryEventTypes": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "mandatoryPrivacyFloor": { "nullable": true, "type": "string" }, "segmentEnabled": { "nullable": true, "type": "boolean" } }, "type": "object" }, "UpdatePreferenceRequest": { "additionalProperties": false, "properties": { "channels": { "$ref": "#/components/schemas/ChannelPreferences" }, "eventType": { "nullable": true, "type": "string" }, "perType": { "items": { "$ref": "#/components/schemas/PerTypePreferenceRow" }, "nullable": true, "type": "array" } }, "type": "object" }, "UpdateQuietHoursRequest": { "additionalProperties": false, "properties": { "channels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "enabled": { "nullable": true, "type": "boolean" }, "end": { "nullable": true, "type": "string" }, "start": { "nullable": true, "type": "string" }, "timeZone": { "nullable": true, "type": "string" } }, "type": "object" }, "UpdateReattestationCadenceRequest": { "additionalProperties": false, "properties": { "channels": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "instanceId": { "format": "uuid", "type": "string" }, "leadTimeDays": { "format": "int32", "nullable": true, "type": "integer" }, "repeatEveryDays": { "format": "int32", "nullable": true, "type": "integer" } }, "type": "object" }, "UpdateTemplateRequest": { "additionalProperties": false, "properties": { "actions": { "nullable": true, "type": "string" }, "bodyTemplate": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "subject": { "nullable": true, "type": "string" }, "variablesSchema": { "nullable": true, "type": "string" } }, "type": "object" }, "UpsertChannelProviderConfigBody": { "additionalProperties": false, "properties": { "providerType": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "format": "int32", "nullable": true, "type": "integer" }, "senderIdentity": { "nullable": true, "type": "string" }, "settings": { "additionalProperties": { "type": "string" }, "nullable": true, "type": "object" } }, "type": "object" }, "VerifiedChangeBroadcastResultDto": { "additionalProperties": false, "properties": { "broadcastId": { "format": "uuid", "type": "string" }, "contentHash": { "nullable": true, "type": "string" }, "deliveryRecordId": { "format": "uuid", "type": "string" }, "excludedRevokedCount": { "format": "int32", "type": "integer" }, "networkResolved": { "type": "boolean" }, "reachedCount": { "format": "int32", "type": "integer" }, "reconciliationId": { "format": "uuid", "nullable": true, "type": "string" }, "refusalCode": { "nullable": true, "type": "string" }, "sent": { "type": "boolean" }, "skippedCount": { "format": "int32", "type": "integer" }, "statusMessage": { "nullable": true, "type": "string" } }, "type": "object" }, "VerifiedChangeDeliveryRecordDto": { "additionalProperties": false, "properties": { "broadcastId": { "format": "uuid", "type": "string" }, "changeId": { "format": "uuid", "type": "string" }, "completedAt": { "format": "date-time", "type": "string" }, "contentHash": { "nullable": true, "type": "string" }, "deliveryRecordId": { "format": "uuid", "type": "string" }, "excludedRevoked": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "excludedRevokedCount": { "format": "int32", "type": "integer" }, "integrityVerified": { "type": "boolean" }, "reached": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "reachedCount": { "format": "int32", "type": "integer" }, "reconciliationId": { "format": "uuid", "nullable": true, "type": "string" }, "retracted": { "type": "boolean" }, "retractedAt": { "format": "date-time", "nullable": true, "type": "string" }, "signatureRef": { "nullable": true, "type": "string" }, "skipped": { "items": { "$ref": "#/components/schemas/VerifiedChangeSkippedDto" }, "nullable": true, "type": "array" }, "skippedCount": { "format": "int32", "type": "integer" }, "statusMessage": { "nullable": true, "type": "string" } }, "type": "object" }, "VerifiedChangeSkippedDto": { "additionalProperties": false, "properties": { "contactRef": { "nullable": true, "type": "string" }, "reasonCode": { "nullable": true, "type": "string" } }, "type": "object" }, "VerifiedChangeUndoResultDto": { "additionalProperties": false, "properties": { "broadcastId": { "format": "uuid", "type": "string" }, "retracted": { "type": "boolean" }, "statusMessage": { "nullable": true, "type": "string" }, "suppressedCount": { "format": "int32", "type": "integer" }, "windowExpired": { "type": "boolean" } }, "type": "object" }, "WhatsAppOptOutRequest": { "additionalProperties": false, "properties": { "token": { "nullable": true, "type": "string" } }, "type": "object" }, "WithheldContactDto": { "additionalProperties": false, "properties": { "contactRef": { "nullable": true, "type": "string" }, "reasonCode": { "nullable": true, "type": "string" } }, "type": "object" } } }, "info": { "description": "EPIC 66: Centralised notification & messaging engine", "title": "Essence Notification Service API", "version": "v1" }, "openapi": "3.0.1", "paths": { "/api/v1/admin/notifications/confirmation-gates/pending": { "get": { "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "ConfirmationGates" ] } }, "/api/v1/admin/notifications/confirmation-gates/{id}": { "patch": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideGateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DecideGateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideGateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "ConfirmationGates" ] } }, "/api/v1/admin/notifications/dashboard": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "AdminDashboard" ] } }, "/api/v1/admin/notifications/dlq": { "get": { "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "AdminDashboard" ] } }, "/api/v1/admin/notifications/dlq/bulk-retry": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkRetryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkRetryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkRetryRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "AdminDeadLetterBulkRetry" ] } }, "/api/v1/admin/notifications/dlq/{id}": { "delete": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "AdminDashboard" ] } }, "/api/v1/admin/notifications/dlq/{id}/retry": { "post": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "AdminDashboard" ] } }, "/api/v1/admin/notifications/instances/{instanceId}/providers": { "get": { "parameters": [ { "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" }, "type": "array" } }, "text/json": { "schema": { "items": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" }, "type": "array" } }, "text/plain": { "schema": { "items": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" }, "type": "array" } } }, "description": "Success" } }, "tags": [ "AdminChannelProviderConfig" ] } }, "/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}": { "get": { "parameters": [ { "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "channel", "required": true, "schema": { "$ref": "#/components/schemas/NotificationChannel" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "AdminChannelProviderConfig" ] }, "put": { "parameters": [ { "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "channel", "required": true, "schema": { "$ref": "#/components/schemas/NotificationChannel" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertChannelProviderConfigBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpsertChannelProviderConfigBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertChannelProviderConfigBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } } }, "description": "Success" } }, "tags": [ "AdminChannelProviderConfig" ] } }, "/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}/activate": { "post": { "parameters": [ { "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "channel", "required": true, "schema": { "$ref": "#/components/schemas/NotificationChannel" }, "style": "simple" } ], "responses": { "204": { "description": "No Content" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "AdminChannelProviderConfig" ] } }, "/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}/deactivate": { "post": { "parameters": [ { "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "channel", "required": true, "schema": { "$ref": "#/components/schemas/NotificationChannel" }, "style": "simple" } ], "responses": { "204": { "description": "No Content" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "AdminChannelProviderConfig" ] } }, "/api/v1/admin/notifications/providers": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "AdminChannelProviders" ] } }, "/api/v1/admin/notifications/providers/{id}": { "put": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateChannelProviderBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChannelProviderBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateChannelProviderBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelProviderConfigSummary" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "AdminChannelProviders" ] } }, "/api/v1/admin/notifications/templates": { "get": { "parameters": [ { "in": "query", "name": "governanceStatus", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "channel", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "language", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Templates" ] }, "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Templates" ] } }, "/api/v1/admin/notifications/templates/{id}": { "put": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Templates" ] } }, "/api/v1/admin/notifications/templates/{id}/governance": { "patch": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateGovernanceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateGovernanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateGovernanceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Templates" ] } }, "/api/v1/admin/notifications/templates/{id}/preview": { "post": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Templates" ] } }, "/api/v1/admin/notifications/templates/{id}/test": { "post": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateTestSendRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateTestSendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateTestSendRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Templates" ] } }, "/api/v1/contact-cards/{cardId}/reattestation/remind": { "post": { "parameters": [ { "in": "path", "name": "cardId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindResponseDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ReattestationRemindResponseDto" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "ReattestationReminder" ] } }, "/api/v1/credential-compromise-notifications": { "get": { "parameters": [ { "in": "query", "name": "correlationId", "schema": { "format": "uuid", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialCompromiseNotificationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialCompromiseNotificationDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CredentialCompromiseNotificationDto" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "CredentialCompromise" ] } }, "/api/v1/credential-compromise-notifications/{id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialCompromiseNotificationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialCompromiseNotificationDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CredentialCompromiseNotificationDto" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "CredentialCompromise" ] } }, "/api/v1/erasure-probe/{subjectId}": { "get": { "operationId": "EssenceErasureProbe", "parameters": [ { "in": "path", "name": "subjectId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Erasure" ] } }, "/api/v1/institutional/notifications/pending": { "get": { "parameters": [ { "in": "query", "name": "eventType", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "since", "schema": { "format": "date-time", "type": "string" }, "style": "form" }, { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 50, "format": "int32", "type": "integer" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalPull" ] } }, "/api/v1/institutional/notifications/{id}/acknowledge": { "post": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/AcknowledgeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalPull" ] } }, "/api/v1/internal/notifications/direct-send": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/InternalDirectSendRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InternalDirectSendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InternalDirectSendRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectSendOutcome" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DirectSendOutcome" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DirectSendOutcome" } } }, "description": "Success" } }, "tags": [ "InternalSend" ] } }, "/api/v1/internal/notifications/send": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/InternalSendRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InternalSendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InternalSendRequest" } } } }, "responses": { "202": { "description": "Accepted" } }, "tags": [ "InternalSend" ] } }, "/api/v1/notifications": { "get": { "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "instance", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "module", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Inbox" ] } }, "/api/v1/notifications/card-capture/{captureId}/notice": { "post": { "parameters": [ { "in": "path", "name": "captureId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeRequestDto" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeResultDto" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "CardCaptureNotice" ] } }, "/api/v1/notifications/card-capture/{captureId}/outcome": { "post": { "parameters": [ { "in": "path", "name": "captureId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/CardCaptureOutcomeRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CardCaptureOutcomeRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardCaptureOutcomeRequestDto" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CardCaptureNoticeResultDto" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "CardCaptureNotice" ] } }, "/api/v1/notifications/consent-revocations/{revocationBatchId}/status": { "get": { "parameters": [ { "in": "path", "name": "revocationBatchId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentRevocationBatchStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentRevocationBatchStatusDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentRevocationBatchStatusDto" } } }, "description": "Success" } }, "tags": [ "ConsentRevocations" ] } }, "/api/v1/notifications/contact-card/reattestation/{broadcastId}/remind": { "post": { "parameters": [ { "in": "path", "name": "broadcastId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindRequestDto" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReattestationRemindResponseDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ReattestationRemindResponseDto" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "NotificationsReattestationRemind" ] } }, "/api/v1/notifications/contact-updated": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedDispatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedDispatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedDispatchRequest" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedDispatchResult" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" } }, "tags": [ "ContactUpdatedNoticeDispatch" ] } }, "/api/v1/notifications/contact-updated/delivery-record/{deliveryRecordId}": { "get": { "parameters": [ { "in": "path", "name": "deliveryRecordId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedDeliveryRecord" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "ContactUpdatedNotice" ] } }, "/api/v1/notifications/contact-updated/delivery-record/{deliveryRecordId}/export": { "get": { "parameters": [ { "in": "path", "name": "deliveryRecordId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "ContactUpdatedNotice" ] } }, "/api/v1/notifications/contact-updated/{notificationId}": { "get": { "parameters": [ { "in": "path", "name": "notificationId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedNoticeDetail" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "ContactUpdatedNotice" ] } }, "/api/v1/notifications/cross-instance/consent": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "CrossInstanceAggregation" ] }, "put": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/SetCrossInstanceConsentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetCrossInstanceConsentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetCrossInstanceConsentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "CrossInstanceAggregation" ] } }, "/api/v1/notifications/cross-instance/delivery-log": { "get": { "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "CrossInstanceAggregation" ] } }, "/api/v1/notifications/cross-instance/delivery-log/export": { "get": { "parameters": [ { "in": "query", "name": "maxRows", "schema": { "default": 5000, "format": "int32", "type": "integer" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "CrossInstanceAggregation" ] } }, "/api/v1/notifications/devices": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "Devices" ] }, "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterDeviceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegisterDeviceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterDeviceRequestDto" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Devices" ] } }, "/api/v1/notifications/devices/{id}": { "delete": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Devices" ] } }, "/api/v1/notifications/escalation-policies/{obligationRef}": { "get": { "parameters": [ { "in": "path", "name": "obligationRef", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } } }, "description": "Success" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "ObligationEscalationPolicies" ] }, "put": { "parameters": [ { "in": "path", "name": "obligationRef", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/EscalationPolicyDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Client Error" } }, "tags": [ "ObligationEscalationPolicies" ] } }, "/api/v1/notifications/escalation-policies/{obligationRef}/decisions": { "post": { "parameters": [ { "in": "path", "name": "obligationRef", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/EscalationDecisionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EscalationDecisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EscalationDecisionRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EscalationDecisionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EscalationDecisionDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/EscalationDecisionDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "ObligationEscalationPolicies" ] } }, "/api/v1/notifications/inbox": { "get": { "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "status", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "instance", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "module", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Inbox" ] } }, "/api/v1/notifications/invitations/delegate-assist": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/DelegateAssistInvitationRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DelegateAssistInvitationRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelegateAssistInvitationRequestDto" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelegateAssistInvitationAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DelegateAssistInvitationAcceptedDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DelegateAssistInvitationAcceptedDto" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Client Error" } }, "tags": [ "Invitations" ] } }, "/api/v1/notifications/marketing/unsubscribe": { "get": { "parameters": [ { "in": "query", "name": "token", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "503": { "description": "Server Error" } }, "tags": [ "MarketingUnsubscribe" ] }, "post": { "parameters": [ { "in": "query", "name": "token", "schema": { "type": "string" }, "style": "form" } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "503": { "description": "Server Error" } }, "tags": [ "MarketingUnsubscribe" ] } }, "/api/v1/notifications/marketing/whatsapp-optout": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/WhatsAppOptOutRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WhatsAppOptOutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WhatsAppOptOutRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "503": { "description": "Server Error" } }, "tags": [ "MarketingUnsubscribe" ] } }, "/api/v1/notifications/muted-senders": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "MutedSenders" ] }, "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/MuteSenderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MuteSenderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MuteSenderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "MutedSenders" ] } }, "/api/v1/notifications/muted-senders/{id}": { "delete": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "MutedSenders" ] } }, "/api/v1/notifications/name-change/broadcast/{broadcastId}/undo": { "post": { "parameters": [ { "in": "path", "name": "broadcastId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameChangeUndoResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NameChangeUndoResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/NameChangeUndoResultDto" } } }, "description": "Success" } }, "tags": [ "NameChangeBroadcast" ] } }, "/api/v1/notifications/name-change/{changeId}/broadcast": { "post": { "parameters": [ { "in": "path", "name": "changeId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameChangeBroadcastResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NameChangeBroadcastResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/NameChangeBroadcastResultDto" } } }, "description": "Accepted" } }, "tags": [ "NameChangeBroadcast" ] } }, "/api/v1/notifications/name-change/{changeId}/broadcast/preview": { "get": { "parameters": [ { "in": "path", "name": "changeId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameChangeBroadcastPreviewDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NameChangeBroadcastPreviewDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/NameChangeBroadcastPreviewDto" } } }, "description": "Success" } }, "tags": [ "NameChangeBroadcast" ] } }, "/api/v1/notifications/non-suppressible-register": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonSuppressibleRegisterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NonSuppressibleRegisterDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/NonSuppressibleRegisterDto" } } }, "description": "Success" } }, "tags": [ "NonSuppressibleRegister" ] } }, "/api/v1/notifications/org-subscriptions": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "OrgSubscriptions" ] }, "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrgSubscriptionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrgSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrgSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "OrgSubscriptions" ] } }, "/api/v1/notifications/org-subscriptions/by-org/{orgId}": { "delete": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "query", "name": "moduleId", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgSubscriptions" ] } }, "/api/v1/notifications/org-subscriptions/{id}": { "delete": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgSubscriptions" ] } }, "/api/v1/notifications/portfolio-transfers/{corporateEventId}/evidence-of-service": { "get": { "parameters": [ { "in": "path", "name": "corporateEventId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "query", "name": "policyholdersInBook", "schema": { "format": "int32", "type": "integer" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioTransferServiceEvidenceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PortfolioTransferServiceEvidenceDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PortfolioTransferServiceEvidenceDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" } }, "tags": [ "PortfolioTransferServiceEvidence" ] } }, "/api/v1/notifications/preferences": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "Preferences" ] }, "put": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Preferences" ] } }, "/api/v1/notifications/preferences/digest": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "Preferences" ] }, "put": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDigestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDigestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDigestRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Preferences" ] } }, "/api/v1/notifications/preferences/privacy-mode": { "put": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/PrivacyModeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyModeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivacyModeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Preferences" ] } }, "/api/v1/notifications/preferences/quiet-hours": { "get": { "responses": { "200": { "description": "Success" } }, "tags": [ "QuietHours" ] }, "put": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateQuietHoursRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateQuietHoursRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateQuietHoursRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "QuietHours" ] } }, "/api/v1/notifications/read-all": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ReadAllRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadAllRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadAllRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "Inbox" ] } }, "/api/v1/notifications/reengagement/opt-out": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ReengagementOptOutRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReengagementOptOutRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReengagementOptOutRequestDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "503": { "description": "Server Error" } }, "tags": [ "Reengagement" ] } }, "/api/v1/notifications/reengagement/preference": { "get": { "parameters": [ { "in": "query", "name": "token", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReengagementPreferenceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReengagementPreferenceDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ReengagementPreferenceDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "503": { "description": "Server Error" } }, "tags": [ "Reengagement" ] } }, "/api/v1/notifications/reengagement/snooze": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ReengagementSnoozeRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReengagementSnoozeRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReengagementSnoozeRequestDto" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReengagementPreferenceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReengagementPreferenceDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ReengagementPreferenceDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "503": { "description": "Server Error" } }, "tags": [ "Reengagement" ] } }, "/api/v1/notifications/safeguarding-scopes": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeListDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeListDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeListDto" } } }, "description": "Success" } }, "tags": [ "SafeguardingScopes" ] } }, "/api/v1/notifications/safeguarding-scopes/{consentGrantId}": { "delete": { "parameters": [ { "in": "path", "name": "consentGrantId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "SafeguardingScopes" ] }, "get": { "parameters": [ { "in": "path", "name": "consentGrantId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeDto" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "SafeguardingScopes" ] }, "put": { "parameters": [ { "in": "path", "name": "consentGrantId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/PutSafeguardingScopeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PutSafeguardingScopeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PutSafeguardingScopeRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SafeguardingScopeDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Client Error" } }, "tags": [ "SafeguardingScopes" ] } }, "/api/v1/notifications/security-advisories": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" }, "type": "array" } }, "text/json": { "schema": { "items": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" }, "type": "array" } }, "text/plain": { "schema": { "items": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" } }, "tags": [ "SecurityAdvisoryInbox" ] } }, "/api/v1/notifications/security-advisories/{advisoryId}": { "get": { "parameters": [ { "in": "path", "name": "advisoryId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "SecurityAdvisoryInbox" ] } }, "/api/v1/notifications/security-advisories/{advisoryId}/acknowledge": { "post": { "parameters": [ { "in": "path", "name": "advisoryId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAdvisoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAdvisoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeAdvisoryRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TenantSecurityAdvisoryDto" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "SecurityAdvisoryInbox" ] } }, "/api/v1/notifications/shared-contact-consent/{designationId}/acceptance": { "post": { "parameters": [ { "in": "path", "name": "designationId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/SharedContactAcceptanceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SharedContactAcceptanceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharedContactAcceptanceRequestDto" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "SharedContactConsent" ] } }, "/api/v1/notifications/shared-contact-consent/{designationId}/invitation": { "post": { "parameters": [ { "in": "path", "name": "designationId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/SharedContactInvitationRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SharedContactInvitationRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharedContactInvitationRequestDto" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "SharedContactConsent" ] } }, "/api/v1/notifications/shared-contact-consent/{designationId}/revocation": { "post": { "parameters": [ { "in": "path", "name": "designationId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/SharedContactRevocationRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SharedContactRevocationRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharedContactRevocationRequestDto" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SharedContactConsentResultDto" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "SharedContactConsent" ] } }, "/api/v1/notifications/statutory-services/{serviceId}": { "get": { "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceEvidenceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceEvidenceDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StatutoryServiceEvidenceDto" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "StatutoryServices" ] } }, "/api/v1/notifications/statutory-services/{serviceId}/attempts": { "post": { "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceAttemptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceAttemptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceAttemptRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceAttemptResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatutoryServiceAttemptResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StatutoryServiceAttemptResultDto" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Client Error" } }, "tags": [ "StatutoryServices" ] } }, "/api/v1/notifications/trusted-contact-consent": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "TrustedContactConsent" ] } }, "/api/v1/notifications/trusted-contact-consent/arm": { "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ArmTrustedContactRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ArmTrustedContactRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArmTrustedContactRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustedContactArmResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrustedContactArmResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TrustedContactArmResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" } }, "tags": [ "TrustedContactConsent" ] } }, "/api/v1/notifications/trusted-contact-consent/reinvite": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } } }, "description": "Success" } }, "tags": [ "TrustedContactConsent" ] } }, "/api/v1/notifications/trusted-contact-consent/respond": { "post": { "parameters": [ { "in": "query", "name": "user", "schema": { "format": "uuid", "type": "string" }, "style": "form" }, { "in": "query", "name": "action", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "exp", "schema": { "format": "int64", "type": "integer" }, "style": "form" }, { "in": "query", "name": "sig", "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "TrustedContactConsent" ] } }, "/api/v1/notifications/trusted-contact-consent/revoke": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TrustedContactConsentStatusResponse" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "TrustedContactConsent" ] } }, "/api/v1/notifications/verified-change/broadcast/{broadcastId}/undo": { "post": { "parameters": [ { "in": "path", "name": "broadcastId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeUndoResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeUndoResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/VerifiedChangeUndoResultDto" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "VerifiedChangeBroadcast" ] } }, "/api/v1/notifications/verified-change/delivery-record/{id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeDeliveryRecordDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeDeliveryRecordDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/VerifiedChangeDeliveryRecordDto" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "VerifiedChangeBroadcast" ] } }, "/api/v1/notifications/verified-change/delivery-record/{id}/export": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "VerifiedChangeBroadcast" ] } }, "/api/v1/notifications/verified-change/{changeId}/broadcast": { "post": { "parameters": [ { "in": "path", "name": "changeId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "query", "name": "signatureRef", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "reconciliationId", "schema": { "format": "uuid", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeBroadcastResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeBroadcastResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/VerifiedChangeBroadcastResultDto" } } }, "description": "Success" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeBroadcastResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifiedChangeBroadcastResultDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/VerifiedChangeBroadcastResultDto" } } }, "description": "Accepted" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "VerifiedChangeBroadcast" ] } }, "/api/v1/notifications/{id}": { "delete": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Inbox" ] } }, "/api/v1/notifications/{id}/read": { "patch": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Inbox" ] } }, "/api/v1/notifications/{id}/unread": { "patch": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "Inbox" ] } }, "/api/v1/org/{orgId}/notifications/broadcast": { "post": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/OrgBroadcastRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrgBroadcastRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrgBroadcastRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/org/{orgId}/notifications/broadcasts/{broadcastId}": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "broadcastId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/org/{orgId}/notifications/category-governance": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] }, "put": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryGovernanceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryGovernanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryGovernanceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/org/{orgId}/notifications/digest-floor": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] }, "put": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/SetDigestFloorRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetDigestFloorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetDigestFloorRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/org/{orgId}/notifications/history": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "pageSize", "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "in": "query", "name": "channel", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "eventType", "schema": { "type": "string" }, "style": "form" }, { "in": "query", "name": "userId", "schema": { "format": "uuid", "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/org/{orgId}/notifications/institutional/endpoints": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalEndpoints" ] }, "post": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterInstitutionalEndpointRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegisterInstitutionalEndpointRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterInstitutionalEndpointRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalEndpoints" ] } }, "/api/v1/org/{orgId}/notifications/institutional/endpoints/{id}": { "delete": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalEndpoints" ] }, "put": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInstitutionalEndpointRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInstitutionalEndpointRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInstitutionalEndpointRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalEndpoints" ] } }, "/api/v1/org/{orgId}/notifications/institutional/endpoints/{id}/test": { "post": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "InstitutionalEndpoints" ] } }, "/api/v1/org/{orgId}/notifications/reattestation-cadence": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] }, "put": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReattestationCadenceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReattestationCadenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReattestationCadenceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/org/{orgId}/notifications/settings": { "get": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] }, "put": { "parameters": [ { "in": "path", "name": "orgId", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrgSettingsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrgSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrgSettingsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "tags": [ "OrgNotifications" ] } }, "/api/v1/security-advisories": { "get": { "parameters": [ { "in": "query", "name": "status", "schema": { "default": "draft", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SecurityAdvisoryDto" }, "type": "array" } }, "text/json": { "schema": { "items": { "$ref": "#/components/schemas/SecurityAdvisoryDto" }, "type": "array" } }, "text/plain": { "schema": { "items": { "$ref": "#/components/schemas/SecurityAdvisoryDto" }, "type": "array" } } }, "description": "Success" } }, "tags": [ "SecurityAdvisories" ] }, "post": { "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSecurityAdvisoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSecurityAdvisoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSecurityAdvisoryRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" } }, "tags": [ "SecurityAdvisories" ] } }, "/api/v1/security-advisories/{id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" } }, "tags": [ "SecurityAdvisories" ] } }, "/api/v1/security-advisories/{id}/send": { "post": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SecurityAdvisoryDto" } } }, "description": "Success" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" } }, "tags": [ "SecurityAdvisories" ] } }, "/api/v1/webhooks/notifications/providers/{provider}/delivery-status": { "post": { "parameters": [ { "in": "path", "name": "provider", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" } }, "tags": [ "ProviderWebhook" ] } } } }