Release version 1.3.0

.github/CODEOWNERS

@@ -1,2 +1,2 @@
 # https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
-*       @asein-sinch @JPPortier @krogers0607 @Dovchik
+*       @asein-sinch @JPPortier @matsk-sinch

.github/scripts/validate-audit-report.sh

@@ -7,7 +7,7 @@ awk 'NR > 1 {print ","} {print}' audit-report.txt >> audit-report.json
 echo ']}' >> audit-report.json
 
 # Filter JSON array to remove jest and lerna's transitive dependencies as these dependencies are not used at runtime
-jq '.vulnerabilities |= map(select(.data.resolution.path | type == "string" and (startswith("lerna") or startswith("jest") or startswith("@types/jest") or startswith("babel-jest") or startswith("eslint") or startswith("@cucumber")) | not))' audit-report.json > audit-report-filtered.json
+jq '.vulnerabilities |= map(select(.data.resolution.path | type == "string" and (startswith("lerna") or startswith("jest") or startswith("@types/jest") or startswith("babel-jest") or startswith("eslint") or startswith("@typescript-eslint") or startswith("@cucumber")) | not))' audit-report.json > audit-report-filtered.json
 
 # Fail the build if filtered JSON array contains audit advisories
 if [ "$(jq '.vulnerabilities[] | select(.type == "auditAdvisory") | .type' audit-report-filtered.json | wc -l)" -gt 0 ]; then

docs/snippets/.env.example

@@ -0,0 +1,12 @@
+# The project ID where are defined the resources you want to use.
+SINCH_PROJECT_ID=
+
+# The API key ID and secret to authenticate your requests to the Sinch API.
+SINCH_KEY_ID=
+SINCH_KEY_SECRET=
+
+# The virtual phone number you have rented from Sinch or planning to rent.
+SINCH_PHONE_NUMBER=
+
+# The service plan ID for your Sinch account to configure the SMS plan associated with your virtual phone number.
+SINCH_SERVICE_PLAN_ID=

docs/snippets/README.md

@@ -0,0 +1,33 @@
+# SDK snippets
+
+This package contains code snippets for the SDK documentation. The snippets are used to demonstrate how to use the SDK to call the supported APIs.
+
+Snippets can be used as a starting point to use Sinch products from your own application.
+
+## Requirements
+
+- Node.js 18 or later
+- [Sinch account](https://dashboard.sinch.com)
+
+### Snippets execution settings
+When executing a snippet, you will need to provide some information about your Sinch account (credentials, Sinch virtual phone number, ...)
+
+This setting can be placed directly in the snippet source, or you can use an [environment file](.env), in which case the settings will be shared and used automatically by every snippet.
+
+```shell
+# Copy the .env.example file to .env
+cp .env.example .env
+```
+
+### Running snippets
+
+To run a snippet, you can use the `npm run` command followed by the name of the snippet. For example:
+
+```shell
+# Run the snippets to get the details about a Sinch number you own
+npm run numbers:get
+#Run the snippets to list the available regions where to rent a Sinch number from
+npm run numbers:regions:list
+```
+
+You can find all the available snippets in the `package.json` file under the `scripts` section.

docs/snippets/numbers/active-numbers/get.js

@@ -0,0 +1,23 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const phoneNumberToGet = process.env.SINCH_PHONE_NUMBER || 'MY_SINCH_PHONE_NUMBER';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const rentedNumber = await sinch.numbers.get({
+    phoneNumber: phoneNumberToGet,
+  });
+
+  console.log(`Rented number:\n${JSON.stringify(rentedNumber, null, 2)}`);
+})();

docs/snippets/numbers/active-numbers/list.js

@@ -0,0 +1,26 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const requestData = {
+    regionCode: 'US',
+    type: 'LOCAL',
+  };
+
+  console.log('List of numbers printed one by one:');
+  // Use the iterator and fetch data from all the pages automatically
+  for await (const rentedNumber of sinch.numbers.list(requestData)) {
+    console.log(JSON.stringify(rentedNumber, null, 2));
+  }
+})();

docs/snippets/numbers/active-numbers/release.js

@@ -0,0 +1,21 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const phoneNumber = process.env.SINCH_PHONE_NUMBER || 'MY_SINCH_PHONE_NUMBER';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const releasedNumber = await sinch.numbers.release({ phoneNumber });
+
+  console.log(`Released number:\n${JSON.stringify(releasedNumber, null, 2)}`);
+})();

docs/snippets/numbers/active-numbers/update.js

@@ -0,0 +1,27 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const phoneNumberToUpdate = process.env.SINCH_PHONE_NUMBER || 'MY_SINCH_PHONE_NUMBER';
+  const updatedDisplayName = 'Updated name with Sinch Node.js SDK';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const updatedNumber = await sinch.numbers.update({
+    phoneNumber: phoneNumberToUpdate,
+    updateActiveNumberRequestBody: {
+      displayName: updatedDisplayName,
+    },
+  });
+
+  console.log(`Updated number:\n${JSON.stringify(updatedNumber, null, 2)}`);
+})();

