chore(docs): Generated API Reference (#3718)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
51d0b88404
commit
70435d5631
95
docs/api/admin/paths/admin_notifications.yaml
Normal file
95
docs/api/admin/paths/admin_notifications.yaml
Normal file
@@ -0,0 +1,95 @@
|
||||
get:
|
||||
operationId: GetNotifications
|
||||
summary: List Notifications
|
||||
description: Retrieves a list of Notifications.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: offset
|
||||
description: >-
|
||||
The number of notifications to skip before starting to collect the
|
||||
notifications set
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: limit
|
||||
description: The number of notifications to return
|
||||
schema:
|
||||
type: integer
|
||||
default: 50
|
||||
- in: query
|
||||
name: fields
|
||||
description: Comma separated fields to include in the result set
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: Comma separated fields to populate
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: event_name
|
||||
description: The name of the event that the notification was sent for.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: resource_type
|
||||
description: The type of resource that the Notification refers to.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: resource_id
|
||||
description: The ID of the resource that the Notification refers to.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: to
|
||||
description: >-
|
||||
The address that the Notification was sent to. This will usually be an
|
||||
email address, but represent other addresses such as a chat bot user id
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: include_resends
|
||||
description: >-
|
||||
A boolean indicating whether the result set should include resent
|
||||
notifications or not
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetNotificationsParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_notifications/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_notifications/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Notifications
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminNotificationsListRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
Reference in New Issue
Block a user