File tree Expand file tree Collapse file tree 1 file changed +57
-0
lines changed Expand file tree Collapse file tree 1 file changed +57
-0
lines changed Original file line number Diff line number Diff line change 1+ # Vapi Ruby Library
2+
3+ [ ![ Gem Version] ( https://img.shields.io/badge/vapi-server-sdk-v0.0.3-red?logo=ruby )] ( https://rubygems.org/gems//vapi-server-sdk )
4+
5+ The Vapi Ruby library provides access to the Vapi API from Ruby.
6+
7+ ## Documentation
8+
9+ API reference documentation is available [ here] ( https://docs.vapi.ai/ ) .
10+
11+ ## Installation
12+
13+ Install the gem and add to the application's Gemfile by executing:
14+
15+ ``` sh
16+ bundle add vapi-server-sdk
17+ ```
18+
19+ If bundler is not being used to manage dependencies, install the gem by executing:
20+
21+ ``` sh
22+ gem install vapi-server-sdk
23+ ```
24+
25+ ## Usage
26+
27+ ``` ruby
28+ require " vapi-server-sdk"
29+
30+ client = Vapi ::Client .new (
31+ token: ' YOUR_TOKEN'
32+ )
33+ result = client.calls.create()
34+ ```
35+
36+ ## Async Client
37+
38+ The SDK exposes an async client that you can use to make non-blocking requests.
39+
40+ ``` ruby
41+ require " vapi-server-sdk"
42+
43+ client = Vapi ::AsyncClient .new (
44+ token: ' YOUR_TOKEN'
45+ )
46+ result = client.calls.create()
47+ ```
48+
49+
50+ ## Contributing
51+
52+ While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly
53+ to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next
54+ generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is.
55+ We suggest opening an issue first to discuss with us!
56+
57+ On the other hand, contributions to the README are always very welcome!
You can’t perform that action at this time.
0 commit comments