Merge pull request #76 from GTBitsOfGood/akash/delete-files

Implemented delete file api route and model

Author: aakashg00

.github/workflows/update-juno-sdk.yml

@@ -14,24 +14,23 @@ jobs:
         run: |
           # fetch latest prerelease
           latest_prerelease=$(jq -r 'map(select(.prerelease)) | first | .tag_name' <<< "$(curl --silent https://api.github.com/repos/GTBitsOfGood/juno/releases)")
-          
+
           # retrieve auto-generated sdk files
           wget "https://github.com/GTBitsOfGood/juno/releases/download/${latest_prerelease}/juno-client-sdk.tar.gz"
-          
+
           # unzip 
           tar -xvzf "juno-client-sdk.tar.gz"
-          
+
           # move relevant api files over 
           cp -r juno-client-sdk/api src/internal/
           cp -r juno-client-sdk/api.ts src/internal/
           cp -r juno-client-sdk/model src/internal/
 
-          
+
           # cleanup files
           rm "juno-client-sdk.tar.gz"
           rm -r "juno-client-sdk"
 
-          
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v7
         with:

README.md

@@ -27,6 +27,7 @@
 The SDK uses several models to structure the data exchanged between the client and Juno's services. These models represent the input data for API requests and the output data returned by the server.
 
 #### Key Models:
+
 - **CreateProjectModel**: Defines the structure for creating a new project.
 - **CreateUserModel**: Contains the necessary fields to create a new user (email, name, password).
 - **IssueApiKeyRequest**: Defines the request data for issuing an API key for a project.
@@ -41,6 +42,7 @@ The SDK uses several models to structure the data exchanged between the client a
 The SDK includes API methods for interacting with Juno services. These methods abstract the complexities of making HTTP requests and ensure that data is structured according to Juno's requirements.
 
 #### Core APIs:
+
 - **AuthApi**: Handles authentication tasks, such as issuing API keys and generating JWT tokens.
 - **EmailApi**: Manages email operations like sending emails and registering domains.
 - **ProjectApi**: Manages project-related tasks, including creating projects and linking users.
@@ -51,30 +53,35 @@ The SDK includes API methods for interacting with Juno services. These methods a
 The Juno SDK provides a set of APIs for managing various services. Each API is built to simplify interactions with specific Juno infrastructure components. Below is an overview of how to use the main APIs.
 
 ### Authentication
+
 The **AuthApi** is used to handle authentication-related tasks, including issuing API keys and generating JWT tokens for secure access to Juno services.
 
 - **Issue API Key**: Create a new API key for project access. This is necessary for authenticating requests to other services.
 - **Generate JWT**: Once you have an API key, use it to generate a JWT, which is required to authenticate further API requests.
 
 ### Project Management
+
 The **ProjectApi** is responsible for managing projects within Juno’s infrastructure:
 
 - **Create Project**: Define and create a new project using the provided model.
 - **Link User to Project**: Associate a user with a project, allowing them to access or contribute to the project.
 
 ### User Management
+
 The **UserApi** is designed for creating and managing users:
 
 - **Create User**: Create a new user by providing necessary details like email, name, and password.
 - **Set User Role**: Update a user's role to control access levels (e.g., ADMIN, SUPERADMIN).
 
 ### Email Management
+
 The **EmailApi** allows you to manage email-related operations, such as registering domains and sending emails. It includes the following functionality:
 
 - **Register Domain**: Register a domain to use as the sender of emails.
 - **Send Email**: Send an email through Juno’s email service by specifying the sender, recipient, and content.
 
 ### General Workflow
+
 1. **Authentication**: Start by using the **AuthApi** to issue an API key and generate a JWT token.
 2. **Project and User Management**: Set up projects and link users using **ProjectApi** and **UserApi**.
 3. **Email Operations**: If your project involves email management, use **EmailApi** to register sender domains and send emails.

jest.config.js

@@ -1,10 +1,8 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} **/
 module.exports = {
-  testEnvironment: "node",
+  testEnvironment: 'node',
   transform: {
-    "^.+.tsx?$": ["ts-jest",{}],
+    '^.+.tsx?$': ['ts-jest', {}],
   },
-  roots: [
-    "./tests/"
-  ]
+  roots: ['./tests/'],
 };

