mirror of
https://github.com/btcpayserver/btcpayserver.git
synced 2025-02-23 22:46:49 +01:00
a4a1fa0746
* Rename filter to storeid for consistency with other filters * Greenfield: Add storeId to notification * Cleanups * Greenfield: Allow filtering notifications by store id
469 lines
18 KiB
JSON
469 lines
18 KiB
JSON
{
|
|
"paths": {
|
|
"/api/v1/users/me/notifications": {
|
|
"get": {
|
|
"tags": [
|
|
"Notifications (Current User)"
|
|
],
|
|
"summary": "Get notifications",
|
|
"parameters": [
|
|
{
|
|
"name": "seen",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "filter by seen notifications",
|
|
"schema": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Number of records to skip",
|
|
"schema": {
|
|
"nullable": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Number of records returned in response",
|
|
"schema": {
|
|
"nullable": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"name": "storeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Array of store ids to fetch the notifications for",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"example": "&storeId=ABCDE&storeId=FGHIJ"
|
|
}
|
|
],
|
|
"description": "View current user's notifications",
|
|
"operationId": "Notifications_GetNotifications",
|
|
"responses": {
|
|
"200": {
|
|
"description": "list of notifications",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NotificationData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"API_Key": [
|
|
"btcpay.user.canmanagenotificationsforuser",
|
|
"btcpay.user.canviewnotificationsforuser"
|
|
],
|
|
"Basic": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/api/v1/users/me/notifications/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Notifications (Current User)"
|
|
],
|
|
"summary": "Get notification",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "The notification to fetch",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"description": "View information about the specified notification",
|
|
"operationId": "Notifications_GetNotification",
|
|
"responses": {
|
|
"200": {
|
|
"description": "specified notification",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NotificationData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to view the specified notification"
|
|
},
|
|
"404": {
|
|
"description": "The key is not found for this notification"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"API_Key": [
|
|
"btcpay.user.canmanagenotificationsforuser",
|
|
"btcpay.user.canviewnotificationsforuser"
|
|
],
|
|
"Basic": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Notifications (Current User)"
|
|
],
|
|
"summary": "Update notification",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "The notification to update",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"description": "Updates the notification",
|
|
"operationId": "Notifications_UpdateNotification",
|
|
"responses": {
|
|
"200": {
|
|
"description": "updated notification",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NotificationData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to update the specified notification"
|
|
},
|
|
"404": {
|
|
"description": "The key is not found for this notification"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"API_Key": [
|
|
"btcpay.user.canmanagenotificationsforuser"
|
|
],
|
|
"Basic": []
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateNotification"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Notifications (Current User)"
|
|
],
|
|
"summary": "Remove Notification",
|
|
"description": "Removes the specified notification.",
|
|
"operationId": "Notifications_DeleteNotification",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "The notification to remove",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The notification has been deleted"
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to remove the specified notification"
|
|
},
|
|
"404": {
|
|
"description": "The key is not found for this notification"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"API_Key": [
|
|
"btcpay.user.canmanagenotificationsforuser"
|
|
],
|
|
"Basic": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/api/v1/users/me/notification-settings": {
|
|
"get": {
|
|
"tags": [
|
|
"Notifications (Current User)"
|
|
],
|
|
"summary": "Get notification settings",
|
|
"description": "View information about your notification settings",
|
|
"operationId": "Notifications_GetNotificationSettings",
|
|
"responses": {
|
|
"200": {
|
|
"description": "The current user's notification settings",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NotificationSettingsData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to view the notification settings"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"API_Key": [
|
|
"btcpay.user.canmanagenotificationsforuser"
|
|
],
|
|
"Basic": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Notifications (Current User)"
|
|
],
|
|
"summary": "Update notification settings",
|
|
"description": "Updates the current user's notification settings",
|
|
"operationId": "Notifications_UpdateNotification",
|
|
"responses": {
|
|
"200": {
|
|
"description": "The current user's notification settings",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NotificationSettingsData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to update the notification settings"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"API_Key": [
|
|
"btcpay.user.canmanagenotificationsforuser"
|
|
],
|
|
"Basic": []
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateNotificationSettingsRequest"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"UpdateNotification": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"seen": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"description": "Sets the notification as seen/unseen. If left null, sets it to the opposite value"
|
|
}
|
|
}
|
|
},
|
|
"NotificationData": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The id of the notification"
|
|
},
|
|
"identifier": {
|
|
"type": "string",
|
|
"description": "The identifier of the notification"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the notification"
|
|
},
|
|
"body": {
|
|
"type": "string",
|
|
"format": "html",
|
|
"description": "The html body of the notifications"
|
|
},
|
|
"storeId": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "If related to a store, the store id of the notification"
|
|
},
|
|
"link": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"nullable": true,
|
|
"description": "The link of the notification"
|
|
},
|
|
"createdTime": {
|
|
"description": "The creation time of the notification",
|
|
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
|
|
},
|
|
"seen": {
|
|
"type": "boolean",
|
|
"description": "If the notification has been seen by the user"
|
|
}
|
|
}
|
|
},
|
|
"UpdateNotificationSettingsRequest": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "List of the notification type identifiers, which should be disabled. Can also be a single item 'all'.",
|
|
"example": ["newversion", "pluginupdate"],
|
|
"nullable": false
|
|
}
|
|
}
|
|
},
|
|
"NotificationSettingsData": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"notifications": {
|
|
"type": "array",
|
|
"description": "The notification types",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationSettingsItemData"
|
|
}
|
|
}
|
|
},
|
|
"example": [
|
|
{
|
|
"identifier": "newversion",
|
|
"name": "New version",
|
|
"enabled": false
|
|
},
|
|
{
|
|
"identifier": "newuserrequiresapproval",
|
|
"name": "New user requires approval",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "inviteaccepted",
|
|
"name": "User accepted invitation",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "pluginupdate",
|
|
"name": "Plugin update",
|
|
"enabled": false
|
|
},
|
|
{
|
|
"identifier": "invoicestate",
|
|
"name": "All invoice updates",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "invoicestate_invoice_paidAfterExpiration",
|
|
"name": "Invoice was paid after expiration",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "invoicestate_invoice_expiredPaidPartial",
|
|
"name": "Invoice expired with partial payments",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "invoicestate_invoice_failedToConfirm",
|
|
"name": "Invoice has payments that failed to confirm on time",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "invoicestate_invoice_confirmed",
|
|
"name": "Invoice is settled",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "payout",
|
|
"name": "Payouts",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"identifier": "external-payout-transaction",
|
|
"name": "External payout approval",
|
|
"enabled": true
|
|
}
|
|
]
|
|
},
|
|
"NotificationSettingsItemData": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"description": "The identifier of the notification type",
|
|
"nullable": false
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The description of the notification type",
|
|
"nullable": false
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"description": "If the notification type is enabled",
|
|
"nullable": false
|
|
}
|
|
},
|
|
"example": {
|
|
"identifier": "newversion",
|
|
"name": "New version",
|
|
"enabled": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Notifications (Current User)",
|
|
"description": "Notifications operations"
|
|
}
|
|
]
|
|
}
|