@sinch/sdk-core 0.0.0

package/README.md

@@ -0,0 +1,107 @@
+# Sinch server SDK for Node.js
+
+This package contains the Sinch Client SDK for Node.js. To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one.
+
+<span style="color:red; font-weight:bold">Warning:</span>
+**This SDK is currently available for preview purposes only. It should not be used in production environments.**
+
+## Installation
+
+### With NPM
+
+```bash
+npm install @sinch/sdk-core
+```
+
+### With Yarn
+
+```bash
+yarn add @sinch/sdk-core
+```
+
+## Usage
+
+The `@sinch/sdk-core` package contains the entry point for a SDK user: the `SinchClient` class. It will use the information given in parameters to initialize the right plugins for the right APIs.
+
+As there are different authentication schemes, the initialization method will depend on which one is used by the API.
+
+### OAuth2 Authentication
+
+```typescript
+import { SinchClient } from '@sinch/sdk-core';
+
+// The credentials can be found on the Account dashboard: https://dashboard.sinch.com/account/access-keys
+const sinch = new SinchClient({
+    projectId: 'my-project-id',
+    keyId: 'my-key-id',
+    keySecret: 'my-key-secret',
+});
+
+const response = await sinch.numbers.availableRegions.list({
+    types: 'LOCAL',
+});
+```
+The initialization method above will work for the APIs that supports the authentication with OAuth2 (Numbers and SMS on US and EU regions).
+
+### API Token authentication
+
+If you want to use the SMS API on the other regions (or US and EU too, it will work), you'll need other credentials in order to give to the Client the `servicePlanId` and the associated `apiToken`. 
+
+```typescript
+import { SinchSmsClient } from '@sinch/sdk-core';
+
+// The credentials can be found on the Service APIs dashboard: https://dashboard.sinch.com/sms/api/services
+const sinch = new SinchClient({
+    servicePlanId: 'my-service-plan-id',
+    apiToken: 'my-key-id',
+    region: 'my-region', // Optional, can be 'us', 'eu', 'br', 'au', 'ca'. Default is 'us'
+});
+
+const response = await sinch.sms.batches.get({
+    batch_id: '01HF28S9AABBBCCCCY92BJB569',
+});
+```
+
+### Signed application authentication
+
+Both `Verification` and `Voice` APIs are using this authentication method: the request is encoded using the `Application Secret` and identified with the `Application Key`.
+
+```typescript
+import { SinchClient } from '@sinch/sdk-core';
+
+// The credentials can be found on the Verification or Voice dashboard: 
+// https://dashboard.sinch.com/verification/apps or 
+// https://dashboard.sinch.com/voice/apps
+const sinch = new SinchClient({
+  applicationId: 'my-application-key',
+  applicationSecret: 'my-application-secret',
+});
+
+const response = await sinch.verification.verificationStatus.getById({
+  id: '018bfc3e-1234-5678-1234-ebdb3fd6d30f',
+});
+```
+
+## Examples
+You can find an example of each request in the [../../examples/simple-examples](../../examples/simple-examples/) folder.
+
+## Contact
+Developer Experience team: [devexp@sinch.com](mailto:devexp@sinch.com)
+
+## Supported APIs
+
+Here is the list of the Sinch API and there level of support by the Node.js SDK:
+
+| API Category           | API Name                            | Status |
+|------------------------|-------------------------------------|:------:|
+| Messaging              | SMS API                             |   ✅    |
+|                        | Conversation API                    |   ❌    |
+|                        | RCS API                             |   ❌    |
+|                        | MMS API                             |   ❌    |
+|                        | Provisioning API                    |   ❌    |
+| Voice and Video        | Voice API                           |   ❌    |
+|                        | Elastic SIP Trunking                |   ❌    |
+| Numbers & Connectivity | Numbers API                         |   ✅    |
+|                        | Brand and Campaign Registration API |   ❌    |
+|                        | Number Lookup API                   |   ❌    |
+| Verification           | Verification API                    |   ✅    |

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './sinch-client';
+export * from '@sinch/numbers';
+export * from '@sinch/sms';
+export * from '@sinch/verification';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./sinch-client"), exports);
+__exportStar(require("@sinch/numbers"), exports);
+__exportStar(require("@sinch/sms"), exports);
+__exportStar(require("@sinch/verification"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,iDAA+B;AAC/B,6CAA2B;AAC3B,sDAAoC"}

package/dist/sinch-client.d.ts

@@ -0,0 +1,16 @@
+import { Numbers } from '@sinch/numbers';
+import { Sms } from '@sinch/sms';
+import { Verification } from '@sinch/verification';
+import { SinchClientParameters } from '@sinch/sdk-client';
+/** Sinch Client to declare and initialize the supported APIs */
+export declare class SinchClient {
+    readonly numbers: Numbers;
+    readonly sms: Sms;
+    readonly verification: Verification;
+    /**
+     * Initialize your API Client instance with the provided credentials.
+     *
+     * @param {SinchClientParameters} params - The object containing the Sinch credentials.
+     */
+    constructor(params: SinchClientParameters);
+}

package/dist/sinch-client.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SinchClient = void 0;
+const numbers_1 = require("@sinch/numbers");
+const sms_1 = require("@sinch/sms");
+const verification_1 = require("@sinch/verification");
+/** Sinch Client to declare and initialize the supported APIs */
+class SinchClient {
+    /**
+     * Initialize your API Client instance with the provided credentials.
+     *
+     * @param {SinchClientParameters} params - The object containing the Sinch credentials.
+     */
+    constructor(params) {
+        // Initialize the "Numbers" API
+        this.numbers = new numbers_1.Numbers(params);
+        // Initialize the "SMS" API.
+        this.sms = new sms_1.Sms(params);
+        // Initialize the "Verification" API
+        this.verification = new verification_1.Verification(params);
+    }
+}
+exports.SinchClient = SinchClient;
+//# sourceMappingURL=sinch-client.js.map

package/dist/sinch-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sinch-client.js","sourceRoot":"","sources":["../src/sinch-client.ts"],"names":[],"mappings":";;;AAAA,4CAAyC;AACzC,oCAAiC;AACjC,sDAAmD;AAGnD,gEAAgE;AAChE,MAAa,WAAW;IAMtB;;;;OAIG;IACH,YAAY,MAA6B;QACvC,+BAA+B;QAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,MAAM,CAAC,CAAC;QAEnC,4BAA4B;QAC5B,IAAI,CAAC,GAAG,GAAG,IAAI,SAAG,CAAC,MAAM,CAAC,CAAC;QAE3B,oCAAoC;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;CACF;AArBD,kCAqBC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@sinch/sdk-core",
+  "version": "0.0.0",
+  "description": "Node.js client for the Sinch API platform",
+  "homepage": "",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "license": "Apache-2.0",
+  "author": "Sinch",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "directories": {
+    "src": "dist",
+    "test": "tests"
+  },
+  "files": ["/dist"],
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "compile": "tsc --build --verbose"
+  },
+  "dependencies": {
+    "@sinch/numbers": "^0.0.0",
+    "@sinch/sms": "^0.0.0",
+    "@sinch/verification": "^0.0.0"
+  },
+  "devDependencies": {},
+  "publishConfig": {
+    "directory": "dist"
+  }
+}