feat: migrations find endpoint (#485)

Author: YegorZh

resources/migrations.ts

@@ -0,0 +1,31 @@
+import { UnitResponse, UnitConfig, QueryParameters } from "../types/common"
+import { Migration, MigrationStatus } from "../types/migration"
+import { BaseResource } from "./baseResource"
+
+export class Migrations extends BaseResource {
+  constructor(token: string, basePath: string, config?: UnitConfig) {
+    super(token, basePath + "/migrations", config)
+  }
+
+  public async find(
+    params?: MigrationsFindParams
+  ): Promise<UnitResponse<Migration[]>> {
+    const parameters: QueryParameters = {
+      ...(params?.customerId && { "filter[customerId]": params.customerId }),
+    }
+
+    if (params?.status)
+      params.status.forEach((s, idx) => {
+        parameters[`filter[status][${idx}]`] = s
+      })
+
+    return this.httpGet<UnitResponse<Migration[]>>("", {
+      params: parameters,
+    })
+  }
+}
+
+export interface MigrationsFindParams {
+  status?: MigrationStatus[]
+  customerId?: string
+}

tests/migrations.spec.ts

@@ -0,0 +1,18 @@
+import { Unit } from "../unit"
+
+import dotenv from "dotenv"
+dotenv.config()
+const unit = new Unit(
+  process.env.UNIT_TOKEN || "test",
+  process.env.UNIT_API_URL || "test"
+)
+
+describe("Find Migrations", () => {
+  test("Find Migrations", async () => {
+    const res = await unit.migrations.find()
+    expect(res.data.length > 0).toBeTruthy()
+    res.data.forEach((migration) =>
+      expect(migration.type === "customerBankMigration").toBeTruthy()
+    )
+  })
+})

types/migration.ts

@@ -0,0 +1,57 @@
+export enum MigrationStatus {
+  MigrationStarted = "MigrationStarted",
+  CollectingAccountsConsent = "CollectingAccountsConsent",
+  MigratingAccounts = "MigratingAccounts",
+  CollectingMoneyMovementConsent = "CollectingMoneyMovementConsent",
+  ExecutingMoneyMovement = "ExecutingMoneyMovement",
+  PendingMigrationDeadline = "PendingMigrationDeadline",
+  PendingMoneyMovementOnDeadline = "PendingMoneyMovementOnDeadline",
+  ClosingAccounts = "ClosingAccounts",
+  Completed = "Completed",
+  Cancelled = "Cancelled",
+}
+
+export enum BalanceTransferTiming {
+  NewAccountCreation = "NewAccountCreation",
+  MigrationDeadline = "MigrationDeadline",
+}
+
+export interface Migration {
+  id: string
+  type: "customerBankMigration"
+  attributes: {
+    migrationStatus: MigrationStatus
+    deadLine: string
+    fromBank: string
+    toBank: string
+    orgName: string
+    supportEmail: string
+    supportPhone: string
+    migrationUrl: string
+    createdAt: string
+    updatedAt: string
+    supressInvitationEmail: boolean
+    digitallyActivatePhysicalCards: boolean
+    balanceTransferTiming: BalanceTransferTiming
+  }
+  relationships: {
+    org: {
+      data: {
+        type: "org"
+        id: string
+      }
+    }
+    customer: {
+      data: {
+        type: "customer"
+        id: string
+      }
+    }
+    whiteLabelTheme: {
+      data: {
+        type: "whiteLabelTheme"
+        id: string
+      }
+    }
+  }
+}

unit.ts

@@ -33,6 +33,7 @@ import { Chargebacks } from "./resources/chargeback"
 import { CashDeposits } from "./resources/cashDeposits"
 import { CreditApplications } from "./resources/creditApplication"
 import { RecurringRepayments } from "./resources/recurringRepayments"
+import { Migrations } from "./resources/migrations"
 
 export class Unit {
     public applications: Applications
@@ -71,6 +72,7 @@ export class Unit {
     public cashDeposits: CashDeposits
     public creditApplications: CreditApplications
     public recurringRepayments: RecurringRepayments
+    public migrations: Migrations;
 
     constructor(token: string, basePath: string, config?: UnitConfig) {
         // remove all trailing slashes from user-provided basePath
@@ -111,6 +113,7 @@ export class Unit {
         this.cashDeposits = new CashDeposits(token, basePath, config)
         this.creditApplications = new CreditApplications(token, basePath, config)
         this.recurringRepayments = new RecurringRepayments(token, basePath, config)
+        this.migrations = new Migrations(token, basePath, config)
         this.helpers = helpers
     }