docs/snippets/numbers/available-numbers/check-availability.js

@@ -0,0 +1,23 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const phoneNumberToCheck = 'A_PHONE_NUMBER_TO_CHECK';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.checkAvailability({
+    phoneNumber: phoneNumberToCheck,
+  });
+
+  console.log(`Response:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/numbers/available-numbers/rent-any.js

@@ -0,0 +1,29 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const servicePlanIdToAssociateWithTheNumber = process.env.SINCH_SERVICE_PLAN_ID || 'MY_SERVICE_PLAN_ID';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.rentAny({
+    rentAnyNumberRequestBody: {
+      regionCode: 'US',
+      type: 'LOCAL',
+      smsConfiguration: {
+        servicePlanId: servicePlanIdToAssociateWithTheNumber,
+      },
+    },
+  });
+
+  console.log(`Rented number:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/numbers/available-numbers/rent.js

@@ -0,0 +1,29 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const phoneNumberToBeRented = 'AVAILABLE_PHONE_NUMBER_TO_BE_RENTED';
+  const servicePlanIdToAssociateWithTheNumber = process.env.SINCH_SERVICE_PLAN_ID || 'MY_SERVICE_PLAN_ID';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.rent({
+    phoneNumber: phoneNumberToBeRented,
+    rentNumberRequestBody: {
+      smsConfiguration: {
+        servicePlanId: servicePlanIdToAssociateWithTheNumber,
+      },
+    },
+  });
+
+  console.log(`Rented number:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/numbers/available-numbers/search-for-available-numbers.js

@@ -0,0 +1,22 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.searchForAvailableNumbers({
+    regionCode: 'US',
+    type: 'LOCAL',
+  });
+
+  console.log(`Available numbers to rent:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/numbers/available-regions/list.js

@@ -0,0 +1,19 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.availableRegions.list({});
+
+  console.log(`Available regions:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/numbers/callback-configuration/get.js

@@ -0,0 +1,19 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.callbacks.get({});
+
+  console.log(`Callback configuration:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/numbers/callback-configuration/update.js

@@ -0,0 +1,25 @@
+/**
+ * Sinch Node.js Snippet
+ * See: https://github.com/sinch/sinch-sdk-node/docs/snippets
+ */
+import { SinchClient } from '@sinch/sdk-core';
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+(async () => {
+  const projectId = process.env.SINCH_PROJECT_ID || 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID || 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET || 'MY_KEY_SECRET';
+
+  const newHmacSecret = 'NEW_HMAC_SECRET';
+
+  const sinch = new SinchClient({ projectId, keyId, keySecret });
+
+  const response = await sinch.numbers.callbacks.update({
+    updateCallbackConfigurationRequestBody: {
+      hmacSecret: newHmacSecret,
+    },
+  });
+
+  console.log(`Updated callback configuration:\n${JSON.stringify(response, null, 2)}`);
+})();

docs/snippets/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@sinch/code-snippets",
+  "version": "0.0.0",
+  "description": "Code snippets related to the Sinch Node.js SDK usage",
+  "author": "Sinch",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "@sinch/sdk-core": "^1.3.0"
+  },
+  "scripts": {
+    "build": "tsc --noEmit",
+    "numbers:get": "node numbers/active-numbers/get.js",
+    "numbers:list": "node numbers/active-numbers/list.js",
+    "numbers:release": "node numbers/active-numbers/release.js",
+    "numbers:update": "node numbers/active-numbers/update.js",
+    "numbers:check-availability": "node numbers/available-numbers/check-availability.js",
+    "numbers:search-for-available-numbers": "node numbers/available-numbers/search-for-available-numbers.js",
+    "numbers:rent": "node numbers/available-numbers/rent.js",
+    "numbers:rent-any": "node numbers/available-numbers/rent-any.js",
+    "numbers:regions:list": "node numbers/available-regions/list.js",
+    "numbers:callback-config:get": "node numbers/callback-configuration/get.js",
+    "numbers:callback-config:update": "node numbers/callback-configuration/update.js"
+  }
+}

docs/snippets/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "target": "es2020",
+    "module": "es2020",
+    "moduleResolution": "node",
+    "pretty": true,
+    "baseUrl": ".",
+    "noEmit": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "**/*.js"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

examples/integrated-flows-examples/package.json

@@ -13,10 +13,10 @@
     "verification:app": "yarn compile && node dist/verification/app.js"
   },
   "dependencies": {
-    "@sinch/sdk-core": "^1.2.0",
+    "@sinch/sdk-core": "^1.3.0",
     "@types/node": "^20.8.7",
     "dotenv": "^16.3.1",
-    "inquirer": "^9.2.14",
+    "inquirer": "^12.9.1",
     "typescript": "^5.2.2"
   },
   "devDependencies": {