Merge branch 'release-25.11' into 'main'

Release 25.11

See merge request nwac/sdk-ts!150

Author: slahtine

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## Version 7.0.0
+
+Breaking changes:
+- KYC functionality is now under `NetworkAsCodeClient.kyc.*` namespace instead of under `Device`
+
+Changes:
+- KYC Fill-in is now supported
+- KYC Tenure is now supported
+- Quality-on-Demand has been updated to support V1 API
+- Device Status now supports Device Roaming and Device Reachability V1
+- KYC functionality now has return models and types for easier use
+
+Fixes:
+- Test mocks were not properly checking request bodies and therefore
+  gave false negatives. These mocks have now been fixed
+
 ## Version 6.0.0
 
 Breaking Changes:

Jenkinsfile

@@ -13,8 +13,8 @@ pipeline {
       yaml """
         spec:
           containers:
-          - name: narwhal
-            image: nex-nef-docker-releases.repo.cci.nokia.net/nmp/narwhal:latest
+          - name: typescript
+            image: nex-nef-docker-candidates.repo.cci.nokia.net/nmp-sdk-typescript-container:latest
             workingDir: /home/jenkins
             tty: true
             command:
@@ -71,7 +71,7 @@ pipeline {
   stages {
     stage('Setup') {
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh """
               npm config set proxy http://fihel1d-proxy.emea.nsn-net.net:8080
@@ -83,7 +83,7 @@ pipeline {
     }
     stage('Linting') {
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh """
               npm run lint
@@ -94,7 +94,7 @@ pipeline {
     }
     stage('Test') {
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh """
               npm test
@@ -105,7 +105,7 @@ pipeline {
     }
     stage('Audit') {
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh """
               npm audit --prod
@@ -117,7 +117,7 @@ pipeline {
     stage('Integration Test') {
       when { expression { env.gitlabActionType != "TAG_PUSH"} }
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh """
               env | grep gitlab
@@ -149,7 +149,7 @@ pipeline {
       }
     stage('Build') {
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh """
               npm run build
@@ -160,7 +160,7 @@ pipeline {
     }
     stage('Installation Test'){
       steps {
-        container('narwhal') {
+        container('typescript') {
           script {
             sh '''
                 bash installation-test/installation-test-ts.sh              
@@ -174,7 +174,7 @@ pipeline {
     stage('Candidate integration tests against production') {
         when { expression { env.gitlabActionType == "TAG_PUSH" && env.gitlabBranch.contains("rc-")} }
         steps {
-            container('narwhal') {
+            container('typescript') {
                 script {
                     sh """
                     env | grep gitlab
@@ -193,7 +193,7 @@ pipeline {
     stage('Release integration tests against production') {
         when { expression { env.gitlabActionType == "TAG_PUSH" && env.gitlabBranch.contains("release-")} }
         steps {
-            container('narwhal') {
+            container('typescript') {
                 script {
                     sh """
                     env | grep gitlab
@@ -211,7 +211,7 @@ pipeline {
     stage('Publish') {
         when { expression { env.gitlabActionType == "TAG_PUSH" && env.gitlabBranch.contains("release-")} }
             steps {
-                container('narwhal') {
+                container('typescript') {
                     script {
                         if(env.gitlabActionType == "TAG_PUSH" && env.gitlabBranch.contains("release-")) {
                             sh '''

examples/device-status-connectivity.ts examples/device-status.tsexamples/device-status-connectivity.ts renamed to examples/device-status.ts

@@ -1,44 +1,39 @@
 // Device Status functionalities
 
-// Subscribing to Connectivity and Roaming updates:
+// Subscribing to Reachability or Roaming updates:
 
 import { NetworkAsCodeClient } from "network-as-code";
-
+import { EventType } from "../src/models/deviceStatus";
 
 const client = new NetworkAsCodeClient("<your-application-key-here>");
 
 // Create a device object for the mobile device we want to use
 const myDevice = client.devices.get({
-    networkAccessIdentifier: "[email protected]",
-    ipv4Address: {
-        publicAddress: "233.252.0.2",
-        privateAddress: "192.0.2.25",
-        publicPort: 80,
-    },
-    Ipv6Address: "2041:0000:140F::875B:131B",
     // The phone number accepts the "+" sign, but not spaces or "()" marks
-    phoneNumber: "36721601234567"
+    phoneNumber: "+99999991000"
 });
 
 // Simply change the event_type whenever needed.
 const mySubscription = await client.deviceStatus.subscribe(
     myDevice,
-    // When necessary, change it to:
-    // "org.camaraproject.device-status.v0.roaming-status"
-    "org.camaraproject.device-status.v0.connectivity-data",
+    // When necessary, change this to different event_type, for example:
+    // [EventType.ROAMING_STATUS]
+    [EventType.REACHABILITY_DATA],
     // Use HTTPS to send notifications
     "https://example.com/notify",
+    // You can add optional parameters as well
     {
-        maxNumberOfReports: 5,
-        notificationAuthToken: "replace-with-your-auth-token"
+        initialEvent: true,
+        subscriptionMaxEvents: 5
     }
 );
 
 // Use this to show the roaming subscription status
 console.log(mySubscription);
 
-// Get the subscription by its ID
-const subscription = await client.deviceStatus.get(mySubscription.eventSubscriptionId);
+// Get the reachability subscription by its ID
+// Change the method call to getRoamingSubscription() to get a roaming subscription
+const subscription = await client.deviceStatus.getReachabilitySubscription(mySubscription.eventSubscriptionId);
 
 // Then, delete the subscription whenever needed
 subscription.delete();

examples/kyc-age-verification.ts

@@ -5,13 +5,6 @@ import { NetworkAsCodeClient } from "network-as-code";
 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. 
@@ -31,6 +24,6 @@ const parameters =
         includeParentalControl: true
     }
 
-const customerAgeVerifyResult = await device.verifyAge(parameters);
+const customerAgeVerifyResult = await client.kyc.verifyAge(parameters);
 
-console.log(customerAgeVerifyResult)
+console.log(customerAgeVerifyResult)

examples/kyc-fill-in.ts

@@ -0,0 +1,13 @@
+import { NetworkAsCodeClient } from "network-as-code";
+
+
+// Initialize the client object with your application key
+const client = new NetworkAsCodeClient("<your-application-key-here>");
+
+
+// To use the requestCustomerInfo method you must provide the customer's phone number.
+const result = await client.kyc.requestCustomerInfo("+99999991000");
+
+
+// If successful, you can access the results like so:
+console.log(result);

examples/kyc-match.ts

@@ -5,14 +5,9 @@ import { NetworkAsCodeClient } from "network-as-code";
 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"
-});
+// To match customer records, you must provide the customer's phone number.
 
-
-// Add the customer identity data here, which is to be used in matching
+// Add additional customer identity data, which is to be used in matching
 // a customer against the account data bound to their phone number.
 const parameters =
     {
@@ -38,6 +33,6 @@ const parameters =
         gender: "OTHER"
     }
 
-const customerMatchResult = await device.matchCustomer(parameters);
+const customerMatchResult = await client.kyc.matchCustomer(parameters);
 
-console.log(customerMatchResult)
+console.log(customerMatchResult)

examples/kyc-tenure.ts

@@ -0,0 +1,25 @@
+import { NetworkAsCodeClient } from "network-as-code";
+
+
+// Initialize the client object with your application key
+const client = new NetworkAsCodeClient("<your-application-key-here>");
+
+
+// To use the check_tenure method you must provide the customer's phone number.
+
+// Add the tenure date from which the continuous tenure of the subscriber is to be confirmed
+
+const result = await client.kyc.checkTenure(
+    {
+        phoneNumber: "+99999991000",
+        // You can also use a string value in format of "YYYY-MM-DD"
+        tenureDate: new Date(2023, 7, 17)
+    }
+)
+
+// If successful, you can access the results like so:
+console.log(result)
+
+// Or
+console.log(result.tenureDateCheck)
+console.log(result.contractType)

examples/qod-session.ts

@@ -1,6 +1,6 @@
 // QoD functionalities
 
-// QoS session examples:
+// QoD session examples:
 
 import { NetworkAsCodeClient } from "network-as-code";
 
@@ -25,14 +25,18 @@ const myDevice = client.devices.get({
 // Create a QoD session with QOS_L (large bandwidth)
 // that lasts for 3,600 seconds (1 hour).
 // For TypeScript, values can be expressed directly,
-// but the QoS profile comes before the IP address(es) and duration:
+// but the QoD profile comes before the IP address(es) and duration:
 const mySession = await myDevice.createQodSession("QOS_L", {
     serviceIpv4: "233.252.0.2",
     serviceIpv6: "2001:db8:1234:5678:9abc:def0:fedc:ba98",
     duration: 3600,
     // Use HTTPS to send or subscribe to notifications
-    notificationUrl: "https://notify.me/here",
-    notificationAuthToken: "replace-with-your-auth-token",
+    sink: "https://example.com/notifications",
+    sinkCredential: {
+        credentialType:"ACCESSTOKEN", 
+        accessToken: "some-access-token", 
+        accessTokenType: "bearer", 
+        accessTokenExpiresUtc: new Date("2025-01-23T10:40:30.616Z")}
 });
 
 // Let's confirm that the device has the newly created session