feat: Add endpoints for organisation page [DEV-3848]

README.md

@@ -37,8 +37,7 @@ The application allows configuring the following parameters using environment va
 
 #### Events tracking
 
-1. `ENABLE_DATADOG`: enables sending information about events to datadog
-2. `LOG_LEVEL`: specifies log level, like 'trace', 'debug', 'info', 'warn' or 'error';
+1. `LOG_LEVEL`: specifies log level, like 'trace', 'debug', 'info', 'warn' or 'error';
 
 #### Network API endpoints
 

docker/Dockerfile

@@ -68,7 +68,6 @@ ARG LOGTO_M2M_APP_SECRET
 ARG LOGTO_MANAGEMENT_API
 ARG LOGTO_DEFAULT_ROLE_ID
 ARG LOGTO_WEBHOOK_SECRET
-ARG ENABLE_DATADOG=false
 ARG LOG_LEVEL=info
 
 # API generation
@@ -118,7 +117,6 @@ ENV LOGTO_M2M_APP_SECRET ${LOGTO_M2M_APP_SECRET}
 ENV LOGTO_MANAGEMENT_API ${LOGTO_MANAGEMENT_API}
 ENV LOGTO_DEFAULT_ROLE_ID ${LOGTO_DEFAULT_ROLE_ID}
 ENV LOGTO_WEBHOOK_SECRET ${LOGTO_WEBHOOK_SECRET}
-ENV ENABLE_DATADOG ${ENABLE_DATADOG}
 ENV LOG_LEVEL ${LOG_LEVEL}
 
 # API generatioin

src/app.ts

@@ -32,6 +32,7 @@ import { SubscriptionController } from './controllers/admin/subscriptions.js';
 import { PriceController } from './controllers/admin/prices.js';
 import { WebhookController } from './controllers/admin/webhook.js';
 import { APIKeyController } from './controllers/admin/api-key.js';
+import { OrganisationController } from './controllers/admin/organisation.js';
 
 let swaggerOptions = {};
 if (process.env.ENABLE_AUTHENTICATION === 'true') {
@@ -282,6 +283,14 @@ class App {
 
 			// Webhook
 			app.post('/admin/webhook', new WebhookController().handleWebhook);
+
+			// Customer
+			app.post(
+				'/admin/organisation/update',
+				OrganisationController.organisationUpdatevalidator,
+				new OrganisationController().update
+			);
+			app.get('/admin/organisation/get', new OrganisationController().get);
 		}
 
 		// 404 for all other requests

src/controllers/admin/api-key.ts

@@ -20,7 +20,7 @@ import type {
 	APIKeyUpdateResponseBody,
 	APIKeyUpdateUnsuccessfulResponseBody,
 	APIServiceOptions,
-} from '../../types/portal.js';
+} from '../../types/admin.js';
 import { EventTracker, eventTracker } from '../../services/track/tracker.js';
 import { OperationNameEnum } from '../../types/constants.js';
 

src/controllers/admin/organisation.ts

