Merge pull request #257 from Scalingo/feat/improve-data-consent

Author: ksol

CHANGELOG.md

@@ -1,6 +1,7 @@
-## 0.6.5 (unreleased)
+## 0.7.0 (unreleased)
 
 * chore: bump dependencies
+* feat(data consent): update modelisation and signature calls (preview endpoint)
 
 ## 0.6.4
 

src/DataAccessConsent/index.ts

@@ -0,0 +1,52 @@
+import {
+  CreateParams,
+  UpdateParams,
+} from "src/params/regional/data_access_consent";
+
+import { Client } from "..";
+import { DataAccessConsent as DataAccessConsentModel } from "../models/regional";
+import { unpackData } from "../utils";
+
+/**
+ * Data Access Consent API Client
+ */
+export default class DataAccessConsent {
+  /** Scalingo API Client */
+  _client: Client;
+
+  /**
+   * Create a new "thematic" client
+   * @param client Scalingo API Client
+   */
+  constructor(client: Client) {
+    this._client = client;
+  }
+
+  /**
+   * Create a DataAccessConsent
+   * @see https://developers.scalingo.com/data_access_consent#create-a-new-dataaccessconsent
+   * @param appId ID of the app we're interested in
+   */
+  create(appId: string, params: CreateParams): Promise<DataAccessConsentModel> {
+    return unpackData(
+      this._client.apiClient().post(`/apps/${appId}/data_access_consent`, {
+        data_access_consent: params,
+      }),
+      "data_access_consent"
+    );
+  }
+
+  /**
+   * Create a DataAccessConsent
+   * @see https://developers.scalingo.com/data_access_consent#create-a-new-dataaccessconsent
+   * @param appId ID of the app we're interested in
+   */
+  update(appId: string, params: UpdateParams): Promise<DataAccessConsentModel> {
+    return unpackData(
+      this._client.apiClient().patch(`/apps/${appId}/data_access_consent`, {
+        data_access_consent: params,
+      }),
+      "data_access_consent"
+    );
+  }
+}

src/DataAccessConsents/index.ts

@@ -10,7 +10,7 @@ import Collaborators from "./Collaborators";
 import Containers from "./Containers";
 import Contracts from "./Contracts";
 import CronTasks from "./CronTasks";
-import DataAccessConsents from "./DataAccessConsents";
+import DataAccessConsent from "./DataAccessConsent";
 import Deployments from "./Deployments";
 import Domains from "./Domains";
 import Environment from "./Environment";
@@ -93,7 +93,7 @@ export class Client {
   Containers = new Containers(this);
   Contracts = new Contracts(this);
   CronTasks = new CronTasks(this);
-  DataAccessConsents = new DataAccessConsents(this);
+  DataAccessConsent = new DataAccessConsent(this);
   Deployments = new Deployments(this);
   Domains = new Domains(this);
   Environment = new Environment(this);

src/index.ts

@@ -0,0 +1,10 @@
+export interface DataAccessConsent {
+  /** UUID of the related application */
+  app_id: string;
+  /** UUID of the person who granted the access */
+  user_id: string;
+  /** Databases access granted until */
+  databases_until: string | null;
+  /** Containers access granted until */
+  containers_until: string | null;
+}

src/models/regional/data_access_consent.ts

@@ -6,7 +6,7 @@ export * from "./autoscalers";
 export * from "./collaborators";
 export * from "./containers";
 export * from "./cron_tasks";
-export * from "./data_access_consents";
+export * from "./data_access_consent";
 export * from "./deployments";
 export * from "./domains";
 export * from "./environment";

src/models/regional/data_access_consents.ts

@@ -0,0 +1,8 @@
+import { DataAccessConsent } from "src/models/regional";
+
+export type CreateParams = Pick<
+  DataAccessConsent,
+  "containers_until" | "databases_until"
+>;
+
+export type UpdateParams = CreateParams;

src/models/regional/index.ts

@@ -0,0 +1,39 @@
+import DataAccessConsent from "../../src/DataAccessConsent";
+import { testPost, testUpdate } from "../utils/http";
+
+describe("DataAccessConsent#create", () => {
+  testPost(
+    "https://api.osc-fr1.scalingo.com/v1/apps/test/data_access_consent",
+    null,
+    {
+      data_access_consent: {
+        containers_until: "2022-07-06T00:00:00.000+00:00",
+        databases_until: "2022-07-08T00:00:00.000+00:00",
+      },
+    },
+    "data_access_consent",
+    (client) => {
+      return new DataAccessConsent(client).create("test", {
+        containers_until: "2022-07-06T00:00:00.000+00:00",
+        databases_until: "2022-07-08T00:00:00.000+00:00",
+      });
+    }
+  );
+});
+
+describe("DataAccessConsent#update", () => {
+  testUpdate(
+    "https://api.osc-fr1.scalingo.com/v1/apps/test/data_access_consent",
+    {
+      data_access_consent: {
+        containers_until: "2022-07-10T00:00:00.000+00:00",
+      },
+    },
+    "data_access_consent",
+    (client) => {
+      return new DataAccessConsent(client).update("test", {
+        containers_until: "2022-07-10T00:00:00.000+00:00",
+      });
+    }
+  );
+});