feat: applications api updates (#403)

crowdin · Jul 7, 2024 · 2ebbc05 · 2ebbc05
1 parent c1f7df4
commit 2ebbc05
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 39 deletions.
diff --git a/src/applications/index.ts b/src/applications/index.ts
@@ -1,4 +1,4 @@
-import { CrowdinApi, ResponseObject, PatchRequest, Pagination } from '../core';
+import { CrowdinApi, ResponseObject, PatchRequest, Pagination, ResponseList } from '../core';
 
 /**
  * Crowdin Apps are web applications that can be integrated with Crowdin to extend its functionality.
@@ -10,29 +10,27 @@ export class Applications extends CrowdinApi {
      * @param options optional pagination parameters for the request
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.installations.getMany
      */
-    listApplicationInstallations(options?: Pagination): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    listApplicationInstallations(options?: Pagination): Promise<ResponseList<ApplicationsModel.Application>> {
         const url = `${this.url}/applications/installations`;
         return this.getList(url, options?.limit, options?.offset);
     }
 
     /**
-     * @param applicationUrl Manifest URL
-     * @param permissions application permissions
+     * @param request request body
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.installations.post
      */
     installApplication(
-        applicationUrl: string,
-        permissions?: ApplicationsModel.ApplicationPermissions,
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+        request: ApplicationsModel.InstallApplication,
+    ): Promise<ResponseObject<ApplicationsModel.Application>> {
         const url = `${this.url}/applications/installations`;
-        return this.post(url, { url: applicationUrl, permissions: permissions }, this.defaultConfig());
+        return this.post(url, request, this.defaultConfig());
     }
 
     /**
      * @param applicationId application identifier
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.installations.get
      */
-    getApplicationInstallation(applicationId: string): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    getApplicationInstallation(applicationId: string): Promise<ResponseObject<ApplicationsModel.Application>> {
         const url = `${this.url}/applications/installations/${applicationId}`;
         return this.get(url, this.defaultConfig());
     }
@@ -45,7 +43,7 @@ export class Applications extends CrowdinApi {
     deleteApplicationInstallation(
         applicationId: string,
         force?: boolean,
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    ): Promise<ResponseObject<ApplicationsModel.Application>> {
         const url = `${this.url}/applications/installations/${applicationId}`;
         if (force) {
             this.addQueryParam(url, 'force', String(force));
@@ -61,7 +59,7 @@ export class Applications extends CrowdinApi {
     editApplicationInstallation(
         applicationId: string,
         request: PatchRequest[],
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    ): Promise<ResponseObject<ApplicationsModel.Application>> {
         const url = `${this.url}/applications/installations/${applicationId}`;
         return this.patch(url, request, this.defaultConfig());
     }
@@ -71,10 +69,7 @@ export class Applications extends CrowdinApi {
      * @param path path implemented by the application
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.api.get
      */
-    getApplicationData(
-        applicationId: string,
-        path: string,
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    getApplicationData(applicationId: string, path: string): Promise<ResponseObject<any>> {
         const url = `${this.url}/applications/${applicationId}/api/${path}`;
         return this.get(url, this.defaultConfig());
     }
@@ -85,11 +80,7 @@ export class Applications extends CrowdinApi {
      * @param request request body
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.api.put
      */
-    updateOrRestoreApplicationData(
-        applicationId: string,
-        path: string,
-        request: ApplicationsModel.ApplicationData,
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    updateOrRestoreApplicationData(applicationId: string, path: string, request: any): Promise<ResponseObject<any>> {
         const url = `${this.url}/applications/${applicationId}/api/${path}`;
         return this.put(url, request, this.defaultConfig());
     }
@@ -100,11 +91,7 @@ export class Applications extends CrowdinApi {
      * @param request request body
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.api.post
      */
-    addApplicationData(
-        applicationId: string,
-        path: string,
-        request: ApplicationsModel.ApplicationData,
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    addApplicationData(applicationId: string, path: string, request: any): Promise<ResponseObject<any>> {
         const url = `${this.url}/applications/${applicationId}/api/${path}`;
         return this.post(url, request, this.defaultConfig());
     }
@@ -125,29 +112,50 @@ export class Applications extends CrowdinApi {
      * @param request request body
      * @see https://developer.crowdin.com/api/v2/#operation/api.applications.api.patch
      */
-    editApplicationData(
-        applicationId: string,
-        path: string,
-        request: ApplicationsModel.ApplicationData,
-    ): Promise<ResponseObject<ApplicationsModel.ApplicationData>> {
+    editApplicationData(applicationId: string, path: string, request: any): Promise<ResponseObject<any>> {
         const url = `${this.url}/applications/${applicationId}/api/${path}`;
         return this.patch(url, request, this.defaultConfig());
     }
 }
 
 export namespace ApplicationsModel {
-    export interface ApplicationData {
-        [key: string]: any;
+    export interface Application {
+        identifier: string;
+        name: string;
+        description: string;
+        logo: string;
+        baseUrl: string;
+        manifestUrl: string;
+        createdAt: string;
+        modules: ApplicationModule[];
+        scopes: string[];
+        permissions: ApplicationPermissions;
+        defaultPermissions: any;
+        limitReached: boolean;
+    }
+
+    export interface InstallApplication {
+        url: string;
+        permissions?: ApplicationPermissions;
+        modules?: ApplicationModule[];
     }
 
     export interface ApplicationPermissions {
         user: {
             value: 'all' | 'owner' | 'managers' | 'guests' | 'restricted';
-            ids: Array<number>;
+            ids: number[];
         };
         project: {
             value: 'own' | 'restricted';
-            ids: Array<number>;
+            ids: number[];
         };
     }
+
+    export interface ApplicationModule {
+        key: string;
+        type?: string;
+        data?: any;
+        authenticationType?: string;
+        permissions: Omit<ApplicationPermissions, 'project'>;
+    }
 }
diff --git a/src/translations/index.ts b/src/translations/index.ts
@@ -347,10 +347,6 @@ export namespace TranslationsModel {
         importEqSuggestions?: boolean;
         autoApproveImported?: boolean;
         translateHidden?: boolean;
-        /**
-         * @deprecated
-         */
-        markAddedTranslationsAsDone?: boolean;
     }
 
     export interface UploadTranslationStringsRequest {

diff --git a/tests/applications/api.test.ts b/tests/applications/api.test.ts
@@ -107,7 +107,9 @@ describe('Applications API', () => {
     });
 
     it('Install Application', async () => {
-        await api.installApplication('https://localhost.dev/crowdin.json');
+        await api.installApplication({
+            url: 'https://localhost.dev/crowdin.json',
+        });
     });
 
     it('Get Application Installation', async () => {