src/internal/apis/FileDeleteApi.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Juno
+ * Juno Public API Docs
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import type { DeleteFilesModel, DeleteFilesResponse } from '../models/index';
+import {
+  DeleteFilesModelFromJSON,
+  DeleteFilesModelToJSON,
+  DeleteFilesResponseFromJSON,
+  DeleteFilesResponseToJSON,
+} from '../models/index';
+
+export interface FileDeleteControllerDeleteFilesRequest {
+  deleteFilesModel: DeleteFilesModel;
+}
+
+/**
+ *
+ */
+export class FileDeleteApi extends runtime.BaseAPI {
+  /**
+   * Delete files from a bucket
+   */
+  async fileDeleteControllerDeleteFilesRaw(
+    requestParameters: FileDeleteControllerDeleteFilesRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction
+  ): Promise<runtime.ApiResponse<DeleteFilesResponse>> {
+    if (requestParameters['deleteFilesModel'] == null) {
+      throw new runtime.RequiredError(
+        'deleteFilesModel',
+        'Required parameter "deleteFilesModel" was null or undefined when calling fileDeleteControllerDeleteFiles().'
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    headerParameters['Content-Type'] = 'application/json';
+
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token('API_Key', []);
+
+      if (tokenString) {
+        headerParameters['Authorization'] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request(
+      {
+        path: `/file/delete`,
+        method: 'DELETE',
+        headers: headerParameters,
+        query: queryParameters,
+        body: DeleteFilesModelToJSON(requestParameters['deleteFilesModel']),
+      },
+      initOverrides
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) =>
+      DeleteFilesResponseFromJSON(jsonValue)
+    );
+  }
+
+  /**
+   * Delete files from a bucket
+   */
+  async fileDeleteControllerDeleteFiles(
+    requestParameters: FileDeleteControllerDeleteFilesRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction
+  ): Promise<DeleteFilesResponse> {
+    const response = await this.fileDeleteControllerDeleteFilesRaw(
+      requestParameters,
+      initOverrides
+    );
+    return await response.value();
+  }
+}

src/internal/apis/index.ts

@@ -6,6 +6,7 @@ export * from './AuthApi';
 export * from './EmailApi';
 export * from './FileBucketApi';
 export * from './FileConfigApi';
+export * from './FileDeleteApi';
 export * from './FileDownloadApi';
 export * from './FileProviderApi';
 export * from './FileUploadApi';

src/internal/models/DeleteFilesModel.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Juno
+ * Juno Public API Docs
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ *
+ * @export
+ * @interface DeleteFilesModel
+ */
+export interface DeleteFilesModel {
+  /**
+   * Name of the bucket containing the files
+   * @type {string}
+   * @memberof DeleteFilesModel
+   */
+  bucketName: string;
+  /**
+   * Configuration ID for the bucket
+   * @type {number}
+   * @memberof DeleteFilesModel
+   */
+  configId: number;
+  /**
+   * List of file names to delete
+   * @type {Array<string>}
+   * @memberof DeleteFilesModel
+   */
+  fileNames: Array<string>;
+}
+
+/**
+ * Check if a given object implements the DeleteFilesModel interface.
+ */
+export function instanceOfDeleteFilesModel(
+  value: object
+): value is DeleteFilesModel {
+  if (!('bucketName' in value) || value['bucketName'] === undefined)
+    return false;
+  if (!('configId' in value) || value['configId'] === undefined) return false;
+  if (!('fileNames' in value) || value['fileNames'] === undefined) return false;
+  return true;
+}
+
+export function DeleteFilesModelFromJSON(json: any): DeleteFilesModel {
+  return DeleteFilesModelFromJSONTyped(json, false);
+}
+
+export function DeleteFilesModelFromJSONTyped(
+  json: any,
+  ignoreDiscriminator: boolean
+): DeleteFilesModel {
+  if (json == null) {
+    return json;
+  }
+  return {
+    bucketName: json['bucketName'],
+    configId: json['configId'],
+    fileNames: json['fileNames'],
+  };
+}
+
+export function DeleteFilesModelToJSON(value?: DeleteFilesModel | null): any {
+  if (value == null) {
+    return value;
+  }
+  return {
+    bucketName: value['bucketName'],
+    configId: value['configId'],
+    fileNames: value['fileNames'],
+  };
+}

src/internal/models/DeleteFilesResponse.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Juno
+ * Juno Public API Docs
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ *
+ * @export
+ * @interface DeleteFilesResponse
+ */
+export interface DeleteFilesResponse {
+  /**
+   * The name of the bucket from which files were deleted
+   * @type {string}
+   * @memberof DeleteFilesResponse
+   */
+  bucketName: string;
+  /**
+   * List of file names that were deleted
+   * @type {Array<string>}
+   * @memberof DeleteFilesResponse
+   */
+  fileNames: Array<string>;
+}
+
+/**
+ * Check if a given object implements the DeleteFilesResponse interface.
+ */
+export function instanceOfDeleteFilesResponse(
+  value: object
+): value is DeleteFilesResponse {
+  if (!('bucketName' in value) || value['bucketName'] === undefined)
+    return false;
+  if (!('fileNames' in value) || value['fileNames'] === undefined) return false;
+  return true;
+}
+
+export function DeleteFilesResponseFromJSON(json: any): DeleteFilesResponse {
+  return DeleteFilesResponseFromJSONTyped(json, false);
+}
+
+export function DeleteFilesResponseFromJSONTyped(
+  json: any,
+  ignoreDiscriminator: boolean
+): DeleteFilesResponse {
+  if (json == null) {
+    return json;
+  }
+  return {
+    bucketName: json['bucketName'],
+    fileNames: json['fileNames'],
+  };
+}
+
+export function DeleteFilesResponseToJSON(
+  value?: DeleteFilesResponse | null
+): any {
+  if (value == null) {
+    return value;
+  }
+  return {
+    bucketName: value['bucketName'],
+    fileNames: value['fileNames'],
+  };
+}

src/internal/models/index.ts

@@ -13,6 +13,8 @@ export * from './CustomEventTypeResponse';
 export * from './CustomGraphType';
 export * from './CustomGraphTypeResponse';
 export * from './DeleteFileBucketModel';
+export * from './DeleteFilesModel';
+export * from './DeleteFilesResponse';
 export * from './DownloadFileModel';
 export * from './DownloadFileResponse';
 export * from './EmailConfigResponse';