@sinch/sms 0.0.4 → 0.0.5

package/dist/rest/v1/sms-service.js

@@ -5,7 +5,26 @@ const groups_1 = require("./groups");
 const delivery_reports_1 = require("./delivery-reports");
 const batches_1 = require("./batches");
 const inbounds_1 = require("./inbounds");
+/**
+ * The SMS Service exposes the following APIs:
+ *  - groups
+ *  - batches
+ *  - inbounds
+ *  - deliveryReports
+ */
 class SmsService {
+    /**
+     * Create a new SmsService instance with its configuration. This service can be instantiated with 2 different authentication mechanisms:
+     * - OAuth2: the required properties are `projectId`, `keyId` and `keySecret`
+     * - API Token: the required properties are `servicePlanId` and `apiToken`
+     *
+     * Other supported properties:
+     *  - `smsRegion`
+     *  - `smsHostname`
+     *  - `forceOAuth2ForSmsApi`
+     *  - `forceServicePlanIdUsageForSmsApi`
+     * @param {SinchClientParameters} params - an Object containing the necessary properties to initialize the service
+     */
     constructor(params) {
         this.groups = new groups_1.GroupsApi(params);
         this.deliveryReports = new delivery_reports_1.DeliveryReportsApi(params);
@@ -13,15 +32,24 @@ class SmsService {
         this.inbounds = new inbounds_1.InboundsApi(params);
     }
     /**
-     * Update the default basePath for each API
-     *
-     * @param {string} basePath - The new base path to use for all the APIs.
+     * Update the default hostname for each API
+     * @param {string} hostname - The new hostname to use for all the APIs.
+     */
+    setHostname(hostname) {
+        this.groups.setHostname(hostname);
+        this.deliveryReports.setHostname(hostname);
+        this.batches.setHostname(hostname);
+        this.inbounds.setHostname(hostname);
+    }
+    /**
+     * Update the current region for each API
+     * @param {SmsRegion} region - The new region to use in the production URL
      */
-    setBasePath(basePath) {
-        this.groups.setBasePath(basePath);
-        this.deliveryReports.setBasePath(basePath);
-        this.batches.setBasePath(basePath);
-        this.inbounds.setBasePath(basePath);
+    setRegion(region) {
+        this.groups.setRegion(region);
+        this.deliveryReports.setRegion(region);
+        this.batches.setRegion(region);
+        this.inbounds.setRegion(region);
     }
 }
 exports.SmsService = SmsService;

package/dist/rest/v1/sms-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"sms-service.js","sourceRoot":"","sources":["../../../src/rest/v1/sms-service.ts"],"names":[],"mappings":";;;AAGA,qCAAqC;AACrC,yDAAwD;AACxD,uCAAuC;AACvC,yCAAyC;AAEzC,MAAa,UAAU;IAMrB,YAAY,MAA6B;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAS,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,IAAI,qCAAkB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAW,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;CACF;AAxBD,gCAwBC"}
+{"version":3,"file":"sms-service.js","sourceRoot":"","sources":["../../../src/rest/v1/sms-service.ts"],"names":[],"mappings":";;;AAGA,qCAAqC;AACrC,yDAAwD;AACxD,uCAAuC;AACvC,yCAAyC;AAEzC;;;;;;GAMG;AACH,MAAa,UAAU;IAMrB;;;;;;;;;;;OAWG;IACH,YAAY,MAA6B;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAS,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,IAAI,qCAAkB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAU,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAW,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,QAAgB;QACjC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,MAAiB;QAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;CACF;AA9CD,gCA8CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinch/sms",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Sinch SMS API",
   "homepage": "",
   "repository": {
@@ -28,7 +28,7 @@
     "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests tsconfig.build.tsbuildinfo"
   },
   "dependencies": {
-    "@sinch/sdk-client": "^0.0.4"
+    "@sinch/sdk-client": "^0.0.5"
   },
   "devDependencies": {},
   "publishConfig": {