@ampsec/platform-client 84.26.0 → 84.28.0

package/src/services/trainings.service.ts

@@ -0,0 +1,47 @@
+import {TrainingDto} from '../dto/trainings.dto';
+import {TargetApi} from './constants';
+import {RestClient, RestResponse} from './rest';
+
+/**
+ *  Service to manage compliance trainings.
+ */
+export class TrainingsService {
+  protected readonly rest: RestClient;
+  protected readonly targetApi: string;
+  protected readonly kind: string;
+  constructor(rest: RestClient, kind: string, targetApi: TargetApi = 'api') {
+    this.rest = rest;
+    this.kind = kind;
+    this.targetApi = targetApi;
+  }
+
+  // Creates a new training with the provided details
+  createTraining = async (trainingDto: TrainingDto): Promise<RestResponse> => {
+    const res = await this.rest.call({
+      url: `/${this.targetApi}/v1/${this.kind}/create`,
+      method: 'POST',
+      data: trainingDto,
+    });
+    return res;
+  };
+
+  // Fetches the video URL for a given training identified by HMAC
+  getVideoUrl = async (hmac: string): Promise<{success: boolean; videoUrl: string}> => {
+    const res = await this.rest.call({
+      url: `/${this.targetApi}/v1/${this.kind}/${hmac}`,
+      method: 'GET',
+    });
+    return res as unknown as {success: boolean; videoUrl: string};
+  };
+
+  // Marks the training identified by HMAC as complete
+  completeTraining = async (hmac: string): Promise<{success: boolean; message: string; findingsClosed: number}> => {
+    const res = await this.rest.call({
+      url: `/${this.targetApi}/v1/${this.kind}/${hmac}/complete`,
+      method: 'POST',
+    });
+    return res as unknown as {success: boolean; message: string; findingsClosed: number};
+  };
+}
+
+export default TrainingsService;

package/src/settings.ts

@@ -111,6 +111,8 @@ const TENANT_SETTINGS = {
   SECURITY_TIPS_USERS_TEST_COHORTS: AmpSettingsMap.asKey<string[]>('securitytips.users.test.cohorts', []),
 
   SECURITY_TIPS_NOTIFICATION_CONNECTOR_ID: AmpSettingsMap.asKey<string>('securitytips.notification.connectorId'),
+
+  FINDINGS_TAGS_ENABLED: AmpSettingsMap.asKey<boolean>('findingstags.enabled', false),
 };
 
 /**