@sinch/numbers 1.1.0 → 1.2.0

package/dist/models/v1/active-number/active-number.d.ts

@@ -1,6 +1,6 @@
 import { Money } from '../money';
-import { SMSConfiguration } from '../sms-configuration';
-import { VoiceConfiguration } from '../voice-configuration';
+import { SMSConfigurationResponse } from '../sms-configuration';
+import { VoiceConfigurationResponse } from '../voice-configuration';
 import { CapabilitiesEnum, NumberTypeEnum } from '../enums';
 /**
  * The phone number that has been rented by a customer and assigned to a project.
@@ -27,9 +27,9 @@ export interface ActiveNumber {
     /** The timestamp when the subscription will expire if an expiration date has been set. */
     expireAt?: Date | null;
     /** @see SMSConfiguration */
-    smsConfiguration?: SMSConfiguration;
+    smsConfiguration?: SMSConfigurationResponse;
     /** @see VoiceConfiguration */
-    voiceConfiguration?: VoiceConfiguration;
+    voiceConfiguration?: VoiceConfigurationResponse;
     /** The active number\'s callback URL to be called for provisioning / deprovisioning updates */
     callbackUrl?: string;
 }

package/dist/models/v1/sms-configuration/index.d.ts

@@ -1 +1 @@
-export type { SMSConfiguration } from './sms-configuration';
+export type { SMSConfiguration, SMSConfigurationResponse } from './sms-configuration';

package/dist/models/v1/sms-configuration/sms-configuration.d.ts

@@ -7,6 +7,8 @@ export interface SMSConfiguration {
     servicePlanId: string;
     /** Only for US virtual numbers. This campaign ID relates to <a href=\"https://community.sinch.com/t5/10DLC/What-is-10DLC/ta-p/7845\" target=\"_blank\">10DLC numbers</a>. So, it is the current campaign ID for this number. The `campaignId` is found on your TCR platform. */
     campaignId?: string;
+}
+export interface SMSConfigurationResponse extends SMSConfiguration {
     /** @see ScheduledProvisioning */
     scheduledProvisioning?: ScheduledProvisioning | null;
 }

package/dist/models/v1/voice-configuration/index.d.ts

@@ -1 +1 @@
-export type { VoiceConfiguration } from './voice-configuration';
+export type { VoiceConfiguration, VoiceConfigurationRtc, VoiceConfigurationFax, VoiceConfigurationEst, VoiceConfigurationResponse, } from './voice-configuration';

package/dist/models/v1/voice-configuration/voice-configuration.d.ts

@@ -1,8 +1,30 @@
 import { ScheduledVoiceProvisioning } from '../scheduled-voice-provisioning';
+/**
+ * The current voice configuration for this number.
+ */
+export type VoiceConfiguration = VoiceConfigurationRtc | VoiceConfigurationFax | VoiceConfigurationEst;
+export interface VoiceConfigurationRtc {
+    /** The voice application type. */
+    type: 'RTC';
+    /** Your app ID for the Voice API. The `appId` can be found in your <a href="https://dashboard.sinch.com/voice/apps" target="_blank">Sinch Customer Dashboard</a> under Voice, then apps. */
+    appId?: string;
+}
+export interface VoiceConfigurationFax {
+    /** The voice application type. */
+    type: 'FAX';
+    /** The service ID for the FAX configuration. The `serviceId` can be found in your <a href="https://dashboard.sinch.com/fax/services" target="_blank">Sinch Customer Dashboard</a> under fax, then services.*/
+    serviceId?: string;
+}
+export interface VoiceConfigurationEst {
+    /** The voice application type. */
+    type: 'EST';
+    /** The trunk ID for the EST voice configuration. The `trunkId` can be found in your <a href="https://dashboard.sinch.com/sip/trunks" target="_blank">Sinch Customer Dashboard</a> under sip, then trunks.*/
+    trunkId?: string;
+}
 /**
  * The current voice configuration for this number. During scheduled provisioning, the app ID value may be empty in a response if it is still processing or if it has failed. The status of scheduled provisioning will show under a `scheduledVoiceProvisioning` object if it\'s still running. Once processed successfully, the `appId` sent will appear directly under the `voiceConfiguration` object.
  */
