backend/source/api/actions/invite_read.ts

/*
Espe | Ein schlichtes Werkzeug zur Mitglieder-Verwaltung | Backend
Copyright (C) 2024 Christian Fraß

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public 
License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later 
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see 
<https://www.gnu.org/licenses/>. 
 */

namespace _espe.api
{
	
	/**
	 */
	export function register_invite_read(
		rest_subject : lib_plankton.rest_http.type_rest
	) : void
	{
		lib_plankton.rest_http.register<
			int,
			(
				string
				|
				{
					key : string;
					expiry : (null | int);
					membership_number_changeable : boolean;
					membership_number_value : (null | string);
					name_changeable : boolean;
					name_value : string;
					email_address_changeable : boolean;
					email_address_value : (null | string);
					groups_changeable : boolean;
					groups_value : Array<string>;
				}
			)
		>(
			rest_subject,
			lib_plankton.http.enum_method.get,
			_espe.api.full_path("/invite/read"),
			{
				/**
				 * @todo translation
				 */
				"description": () => "gibt die Daten einer Einladung anhand ihrer ID aus",
				"query_parameters": () => [
					{
						"name": "id",
						"required": true,
						"description": "id",
					}
				],
				"output_schema": () => ({
					"type": "object",
					"nullable": false,
					"additionalProperties": false,
					"properties": {
						"expiry": {
							"nullable": true,
							"type": "integer",
							"description": "Ablaufzeitpunkt"
						},
						"membership_number_changeable": {
							"type": "boolean",
							"nullable": false,
							"description": "Mitgliedsnummer | änderbar"
						},
						"membership_number_value": {
							"type": "string",
							"nullable": true,
							"description": "Mitgliedsnummer | Wert"
						},
						"name_changeable": {
							"type": "boolean",
							"nullable": false,
							"description": "Name | änderbar"
						},
						"name_value": {
							"type": "string",
							"nullable": true,
							"description": "Name | Wert"
						},
						"email_address_changeable": {
							"type": "boolean",
							"nullable": false,
							"description": "E-Mail-Adresse | änderbar"
						},
						"email_address_value": {
							"type": "string",
							"nullable": true,
							"description": "E-Mail-Adresse | Wert"
						},
						"groups_changeable": {
							"type": "boolean",
							"nullable": false,
							"description": "Gruppen | änderbar"
						},
						"groups_value": {
							"nullable": false,
							"type": "array",
							"items": {
								"type": "string",
								"nullable": false,
							},
							"description": "Gruppen | Wert"
						},
					},
					"required": [
						"expiry",
						"membership_number_mode",
						"membership_number_value",
						"name_mode",
						"name_value",
						"email_address_mode",
						"email_address_value",
						"groups_mode",
						"groups_value",
					]
				}),
				"restriction": () => restriction_logged_in,
				"execution": () => ({"query_parameters": query_parameters, "input": input}) => {
					const invite_id : _espe.type.invite_id = parseInt(query_parameters["id"]);
					return (
						_espe.service.invite.get_by_id(invite_id)
						.then(
							(invite_object) => Promise.resolve({
								"status_code": 200,
								"data": {
									"key": invite_object.key,
									"expiry": invite_object.expiry,
									"membership_number_changeable": invite_object.membership_number_changeable,
									"membership_number_value": invite_object.membership_number_value,
									"name_changeable": invite_object.name_changeable,
									"name_value": invite_object.name_value,
									"email_address_changeable": invite_object.email_address_changeable,
									"email_address_value": invite_object.email_address_value,
									"groups_changeable": invite_object.groups_changeable,
									"groups_value": invite_object.groups_value,
								}
							})
						)
						.catch(
							(error) => Promise.resolve({
								"status_code": 404,
								"data": "not found"
							})
						)
					);
				}
			}
		);
	}
	
}