Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions packages/identity-insights/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,20 @@

This is the Vonage Identity Insights 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.nexmo.com](https://developer.nexmo.com/).
For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/).

* [Installation](#installation)
* [Usage](#usage)
* [Promises](#promises)
* [Debugging](#debugging)
* [Testing](#testing)
* [Insights Release Status](#insights-release-status)

## Installation

We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Identity Insights API.
If you only need the Identity Insights API specifically, you may install this package directly.

### With NPM

Expand All @@ -33,8 +35,6 @@ yarn add @vonage/identity-insights

## 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
import { Auth } from "@vonage/auth";
import { IdentityInsights } from "@vonage/identity-insights";
Expand Down Expand Up @@ -107,12 +107,12 @@ insight implemented in this SDK:

| Insight | API Release Status |
|-----------------------|:--------------------:|
| Format | Beta |
| SIM Swap | Beta |
| Original Carrier | Beta |
| Current Carrier | Beta |
| Format | GA |
| SIM Swap | GA |
| Original Carrier | GA |
| Current Carrier | GA |
| Subscriber Match | Alpha |
| Location Verification | Developer Preview |
| Subscriber Match | Developer Preview |
| Roaming | Developer Preview |
| Reachability | Developer Preview |

Expand Down
2 changes: 1 addition & 1 deletion packages/identity-insights/__tests__/__dataSets__/post.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ const response = {
export default [
{
label: 'retrieve identity insights',
requests: [['/v0.1/identity-insights', 'POST', params]],
requests: [['/identity-insights/v1/requests', 'POST', params]],
responses: [[200, response]],
clientMethod: 'getIdentityInsights',
parameters: [params],
Expand Down
2 changes: 1 addition & 1 deletion packages/identity-insights/lib/identityInsights.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export class IdentityInsights extends Client {
params: IdentityInsightsParameters
): Promise<IdentityInsightsType> {
const resp = await this.sendPostRequest<IdentityInsightsResponse>(
`${this.config.identityInsightsHost}/v0.1/identity-insights`,
`${this.config.identityInsightsHost}/identity-insights/v1/requests`,
params
);

Expand Down
Loading