@sinch/sdk-core 0.0.2 → 0.0.3

package/README.md

@@ -21,7 +21,7 @@ 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.
+The `@sinch/sdk-core` package contains the entry point for an 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.
 
@@ -31,13 +31,14 @@ As there are different authentication schemes, the initialization method will de
 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({
+const sinch: Pick<SinchClient, 'conversation' | 'fax' | 'numbers' | 'sms'> = new SinchClient({
     projectId: 'my-project-id',
     keyId: 'my-key-id',
     keySecret: 'my-key-secret',
 });
+const numbersService = sinch.numbers;
 
-const response = await sinch.numbers.availableRegions.list({
+const response = await numbersService.availableRegions.list({
     types: 'LOCAL',
 });
 ```
@@ -48,16 +49,17 @@ The initialization method above will work for the APIs that supports the authent
 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';
+import { SinchClient } 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({
+const sinch: Pick<SinchClient, 'sms'> = 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 smsService = sinch.sms;
 
-const response = await sinch.sms.batches.get({
+const response = await smsService.batches.get({
     batch_id: '01HF28S9AABBBCCCCY92BJB569',
 });
 ```
@@ -72,18 +74,19 @@ 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({
+const sinch: Pick<SinchClient, 'verification' | 'voice'> = new SinchClient({
   applicationId: 'my-application-key',
   applicationSecret: 'my-application-secret',
 });
+const verificationService = sinch.verification;
 
-const response = await sinch.verification.verificationStatus.getById({
+const response = await verificationService.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.
+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)
@@ -97,12 +100,6 @@ Here is the list of the Sinch API and there level of support by the Node.js SDK:
 | Messaging              | SMS API                             |   ✅    |
 |                        | Conversation API                    |   ✅    |
 |                        | Fax 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

@@ -1,5 +1,6 @@
 export * from './sinch-client';
 export * from '@sinch/conversation';
+export * from '@sinch/fax';
 export * from '@sinch/numbers';
 export * from '@sinch/sms';
 export * from '@sinch/verification';

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./sinch-client"), exports);
 __exportStar(require("@sinch/conversation"), exports);
+__exportStar(require("@sinch/fax"), exports);
 __exportStar(require("@sinch/numbers"), exports);
 __exportStar(require("@sinch/sms"), exports);
 __exportStar(require("@sinch/verification"), exports);

package/dist/index.js.map

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

package/dist/sinch-client.d.ts

@@ -1,4 +1,5 @@
 import { ConversationService } from '@sinch/conversation';
+import { FaxService } from '@sinch/fax';
 import { NumbersService } from '@sinch/numbers';
 import { SmsService } from '@sinch/sms';
 import { VerificationService } from '@sinch/verification';
@@ -7,6 +8,7 @@ import { SinchClientParameters } from '@sinch/sdk-client';
 /** Sinch Client to declare and initialize the supported APIs */
 export declare class SinchClient {
     readonly conversation: ConversationService;
+    readonly fax: FaxService;
     readonly numbers: NumbersService;
     readonly sms: SmsService;
     readonly verification: VerificationService;

package/dist/sinch-client.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SinchClient = void 0;
 const conversation_1 = require("@sinch/conversation");
+const fax_1 = require("@sinch/fax");
 const numbers_1 = require("@sinch/numbers");
 const sms_1 = require("@sinch/sms");
 const verification_1 = require("@sinch/verification");
@@ -16,6 +17,8 @@ class SinchClient {
     constructor(params) {
         // Initialize the "Conversation" API
         this.conversation = new conversation_1.ConversationService(params);
+        // Initialize the "Fax" API
+        this.fax = new fax_1.FaxService(params);
         // Initialize the "Numbers" API
         this.numbers = new numbers_1.NumbersService(params);
         // Initialize the "SMS" API.

package/dist/sinch-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"sinch-client.js","sourceRoot":"","sources":["../src/sinch-client.ts"],"names":[],"mappings":";;;AAAA,sDAA0D;AAC1D,4CAAgD;AAChD,oCAAwC;AACxC,sDAA0D;AAC1D,wCAA4C;AAG5C,gEAAgE;AAChE,MAAa,WAAW;IAQtB;;;;OAIG;IACH,YAAY,MAA6B;QACvC,oCAAoC;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAmB,CAAC,MAAM,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,MAAM,CAAC,CAAC;QAE1C,4BAA4B;QAC5B,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAU,CAAC,MAAM,CAAC,CAAC;QAElC,oCAAoC;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAmB,CAAC,MAAM,CAAC,CAAC;QAEpD,6BAA6B;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF;AA7BD,kCA6BC"}
+{"version":3,"file":"sinch-client.js","sourceRoot":"","sources":["../src/sinch-client.ts"],"names":[],"mappings":";;;AAAA,sDAA0D;AAC1D,oCAAwC;AACxC,4CAAgD;AAChD,oCAAwC;AACxC,sDAA0D;AAC1D,wCAA4C;AAG5C,gEAAgE;AAChE,MAAa,WAAW;IAStB;;;;OAIG;IACH,YAAY,MAA6B;QACvC,oCAAoC;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAmB,CAAC,MAAM,CAAC,CAAC;QAEpD,2BAA2B;QAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAU,CAAC,MAAM,CAAC,CAAC;QAElC,+BAA+B;QAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,MAAM,CAAC,CAAC;QAE1C,4BAA4B;QAC5B,IAAI,CAAC,GAAG,GAAG,IAAI,gBAAU,CAAC,MAAM,CAAC,CAAC;QAElC,oCAAoC;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAmB,CAAC,MAAM,CAAC,CAAC;QAEpD,6BAA6B;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF;AAjCD,kCAiCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinch/sdk-core",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Node.js client for the Sinch API platform",
   "homepage": "",
   "repository": {
@@ -29,11 +29,12 @@
     "compile": "tsc --build --verbose"
   },
   "dependencies": {
-    "@sinch/conversation": "^0.0.2",
-    "@sinch/numbers": "^0.0.2",
-    "@sinch/sms": "^0.0.2",
-    "@sinch/verification": "^0.0.2",
-    "@sinch/voice": "^0.0.2"
+    "@sinch/conversation": "^0.0.3",
+    "@sinch/fax": "^0.0.3",
+    "@sinch/numbers": "^0.0.3",
+    "@sinch/sms": "^0.0.3",
+    "@sinch/verification": "^0.0.3",
+    "@sinch/voice": "^0.0.3"
   },
   "devDependencies": {},
   "publishConfig": {