Skip to content

Commit

Permalink
docs: updating status of verify v2
Browse files Browse the repository at this point in the history
  • Loading branch information
manchuck committed Jun 17, 2024
1 parent 70f9c25 commit a14b999
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,18 @@ The following is a list of Vonage APIs and whether the Node Server SDK provides
| Alerts API | General Availability ||
| Application API | General Availability ||
| Audit API | Beta ||
| Conversation API | Beta | |
| Conversation API | General Availability | |
| Dispatch API | Beta ||
| External Accounts API | Beta ||
| Media API | Beta | |
| Messages API | Beta ||
| Media API | Beta | |
| Messages API | General Availability ||
| Number Insight V2 API | Beta ||
| Number Insights API | General Availability ||
| Number Management API | General Availability ||
| Pricing API | General Availability ||
| Proactive Connect API | Beta ||
| Redact API | Developer Preview ||
| Reports API | Beta | |
| Reports API | Beta | |
| SMS API | General Availability ||
| Sub Accounts | Beta ||
| Users | General Availability ||
Expand Down
8 changes: 4 additions & 4 deletions packages/server-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,18 @@ The following is a list of Vonage APIs and whether the Node Server SDK provides
| Alerts API | General Availability ||
| Application API | General Availability ||
| Audit API | Beta ||
| Conversation API | Beta | |
| Conversation API | General Availability | |
| Dispatch API | Beta ||
| External Accounts API | Beta ||
| Media API | Beta | |
| Messages API | Beta ||
| Media API | Beta | |
| Messages API | General Availability ||
| Number Insight V2 API | Beta ||
| Number Insights API | General Availability ||
| Number Management API | General Availability ||
| Pricing API | General Availability ||
| Proactive Connect API | Beta ||
| Redact API | Developer Preview ||
| Reports API | Beta | |
| Reports API | Beta | |
| SMS API | General Availability ||
| Sub Accounts | Beta ||
| Users | General Availability ||
Expand Down
4 changes: 2 additions & 2 deletions packages/verify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Note: This package is only compatible with verify V1.

For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/).

If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/verify/v2_TO_v3_MIGRATION_GUIDE.md)
If you are updating from V2 to V3 of the SDK, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/verify/v2_TO_v3_MIGRATION_GUIDE.md)

- [Installation](#installation)
- [Usage](#usage)
Expand Down Expand Up @@ -44,7 +44,7 @@ If you are using this SDK as part of the Vonage Server SDK, you can access it as
```js
const { Vonage } = require('@vonage/server-sdk')

const credentials = {
const credentials = {
apiKey: API_KEY,
apiSecret: API_SECRET,
}
Expand Down
28 changes: 26 additions & 2 deletions packages/verify2/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Vonage Verify SDK for Node.js
# Vonage Verify V2 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/verify2?label=%40vonage%2Fverify2&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]

Expand All @@ -16,6 +16,10 @@ For full API documentation refer to [developer.vonage.com](https://developer.von

## 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 Verify API.

### With NPM

```bash
Expand All @@ -30,7 +34,27 @@ yarn add @vonage/verify2

## 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)
If you are using this SDK as part of the Vonage Server SDK, you can access it as the `verify2` property off of the client that you instantiate.

```js
const { Vonage } = require('@vonage/server-sdk')

const credentials = {
apiKey: API_KEY,
apiSecret: API_SECRET,
}
const options = {}
const vonage = new Vonage(credentials, options)

vonage.verify2
.newRequest()
.then((resp) => console.log(resp))
.catch((err) => console.error(err))
```

### Standalone

The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Verify V2 API. All you need to do is `require('@vonage/verify2')`, and use the returned object to create your own client.

```js
const { Auth } = require('@vonage/auth')
Expand Down

0 comments on commit a14b999

Please sign in to comment.