-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
642 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| # Vonage Redact SDK for Node.js | ||
|
|
||
|  | ||
| [](https://codecov.io/gh/Vonage/vonage-server-sdk) | ||
|  | ||
| [](../../CODE_OF_CONDUCT.md) | ||
| [][license] | ||
|
|
||
| <img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px" alt="Vonage" /> | ||
|
|
||
| This is the Vonage Redact (for version 1) 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]. | ||
|
|
||
| We recommend using this package as part of the overall | ||
| [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). | ||
|
|
||
| For full API documentation refer to | ||
| [developer.vonage.com](https://developer.vonage.com/). | ||
|
|
||
| - [Installation](#installation) | ||
| - [Usage](#using-the-vonage-redact-sdk) | ||
| - [Promises](#promises) | ||
| - [Testing](#testing) | ||
|
|
||
| ## 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 | ||
| Redact API. | ||
|
|
||
| ### With NPM | ||
|
|
||
| ```bash | ||
| npm install @vonage/redact | ||
| ``` | ||
|
|
||
| ### With Yarn | ||
|
|
||
| ```bash | ||
| yarn add @vonage/redact | ||
| ``` | ||
|
|
||
| ## Using the Vonage Redact SDK | ||
|
|
||
| ### As part of the Vonage Server SDK | ||
|
|
||
| If you are using this SDK as part of the Vonage Server SDK, you can access it | ||
| as the `redact` property off of the client that you instantiate. | ||
|
|
||
| ```js | ||
| const { Vonage } = require('@vonage/server-sdk') | ||
| const { ProductType, Type } = require('@vonage/redact'); | ||
|
|
||
| const credentials = { | ||
| apiKey: API_KEY, | ||
| apiSecret: API_SECRET, | ||
| } | ||
|
|
||
| const options = {} | ||
| const vonage = new Vonage(credentials, options) | ||
|
|
||
| vonage.redact | ||
| .redactMessage({ | ||
| id: '209ab3c7536542b91e8b5aef032f6861', | ||
| product: ProductType.SMS, | ||
| type: Type.INBOUND, | ||
| }) | ||
| .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 Messages API. All you need to do is | ||
| `require('@vonage/redact')`, and use the returned object to create your own | ||
| client. | ||
|
|
||
| ```js | ||
| const { Auth } = require('@vonage/auth') | ||
| const { Redact } = require('@vonage/redact') | ||
|
|
||
| const credentials = new Auth({ | ||
| apiKey: API_KEY, | ||
| apiSecret: API_SECRET, | ||
| }) | ||
| const options = {} | ||
| const redactClient = new Redact(credentials, options) | ||
| ``` | ||
|
|
||
| Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/tree/3.x/readme/packages/auth#options), | ||
| and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/tree/3.x/readme/packages/server-client#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 vonage.redact | ||
| .redactMessage({ | ||
| id: '209ab3c7536542b91e8b5aef032f6861', | ||
| product: ProductType.SMS, | ||
| type: Type.INBOUND, | ||
| }); | ||
|
|
||
| vonage.redact | ||
| .redactMessage({ | ||
| id: '209ab3c7536542b91e8b5aef032f6861', | ||
| product: ProductType.SMS, | ||
| type: Type.INBOUND, | ||
| }) | ||
| .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]: ../../LICENSE.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import redactTests from './redact'; | ||
|
|
||
| export default [ | ||
| { | ||
| label: 'Redact Transactions', | ||
| tests: redactTests, | ||
| }, | ||
| ]; |
Oops, something went wrong.