DEVEXP-595: [Bugfix] Remove scheduledProvisioning elements from updat…

examples/simple-examples/src/numbers/active/update.ts

@@ -1,4 +1,5 @@
 import {
+  getFaxServiceIdFromConfig,
   getNumberCallbackUrlFromConfig,
   getPhoneNumberFromConfig,
   getPrintFormat,
@@ -16,6 +17,7 @@ import { Numbers } from '@sinch/sdk-core';
   const phoneNumber = getPhoneNumberFromConfig();
   const servicePlanId = getServicePlanIdFromConfig();
   const callbackUrl = getNumberCallbackUrlFromConfig();
+  const faxServiceId = getFaxServiceIdFromConfig();
 
   const requestData: Numbers.UpdateActiveNumberRequestData= {
     phoneNumber,
@@ -24,6 +26,10 @@ import { Numbers } from '@sinch/sdk-core';
       smsConfiguration: {
         servicePlanId,
       },
+      voiceConfiguration: {
+        type: 'FAX',
+        serviceId: faxServiceId,
+      },
       callbackUrl,
     },
   };

packages/numbers/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Version 1.2.0
 - [Tech] Update dependency `@sinch/sdk-client` to `1.2.0`.
+- [Bugfix] Remove the "scheduledProvisioning" properties for SMS and Voice in the update number request.
 - [Deprecation notice] `availableNumber` and `activeNumber` subdomain are deprecated and all methods are now defined on the upper numbers service.
    All the methods names are the same except `availableNumber.list()` -> `searchForAvailableNumbers()`
 

packages/numbers/src/models/v1/active-number/active-number.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';
 
 /**
@@ -28,9 +28,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;
 }

packages/numbers/src/models/v1/sms-configuration/index.ts

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

packages/numbers/src/models/v1/sms-configuration/sms-configuration.ts

@@ -8,6 +8,9 @@ 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;
 }

packages/numbers/src/models/v1/voice-configuration/index.ts

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

packages/numbers/src/models/v1/voice-configuration/voice-configuration.ts

@@ -1,9 +1,35 @@
 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. */

packages/numbers/tests/rest/v1/numbers.steps.ts

@@ -92,7 +92,7 @@ Then('the response contains a rented phone number', () => {
   assert.equal(activeNumber.paymentIntervalMonths, 1);
   assert.deepEqual(activeNumber.nextChargeDate, new Date('2024-06-06T14:42:42.022227Z'));
   assert.equal(activeNumber.expireAt, null);
-  const expectedSmsConfiguration: Numbers.SMSConfiguration = {
+  const expectedSmsConfiguration: Numbers.SMSConfigurationResponse = {
     servicePlanId: '',
     campaignId: '',
     scheduledProvisioning: {
@@ -104,7 +104,7 @@ Then('the response contains a rented phone number', () => {
     },
   };
   assert.deepEqual(activeNumber.smsConfiguration, expectedSmsConfiguration);
-  const expectedVoiceConfiguration: Numbers.VoiceConfiguration = {
+  const expectedVoiceConfiguration: Numbers.VoiceConfigurationResponse = {
     type: 'RTC',
     appId: '',
     trunkId: '',
@@ -211,7 +211,7 @@ When('I send a request to update the phone number {string}', async (phoneNumber:
 Then('the response contains a phone number with updated parameters', () => {
   assert.equal(activeNumber.displayName, 'Updated description during E2E tests');
   assert.equal(activeNumber.callbackUrl, 'https://my-callback-server.com/numbers');
-  const smsConfiguration: Numbers.SMSConfiguration = {
+  const smsConfiguration: Numbers.SMSConfigurationResponse = {
     servicePlanId: 'SpaceMonkeySquadron',
     campaignId: '',
     scheduledProvisioning: {
@@ -223,7 +223,7 @@ Then('the response contains a phone number with updated parameters', () => {
     },
   };
   assert.deepEqual(activeNumber.smsConfiguration, smsConfiguration);
-  const voiceVonfiguration: Numbers.VoiceConfiguration = {
+  const voiceVonfiguration: Numbers.VoiceConfigurationResponse = {
     type: 'RTC',
     appId: 'sunshine-rain-drop-very-beautifulday',
     trunkId: '',