@nocobase/plugin-notification-manager 2.2.0-alpha.1 → 2.2.0-alpha.3

package/dist/swagger/index.d.ts

@@ -0,0 +1,542 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+declare const _default: {
+    openapi: string;
+    info: {
+        title: string;
+    };
+    paths: {
+        '/notificationChannels:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        oneOf: ({
+                            type: string;
+                            items?: undefined;
+                        } | {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        })[];
+                        type?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        oneOf?: undefined;
+                    };
+                    description?: undefined;
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/notificationChannels:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/notificationChannels:create': {
+            post: {
+                tags: string[];
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/notificationChannels:update': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/notificationChannels:destroy': {
+            post: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/notificationSendLogs:list': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        oneOf: ({
+                            type: string;
+                            items?: undefined;
+                        } | {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        })[];
+                        type?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        oneOf?: undefined;
+                    };
+                    description?: undefined;
+                })[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/notificationSendLogs:get': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    description: string;
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/messages:send': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        schemas: {
+            NotificationChannel: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                    notificationType: {
+                        type: string;
+                        description: string;
+                    };
+                    options: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    meta: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    createdAt: {
+                        type: string;
+                        format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            NotificationChannelInput: {
+                type: string;
+                required: string[];
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                    notificationType: {
+                        type: string;
+                    };
+                    options: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    meta: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            NotificationChannelResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+            };
+            NotificationChannelListResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    meta: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                };
+            };
+            NotificationSendLog: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                        format: string;
+                    };
+                    channelName: {
+                        type: string;
+                    };
+                    channelTitle: {
+                        type: string;
+                    };
+                    triggerFrom: {
+                        type: string;
+                    };
+                    notificationType: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                        enum: string[];
+                    };
+                    message: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    reason: {
+                        type: string;
+                    };
+                    createdAt: {
+                        type: string;
+                        format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            NotificationSendLogResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+            };
+            NotificationSendLogListResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    meta: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                };
+            };
+            NotificationReceivers: {
+                oneOf: ({
+                    type: string;
+                    required: string[];
+                    properties: {
+                        type: {
+                            type: string;
+                            enum: string[];
+                        };
+                        value: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                        channelType?: undefined;
+                    };
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        type: {
+                            type: string;
+                            enum: string[];
+                        };
+                        channelType: {
+                            type: string;
+                        };
+                        value: {
+                            type?: undefined;
+                            items?: undefined;
+                        };
+                    };
+                })[];
+            };
+            NotificationSendRequest: {
+                type: string;
+                required: string[];
+                properties: {
+                    channelName: {
+                        type: string;
+                        description: string;
+                    };
+                    message: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                    receivers: {
+                        $ref: string;
+                    };
+                    triggerFrom: {
+                        type: string;
+                        example: string;
+                    };
+                    data: {
+                        type: string;
+                        additionalProperties: boolean;
+                    };
+                };
+            };
+            NotificationSendResult: {
+                type: string;
+                properties: {
+                    status: {
+                        type: string;
+                        enum: string[];
+                    };
+                    reason: {
+                        type: string;
+                    };
+                    triggerFrom: {
+                        type: string;
+                    };
+                    channelName: {
+                        type: string;
+                    };
+                    receivers: {
+                        $ref: string;
+                    };
+                    queued: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            NotificationSendResponse: {
+                type: string;
+                properties: {
+                    data: {
+                        $ref: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;