-export interface VoiceConfiguration {
+export interface VoiceConfigurationResponse {
     /** Your app ID for the Voice API. The `appId` can be found in your <a href="https://dashboard.sinch.com/voice/apps" target="_blank">Sinch Customer Dashboard</a> under Voice, then apps. */
     appId?: string;
     /** Timestamp when the status was last updated. */

package/dist/rest/v1/numbers-service.d.ts

@@ -1,8 +1,9 @@
-import { SinchClientParameters } from '@sinch/sdk-client';
+import { ApiListPromise, SinchClientParameters } from '@sinch/sdk-client';
 import { AvailableRegionsApi } from './available-regions';
 import { CallbacksApi } from './callbacks';
 import { AvailableNumberApi } from './available-number';
 import { ActiveNumberApi } from './active-number';
+import { ActiveNumber, AvailableNumber, AvailableNumbersResponse, GetActiveNumberRequestData, GetAvailableNumberRequestData, ListActiveNumbersRequestData, ListAvailableNumbersRequestData, ReleaseNumberRequestData, RentAnyNumberRequestData, RentNumberRequestData, UpdateActiveNumberRequestData } from '../../models';
 /**
  * The Numbers Service exposes the following APIs:
  *  - availableRegions
@@ -13,7 +14,9 @@ import { ActiveNumberApi } from './active-number';
 export declare class NumbersService {
     readonly availableRegions: AvailableRegionsApi;
     readonly callbacks: CallbacksApi;
+    /** @deprecated Use the methods exposed at the Numbers Service level instead */
     readonly availableNumber: AvailableNumberApi;
+    /** @deprecated Use the methods exposed at the Numbers Service level instead */
     readonly activeNumber: ActiveNumberApi;
     /**
      * Create a new NumbersService instance with its configuration. It needs the following parameters for authentication:
@@ -32,4 +35,49 @@ export declare class NumbersService {
      * @param {string} hostname - The new hostname to use for all the APIs.
      */
     setHostname(hostname: string): void;
+    /**
+     * This endpoint allows you to enter a specific phone number to check if it's available for use.
+     * A 200 response will return the number's capability, setup costs, monthly costs and if supporting documentation is required.
+     * If the phone number is not available, the API will return a 404 error.
+     * @param {GetAvailableNumberRequestData} data - The data to provide to the API call.
+     */
+    checkAvailability(data: GetAvailableNumberRequestData): Promise<AvailableNumber>;
+    /**
+     * Search for virtual numbers that are available for you to activate. You can filter by any property on the available number resource.
+     * @param {ListAvailableNumbersRequestData} data - The data to provide to the API call.
+     */
+    searchForAvailableNumbers(data: ListAvailableNumbersRequestData): Promise<AvailableNumbersResponse>;
+    /**
+     * Rent any virtual number that matches the criteria (Search for and activate an available Sinch virtual number all in one API call).
+     * @param {RentAnyNumberRequestData} data - The data to provide to the API call.
+     */
+    rentAny(data: RentAnyNumberRequestData): Promise<ActiveNumber>;
+    /**
+     * Rent a virtual number to use with SMS products, Voice products, or both. You'll use 'smsConfiguration' to set up your number for SMS and 'voiceConfiguration' for Voice.
+     * @param {RentNumberRequestData} data - The data to provide to the API call.
+     */
+    rent(data: RentNumberRequestData): Promise<ActiveNumber>;
+    /**
+     * Retrieve a virtual number's details
+     * @param {GetActiveNumberRequestData} data - The data to provide to the API call.
+     */
+    get(data: GetActiveNumberRequestData): Promise<ActiveNumber>;
+    /**
+     * Lists all virtual numbers for a project.
+     * @param {ListActiveNumbersRequestData} data - The data to provide to the API call.
+     * @return {ApiListPromise<ActiveNumber>}
+     */
+    list(data: ListActiveNumbersRequestData): ApiListPromise<ActiveNumber>;
+    /**
+     * Release number.
+     * With this endpoint, you can cancel your subscription for a specific virtual phone number.
+     * @param {ReleaseNumberRequestData} data - The data to provide to the API call.
+     */
+    release(data: ReleaseNumberRequestData): Promise<ActiveNumber>;
+    /**
+     * Update a virtual phone number. For example: you can configure SMS/Voice services or set a friendly name. To update the name that displays, modify the `displayName` parameter.
+     * You'll use `smsConfiguration` to update your SMS configuration and `voiceConfiguration` to update the voice configuration.
+     * @param {UpdateActiveNumberRequestData} data - The data to provide to the API call.
+     */
+    update(data: UpdateActiveNumberRequestData): Promise<ActiveNumber>;
 }

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

@@ -40,6 +40,67 @@ class NumbersService {
         this.availableRegions.setHostname(hostname);
         this.callbacks.setHostname(hostname);
     }
+    /**
+     * This endpoint allows you to enter a specific phone number to check if it's available for use.
+     * A 200 response will return the number's capability, setup costs, monthly costs and if supporting documentation is required.
+     * If the phone number is not available, the API will return a 404 error.
+     * @param {GetAvailableNumberRequestData} data - The data to provide to the API call.
+     */
+    async checkAvailability(data) {
+        return this.availableNumber.checkAvailability(data);
+    }
+    /**
+     * Search for virtual numbers that are available for you to activate. You can filter by any property on the available number resource.
+     * @param {ListAvailableNumbersRequestData} data - The data to provide to the API call.
+     */
+    async searchForAvailableNumbers(data) {
+        return this.availableNumber.list(data);
+    }
+    /**
+     * Rent any virtual number that matches the criteria (Search for and activate an available Sinch virtual number all in one API call).
+     * @param {RentAnyNumberRequestData} data - The data to provide to the API call.
+     */
+    async rentAny(data) {
+        return this.availableNumber.rentAny(data);
+    }
+    /**
+     * Rent a virtual number to use with SMS products, Voice products, or both. You'll use 'smsConfiguration' to set up your number for SMS and 'voiceConfiguration' for Voice.
+     * @param {RentNumberRequestData} data - The data to provide to the API call.
+     */
+    async rent(data) {
+        return this.availableNumber.rent(data);
+    }
+    /**
+     * Retrieve a virtual number's details
+     * @param {GetActiveNumberRequestData} data - The data to provide to the API call.
+     */
+    async get(data) {
+        return this.activeNumber.get(data);
+    }
+    /**
+     * Lists all virtual numbers for a project.
+     * @param {ListActiveNumbersRequestData} data - The data to provide to the API call.
+     * @return {ApiListPromise<ActiveNumber>}
+     */
+    list(data) {
+        return this.activeNumber.list(data);
+    }
+    /**
+     * Release number.
+     * With this endpoint, you can cancel your subscription for a specific virtual phone number.
+     * @param {ReleaseNumberRequestData} data - The data to provide to the API call.
+     */
+    async release(data) {
+        return this.activeNumber.release(data);
+    }
+    /**
+     * Update a virtual phone number. For example: you can configure SMS/Voice services or set a friendly name. To update the name that displays, modify the `displayName` parameter.
+     * You'll use `smsConfiguration` to update your SMS configuration and `voiceConfiguration` to update the voice configuration.
+     * @param {UpdateActiveNumberRequestData} data - The data to provide to the API call.
+     */
+    async update(data) {
+        return this.activeNumber.update(data);
+    }
 }
 exports.NumbersService = NumbersService;
 //# sourceMappingURL=numbers-service.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"numbers-service.js","sourceRoot":"","sources":["../../../src/rest/v1/numbers-service.ts"],"names":[],"mappings":";;;AACA,2DAA0D;AAC1D,2CAA2C;AAC3C,yDAAwD;AACxD,mDAAkD;AAElD;;;;;;GAMG;AACH,MAAa,cAAc;IAMzB;;;;;;;;;OASG;IACH,YAAY,MAA6B;QACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,uCAAmB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,wBAAY,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,qCAAkB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,+BAAe,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAlCD,wCAkCC"}
