Skip to content

Commit 3118cb8

Browse files
superchilledsuperchilled
authored
2025 H1 Updates (#115)
Updates to code snippets to unify variable names and examples
1 parent 102db7e commit 3118cb8

File tree

123 files changed

+1054
-956
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+1054
-956
lines changed

‎.env-example‎

Lines changed: 100 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -2,93 +2,134 @@
22
VONAGE_API_KEY=
33
VONAGE_API_SECRET=
44
VONAGE_APPLICATION_ID=
5-
VONAGE_APPLICATION_PRIVATE_KEY_PATH=private.key
6-
TO_NUMBER=
5+
VONAGE_PRIVATE_KEY=private.key
6+
VONAGE_SIGNATURE_SECRET=
7+
VONAGE_VIRTUAL_NUMBER=
78
VONAGE_NUMBER=
9+
COUNTRY_CODE=
810

9-
# Vonage Messages API variables
11+
# Account
12+
ACCOUNT_ID=
13+
ACCOUNT_SECRET_ID=
14+
ACCOUNT_SECRET_VALUE=
15+
ACCOUNT_SMS_CALLBACK_URL=
1016

11-
## For Messages Sandbox
12-
MESSAGES_SANDBOX_URL=
13-
MESSAGES_SANDBOX_WHATSAPP_NUMBER=
14-
MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER=
15-
MESSAGES_SANDBOX_FB_ID=
16-
MESSAGES_SANDBOX_ALLOW_LISTED_FB_RECIPIENT_ID=
17-
MESSAGES_SANDBOX_VIBER_SERVICE_ID=
1817

19-
## For Facebook messaging
20-
FB_SENDER_ID=
21-
FB_RECIPIENT_ID=
18+
# Applications (includes user endpoints)
2219

23-
## For Viber messaging
24-
VIBER_SERVICE_MESSAGE_ID=
20+
# Audit
2521

26-
## For WhatsApp messaging
27-
WHATSAPP_NUMBER=
28-
WHATSAPP_TEMPLATE_NAMESPACE=
29-
WHATSAPP_TEMPLATE_NAME=
30-
WHATSAPP_AUTH_TEMPLATE_NAME=
31-
WHATSAPP_TEMPLATE_REPLACEMENT_TEXT=
22+
# Conversation
23+
24+
# Dispatch
25+
26+
# Messages
27+
28+
MESSAGES_TO_NUMBER=
29+
MESSAGES_API_URL=
30+
GEOSPECIFIC_MESSAGES_API_URL=
31+
MESSAGES_MESSAGE_ID=
32+
33+
## For SMS messaging
34+
35+
SMS_SENDER_ID=
36+
37+
## For MMS messaging
38+
MMS_SENDER_ID=
3239

3340
## For RCS messaging
3441
RCS_SENDER_ID=
3542

36-
## For media messaging (WhatsApp, Messenger, Viber)
37-
IMAGE_URL=
38-
IMAGE_CAPTION=
39-
FILE_URL=
40-
FILE_CAPTION=
41-
AUDIO_URL=
42-
VIDEO_URL=
43-
44-
## For Update Action
43+
# For WhatsApp messaging
44+
WHATSAPP_SENDER_ID=
45+
WHATSAPP_TEMPLATE_NAME=
46+
WHATSAPP_CATALOG_ID=
47+
WHATSAPP_PRODUCT_ID_1=
48+
WHATSAPP_PRODUCT_ID_2=
49+
WHATSAPP_OTP=
4550

46-
MESSAGE_UUID=
47-
GEOSPECIFIC_VONAGE_API_HOST=
51+
## For Facebook Messenger messaging
52+
MESSENGER_RECIPIENT_ID=
53+
MESSENGER_SENDER_ID=
4854

49-
# Vonage Number Insight variables
55+
## For Viber messaging
56+
VIBER_SENDER_ID=
57+
58+
## For media messaging (MMS, RCS, WhatsApp, Messenger, Viber)
59+
MESSAGES_IMAGE_URL=
60+
MESSAGES_AUDIO_URL=
61+
MESSAGES_VIDEO_URL=
62+
MESSAGES_VIDEO_DURATION=
63+
MESSAGES_VIDEO_FILE_SIZE=
64+
MESSAGES_FILE_URL=
65+
MESSAGES_VCARD_URL=
66+
MESSAGES_EMOJI=
67+
WHATSAPP_STICKER_ID=
68+
WHATSAPP_STICKER_URL=
69+
70+
# Number Insight
5071
INSIGHT_NUMBER=
72+
INSIGHT_CALLBACK_URL=
5173

52-
# Vonage Numbers API variables
53-
COUNTRY_CODE=
74+
# Number Verification
75+
76+
# Numbers
77+
VONAGE_NUMBER=
5478
VONAGE_NUMBER_TYPE=
5579
VONAGE_NUMBER_FEATURES=
5680
NUMBER_SEARCH_CRITERIA=
5781
NUMBER_SEARCH_PATTERN=
58-
SMS_CALLBACK_URL=
5982
VOICE_CALLBACK_TYPE=
6083
VOICE_CALLBACK_VALUE=
6184
VOICE_STATUS_URL=
85+
SMS_CALLBACK_URL=
6286

63-
# Vonage SMS API variables
64-
VONAGE_BRAND_NAME=
87+
# Reports
6588

66-
# Vonage Account API variables
67-
VONAGE_SECRET_ID=
89+
# Sim Swap
6890

69-
## Subaccounts
91+
# SMS
7092

71-
START_DATE=
93+
## Note: Set SMS_SENDER_ID under the Messages section
94+
SMS_TO_NUMBER=
95+
SMS_SIGNATURE=
96+
SMS_TIMESTAMP=
97+
98+
# Subaccounts
99+
SUBACCOUNT_KEY=
72100
NEW_SUBACCOUNT_NAME=
73101
NEW_SUBACCOUNT_SECRET=
74-
SUBACCOUNT_KEY=
102+
START_DATE=
75103
AMOUNT=
76-
COUNTRY=
77104

78-
# Vonage Verify2 API variables
79-
REQUEST_ID=
80-
CODE=
81-
BRAND_NAME=
82-
TO_EMAIL=
105+
# VBC
106+
107+
# Verify (v1 & v2)
108+
VERIFY_REQUEST_ID=
109+
VERIFY_CODE=
110+
VERIFY_WORKFLOW_ID=
83111
VERIFY_TEMPLATE_ID=
84112
VERIFY_TEMPLATE_FRAGMENT_ID=
85-
86-
# Vonage Meetings API variables
87-
ROOM_DISPLAY_NAME=
88-
EXPIRATION_DATE=
89-
ROOM_ID=
90-
MAIN_COLOR=
91-
BRAND_TEXT=
92-
THEME_ID=
93-
RECORDING_ID=
94-
SESSION_ID=
113+
VERIFY_NUMBER=
114+
VERIFY_FROM_NUMBER=
115+
VERIFY_BRAND_NAME=
116+
VERIFY_PAYEE_NAME=
117+
VERIFY_AMOUNT=
118+
VERIFY_TO_EMAIL=
119+
VERIFY_FROM_EMAIL=
120+
121+
# Voice / Programmable SIP
122+
VOICE_CALL_ID=
123+
VOICE_TO_NUMBER=
124+
VOICE_TEXT=
125+
VOICE_LANGUAGE=
126+
VOICE_DTMF_DIGITS=
127+
VOICE_CONFERENCE_NAME=
128+
VOICE_ANSWER_URL=
129+
VOICE_STREAM_URL=
130+
VOICE_RECORDING_URL=
131+
VOICE_NCCO_URL=
132+
SIP_DOMAIN=
133+
SIP_USER_ID=
134+
SIP_USER_SECRET=
135+
SIP_ACL_IP_ADDRESS=

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,5 @@ build-iPhoneSimulator/
5151

5252
.env
5353
private.key
54+
*.key
5455
.byebug_history

‎Gemfile.lock‎

Lines changed: 41 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,56 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
ast (2.4.0)
4+
ast (2.4.2)
55
base64 (0.2.0)
6-
byebug (11.0.1)
7-
connection_pool (2.4.1)
8-
daemons (1.3.1)
6+
byebug (11.1.3)
7+
connection_pool (2.5.0)
8+
daemons (1.4.1)
99
dotenv (2.7.6)
1010
eventmachine (1.2.7)
1111
faye-websocket (0.11.0)
1212
eventmachine (>= 0.12.0)
1313
websocket-driver (>= 0.5.1)
14-
jaro_winkler (1.5.3)
15-
jwt (2.9.3)
14+
json (2.10.1)
15+
jwt (2.10.1)
1616
base64
17+
language_server-protocol (3.17.0.4)
18+
lint_roller (1.1.0)
1719
multi_json (1.15.0)
1820
multipart-post (2.4.1)
19-
mustermann (1.1.1)
21+
mustermann (1.1.2)
2022
ruby2_keywords (~> 0.0.1)
21-
net-http-persistent (4.0.4)
23+
net-http-persistent (4.0.5)
2224
connection_pool (~> 2.2)
23-
parallel (1.17.0)
24-
parser (2.6.3.0)
25-
ast (~> 2.4.0)
26-
phonelib (0.9.3)
27-
rack (2.2.3)
25+
parallel (1.26.3)
26+
parser (3.3.7.1)
27+
ast (~> 2.4.1)
28+
racc
29+
phonelib (0.10.4)
30+
racc (1.8.1)
31+
rack (2.2.11)
2832
rack-contrib (2.3.0)
2933
rack (~> 2.0)
3034
rack-protection (2.1.0)
3135
rack
32-
rainbow (3.0.0)
33-
rexml (3.3.9)
34-
rubocop (0.72.0)
35-
jaro_winkler (~> 1.5.1)
36+
rainbow (3.1.1)
37+
regexp_parser (2.10.0)
38+
rexml (3.4.1)
39+
rubocop (1.72.2)
40+
json (~> 2.3)
41+
language_server-protocol (~> 3.17.0.2)
42+
lint_roller (~> 1.1.0)
3643
parallel (~> 1.10)
37-
parser (>= 2.6)
44+
parser (>= 3.3.0.2)
3845
rainbow (>= 2.2.2, < 4.0)
46+
regexp_parser (>= 2.9.3, < 3.0)
47+
rubocop-ast (>= 1.38.0, < 2.0)
3948
ruby-progressbar (~> 1.7)
40-
unicode-display_width (>= 1.4.0, < 1.7)
41-
ruby-progressbar (1.10.1)
42-
ruby2_keywords (0.0.4)
49+
unicode-display_width (>= 2.4.0, < 4.0)
50+
rubocop-ast (1.38.0)
51+
parser (>= 3.3.1.0)
52+
ruby-progressbar (1.13.0)
53+
ruby2_keywords (0.0.5)
4354
sinatra (2.1.0)
4455
mustermann (~> 1.0)
4556
rack (~> 2.2)
@@ -51,14 +62,16 @@ GEM
5162
rack-protection (= 2.1.0)
5263
sinatra (= 2.1.0)
5364
tilt (~> 2.0)
54-
sorbet-runtime (0.5.11625)
65+
sorbet-runtime (0.5.11834)
5566
thin (1.8.0)
5667
daemons (~> 1.0, >= 1.0.9)
5768
eventmachine (~> 1.0, >= 1.0.4)
5869
rack (>= 1, < 3)
59-
tilt (2.0.10)
60-
unicode-display_width (1.6.0)
61-
vonage (7.28.0)
70+
tilt (2.6.0)
71+
unicode-display_width (3.1.4)
72+
unicode-emoji (~> 4.0, >= 4.0.4)
73+
unicode-emoji (4.0.4)
74+
vonage (7.29.1)
6275
multipart-post (~> 2.0)
6376
net-http-persistent (~> 4.0, >= 4.0.2)
6477
phonelib
@@ -68,10 +81,11 @@ GEM
6881
zeitwerk (~> 2, >= 2.2)
6982
vonage-jwt (0.2.0)
7083
jwt (~> 2)
71-
websocket-driver (0.7.3)
84+
websocket-driver (0.7.7)
85+
base64
7286
websocket-extensions (>= 0.1.0)
7387
websocket-extensions (0.1.5)
74-
zeitwerk (2.7.1)
88+
zeitwerk (2.7.2)
7589

7690
PLATFORMS
7791
ruby

‎account/configure-account.rb‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,13 @@
33

44
VONAGE_API_KEY = ENV['VONAGE_API_KEY']
55
VONAGE_API_SECRET = ENV['VONAGE_API_SECRET']
6-
7-
SMS_CALLBACK_URL = ENV['SMS_CALLBACK_URL']
6+
ACCOUNT_SMS_CALLBACK_URL = ENV['ACCOUNT_SMS_CALLBACK_URL']
87

98
client = Vonage::Client.new(
109
api_key: VONAGE_API_KEY,
1110
api_secret: VONAGE_API_SECRET
1211
)
1312

14-
result = client.account.update(
13+
response = client.account.update(
1514
moHttpUrl: SMS_CALLBACK_URL
1615
)
17-
18-
result.to_h.each do |key, value|
19-
puts "#{key}: #{value}"
20-
end

‎account/get-balance.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
api_secret: VONAGE_API_SECRET
1010
)
1111

12-
puts "#{client.account.balance.value.round(2)} EUR"
12+
response = client.account.balance

‎account/secret-management/create-a-secret.rb‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,11 @@
55

66
VONAGE_API_KEY = ENV['VONAGE_API_KEY']
77
VONAGE_API_SECRET = ENV['VONAGE_API_SECRET']
8+
ACCOUNT_SECRET_VALUE = ENV['ACCOUNT_SECRET_VALUE']
89

910
client = Vonage::Client.new(
1011
api_key: VONAGE_API_KEY,
1112
api_secret: VONAGE_API_SECRET
1213
)
1314

14-
begin
15-
response = client.secrets.create(secret: 'Th1s-I5-my_n3w-s3cr3t')
16-
puts 'Secret Created Successfully' if response.created_at
17-
rescue StandardError => e
18-
puts e.message
19-
end
15+
response = client.secrets.create(secret: ACCOUNT_SECRET_VALUE)

‎account/secret-management/fetch-a-secret.rb‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@
55

66
VONAGE_API_KEY = ENV['VONAGE_API_KEY']
77
VONAGE_API_SECRET = ENV['VONAGE_API_SECRET']
8-
9-
VONAGE_SECRET_ID = ENV['VONAGE_SECRET_ID']
8+
ACCOUNT_SECRET_ID = ENV['ACCOUNT_SECRET_ID']
109

1110
client = Vonage::Client.new(
1211
api_key: VONAGE_API_KEY,
1312
api_secret: VONAGE_API_SECRET
1413
)
15-
result = client.secrets.get(VONAGE_SECRET_ID)
1614

17-
puts "ID: #{result.id} created on #{result.created_at}"
15+
response = client.secrets.get(ACCOUNT_SECRET_ID)

‎account/secret-management/list-all-secrets.rb‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,4 @@
1111
api_secret: VONAGE_API_SECRET
1212
)
1313

14-
result = client.secrets.list
15-
16-
result._embedded.secrets.each do |secret|
17-
puts "ID: #{secret.id} created on #{secret.created_at}"
18-
end
14+
response = client.secrets.list

0 commit comments

Comments
 (0)