-
Notifications
You must be signed in to change notification settings - Fork 181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added typings for VoiceAPI#364 #379
Added typings for VoiceAPI#364 #379
Conversation
✨ Added new typings matching the voice API following as much as possible code style inside the file in which the change was made
Codecov Report
@@ Coverage Diff @@
## master #379 +/- ##
=======================================
Coverage 90.78% 90.78%
=======================================
Files 25 25
Lines 846 846
=======================================
Hits 768 768
Misses 78 78 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like I may have given some bad instructions. The PR looks great and matches the docs, however the typings won't line up with the SDK - https://github.com/Vonage/vonage-node-sdk/blob/master/src/Voice.js
If you could adjust the interfaces to match the SDK, and use the docs as a reference for types, I think we have it. Thanks!
typings/index.d.ts
Outdated
@@ -134,7 +134,7 @@ declare module '@vonage/server-sdk' { | |||
export interface RequestObject { | |||
brand: string; | |||
number: string; | |||
sender_id?: string; | |||
To_id?: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since these are updates to the messages interface, move the above changes into a separate PR. Thanks!
typings/index.d.ts
Outdated
dtmf(request: DTMFRequest, callback: (data: ModifyInProgressCallResponse) => void): void; | ||
__proto__: any; | ||
[key: string]: any; | ||
} | ||
|
||
/* Vonage */ | ||
export default class Vonage { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Voice class will need to be exported in the default class as well.
Oh I'm so sorry I missed that part! Absolutely, I will fix it and make it match with the SDK! |
There are a couple of recently closed PRs with typings done very well - you can check those as an example, and always feel free to ask questions. |
Matched methods in Voice class with Voice SDK. Also exported in the default class
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These look great - thanks for getting it ready to go.
Really? Amazing! I did some changes but still didn't know if they were okay, but completely forgot to ask you to review it, I'm glad this PR got approved! |
@PeppermintNDaisies I just realized there are some conflicts that need to be resolved. If you could get those fixed up, I'll get it merged in. The changes look fine - just need to get it up to date with master. |
Got it! |
@kellyjandrews Merge conflicts solved! |
* add types for verify API * fix comment * add e2e test to .npmignore * update app update readme * update dependencies * add workflow_id to Verify typings * cherry pick "refactor app with query" * cherry pick "add test and example" * cherry pick "getWithQuery" * Create package-lock.json * Update CHANGELOG.md * add app tests to make codecov happy * lint app-test.js * update error codes to strings * add back initial changes * Add new numbers fields to README * Add Pricing API * Make applicationId optional in TS typings * npm audit fix * Add steps for running code from an open PR * add Tony's suggestions * Minor improvement to be more specific * encoding query values in signed sms so that SMSs containing more than 1 word can be signed * modifying send signed example to have more than one word * add encoded message test * bump version * Update CHANGELOG.md * add optional host checks * add host change tests * update package & notes for release * remove deployment from travis * Add Code of Conduct * add some typing for message api * add: todo comment for fix verify api's typing * Add Vonage wordmark to README * Link to deployed version of image * remove singleton * lint fix * update tests * bump mocha and audit fix packages * add tests & get coverage to 90% * address Steve's comments * document callbacks and optional key / secret * add a note about compile * update readme and maintenance guide * update changelog and bump package version * Update ResourceTestHelper.js * Add PSD2 Support for Verify * Set version to 2.8.0 and fix typos * Bump package lock for new lib version * Bump lodash from 4.17.15 to 4.17.19 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.15...4.17.19) Signed-off-by: dependabot[bot] <support@github.com> * fix MessageRequestResponseStatusCode enum value to string * add target_api_key for number.buy * Fix issue with local options being overwritten with Nexmo * Update to Babel 7 * update number buy and cancel params * treat strings as keys by default also attempt to resolve common formatting issues when converting from string to buffer * Add an example for reading privateKey, add some string processing when loading creds * add new line fixes for key strings * audit fixes * 2.9.0 release * Fix Nexmo is not a constructor error Add add-module-exports Babel module back in and add Travis test to ensure that this works in the future * update change log * update package-lock file * Create ci.yml create integration test for CI * Create codecov.yml add codecov action * Update ci.yml update node-version reference * Update codecov.yml install all deps * Bump jsonwebtoken from 8.4.0 to 8.5.1 Bumps [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) from 8.4.0 to 8.5.1. - [Release notes](https://github.com/auth0/node-jsonwebtoken/releases) - [Changelog](https://github.com/auth0/node-jsonwebtoken/blob/master/CHANGELOG.md) - [Commits](auth0/node-jsonwebtoken@v8.4.0...v8.5.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/core from 7.10.5 to 7.11.5 Bumps [@babel/core](https://github.com/babel/babel/tree/HEAD/packages/babel-core) from 7.10.5 to 7.11.5. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.11.5/packages/babel-core) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump cross-env from 5.2.0 to 7.0.2 Bumps [cross-env](https://github.com/kentcdodds/cross-env) from 5.2.0 to 7.0.2. - [Release notes](https://github.com/kentcdodds/cross-env/releases) - [Changelog](https://github.com/kentcdodds/cross-env/blob/master/CHANGELOG.md) - [Commits](kentcdodds/cross-env@v5.2.0...v7.0.2) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Update codecov.yml change to codecov action * Update codecov.yml add back report generation * Bump body-parser from 1.18.3 to 1.19.0 Bumps [body-parser](https://github.com/expressjs/body-parser) from 1.18.3 to 1.19.0. - [Release notes](https://github.com/expressjs/body-parser/releases) - [Changelog](https://github.com/expressjs/body-parser/blob/master/HISTORY.md) - [Commits](expressjs/body-parser@1.18.3...1.19.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Remove example folder * change nexmo to vonage * modify tests to support vonage namespace * remove travis dep * modify user agent * Finishing changes for vonage change over * Bump bluebird from 3.5.3 to 3.7.2 Bumps [bluebird](https://github.com/petkaantonov/bluebird) from 3.5.3 to 3.7.2. - [Release notes](https://github.com/petkaantonov/bluebird/releases) - [Commits](petkaantonov/bluebird@v3.5.3...v3.7.2) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/plugin-proposal-object-rest-spread from 7.10.4 to 7.11.0 Bumps [@babel/plugin-proposal-object-rest-spread](https://github.com/babel/babel/tree/HEAD/packages/babel-plugin-proposal-object-rest-spread) from 7.10.4 to 7.11.0. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.11.0/packages/babel-plugin-proposal-object-rest-spread) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/register from 7.10.5 to 7.11.5 Bumps [@babel/register](https://github.com/babel/babel/tree/HEAD/packages/babel-register) from 7.10.5 to 7.11.5. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.11.5/packages/babel-register) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/core from 7.11.5 to 7.11.6 Bumps [@babel/core](https://github.com/babel/babel/tree/HEAD/packages/babel-core) from 7.11.5 to 7.11.6. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.11.6/packages/babel-core) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump ngrok from 2.3.0 to 3.2.7 Bumps [ngrok](https://github.com/bubenshchykov/ngrok) from 2.3.0 to 3.2.7. - [Release notes](https://github.com/bubenshchykov/ngrok/releases) - [Commits](https://github.com/bubenshchykov/ngrok/commits) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump express from 4.16.4 to 4.17.1 Bumps [express](https://github.com/expressjs/express) from 4.16.4 to 4.17.1. - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/master/History.md) - [Commits](expressjs/express@4.16.4...4.17.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump nyc from 14.1.1 to 15.1.0 Bumps [nyc](https://github.com/istanbuljs/nyc) from 14.1.1 to 15.1.0. - [Release notes](https://github.com/istanbuljs/nyc/releases) - [Changelog](https://github.com/istanbuljs/nyc/blob/master/CHANGELOG.md) - [Commits](istanbuljs/nyc@v14.1.1...v15.1.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/preset-env from 7.10.4 to 7.11.5 Bumps [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) from 7.10.4 to 7.11.5. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.11.5/packages/babel-preset-env) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * fix Vonage API text spacing * update support email * updates to contributing file * fix Vonage spacing issue * correct spacing issue * Bump eslint-config-prettier from 6.2.0 to 6.11.0 Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 6.2.0 to 6.11.0. - [Release notes](https://github.com/prettier/eslint-config-prettier/releases) - [Changelog](https://github.com/prettier/eslint-config-prettier/blob/master/CHANGELOG.md) - [Commits](prettier/eslint-config-prettier@v6.2.0...v6.11.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/cli from 7.10.5 to 7.11.6 Bumps [@babel/cli](https://github.com/babel/babel/tree/HEAD/packages/babel-cli) from 7.10.5 to 7.11.6. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.11.6/packages/babel-cli) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump dotenv from 2.0.0 to 8.2.0 Bumps [dotenv](https://github.com/motdotla/dotenv) from 2.0.0 to 8.2.0. - [Release notes](https://github.com/motdotla/dotenv/releases) - [Changelog](https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md) - [Commits](motdotla/dotenv@v2.0.0...v8.2.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump babel-plugin-istanbul from 4.1.6 to 6.0.0 Bumps [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul) from 4.1.6 to 6.0.0. - [Release notes](https://github.com/istanbuljs/babel-plugin-istanbul/releases) - [Changelog](https://github.com/istanbuljs/babel-plugin-istanbul/blob/master/CHANGELOG.md) - [Commits](istanbuljs/babel-plugin-istanbul@v4.1.6...v6.0.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump ngrok from 3.2.7 to 3.3.0 Bumps [ngrok](https://github.com/bubenshchykov/ngrok) from 3.2.7 to 3.3.0. - [Release notes](https://github.com/bubenshchykov/ngrok/releases) - [Commits](https://github.com/bubenshchykov/ngrok/commits/v3.3.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * remove unneeded dev dependencies * Bump babel-plugin-add-module-exports from 1.0.2 to 1.0.4 Bumps [babel-plugin-add-module-exports](https://github.com/59naga/babel-plugin-add-module-exports) from 1.0.2 to 1.0.4. - [Release notes](https://github.com/59naga/babel-plugin-add-module-exports/releases) - [Commits](https://github.com/59naga/babel-plugin-add-module-exports/commits) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump request from 2.88.0 to 2.88.2 Bumps [request](https://github.com/request/request) from 2.88.0 to 2.88.2. - [Release notes](https://github.com/request/request/releases) - [Changelog](https://github.com/request/request/blob/master/CHANGELOG.md) - [Commits](https://github.com/request/request/commits) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * fix links for markdown lint * update workflow rules * Add PR and Issue templates * update changelog * markdown cleanup * update package.json version * update package-lock.json * Correct license information (#347) * correct license information * update changelog * update version * readme updates * Fix typo in typings: `error-text` (#352) * Update README.md (#357) * chore(docs) : fix typo (#358) chore(docs) : fix typo * Update Vonage-test.js (#369) * fixed typo "for for" -> "for" (#370) * fix types module name (#355) * Bump eslint-config-prettier from 6.11.0 to 6.12.0 (#350) Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 6.11.0 to 6.12.0. - [Release notes](https://github.com/prettier/eslint-config-prettier/releases) - [Changelog](https://github.com/prettier/eslint-config-prettier/blob/master/CHANGELOG.md) - [Commits](prettier/eslint-config-prettier@v6.11.0...v6.12.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> * prep v2.10.2 * Updated uuid for performance improvement (#375) * Added typings for MediaApi (#376) * Added typings for MediaApi Fixes #361 * Added media to default class export * Allow for Full URL Overrides in Constructor (#378) * allow for full url overrides in constructor * fixed linting issues * lint fix part 2 * final lint fix * feat: added number typings (#380) * Typings for the Number Insight API (#373) * added typings for number-insight api * added .prettierignore to take care of linting fail on ci * added number-insight webhook interface and cleaned up status codes * rename request to options per src/NumberInsight.js * reverted prettier changes * fixed merge conflicts with the media api typings * downgraded prettier * restored order of babel-plugin-istanbul * feat: add number insight typings * fix: add missing options for NumberInsightObject * Bump @babel/register from 7.11.5 to 7.12.0 (#387) Bumps [@babel/register](https://github.com/babel/babel/tree/HEAD/packages/babel-register) from 7.11.5 to 7.12.0. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.12.0/packages/babel-register) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> * Bump @babel/cli from 7.11.6 to 7.12.0 (#386) Bumps [@babel/cli](https://github.com/babel/babel/tree/HEAD/packages/babel-cli) from 7.11.6 to 7.12.0. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.12.0/packages/babel-cli) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> * Bump @babel/preset-env from 7.11.5 to 7.12.0 (#384) Bumps [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) from 7.11.5 to 7.12.0. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.12.0/packages/babel-preset-env) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> * Bump @babel/core from 7.11.6 to 7.12.0 (#385) Bumps [@babel/core](https://github.com/babel/babel/tree/HEAD/packages/babel-core) from 7.11.6 to 7.12.0. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.12.0/packages/babel-core) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> * adding example with yarn in README.md (#400) * discriminating unions support for different message responses (#398) * Added typings for VoiceAPI#364 (#379) * Added typings for VoiceAPI#364 ✨ Added new typings matching the voice API following as much as possible code style inside the file in which the change was made * Added typings for VoiceAPI#364 Matched methods in Voice class with Voice SDK. Also exported in the default class * Restored sender_id in RequestObject interface Co-authored-by: Juliana Jaime <julianajaimej@gmail.com> * 2.10.3 release prep * fix issue with host override (#407) * fix issue with host override * remove protocol hardcode * 2.10.4 * add lock file * fix code of conduct merge * update http test Co-authored-by: jackTheRipper <baudin.jean@gmail.com> Co-authored-by: Alex Lakatos <alex.lakatos.qa@gmail.com> Co-authored-by: Rory Hughes <RoryDH@users.noreply.github.com> Co-authored-by: Lorna Jane Mitchell <lorna@lornajane.net> Co-authored-by: Tony Bedford <tony.bedford@vonage.com> Co-authored-by: slorello89 <slorello89@gmail.com> Co-authored-by: Stephen Lorello <42971704+slorello89@users.noreply.github.com> Co-authored-by: Ben Greenberg <benhayehudi@users.noreply.github.com> Co-authored-by: Lorna Jane Mitchell <lorna.mitchell@vonage.com> Co-authored-by: woorung <woorung@hpcnt.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Garann Means <garann.means@vonage.com> Co-authored-by: Michael Heap <m@michaelheap.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> Co-authored-by: Baptiste Marchand <baptistemarchand42@gmail.com> Co-authored-by: Pulkit Midha <midhapulkit28@gmail.com> Co-authored-by: Shivay Lamba <shivaylamba@gmail.com> Co-authored-by: Vishal Kichloo <31816531+kichloo@users.noreply.github.com> Co-authored-by: Zerplin <43621940+Zerplin@users.noreply.github.com> Co-authored-by: Eric Smekens <ericsmekens@msn.com> Co-authored-by: Rahul Singh <rahul.singh12221998@gmail.com> Co-authored-by: Kiran Mathew Mohan <privateomega@protonmail.com> Co-authored-by: Sudipto Ghosh <sudipto@ghosh.pro> Co-authored-by: Lucas Mesquita <lucasoliveira98@outlook.com> Co-authored-by: Daniel Glazer <danielglazer123@gmail.com> Co-authored-by: Juliana Jaime <mj.jaime10@uniandes.edu.co> Co-authored-by: Juliana Jaime <julianajaimej@gmail.com>
✨ Added new typings matching the voice API
Description
Added a voice API section at the end of typings/index.d.ts in which the typings for Voice API were added, following as much as possible code style inside the file in which the changes were made. A total of 16 interfaces and 1 class were added, nothing (code that was already there) was changed.
Motivation and Context
This solves issue #364
Testing Details
Example Output or Screenshots (if appropriate)
Types of changes
Checklist