Skip to content

Commit 110f4d1

Browse files
bharatmuralibharatmurali
authored
chore(env): update descriptions for additional clarity (#175)
1 parent be2d2bf commit 110f4d1

File tree

18 files changed

+44
-38
lines changed

18 files changed

+44
-38
lines changed

‎blocklist-call/.env

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# description: The list of numbers you want to reject
1+
# description: Only phone numbers in this comma-separated list will be allowed to join the conference. All phone numbers must follow the E.164 format
22
# format: list(phone_number)
33
# required: true
4+
# link: https://www.twilio.com/docs/glossary/what-e164
45
BLOCKLIST="+12125551234,+17025556789"
56

67
# description: The path to the webhook

‎conference-caller-gated/.env

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
# required: true
44
MODERATOR_PHONE_NUMBER=
55

6-
# description: Phone numbers in E.164 format of valid participants. Comma separated
6+
# description: Only phone numbers in this comma-separated list will be allowed to join the conference. All phone numbers must follow the E.164 format
77
# format: list(phone_number)
88
# required: true
9+
# link: https://www.twilio.com/docs/glossary/what-e164
910
VALID_PARTICIPANTS=
1011

1112
# description: The path to the webhook

‎conference-pin/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# description: A PIN code (only digits) that the caller has to enter to be connected to your conference line
1+
# description: Choose a PIN code (only digits) for your app. Callers have to enter this code to be connected to your conference line
22
# format: integer
33
# required: true
44
CONFERENCE_PIN=

‎conference-verify/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ VERIFY_SERVICE_SID=
88
# required: true
99
MODERATOR_PHONE_NUMBER=
1010

11-
# description: Phone numbers in E.164 format of valid participants. Comma separated
11+
# description: Only phone numbers in this comma-separated list will be allowed to join the conference. All phone number must use E.164 format
1212
# format: list(phone_number)
1313
# required: true
1414
VALID_PARTICIPANTS=

‎forward-call/.env

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# description: The number you want to forward incoming calls to
1+
# description: Calls made to your Twilio number will get forwarded to this e164-formatted phone number
22
# format: phone_number
33
# required: true
4+
# link: https://www.twilio.com/docs/glossary/what-e164
45
MY_PHONE_NUMBER=+12223334444
56

67
# description: The path to the webhook

‎forward-message-mailgun/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ MAILGUN_API_KEY=
77
#format: text
88
MG_VERIFIED_DOMAIN=
99

10-
# description: The email address to forward the message to
10+
# description: Messages sent to your Twilio number will be forwarded to this email address
1111
# format: email
1212
# required: true
1313
TO_EMAIL_ADDRESS=

‎forward-message-sendgrid/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# required: true
55
SENDGRID_API_KEY=
66

7-
# description: The email address to forward the message to
7+
# description: Messages sent to your Twilio number will be forwarded to this email address
88
# format: email
99
# required: true
1010
TO_EMAIL_ADDRESS=

‎forward-message-sparkpost/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# required: true
55
SPARKPOST_API_KEY=
66

7-
# description: The email address to forward the message to
7+
# description: Messages sent to your Twilio number will be forwarded to this email address
88
# format: email
99
# required: true
1010
TO_EMAIL_ADDRESS=

‎forward-message/.env

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# description: The number you want to forward incoming messages to
1+
# description: Messages sent to your Twilio number will get forwarded to this E.164-formatted phone number
22
# format: phone_number
33
# required: true
4+
# link: https://www.twilio.com/docs/glossary/what-e164
45
MY_PHONE_NUMBER=+12223334444
56

67
# description: The path to the webhook

‎masked-number/.env

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# description: The number you want to forward incoming messages to
1+
# description: Messages sent to your Twilio number will get forwarded to this E.164-formatted phone number
22
# format: phone_number
33
# required: true
4-
MY_PHONE_NUMBER=+1112223333
4+
# link: https://www.twilio.com/docs/glossary/what-e164
5+
MY_PHONE_NUMBER=+12223334444
56

67
# description: The path to the webhook
78
# configurable: false

‎masked-number/tests/relay-sms.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const mockTwilioClient = {
1818

1919
const context = {
2020
getTwilioClient: () => mockTwilioClient,
21-
MY_PHONE_NUMBER: '+1112223333',
21+
MY_PHONE_NUMBER: '+12223334444',
2222
};
2323

2424
const baseEvent = {

‎sip-quickstart/.env

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# description: The name of your SIP application
1+
# description: Choose a name for your application
22
# format: text
33
# required: true
44
APP_NAME=SIP Quickstart
55

6-
# description: A password to protect your admin interface
6+
# description: Set a password for your app. Users who want to use the admin interface will have to use this password to access it
77
# format: text
88
# required: true
99
ADMIN_PASSWORD=default

‎sms-notifications/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# required: true
44
TWILIO_PHONE_NUMBER=
55

6-
# description: Passcode for your SMS notifications app
6+
# description: Choose a passcode for your app. Users have to use this passcode to send SMS broadcasts
77
# format: text
88
# required: true
99
PASSCODE=

‎video/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ API_KEY=
1010
# required: true
1111
API_SECRET=
1212

13-
# description: Passcode for your Video chat app
13+
# description: Choose a passcode for your app. Users have to use this passcode to enter the video call
1414
# format: text
1515
# required: true
1616
PASSCODE=

‎voice-client-javascript/.env

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
# See: /admin/index.html
33
# Be cautious adding values to this file as they will override the environment's values.
44

5-
# description: TwiML application name
5+
# description: Choose a name for your application
66
# format: text
77
# required: true
88
APP_NAME=voice-client-javascript
99

10-
# description: the password to protect your admin interface
10+
# description: Set a password for your app. Users who want to use the admin interface will have to use this password to access it
1111
# format: text
1212
# required: true
1313
ADMIN_PASSWORD=default

‎voicemail/.env

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
1-
# description: The phone number to forward the phone calls to
1+
# description: Calls made to your Twilio number will get forwarded to this E.164-formatted phone number
22
# format: phone_number
33
# required: true
4-
MY_PHONE_NUMBER=+1112223333
4+
# link: https://www.twilio.com/docs/glossary/what-e164
5+
MY_PHONE_NUMBER=+12223334444
56

6-
# description: The timezone offset from UTC to check for business hours
7+
# description: The timezone offset from UTC to check for business hours (-8 for PST, -5 for EST)
78
# format: integer
89
# required: false
910
TIMEZONE_OFFSET=0
1011

11-
# description: Day of the week where the business hours should start applying. 0-6 = Sunday - Saturday. 1 = Monday
12+
# description: Day of the week where the business hours should start applying. 0-6 = Sunday - Saturday. Default is set to 1, which is Monday
1213
# format: integer
1314
# required: false
1415
WORK_WEEK_START=1
1516

16-
# description: Day of the week after which the business hours should stop applying. 0-6 = Sunday - Saturday. 5 = Friday
17+
# description: Day of the week after which the business hours should stop applying. 0-6 = Sunday - Saturday. Default is set to 5, which is Friday
1718
# format: integer
1819
# required: false
1920
WORK_WEEK_END=5
2021

21-
# description: Hour of the day where business hours should start. 0-23. 8 = 8:00:00 = 8:00:00AM
22+
# description: Hour of the day where business hours should start. 0-23. Default is set to 8, meaning business hours start at 8:00:00AM
2223
# format: integer
2324
# required: false
2425
WORK_HOUR_START=8
2526

26-
# description: Hour of the day where business hours should stop. 0-23. 18 = 18:59:59 = 6:59:59PM
27+
# description: Hour of the day where business hours should stop. 0-23. Default is set to 18, meaning business hours end at 18:59:59 or 6:59:59PM
2728
# format: integer
2829
# required: false
2930
WORK_HOUR_END=18

‎voicemail/tests/recoding.test.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const mockClient = {
3838

3939
let context = {
4040
getTwilioClient: () => mockClient,
41-
MY_PHONE_NUMBER: '+1112223333',
41+
MY_PHONE_NUMBER: '+12223334444',
4242
};
4343
let event = {
4444
RecordingUrl: 'http://localhost/demo',
@@ -63,7 +63,7 @@ test('sends an sms', done => {
6363
expect(mockClient.messages.create.mock.calls[0]).toEqual([
6464
{
6565
from: '+1234567890',
66-
to: '+1112223333',
66+
to: '+12223334444',
6767
body:
6868
'You have a new message to your Twilio voicemail from +9998887777.\nhttp://localhost/demo',
6969
},

‎voicemail/tests/voicemail.test.js

+11-11
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ test('returns a VoiceResponse', done => {
3838
test('forwards calls during business hours', done => {
3939
context = {
4040
PATH: '/demo/voicemail',
41-
MY_PHONE_NUMBER: '+1112223333',
41+
MY_PHONE_NUMBER: '+12223334444',
4242
};
4343

4444
const callback = (err, result) => {
4545
expect(result.toString()).toMatch(
46-
'<Response><Dial>+1112223333</Dial></Response>'
46+
'<Response><Dial>+12223334444</Dial></Response>'
4747
);
4848
done();
4949
};
@@ -54,7 +54,7 @@ test('forwards calls during business hours', done => {
5454
test('allows to configure business week start', done => {
5555
context = {
5656
PATH: '/demo/voicemail',
57-
MY_PHONE_NUMBER: '+1112223333',
57+
MY_PHONE_NUMBER: '+12223334444',
5858
WORK_WEEK_START: 2,
5959
};
6060

@@ -73,7 +73,7 @@ test('allows to configure business week start', done => {
7373
test('allows to configure business hours start', done => {
7474
context = {
7575
PATH: '/demo/voicemail',
76-
MY_PHONE_NUMBER: '+1112223333',
76+
MY_PHONE_NUMBER: '+12223334444',
7777
WORK_HOUR_START: 9,
7878
};
7979

@@ -92,7 +92,7 @@ test('allows to configure business hours start', done => {
9292
test('allows to configure business week end', done => {
9393
context = {
9494
PATH: '/demo/voicemail',
95-
MY_PHONE_NUMBER: '+1112223333',
95+
MY_PHONE_NUMBER: '+12223334444',
9696
WORK_WEEK_END: 4,
9797
};
9898

@@ -111,7 +111,7 @@ test('allows to configure business week end', done => {
111111
test('allows to configure business hours end', done => {
112112
context = {
113113
PATH: '/demo/voicemail',
114-
MY_PHONE_NUMBER: '+1112223333',
114+
MY_PHONE_NUMBER: '+12223334444',
115115
WORK_HOUR_END: 16,
116116
};
117117

@@ -130,15 +130,15 @@ test('allows to configure business hours end', done => {
130130
test('handles timezone offset', done => {
131131
context = {
132132
PATH: '/demo/voicemail',
133-
MY_PHONE_NUMBER: '+1112223333',
133+
MY_PHONE_NUMBER: '+12223334444',
134134
TIMEZONE_OFFSET: '-1',
135135
};
136136

137137
mockedTimeString = '2020-02-13T18:59:00.000Z';
138138

139139
const callback = (err, result) => {
140140
expect(result.toString()).toMatch(
141-
'<Response><Dial>+1112223333</Dial></Response>'
141+
'<Response><Dial>+12223334444</Dial></Response>'
142142
);
143143
done();
144144
};
@@ -149,7 +149,7 @@ test('handles timezone offset', done => {
149149
test('handles timezone offset outside business hours', done => {
150150
context = {
151151
PATH: '/demo/voicemail',
152-
MY_PHONE_NUMBER: '+1112223333',
152+
MY_PHONE_NUMBER: '+12223334444',
153153
TIMEZONE_OFFSET: '-1',
154154
};
155155

@@ -168,7 +168,7 @@ test('handles timezone offset outside business hours', done => {
168168
test('sends default message outside of business hours', done => {
169169
context = {
170170
PATH: '/demo/voicemail',
171-
MY_PHONE_NUMBER: '+1112223333',
171+
MY_PHONE_NUMBER: '+12223334444',
172172
};
173173

174174
mockedTimeString = '2020-02-13T19:00:00.000Z';
@@ -186,7 +186,7 @@ test('sends default message outside of business hours', done => {
186186
test('sends translated message outside of business hours', done => {
187187
context = {
188188
PATH: '/demo/voicemail',
189-
MY_PHONE_NUMBER: '+1112223333',
189+
MY_PHONE_NUMBER: '+12223334444',
190190
};
191191

192192
event = {

0 commit comments

Comments
 (0)