feat: Improve error message if an API Key is passed in place of an Auth Token #637
Conversation
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
…tor in place of Auth Token At present, if an auth token is provided instead of an API key the error 'accountSid must start with AC' is issued. This suggests that it is not possible to use API keys in place of auth tokens with twilio-node, when in fact API keys can be used but require an additional optional paramater to be used. The present error messages encourages poor practice as it indiciates that API keys cannot be used in place of auth tokens. This change implements a new error message that explains to developer the requirements in order to use API keys in the event that a API key SID is provided (whcih starts with "SK").
| @@ -137,6 +137,11 @@ function Twilio(username, password, opts) { | |||
| } | |||
|
|
|||
| if (!this.accountSid.startsWith('AC')) { | |||
|
|
|||
| if (this.accountSid.startsWith('SK')) { | |||
There was a problem hiding this comment.
Could you please add a test to verify this functionality?
We will be making this change internally, since this file is generated.
|
Closing until PR feedback is addressed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Fixes #600
At present, if an auth token is provided instead of an API key the error 'accountSid must start with AC' is issued. This suggests that it is not possible to use API keys in place of auth tokens with twilio-node, when in fact API keys can be used but require an additional optional paramater to be used.
The present error messages encourages poor practice as it indiciates that API keys cannot be used in place of auth tokens.
This change implements a new error message that explains to developer the requirements in order to use API keys in the event that a API key SID is provided (whcih starts with "SK").
Checklist