+{"version":3,"file":"numbers-service.js","sourceRoot":"","sources":["../../../src/rest/v1/numbers-service.ts"],"names":[],"mappings":";;;AACA,2DAA0D;AAC1D,2CAA2C;AAC3C,yDAAwD;AACxD,mDAAkD;AAelD;;;;;;GAMG;AACH,MAAa,cAAc;IAQzB;;;;;;;;;OASG;IACH,YAAY,MAA6B;QACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,uCAAmB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,wBAAY,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,qCAAkB,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,+BAAe,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB,CAAC,IAAmC;QAChE,OAAO,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,IAAqC;QAC1E,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,IAA8B;QACjD,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CAAC,IAA2B;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,CAAC,IAAgC;QAC/C,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,IAAkC;QAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,IAA8B;QACjD,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAmC;QACrD,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACF;AAzGD,wCAyGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinch/numbers",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Sinch Numbers API",
   "homepage": "",
   "repository": {
@@ -25,13 +25,15 @@
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
-    "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests && rimraf tsconfig.build.tsbuildinfo"
+    "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.tests.json && rimraf dist/tests && rimraf tsconfig.build.tsbuildinfo",
+    "test:e2e": "cucumber-js"
   },
   "dependencies": {
-    "@sinch/sdk-client": "^1.1.0"
+    "@sinch/sdk-client": "^1.2.0"
   },
   "devDependencies": {},
   "publishConfig": {
-    "directory": "dist"
+    "directory": "dist",
+    "access": "public"
   }
 }