[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage Network SIM Swap # Vonage SIM Swap SDK for Node.js ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/network-sim-swap?label=%40vonage%2Fnetwork-sim-swap&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license] Vonage This is the Vonage SIM Swap SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup]. For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/). - [Installation](#installation) - [Usage](#usage) - [Promises](#promises) - [Testing](#testing) ## Installation ### With NPM ```bash npm install @vonage/network-sim-swap ``` ### With Yarn ```bash yarn add @vonage/network-sim-swap ``` ## Usage Unlike the other SDK's this package is not include in the [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) ```js const { Auth } = require('@vonage/auth') const { SIMSwap } = require('@vonage/network-sim-swap') const credentials = new Auth({ applicationId: APP_ID, privateKey: PRIAVTE_KEY, }) const options = {} const simSwapClient = new SIMSwap(credentials, options) ``` Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/network-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/network-client/README.md#options) ## Promises Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response. ```js const resp = await simSwapClient.listSIMSwap() simSwapClient .checkSwapSim() .then((resp) => console.log(resp)) .catch((err) => console.error(err)) ``` ## Testing Run: ```bash npm run test ``` [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk [license]: _media/LICENSE.txt ## Classes ### SIMSwap Defined in: [network-sim-swap/lib/simSwap.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/simSwap.ts#L5) #### Extends - [`NetworkClient`](Vonage-Network-Auth.md#networkclient) #### Constructors ##### Constructor ```ts new SIMSwap(auth, config?): SIMSwap; ``` Defined in: network-client/dist/networkClient.d.ts:34 ###### Parameters ###### auth [`NetworkAuthParameters`](Vonage-Network-Auth.md#networkauthparameters) ###### config? [`NetworkConfigParameters`](Vonage-Network-Auth.md#networkconfigparameters) ###### Returns [`SIMSwap`](#simswap) ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`constructor`](Vonage-Network-Auth.md#networkclient#constructor-4) #### Properties ##### \_msisdn ```ts protected _msisdn: string; ``` Defined in: network-client/dist/networkClient.d.ts:21 The msisdn that will be used for API calls ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`_msisdn`](Vonage-Network-Auth.md#networkclient#_msisdn) ##### \_purpose? ```ts protected optional _purpose: FRAUD_PREVENTION_AND_DETECTION; ``` Defined in: network-client/dist/networkClient.d.ts:25 The purpose for the scope ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`_purpose`](Vonage-Network-Auth.md#networkclient#_purpose) ##### \_scope? ```ts protected optional _scope: Scope; ``` Defined in: network-client/dist/networkClient.d.ts:29 The scope for the token ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`_scope`](Vonage-Network-Auth.md#networkclient#_scope) ##### accessToken? ```ts protected optional accessToken: string; ``` Defined in: network-client/dist/networkClient.d.ts:13 The current token ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`accessToken`](Vonage-Network-Auth.md#networkclient#accesstoken) ##### auth ```ts protected auth: AuthInterface; ``` Defined in: server-client/dist/lib/client.d.ts:24 The authentication instance responsible for generating authentication headers and query parameters. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`auth`](Vonage-Network-Auth.md#networkclient#auth) ##### authType? ```ts protected optional authType: CIBA = AuthenticationType.CIBA; ``` Defined in: [network-sim-swap/lib/simSwap.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/simSwap.ts#L6) The type of authentication used for the client's requests. ###### Overrides [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`authType`](Vonage-Network-Auth.md#networkclient#authtype) ##### config ```ts protected config: NetworkConfigParameters; ``` Defined in: network-client/dist/networkClient.d.ts:33 Configuration settings for the client, including default hosts for various services and other request settings. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`config`](Vonage-Network-Auth.md#networkclient#config) ##### expires ```ts protected expires: number; ``` Defined in: network-client/dist/networkClient.d.ts:17 Timestamp until the token expires ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`expires`](Vonage-Network-Auth.md#networkclient#expires) ##### gettingToken ```ts protected gettingToken: boolean; ``` Defined in: network-client/dist/networkClient.d.ts:9 Flags if we are currently getting a token ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`gettingToken`](Vonage-Network-Auth.md#networkclient#gettingtoken) ##### transformers ```ts static transformers: object; ``` Defined in: server-client/dist/lib/client.d.ts:11 Static property containing utility transformers. ###### camelCaseObjectKeys ```ts camelCaseObjectKeys: PartialTransformFunction; ``` ###### kebabCaseObjectKeys ```ts kebabCaseObjectKeys: PartialTransformFunction; ``` ###### omit() ```ts omit: (keys, obj) => TransformedObject; ``` ###### Parameters ###### keys `string`[] ###### obj [`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform) ###### Returns [`TransformedObject`](Vonage-Server-Client.md#transformedobject) ###### snakeCaseObjectKeys ```ts snakeCaseObjectKeys: PartialTransformFunction; ``` ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`transformers`](Vonage-Network-Auth.md#networkclient#transformers) #### Accessors ##### msisdn ###### Get Signature ```ts get msisdn(): string; ``` Defined in: network-client/dist/networkClient.d.ts:40 Get the msisdn ###### Throws If the msisdn is not set ###### Returns `string` The msisdn ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`msisdn`](Vonage-Network-Auth.md#networkclient#msisdn) ##### purpose ###### Get Signature ```ts get purpose(): FRAUD_PREVENTION_AND_DETECTION; ``` Defined in: network-client/dist/networkClient.d.ts:48 Get the purpose ###### Throws If the purpose is not set ###### Throws If the purpose is not valid ###### Returns [`FRAUD_PREVENTION_AND_DETECTION`](Vonage-Network-Auth.md#purpose#fraud_prevention_and_detection) The purpose ###### Set Signature ```ts set purpose(value): void; ``` Defined in: network-client/dist/networkClient.d.ts:53 Set the purpose ###### Parameters ###### value [`FRAUD_PREVENTION_AND_DETECTION`](Vonage-Network-Auth.md#purpose#fraud_prevention_and_detection) The purpose ###### Returns `void` ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`purpose`](Vonage-Network-Auth.md#networkclient#purpose-1) ##### scope ###### Get Signature ```ts get scope(): Scope; ``` Defined in: network-client/dist/networkClient.d.ts:61 Get the scope ###### Throws If the scope is not set ###### Throws If the scope is not valid ###### Returns [`Scope`](Vonage-Network-Auth.md#scope) The scope ###### Set Signature ```ts set scope(value): void; ``` Defined in: network-client/dist/networkClient.d.ts:69 Set the scope ###### Throws If the scope is not valid ###### Throws If the scope is not set ###### Parameters ###### value [`Scope`](Vonage-Network-Auth.md#scope) The scope ###### Returns `void` ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`scope`](Vonage-Network-Auth.md#networkclient#scope-1) #### Methods ##### addAuthenticationToRequest() ```ts addAuthenticationToRequest(request): Promise; ``` Defined in: network-client/dist/networkClient.d.ts:78 Add authentication to the auth This will make the calls to get a network token if required. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request to add authentication to ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> The request with authentication added ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`addAuthenticationToRequest`](Vonage-Network-Auth.md#networkclient#addauthenticationtorequest) ##### addBasicAuthToRequest() ```ts protected addBasicAuthToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:71 Adds basic authentication headers to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`addBasicAuthToRequest`](Vonage-Network-Auth.md#networkclient#addbasicauthtorequest) ##### addJWTToRequest() ```ts protected addJWTToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:64 Adds a JWT to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`addJWTToRequest`](Vonage-Network-Auth.md#networkclient#addjwttorequest) ##### addQueryKeySecretToRequest() ```ts protected addQueryKeySecretToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:57 Adds API key and secret to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`addQueryKeySecretToRequest`](Vonage-Network-Auth.md#networkclient#addquerykeysecrettorequest) ##### addQueryKeySecretToRequestBody() ```ts protected addQueryKeySecretToRequestBody(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:50 Adds API key and secret to the request body. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`addQueryKeySecretToRequestBody`](Vonage-Network-Auth.md#networkclient#addquerykeysecrettorequestbody) ##### buildOIDCURL() ```ts buildOIDCURL(state?): string; ``` Defined in: network-client/dist/networkClient.d.ts:85 Build the URL for the OIDC flow ###### Parameters ###### state? `string` The state to use ###### Returns `string` The URL for the OIDC flow ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`buildOIDCURL`](Vonage-Network-Auth.md#networkclient#buildoidcurl) ##### checkSwapSim() ```ts checkSwapSim(params): Promise; ``` Defined in: [network-sim-swap/lib/simSwap.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/simSwap.ts#L8) ###### Parameters ###### params [`SIMSwapParameters`](#simswapparameters) ###### Returns `Promise`\<`boolean`\> ##### exchangeCodeForToken() ```ts exchangeCodeForToken(code): Promise; ``` Defined in: network-client/dist/networkClient.d.ts:92 Exchange the code for a network token ###### Parameters ###### code `string` The code to exchange ###### Returns `Promise`\<[`NetworkTokenResponse`](Vonage-Network-Auth.md#networktokenresponse)\> The network token token ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`exchangeCodeForToken`](Vonage-Network-Auth.md#networkclient#exchangecodefortoken) ##### getCIBAAccessToken() ```ts protected getCIBAAccessToken(cibaRequestId): Promise; ``` Defined in: network-client/dist/networkClient.d.ts:106 Get a network token ###### Parameters ###### cibaRequestId `string` The CIBA request id ###### Returns `Promise`\<[`NetworkTokenResponse`](Vonage-Network-Auth.md#networktokenresponse)\> The network token data ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`getCIBAAccessToken`](Vonage-Network-Auth.md#networkclient#getcibaaccesstoken) ##### getCIBARequestId() ```ts protected getCIBARequestId(): Promise; ``` Defined in: network-client/dist/networkClient.d.ts:112 Get an CIBA request id ###### Returns `Promise`\<`string`\> The CIBA request id ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`getCIBARequestId`](Vonage-Network-Auth.md#networkclient#getcibarequestid) ##### getCIBAToken() ```ts protected getCIBAToken(): Promise; ``` Defined in: network-client/dist/networkClient.d.ts:99 Get the access token for the CIBA flow This is a two step process. First we need to get an CIBA request id, then we can use that to get a network token. ###### Returns `Promise`\<`void`\> ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`getCIBAToken`](Vonage-Network-Auth.md#networkclient#getcibatoken) ##### getConfig() ```ts getConfig(): ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:36 ###### Returns [`ConfigParams`](Vonage-Server-Client.md#configparams) ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`getConfig`](Vonage-Network-Auth.md#networkclient#getconfig) ##### parseResponse() ```ts protected parseResponse(request, response): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:168 Parses the response based on its content type. ###### Type Parameters ###### T `T` The expected type of the parsed response data. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### response `Response` The raw response from the request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`parseResponse`](Vonage-Network-Auth.md#networkclient#parseresponse) ##### prepareBody() ```ts protected prepareBody(request): undefined | string; ``` Defined in: server-client/dist/lib/client.d.ts:158 Prepares the body for the request based on the content type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### Returns `undefined` \| `string` - The prepared request body as a string or undefined. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`prepareBody`](Vonage-Network-Auth.md#networkclient#preparebody) ##### prepareRequest() ```ts protected prepareRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:151 Prepares the request with necessary headers, authentication, and query parameters. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The initial request options. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The modified request options. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`prepareRequest`](Vonage-Network-Auth.md#networkclient#preparerequest) ##### sendDeleteRequest() ```ts sendDeleteRequest(url): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:78 Sends a DELETE request to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the DELETE request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the DELETE request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendDeleteRequest`](Vonage-Network-Auth.md#networkclient#senddeleterequest) ##### sendFormSubmitRequest() ```ts sendFormSubmitRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:86 Sends a POST request with form data to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? `Record`\<`string`, `undefined` \| `string`\> Optional payload containing form data to send with the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendFormSubmitRequest`](Vonage-Network-Auth.md#networkclient#sendformsubmitrequest) ##### sendGetRequest() ```ts sendGetRequest(url, queryParams?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:94 Sends a GET request to the specified URL with optional query parameters. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the GET request. ###### queryParams? Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the GET request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendGetRequest`](Vonage-Network-Auth.md#networkclient#sendgetrequest) ##### sendPatchRequest() ```ts sendPatchRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:104 Sends a PATCH request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PATCH request. ###### payload? Optional payload to be sent as the body of the PATCH request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PATCH request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendPatchRequest`](Vonage-Network-Auth.md#networkclient#sendpatchrequest) ##### sendPostRequest() ```ts sendPostRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:114 Sends a POST request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? Optional payload to be sent as the body of the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendPostRequest`](Vonage-Network-Auth.md#networkclient#sendpostrequest) ##### sendPutRequest() ```ts sendPutRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:124 Sends a PUT request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PUT request. ###### payload? Optional payload to be sent as the body of the PUT request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PUT request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendPutRequest`](Vonage-Network-Auth.md#networkclient#sendputrequest) ##### sendRequest() ```ts sendRequest(request): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:144 Sends a request adding necessary headers, handling authentication, and parsing the response. ###### Type Parameters ###### T `T` ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The options defining the request, including URL, method, headers, and data. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response from the request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendRequest`](Vonage-Network-Auth.md#networkclient#sendrequest) ##### sendRequestWithData() ```ts sendRequestWithData( method, url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:135 Sends a request with JSON-encoded data to the specified URL using the provided HTTP method. ###### Type Parameters ###### T `T` ###### Parameters ###### method The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable). [`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch) ###### url `string` The URL endpoint for the request. ###### payload? Optional payload to be sent as the body of the request, JSON-encoded. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the request. ###### Inherited from [`NetworkClient`](Vonage-Network-Auth.md#networkclient).[`sendRequestWithData`](Vonage-Network-Auth.md#networkclient#sendrequestwithdata) ## Type Aliases ### SIMSwapParameters ```ts type SIMSwapParameters = object; ``` Defined in: [network-sim-swap/lib/types/parameters/simSwapParameters.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/types/parameters/simSwapParameters.ts#L1) #### Properties ##### maxAge? ```ts optional maxAge: number; ``` Defined in: [network-sim-swap/lib/types/parameters/simSwapParameters.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/types/parameters/simSwapParameters.ts#L12) The number of days to check if the SIM was swapped From 1 to 2400 ##### phoneNumber ```ts phoneNumber: string; ``` Defined in: [network-sim-swap/lib/types/parameters/simSwapParameters.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/types/parameters/simSwapParameters.ts#L5) The Phone number to check if the SIM was swapped *** ### SIMSwapResponse ```ts type SIMSwapResponse = object; ``` Defined in: [network-sim-swap/lib/types/responses/simSwapResponse.ts:1](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/types/responses/simSwapResponse.ts#L1) #### Properties ##### swapped ```ts swapped: boolean; ``` Defined in: [network-sim-swap/lib/types/responses/simSwapResponse.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/network-sim-swap/lib/types/responses/simSwapResponse.ts#L5) Weahter the SIM was swapped or not