@@ -0,0 +1,141 @@
+import * as dotenv from 'dotenv';
+import type { Request, Response } from 'express';
+import { check } from 'express-validator';
+import { validate } from '../validator/decorator.js';
+import { CustomerService } from '../../services/api/customer.js';
+import { StatusCodes } from 'http-status-codes';
+import type {
+	AdminOrganisationGetUnsuccessfulResponseBody,
+	AdminOrganisationUpdateResponseBody,
+	AdminOrganisationUpdateUnsuccessfulResponseBody,
+} from '../../types/admin.js';
+import { PaymentAccountService } from '../../services/api/payment-account.js';
+
+dotenv.config();
+
+export class OrganisationController {
+	static organisationUpdatevalidator = [
+		check('name').optional().isString().withMessage('name should be a valid string'),
+		check('email').optional().isEmail().withMessage('email value should a well-formatted string'),
+		check('description').optional().isString().withMessage('description should be a valid string'),
+	];
+
+	/**
+	 * @openapi
+	 *
+	 * /admin/organisation/update:
+	 *   post:
+	 *     summary: Update an organisation
+	 *     description: Update an organisation
+	 *     tags: [Organisation]
+	 *     requestBody:
+	 *       required: true
+	 *       content:
+	 *         application/json:
+	 *           schema:
+	 *             type: object
+	 *             properties:
+	 *               name:
+	 *                 type: string
+	 *                 example: Cheqd
+	 *               email:
+	 *                 type: string
+	 *                 example: cheqd@example.com
+	 *                 format: email
+	 *               description:
+	 *                 type: string
+	 *                 example: Cheqd organisation
+	 *     responses:
+	 *       200:
+	 *         description: A successful response
+	 *         content:
+	 *           application/json:
+	 *             schema:
+	 *               $ref: '#/components/schemas/OrganisationResponseBody'
+	 *       400:
+	 *         $ref: '#/components/schemas/InvalidRequest'
+	 *       401:
+	 *         $ref: '#/components/schemas/UnauthorizedError'
+	 *       500:
+	 *         $ref: '#/components/schemas/InternalError'
+	 *       404:
+	 *         $ref: '#/components/schemas/NotFoundError'
+	 * */
+	@validate
+	async update(request: Request, response: Response) {
+		const { name, email, description } = request.body;
+		try {
+			const customer = await CustomerService.instance.update(
+				response.locals.customer.customerId,
+				name,
+				email,
+				description
+			);
+			const paymentAccount = await PaymentAccountService.instance.find({ customer: customer });
+
+			if (!customer || paymentAccount.length === 0) {
+				response.status(StatusCodes.NOT_FOUND).json({
+					error: 'Customer for updating not found',
+				} satisfies AdminOrganisationUpdateUnsuccessfulResponseBody);
+			}
+
+			return response.status(StatusCodes.OK).json({
+				name: customer.name,
+				email: customer.email,
+				description: customer.description,
+				cosmosAddress: paymentAccount[0].address as string,
+			} satisfies AdminOrganisationUpdateResponseBody);
+		} catch (error) {
+			return response.status(500).json({
+				error: `Internal error: ${(error as Error)?.message || error}`,
+			} satisfies AdminOrganisationUpdateUnsuccessfulResponseBody);
+		}
+	}
+
+	/**
+	 * @openapi
+	 *
+	 * /admin/organisation/get:
+	 *   get:
+	 *     summary: Get an organisation
+	 *     description: Get an organisation
+	 *     tags: [Organisation]
+	 *     responses:
+	 *       200:
+	 *         description: A successful response
+	 *         content:
+	 *           application/json:
+	 *             schema:
+	 *               $ref: '#/components/schemas/OrganisationResponseBody'
+	 *       400:
+	 *         $ref: '#/components/schemas/InvalidRequest'
+	 *       401:
+	 *         $ref: '#/components/schemas/UnauthorizedError'
+	 *       500:
+	 *         $ref: '#/components/schemas/InternalError'
+	 *       404:
+	 *         $ref: '#/components/schemas/NotFoundError'
+	 */
+	async get(request: Request, response: Response) {
+		try {
+			const customer = response.locals.customer;
+			const paymentAccount = await PaymentAccountService.instance.find({ customer: response.locals.customer });
+
+			if (!customer || paymentAccount.length === 0) {
+				response.status(StatusCodes.NOT_FOUND).json({
+					error: 'Customer for current user was not found or did not setup properly. Please contact administrator.',
+				} satisfies AdminOrganisationGetUnsuccessfulResponseBody);
+			}
+			return response.status(StatusCodes.OK).json({
+				name: customer.name,
+				email: customer.email,
+				description: customer.description,
+				cosmosAddress: paymentAccount[0].address as string,
+			});
+		} catch (error) {
+			return response.status(500).json({
+				error: `Internal error: ${(error as Error)?.message || error}`,
+			} satisfies AdminOrganisationGetUnsuccessfulResponseBody);
+		}
+	}
+}

src/controllers/admin/prices.ts

@@ -1,7 +1,7 @@
 import type { Stripe } from 'stripe';
 import type { Request, Response } from 'express';
 import * as dotenv from 'dotenv';
-import type { PriceListResponseBody, PriceListUnsuccessfulResponseBody } from '../../types/portal.js';
+import type { PriceListResponseBody, PriceListUnsuccessfulResponseBody } from '../../types/admin.js';
 import { StatusCodes } from 'http-status-codes';
 import { check } from '../validator/index.js';
 import { validate } from '../validator/decorator.js';

src/controllers/admin/product.ts

@@ -7,7 +7,7 @@ import type {
 	ProductListResponseBody,
 	ProductListUnsuccessfulResponseBody,
 	ProductWithPrices,
-} from '../../types/portal.js';
+} from '../../types/admin.js';
 import { StatusCodes } from 'http-status-codes';
 import { check } from '../validator/index.js';
 import { validate } from '../validator/decorator.js';

src/controllers/admin/subscriptions.ts

@@ -18,7 +18,7 @@ import type {
 	SubscriptionResumeResponseBody,
 	SubscriptionResumeRequestBody,
 	SubscriptionCancelRequestBody,
-} from '../../types/portal.js';
+} from '../../types/admin.js';
 import { StatusCodes } from 'http-status-codes';
 import { check } from '../validator/index.js';
 import { SubscriptionService } from '../../services/admin/subscription.js';