2.0info: 10.5.0 Notificações description: Serviço de notificações x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: notifications contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /notifications/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getSubscriptions: post: description: Returns all subscriptions for an specific user tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: limit: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – subscriptions properties: subscriptions: type: array items: type: object allOf: – #/definitions/subscriptionRecord minimum: 1 description: Subscriptions List 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns all subscriptions for an specific user tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: in: query type: integer format: int64 – name: limit description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – subscriptions properties: subscriptions: type: array items: type: object allOf: – #/definitions/subscriptionRecord minimum: 1 description: Subscriptions List 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getNotifications: post: description: Returns all notifications for an specific user tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página a ser retornada. A primeira página corresponde ao índice 0. limit: type: integer format: int64 description: Quantidade de registros por página. archived: type: boolean description: Indicador se deve retornar apenas notificações arquivadas. default: false service: type: string description: O nome do serviço. Utilizado para filtrar as notificações. responses: 200: description: Ok schema: type: object required: – listInformation properties: notifications: type: array items: type: object allOf: – #/definitions/notificationRecord description: Lista das notificações. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns all notifications for an specific user tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página a ser retornada. A primeira página corresponde ao índice 0. in: query type: integer format: int64 – name: limit description: Quantidade de registros por página. in: query type: integer format: int64 – name: archived description: Indicador se deve retornar apenas notificações arquivadas. in: query type: boolean – name: service description: O nome do serviço. Utilizado para filtrar as notificações. in: query type: string responses: 200: description: Ok schema: type: object required: – listInformation properties: notifications: type: array items: type: object allOf: – #/definitions/notificationRecord description: Lista das notificações. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getNotificationById: post: description: Retorna uma notificação específica para um usuário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationId properties: notificationId: type: string description: Identificador da notificação. responses: 200: description: Ok schema: type: object required: – notification properties: notification: type: object allOf: – #/definitions/notificationRecord description: Dados da notificação. 401: description: Invalid Credentials 404: description: A notificação não existe ou não está disponível. default: description: Error response schema: #/definitions/genericError get: description: Retorna uma notificação específica para um usuário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: notificationId description: Identificador da notificação. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – notification properties: notification: type: object allOf: – #/definitions/notificationRecord description: Dados da notificação. 401: description: Invalid Credentials 404: description: A notificação não existe ou não está disponível. default: description: Error response schema: #/definitions/genericError /notifications/queries/getUnreadNotifications: post: description: Returns all unread notifications for an specific user tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página a ser retornada. A primeira página corresponde ao índice 0. limit: type: integer format: int64 description: Quantidade de registros por página. archived: type: boolean description: Indicador se deve retornar apenas notificações arquivadas. default: false responses: 200: description: Ok schema: type: object required: – listInformation properties: notifications: type: array items: type: object allOf: – #/definitions/notificationRecord description: Lista das notificações. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns all unread notifications for an specific user tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página a ser retornada. A primeira página corresponde ao índice 0. in: query type: integer format: int64 – name: limit description: Quantidade de registros por página. in: query type: integer format: int64 – name: archived description: Indicador se deve retornar apenas notificações arquivadas. in: query type: boolean responses: 200: description: Ok schema: type: object required: – listInformation properties: notifications: type: array items: type: object allOf: – #/definitions/notificationRecord description: Lista das notificações. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getUnreadNotificationsCount: post: description: Returns the total of unread notifications for an user tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: The total of unread notifications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the total of unread notifications for an user tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: The total of unread notifications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getBlockConfig: post: description: Returns the blocks configuration tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – config properties: config: type: array items: type: object allOf: – #/definitions/blockConfigDef minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the blocks configuration tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – config properties: config: type: array items: type: object allOf: – #/definitions/blockConfigDef minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/searchNotifications: post: description: Faz uma busca textual em notificações pelos campos de assunto e conteúdo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – term properties: term: type: string description: Termo de busca. unread: type: boolean description: Indicador se deve buscar somente por notificações não lidas. default: false includeArchived: type: boolean description: Indicador se deve incluir notificações arquivadas na busca. default: false pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Se não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – listInformation properties: notifications: type: array items: type: object allOf: – #/definitions/notificationRecord description: Lista das notificações encontradas. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/listNotificationMediaTypes: post: description: Lista as classes de notificação e seus tipos de mídia configurados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: O número da página a ser retornada. A primeira página corresponde ao índice 0. limit: type: integer format: int64 description: Quantidade de registros por página. responses: 200: description: Ok schema: type: object required: – listInformation properties: classes: type: array items: type: object allOf: – #/definitions/notificationMediaTypeConfig description: Lista com as classes de notificação e seus tipos de mídia configurados. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as classes de notificação e seus tipos de mídia configurados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: O número da página a ser retornada. A primeira página corresponde ao índice 0. in: query type: integer format: int64 – name: limit description: Quantidade de registros por página. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listInformation properties: classes: type: array items: type: object allOf: – #/definitions/notificationMediaTypeConfig description: Lista com as classes de notificação e seus tipos de mídia configurados. listInformation: type: object allOf: – #/definitions/listInformation description: As informações sobre os resultados de listagem realizada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/testEmailConfiguration: post: description: Testar as configurações de e-mail, conectando no servidor SMTP configurado e enviando um e-mail de teste tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – toEmailAddress properties: toEmailAddress: type: string description: Destinatário do e-mail de teste responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicativo se o e-mail foi enviado com sucesso – notar que não indica se a mensagem foi recebida ou não pelo destinatário message: type: string description: A mensagem de erro, quando o e-mail não foi enviado com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/subscribeToApplication: post: description: Subscribes to an application tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – applicationID – deviceToken – devicePlatform properties: applicationID: type: string description: Apple/Google application ID. deviceToken: type: string description: Device token. devicePlatform: type: string allOf: – #/definitions/platform description: Device platform responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/unsubscribeFromApplication: post: description: Unsubscribes from an application tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – applicationID – deviceToken properties: applicationID: type: string description: Apple/Google application ID. deviceToken: type: string description: Device token. responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/notifyUser: post: description: Envia uma notificação para um usuário, sem realizar validação se o usuário existe. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/notificationPayload responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/notifyUser__2: post: description: Envia uma notificação para um ou mais usuários, validando se os mesmos existem. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/baseNotificationPayload responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se passou pelas validações de envio da notificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/batchNotify: post: description: Sends several notifications tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notifications properties: notifications: type: array items: type: object allOf: – #/definitions/notificationPayload minimum: 1 description: Notifications responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/toggleNotificationsBlockForUser: post: description: Blocks/unblocks the notifications of the type for the specified user. He/her will not receive this type of notifications from now on. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationKind – block properties: notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. If empty, all notifications of this kind will be block/unblock block: type: boolean description: Block status to be set responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/removeAllBlocksForUser: post: description: Remove all the notifications blocks for an user tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/toggleNotificationRead: post: description: Indicates that a notification was read or not tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationId – read properties: notificationId: type: string description: Notification id, in UUID format read: type: boolean description: Status responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/toggleAllNotificationsRead: post: description: Toggle all notifications as read/unread for an user tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – read properties: read: type: boolean description: Status responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/clearOldNotifications: post: description: Remove old notifications. For internal use only. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/archiveNotifications: post: description: Archives the notifications and move them to a history place tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationIDs properties: notificationIDs: type: array items: type: string minimum: 1 description: Notification ids, in UUID format responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/toggleNotifications: post: description: Toggle a list of notifications as read/unread tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notificationIds – read properties: notificationIds: type: array items: type: string minimum: 1 description: List of noitification ids, in UUID format read: type: boolean description: Status responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/configureMediaTypes: post: description: Configures media types to be used to send notifications. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mediaTypeConfigs properties: mediaTypeConfigs: type: array items: type: object allOf: – #/definitions/notificationMediaTypeConfig minimum: 1 description: Media type configurations. responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/notifyUserByEmail: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – to – subject – content properties: from: type: string description: E-mail sender. If not informed, will use the value of smtp.sender property to: type: array items: type: string minimum: 1 description: Additional recipients to send the e-mail to cc: type: array items: type: string description: Recipients to receive a carbon copy bcc: type: array items: type: string description: Recipients to receive a blind carbon copy format: type: string allOf: – #/definitions/emailFormat description: Format of the e-mail message, default is PLAIN_TEXT subject: type: string description: Notification subject content: type: string description: Notification content responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/configureFirebaseServiceAccountKey: post: description: Configure an Firebase Application Service Account Private Key tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceAccount properties: serviceAccount: type: object allOf: – #/definitions/serviceAccountRecord description: The Service Account JSON domain: type: string description: Domain that generates the notification service: type: string description: Service that generates the notification responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/actions/removeFirebaseServiceAccountKey: post: description: Removes an Firebase Application Service Account Private Key tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – applicationID properties: applicationID: type: string description: Apple/Google application ID. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /notifications/signals/notifyTenant: post: description: Send a news notification to one, many or all tenants. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – subject – content properties: subject: type: string description: Subject of notification content: type: string description: Content of notification allTenants: type: boolean description: Send the notification to all tenants administrators in role admin of each tenant default: false destinationTenants: type: array items: type: object allOf: – #/definitions/destinationTenant description: Send notifications to specific tenants when the allTenants param is false,\n when the allTenant is true, the destinationTenants is ignored link: type: string description: Notification link. isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string format: date-time description: Expiration date of the notification severity: type: string allOf: – #/definitions/severity description: Severity of the notification responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /notifications/signals/notifyRoles: post: description: Send a news notification to users on roles. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – subject – content – destinationRoles – sourceDomain – sourceService – notificationPriority – notificationOrigin properties: subject: type: string description: Subject of notification content: type: string description: Content of notification destinationRoles: type: array items: type: string minimum: 1 description: User roles link: type: string description: Notification link. isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string format: date-time description: Expiration date of the notification severity: type: string allOf: – #/definitions/severity description: Severity of the notification sourceDomain: type: string description: Domain that generates the notification sourceService: type: string description: Service that generates the notification notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority notificationClass: type: string description: Class of notification. Identifies the context of the notification/group of notifications. notificationOrigin: type: string description: Origin of notification. Free text. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /notifications/events/userNotified: post: description: Fired when an user receives a notification. It applies only for simple notifications, not for those distributed via specialized means (e.g. e-mail, push). x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/notificationRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN platform: description: Platforms type: string enum: – ANDROID – IOS severity: description: Severity of the notification type: string enum: – INFO – ERROR – WARNING – SUCCESS emailFormat: description: type: string enum: – HTML – PLAIN_TEXT pushNotificationPriority: description: type: string enum: – HIGH – NORMAL notificationMediaType: description: Media type. type: string enum: – NONE – PLATFORM – EMAIL – PUSH userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente subscriptionRecord: description: Represents a subscription type: object required: – applicationID – deviceToken – user – devicePlatform properties: applicationID: type: string description: Apple/Google application ID. deviceToken: type: string description: Device token. user: type: string description: User name. devicePlatform: type: string allOf: – #/definitions/platform description: Device platform notificationRecord: description: Represents a notification type: object required: – notificationID – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – creationDate – read – readDate properties: notificationID: type: string description: Notification id, in UUID format notificationClass: type: string description: Class of notification. notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority notificationSubject: type: string description: Notification subject notificationContent: type: string description: Notification content sourceDomain: type: string description: Domain that generates the notification sourceService: type: string description: Service that generates the notification destinationUser: type: string description: name of the destination user creationDate: type: string format: date-time description: Notification creation date read: type: boolean description: Flag indicating if the notification was already read readDate: type: string format: date-time description: Read date. Null if the notification wasnt read yet link: type: string description: Notification link. archived: type: boolean description: Flag indicating if the notification was archived default: false isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string format: date-time description: Expiration date of the notification severity: type: string allOf: – #/definitions/severity description: Severity of the notification baseNotificationPayload: description: Represents a notification discriminator: _discriminator type: object required: – notificationOrigin – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – _discriminator properties: notificationClass: type: string description: Class of notification. Identifies the context of the notification/group of notifications.\n ATTENTION: THIS FIELD WILL BECOME REQUIRED AS OF AUGUST 2019. notificationOrigin: type: string description: Origin of notification. Free text. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority notificationSubject: type: string description: Notification subject notificationContent: type: string description: Notification content sourceDomain: type: string description: Domain that generates the notification sourceService: type: string description: Service that generates the notification destinationUsers: type: array items: type: string description: Names of the destination users link: type: string description: Notification link. isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string format: date-time description: Expiration date of the notification severity: type: string allOf: – #/definitions/severity description: Severity of the notification _discriminator: type: string description: notificationPayload: description: Represents a notification allOf: – #/definitions/baseNotificationPayload – type: object properties: destinationUser: type: string description: Name of the destination user pushNotificationPayload: description: Represents a push notification allOf: – #/definitions/notificationPayload – type: object required: – applicationId – priority properties: applicationId: type: string description: Apple/Google application ID sound: type: string description: The sound to be played when the device receives the notification priority: type: string allOf: – #/definitions/pushNotificationPriority description: Defines the priority of the notification emailNotificationPayload: description: Represents an e-mail notification. The e-mail of each user in the destionationUsers field will be used, along with any additional recipient defined in this payload. allOf: – #/definitions/notificationPayload – type: object properties: from: type: string description: E-mail sender. If not informed, will use the value of smtp.sender property to: type: array items: type: string description: Additional recipients to send the e-mail to cc: type: array items: type: string description: Recipients to receive a carbon copy bcc: type: array items: type: string description: Recipients to receive a blind carbon copy format: type: string allOf: – #/definitions/emailFormat description: Format of the e-mail message, default is PLAIN_TEXT destinationTenant: description: Represents a tenant notification type: object required: – tenant properties: tenant: type: string description: Tenant name role: type: string description: Role name group: type: string description: Group name user: type: string description: Username blockConfigDef: description: Represents a block configuration type: object required: – id – notificationKind – active – priorities properties: id: type: string description: notificationKind: type: string allOf: – #/definitions/userNotificationKind description: active: type: boolean description: priorities: type: array items: type: object allOf: – #/definitions/blockPriorityDef minimum: 1 description: blockPriorityDef: description: type: object required: – id – notificationPriority – active properties: id: type: string description: notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: active: type: boolean description: notificationClassInfo: description: Information about a notification class. type: object required: – domain – service – notificationClass – origin – kind – priority – mediaType – subject – content – creationDate properties: user: type: string description: User that generates the notification domain: type: string description: Domain that generates the notification service: type: string description: Service that generates the notification notificationClass: type: string description: Class of notification. origin: type: string description: Origin of notification. kind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind priority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority mediaType: type: string allOf: – #/definitions/notificationMediaType description: Notification media type. subject: type: string description: Notification subject content: type: string description: Notification content creationDate: type: string format: date-time description: Notification creation date link: type: string description: Notification link. isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string format: date-time description: Expiration date of the notification severity: type: string allOf: – #/definitions/severity description: Severity of the notification notificationMediaTypeConfig: description: Media type configuration type: object required: – notificationClass properties: notificationClass: type: object allOf: – #/definitions/notificationClassInfo description: Class of notification. mediaTypes: type: array items: type: string allOf: – #/definitions/notificationMediaType description: Configured media types. listInformation: description: As informações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados. totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas. pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página a ser retornada. A primeira página corresponde ao índice 0. default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página. default: 10 serviceAccountRecord: description: The Service Account JSON of Firebase Application type: object required: – type – project_id – private_key_id – private_key – client_email – client_id – auth_uri – token_uri – auth_provider_x509_cert_url – client_x509_cert_url – universe_domain properties: type: type: string description: project_id: type: string description: private_key_id: type: string description: private_key: type: string description: client_email: type: string description: client_id: type: string description: auth_uri: type: string description: token_uri: type: string description: auth_provider_x509_cert_url: type: string description: client_x509_cert_url: type: string description: universe_domain: type: string description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE