seven_api 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/.idea/ruby-client.iml +16 -4
  3. data/README.md +2 -2
  4. data/doc/{Sms77 → SevenApi}/Client.html +222 -222
  5. data/doc/{Sms77 → SevenApi}/Contacts/Action.html +130 -130
  6. data/doc/{Sms77 → SevenApi}/Contacts.html +125 -125
  7. data/doc/{Sms77 → SevenApi}/Endpoint.html +186 -186
  8. data/doc/{Sms77 → SevenApi}/Hooks/Action.html +130 -130
  9. data/doc/{Sms77 → SevenApi}/Hooks/EventType.html +145 -145
  10. data/doc/{Sms77 → SevenApi}/Hooks/RequestMethod.html +130 -130
  11. data/doc/{Sms77 → SevenApi}/Hooks/Validator.html +582 -582
  12. data/doc/{Sms77 → SevenApi}/Hooks.html +125 -125
  13. data/doc/{Sms77 → SevenApi}/Journal/Type.html +135 -135
  14. data/doc/{Sms77 → SevenApi}/Journal/Validator.html +380 -380
  15. data/doc/{Sms77 → SevenApi}/Journal.html +125 -125
  16. data/doc/{Sms77 → SevenApi}/Lookup/Type.html +135 -135
  17. data/doc/{Sms77 → SevenApi}/Lookup.html +125 -125
  18. data/doc/{Sms77 → SevenApi}/Resource.html +857 -857
  19. data/doc/{Sms77 → SevenApi}/Resources/Analytics.html +260 -260
  20. data/doc/{Sms77 → SevenApi}/Resources/Balance.html +243 -243
  21. data/doc/{Sms77 → SevenApi}/Resources/Contacts.html +445 -445
  22. data/doc/{Sms77 → SevenApi}/Resources/Hooks.html +453 -453
  23. data/doc/{Sms77 → SevenApi}/Resources/Journal.html +258 -258
  24. data/doc/{Sms77 → SevenApi}/Resources/Lookup.html +535 -535
  25. data/doc/{Sms77 → SevenApi}/Resources/Pricing.html +260 -260
  26. data/doc/{Sms77 → SevenApi}/Resources/Sms.html +258 -258
  27. data/doc/{Sms77 → SevenApi}/Resources/Status.html +258 -258
  28. data/doc/{Sms77 → SevenApi}/Resources/Subaccounts.html +645 -645
  29. data/doc/{Sms77 → SevenApi}/Resources/ValidateForVoice.html +258 -258
  30. data/doc/{Sms77 → SevenApi}/Resources/Voice.html +258 -258
  31. data/doc/SevenApi/Resources.html +128 -0
  32. data/doc/{Sms77 → SevenApi}/Sms/Type.html +125 -125
  33. data/doc/{Sms77 → SevenApi}/Sms.html +125 -125
  34. data/doc/{Sms77 → SevenApi}/Subaccounts/Action.html +140 -140
  35. data/doc/SevenApi/Subaccounts/Validator.html +490 -0
  36. data/doc/{Sms77 → SevenApi}/Subaccounts.html +125 -125
  37. data/doc/{Sms77 → SevenApi}/Util.html +993 -993
  38. data/doc/{Sms77.html → SevenApi.html} +145 -145
  39. data/doc/_index.html +443 -443
  40. data/doc/class_list.html +51 -51
  41. data/doc/css/full_list.css +58 -58
  42. data/doc/css/style.css +497 -497
  43. data/doc/file.README.html +110 -111
  44. data/doc/file_list.html +56 -56
  45. data/doc/frames.html +17 -17
  46. data/doc/index.html +110 -111
  47. data/doc/js/app.js +314 -314
  48. data/doc/js/full_list.js +216 -216
  49. data/doc/js/jquery.js +3 -3
  50. data/doc/method_list.html +563 -563
  51. data/doc/top-level-namespace.html +109 -109
  52. data/lib/seven_api/client.rb +2 -0
  53. data/lib/seven_api/contacts.rb +0 -5
  54. data/lib/seven_api/endpoint.rb +5 -0
  55. data/lib/seven_api/hooks.rb +1 -0
  56. data/lib/seven_api/lookup.rb +1 -0
  57. data/lib/seven_api/numbers.rb +9 -0
  58. data/lib/seven_api/paginated.rb +10 -0
  59. data/lib/seven_api/rcs.rb +9 -0
  60. data/lib/seven_api/resource.rb +8 -3
  61. data/lib/seven_api/resources/analytics.rb +38 -5
  62. data/lib/seven_api/resources/balance.rb +2 -2
  63. data/lib/seven_api/resources/contacts.rb +36 -18
  64. data/lib/seven_api/resources/groups.rb +57 -0
  65. data/lib/seven_api/resources/hooks.rb +1 -1
  66. data/lib/seven_api/resources/journal.rb +1 -1
  67. data/lib/seven_api/resources/lookup.rb +36 -20
  68. data/lib/seven_api/resources/numbers.rb +70 -0
  69. data/lib/seven_api/resources/pricing.rb +1 -1
  70. data/lib/seven_api/resources/rcs.rb +39 -0
  71. data/lib/seven_api/resources/sms.rb +1 -1
  72. data/lib/seven_api/resources/status.rb +1 -1
  73. data/lib/seven_api/resources/subaccounts.rb +5 -5
  74. data/lib/seven_api/resources/validate_for_voice.rb +1 -1
  75. data/lib/seven_api/resources/voice.rb +1 -1
  76. data/lib/seven_api/version.rb +1 -1
  77. data/seven_api.gemspec +5 -5
  78. data/spec/seven_api/analytics_spec.rb +49 -0
  79. data/spec/seven_api/balance_spec.rb +8 -2
  80. data/spec/seven_api/contacts_spec.rb +52 -81
  81. data/spec/seven_api/groups_spec.rb +74 -0
  82. data/spec/seven_api/lookup_spec.rb +51 -33
  83. data/spec/seven_api/numbers_spec.rb +135 -0
  84. data/spec/seven_api/rcs_spec.rb +99 -0
  85. data/spec/seven_api/sms_spec.rb +2 -2
  86. data/spec/seven_api/voice_spec.rb +2 -2
  87. data/spec/spec_helper.rb +8 -17
  88. metadata +64 -50
  89. data/doc/Sms77/Resources.html +0 -128
  90. data/doc/Sms77/Subaccounts/Validator.html +0 -490
data/doc/file.README.html CHANGED
@@ -1,112 +1,111 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- File: README
8
-
9
- &mdash; Documentation by YARD 0.9.27
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "README";
19
- relpath = '';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="file_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="_index.html">Index</a> &raquo;
40
- <span class="title">File: README</span>
41
-
42
- </div>
43
-
44
- <div id="search">
45
-
46
- <a class="full_list_link" id="class_list_link"
47
- href="class_list.html">
48
-
49
- <svg width="24" height="24">
50
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
- </svg>
54
- </a>
55
-
56
- </div>
57
- <div class="clear"></div>
58
- </div>
59
-
60
- <div id="content"><div id='filecontents'>
61
- <p><img src="https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png"></p>
62
-
63
- <h1 id="label-Ruby+Client+for+the+sms77+SMS+Gateway+API">Ruby Client for the <a href="https://www.sms77.io/">sms77 SMS Gateway API</a></h1>
64
-
65
- <p>This gem requires Ruby &gt;= 2.6.0 &lt; 3.</p>
66
-
67
- <h2 id="label-Installation">Installation</h2>
68
-
69
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_sms77'>sms77</span>
70
- </code></pre>
71
-
72
- <h3 id="label-Usage">Usage</h3>
73
-
74
- <h4 id="label-Retrieve+balance">Retrieve balance</h4>
75
-
76
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sms77/client</span><span class='tstring_end'>&#39;</span></span>
77
-
78
- <span class='id identifier rubyid_api_key'>api_key</span> <span class='op'>=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SMS77_API_KEY</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
79
- <span class='comment'># retrieve balance
80
- </span><span class='id identifier rubyid_puts'>puts</span> <span class='const'><span class='object_link'><a href="Sms77.html" title="Sms77 (module)">Sms77</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources.html" title="Sms77::Resources (module)">Resources</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources/Balance.html" title="Sms77::Resources::Balance (class)">Balance</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Sms77/Resource.html#initialize-instance_method" title="Sms77::Resource#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_retrieve'>retrieve</span>
81
-
82
- <span class='comment'># send SMS
83
- </span><span class='id identifier rubyid_puts'>puts</span> <span class='const'><span class='object_link'><a href="Sms77.html" title="Sms77 (module)">Sms77</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources.html" title="Sms77::Resources (module)">Resources</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources/Sms.html" title="Sms77::Resources::Sms (class)">Sms</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Sms77/Resource.html#initialize-instance_method" title="Sms77::Resource#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_retrieve'>retrieve</span>
84
- </code></pre>
85
-
86
- <h4 id="label-Testing">Testing</h4>
87
-
88
- <pre class="code ruby"><code class="ruby"><span class='const'>SMS77_API_KEY</span><span class='op'>=</span><span class='const'>MySms77ApiKey</span> <span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rspec'>rspec</span>
89
- </code></pre>
90
-
91
- <p><em>Optional environment variables</em></p>
92
-
93
- <p>Setting <code>SMS77_DEBUG=1</code> prints details to stdout.</p>
94
-
95
- <p>Setting <code>SMS77_TEST_HTTP=1</code> enables live testing with actual API requests.</p>
96
-
97
- <h5 id="label-Support">Support</h5>
98
-
99
- <p>Need help? Feel free to <a href="https://www.sms77.io/en/company/contact/">contact us</a>.</p>
100
-
101
- <p><a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-teal.svg"></a></p>
102
- </div></div>
103
-
104
- <div id="footer">
105
- Generated on Wed Mar 30 13:55:36 2022 by
106
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
107
- 0.9.27 (ruby-2.7.4).
108
- </div>
109
-
110
- </div>
111
- </body>
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="file_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><p><img src="https://www.seven.io/wp-content/uploads/Logo.svg" alt="" title="seven Logo" /></p>
61
+
62
+ <h1 id="ruby-client-for-the-seven-sms-gateway-apihttpswwwsevenio">Ruby Client for the <a href="https://www.seven.io/">seven SMS Gateway API</a></h1>
63
+ <p>This gem requires Ruby &gt;= 2.6.0.</p>
64
+
65
+ <h2 id="installation">Installation</h2>
66
+
67
+ <p><code>gem install seven_api</code></p>
68
+
69
+ <h3 id="usage">Usage</h3>
70
+
71
+ <h4 id="retrieve-balance">Retrieve balance</h4>
72
+
73
+ <p>```ruby
74
+ require ‘seven_api/client’</p>
75
+
76
+ <p>api_key = ENV[‘SEVEN_API_KEY’]
77
+ # retrieve balance
78
+ puts SevenApi::Resources::Balance.new(api_key).retrieve</p>
79
+
80
+ <h1 id="send-sms">send SMS</h1>
81
+ <p>puts SevenApi::Resources::Sms.new(api_key).retrieve
82
+ ```</p>
83
+
84
+ <h4 id="testing">Testing</h4>
85
+
86
+ <p><code>shell
87
+ SEVEN_API_KEY=MySevenApiKey bundle exec rspec
88
+ </code></p>
89
+
90
+ <p><em>Optional environment variables</em></p>
91
+
92
+ <p>Setting <code>SEVEN_DEBUG=1</code> prints details to stdout.</p>
93
+
94
+ <p>Setting <code>SEVEN_TEST_HTTP=1</code> enables live testing with actual API requests.</p>
95
+
96
+ <h5 id="support">Support</h5>
97
+
98
+ <p>Need help? Feel free to <a href="https://www.seven.io/en/company/contact/">contact us</a>.</p>
99
+
100
+ <p><a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-teal.svg" alt="MIT" /></a></p>
101
+ </div></div>
102
+
103
+ <div id="footer">
104
+ Generated on Fri Aug 25 14:18:45 2023 by
105
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
106
+ 0.9.34 (ruby-3.2.2).
107
+ </div>
108
+
109
+ </div>
110
+ </body>
112
111
  </html>
data/doc/file_list.html CHANGED
@@ -1,56 +1,56 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
- <meta charset="utf-8" />
6
-
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
-
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
-
11
-
12
-
13
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
-
15
- <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
-
17
-
18
- <title>File List</title>
19
- <base id="base_target" target="_parent" />
20
- </head>
21
- <body>
22
- <div id="content">
23
- <div class="fixed_header">
24
- <h1 id="full_list_header">File List</h1>
25
- <div id="full_list_nav">
26
-
27
- <span><a target="_self" href="class_list.html">
28
- Classes
29
- </a></span>
30
-
31
- <span><a target="_self" href="method_list.html">
32
- Methods
33
- </a></span>
34
-
35
- <span><a target="_self" href="file_list.html">
36
- Files
37
- </a></span>
38
-
39
- </div>
40
-
41
- <div id="search">Search: <input type="text" /></div>
42
- </div>
43
-
44
- <ul id="full_list" class="file">
45
-
46
-
47
- <li id="object_README" class="odd">
48
- <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
- </li>
50
-
51
-
52
-
53
- </ul>
54
- </div>
55
- </body>
56
- </html>
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/doc/frames.html CHANGED
@@ -1,17 +1,17 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <title>Documentation by YARD 0.9.27</title>
6
- </head>
7
- <script type="text/javascript">
8
- var match = unescape(window.location.hash).match(/^#!(.+)/);
9
- var name = match ? match[1] : 'index.html';
10
- name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
- window.top.location = name;
12
- </script>
13
- <noscript>
14
- <h1>Oops!</h1>
15
- <h2>YARD requires JavaScript!</h2>
16
- </noscript>
17
- </html>
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.34</title>
6
+ </head>
7
+ <script type="text/javascript">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>
data/doc/index.html CHANGED
@@ -1,112 +1,111 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- File: README
8
-
9
- &mdash; Documentation by YARD 0.9.27
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "README";
19
- relpath = '';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="_index.html">Index</a> &raquo;
40
- <span class="title">File: README</span>
41
-
42
- </div>
43
-
44
- <div id="search">
45
-
46
- <a class="full_list_link" id="class_list_link"
47
- href="class_list.html">
48
-
49
- <svg width="24" height="24">
50
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
- </svg>
54
- </a>
55
-
56
- </div>
57
- <div class="clear"></div>
58
- </div>
59
-
60
- <div id="content"><div id='filecontents'>
61
- <p><img src="https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png"></p>
62
-
63
- <h1 id="label-Ruby+Client+for+the+sms77+SMS+Gateway+API">Ruby Client for the <a href="https://www.sms77.io/">sms77 SMS Gateway API</a></h1>
64
-
65
- <p>This gem requires Ruby &gt;= 2.6.0 &lt; 3.</p>
66
-
67
- <h2 id="label-Installation">Installation</h2>
68
-
69
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_sms77'>sms77</span>
70
- </code></pre>
71
-
72
- <h3 id="label-Usage">Usage</h3>
73
-
74
- <h4 id="label-Retrieve+balance">Retrieve balance</h4>
75
-
76
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sms77/client</span><span class='tstring_end'>&#39;</span></span>
77
-
78
- <span class='id identifier rubyid_api_key'>api_key</span> <span class='op'>=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SMS77_API_KEY</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
79
- <span class='comment'># retrieve balance
80
- </span><span class='id identifier rubyid_puts'>puts</span> <span class='const'><span class='object_link'><a href="Sms77.html" title="Sms77 (module)">Sms77</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources.html" title="Sms77::Resources (module)">Resources</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources/Balance.html" title="Sms77::Resources::Balance (class)">Balance</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Sms77/Resource.html#initialize-instance_method" title="Sms77::Resource#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_retrieve'>retrieve</span>
81
-
82
- <span class='comment'># send SMS
83
- </span><span class='id identifier rubyid_puts'>puts</span> <span class='const'><span class='object_link'><a href="Sms77.html" title="Sms77 (module)">Sms77</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources.html" title="Sms77::Resources (module)">Resources</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sms77/Resources/Sms.html" title="Sms77::Resources::Sms (class)">Sms</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Sms77/Resource.html#initialize-instance_method" title="Sms77::Resource#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_retrieve'>retrieve</span>
84
- </code></pre>
85
-
86
- <h4 id="label-Testing">Testing</h4>
87
-
88
- <pre class="code ruby"><code class="ruby"><span class='const'>SMS77_API_KEY</span><span class='op'>=</span><span class='const'>MySms77ApiKey</span> <span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rspec'>rspec</span>
89
- </code></pre>
90
-
91
- <p><em>Optional environment variables</em></p>
92
-
93
- <p>Setting <code>SMS77_DEBUG=1</code> prints details to stdout.</p>
94
-
95
- <p>Setting <code>SMS77_TEST_HTTP=1</code> enables live testing with actual API requests.</p>
96
-
97
- <h5 id="label-Support">Support</h5>
98
-
99
- <p>Need help? Feel free to <a href="https://www.sms77.io/en/company/contact/">contact us</a>.</p>
100
-
101
- <p><a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-teal.svg"></a></p>
102
- </div></div>
103
-
104
- <div id="footer">
105
- Generated on Wed Mar 30 13:55:36 2022 by
106
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
107
- 0.9.27 (ruby-2.7.4).
108
- </div>
109
-
110
- </div>
111
- </body>
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><p><img src="https://www.seven.io/wp-content/uploads/Logo.svg" alt="" title="seven Logo" /></p>
61
+
62
+ <h1 id="ruby-client-for-the-seven-sms-gateway-apihttpswwwsevenio">Ruby Client for the <a href="https://www.seven.io/">seven SMS Gateway API</a></h1>
63
+ <p>This gem requires Ruby &gt;= 2.6.0.</p>
64
+
65
+ <h2 id="installation">Installation</h2>
66
+
67
+ <p><code>gem install seven_api</code></p>
68
+
69
+ <h3 id="usage">Usage</h3>
70
+
71
+ <h4 id="retrieve-balance">Retrieve balance</h4>
72
+
73
+ <p>```ruby
74
+ require ‘seven_api/client’</p>
75
+
76
+ <p>api_key = ENV[‘SEVEN_API_KEY’]
77
+ # retrieve balance
78
+ puts SevenApi::Resources::Balance.new(api_key).retrieve</p>
79
+
80
+ <h1 id="send-sms">send SMS</h1>
81
+ <p>puts SevenApi::Resources::Sms.new(api_key).retrieve
82
+ ```</p>
83
+
84
+ <h4 id="testing">Testing</h4>
85
+
86
+ <p><code>shell
87
+ SEVEN_API_KEY=MySevenApiKey bundle exec rspec
88
+ </code></p>
89
+
90
+ <p><em>Optional environment variables</em></p>
91
+
92
+ <p>Setting <code>SEVEN_DEBUG=1</code> prints details to stdout.</p>
93
+
94
+ <p>Setting <code>SEVEN_TEST_HTTP=1</code> enables live testing with actual API requests.</p>
95
+
96
+ <h5 id="support">Support</h5>
97
+
98
+ <p>Need help? Feel free to <a href="https://www.seven.io/en/company/contact/">contact us</a>.</p>
99
+
100
+ <p><a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-teal.svg" alt="MIT" /></a></p>
101
+ </div></div>
102
+
103
+ <div id="footer">
104
+ Generated on Fri Aug 25 14:18:45 2023 by
105
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
106
+ 0.9.34 (ruby-3.2.2).
107
+ </div>
108
+
109
+ </div>
110
+ </body>
112
111
  </html>