Merge branch 'release-25.9' into 'main'

Release 25.9

See merge request nwac/sdk-ts!132

Author: slahtine

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 5.2.0
+
+Changes:
+- Added support for Device Swap
+- Added support for KYC Match and KYC Age Verification
+
 ## Version 5.0.0
 
 Breaking Changes:

examples/device-swap.ts

@@ -0,0 +1,28 @@
+import { NetworkAsCodeClient } from "network-as-code";
+
+const client = new NetworkAsCodeClient("<your-token>");
+
+const device = client.devices.get({ phoneNumber: "+3637123456" });
+
+// Device swap date can be acquired like so:
+const deviceSwapDate = await device.getDeviceSwapDate();
+
+// Under some circumstances if no device swap has occurred, this object may be null
+// Otherwise the device swap date may also be the activation date of the device
+if (!deviceSwapDate) {
+    console.log("Device swap date is null: No device swap has occurred");
+} else {
+    console.log(
+        `Last device swap (or activation) happened on ${deviceSwapDate.toISOString()}`
+    );
+}
+
+// It is also possible to check if a device swap has occurred in general
+if (await device.verifyDeviceSwap()) {
+    console.log("A device swap has occurred!");
+}
+
+// If we want to check if it happened during the past hour:
+if (await device.verifyDeviceSwap(2400)) {
+    console.log("A device swap has occurred in the past hour!");
+}

examples/kyc-age-verification-ts

@@ -0,0 +1,36 @@
+import { NetworkAsCodeClient } from "network-as-code";
+
+
+// Initialize the client object with your application key
+const client = new NetworkAsCodeClient("<your-application-key-here>");
+
+
+// Then, create a device object for the phone number */
+const device = client.devices.get({
+    // The phone number accepts the "+" sign, but not spaces or "()" marks
+    phoneNumber: "+999999991000"
+});
+
+
+// Add the phone number of the subscriber and the age threshold to compare to here. 
+// Add optionally also the other information of the subscriber here, as well as if the
+// subscription has a content lock or parental control. 
+const parameters =
+    {
+        ageThreshold: 18,
+        phoneNumber: "+99999991000",
+        idDocument: "66666666q",
+        name: "Federica Sanchez Arjona",
+        givenName: "Federica",
+        familyName: "Sanchez Arjona",
+        middleNames: "Sanchez",
+        familyNameAtBirth: "YYYY",
+        birthdate: "1978-08-22",
+        email: "federicaSanchez.Arjona@example.com",
+        includeContentLock: true,
+        includeParentalControl: true
+    }
+
+const customerAgeVerifyResult = await device.verifyAge(parameters);
+
+console.log(customerAgeVerifyResult)

examples/kyc-match.ts

@@ -0,0 +1,43 @@
+import { NetworkAsCodeClient } from "network-as-code";
+
+
+// Initialize the client object with your application key
+const client = new NetworkAsCodeClient("<your-application-key-here>");
+
+
+// Then, create a device object for the phone number. */
+const device = client.devices.get({
+    // The phone number accepts the "+" sign, but not spaces or "()" marks
+    phoneNumber: "+999999991000"
+});
+
+
+// Add the customer identity data here, which is to be used in matching
+// a customer against the account data bound to their phone number.
+const parameters =
+    {
+        phoneNumber: '+99999991000',
+        idDocument: "66666666q",
+        name: "Federica Sanchez Arjona",
+        givenName: "Federica",
+        familyName: "Sanchez Arjona",
+        nameKanaHankaku: "federica",
+        nameKanaZenkaku: "Ｆｅｄｅｒｉｃａ",
+        middleNames: "Sanchez",
+        familyNameAtBirth: "YYYY",
+        address: "Tokyo-to Chiyoda-ku Iidabashi 3-10-10",
+        streetName: "Nicolas Salmeron",
+        streetNumber: "4",
+        postalCode: "1028460",
+        region: "Tokyo",
+        locality: "ZZZZ",
+        country: "JP",
+        houseNumberExtension: "VVVV",
+        birthdate: "1978-08-22",
+        email: "abc@example.com",
+        gender: "OTHER"
+    }
+
+const customerMatchResult = await device.matchCustomer(parameters);
+
+console.log(customerMatchResult)

integration-tests/deviceSwap.itest.ts

@@ -0,0 +1,47 @@
+import { beforeAll, beforeEach, describe, expect } from "@jest/globals";
+import "dotenv/config";
+import { NetworkAsCodeClient } from "../src";
+import { Device } from "../src/models/device";
+import { configureClient } from "./configClient";
+
+let client: NetworkAsCodeClient;
+
+beforeAll((): any => {
+    client = configureClient()
+});
+
+describe("Device Swap retrieval and verification", () => {
+    let device: Device;
+
+    beforeEach(() => {
+        device = client.devices.get({
+            phoneNumber: "+99999991000",
+        });
+    });
+    it("should retrieve device swap of a test device", async () => {
+        expect(await device.getDeviceSwapDate()).toBeTruthy();
+    });
+
+    it("should verify device swap without max age", async () => {
+        expect(await device.verifyDeviceSwap()).toBe(true)
+    });
+
+    it("should verify device swap with max age", async () => {
+        expect(await device.verifyDeviceSwap(250)).toBe(true)
+    });
+
+    it("should verify device swap - True", async () => {
+        device = client.devices.get({
+            phoneNumber: "+99999991000"
+        });
+
+        expect(await device.verifyDeviceSwap()).toBe(true)
+    });
+
+    it("should verify device swap - False", async () => {
+        device = client.devices.get({
+            phoneNumber: "+99999991001"
+        });
+        expect(await device.verifyDeviceSwap(120)).toBe(false)
+    });
+});