Skip to content

[DOC] NameError (uninitialized constant RestClient) - Need to use Plivo::RestClient #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ashish Prajapati (ashishprajapati) wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[DOC] NameError (uninitialized constant RestClient) - Need to use Plivo::RestClient #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ If you have the `0.3.19` version (a.k.a legacy) already installed, you may have
## Getting started

### Authentication
To make the API requests, you need to create a `RestClient` and provide it with authentication credentials (which can be found at [https://console.plivo.com/dashboard/](https://console.plivo.com/dashboard/)).
To make the API requests, you need to create a `Plivo::RestClient` and provide it with authentication credentials (which can be found at [https://console.plivo.com/dashboard/](https://console.plivo.com/dashboard/)).

We recommend that you store your credentials in the `PLIVO_AUTH_ID` and the `PLIVO_AUTH_TOKEN` environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:

```ruby
client = RestClient.new;
client = Plivo::RestClient.new;
```

Alternatively, you can specifiy the authentication credentials while initializing the `RestClient`.
Alternatively, you can specifiy the authentication credentials while initializing the `Plivo::RestClient`.

```ruby
client = RestClient.new('your_auth_id', 'your_auth_token');
client = Plivo::RestClient.new('your_auth_id', 'your_auth_token');
```

### The basics
Expand Down Expand Up @@ -81,7 +81,7 @@ require 'plivo'

include Plivo

client = RestClient.new
client = Plivo::RestClient.new
message_created = client.messages.create(
'your_source_number',
%w[your_destination_number_1 your_destination_number_2],
Expand All @@ -97,7 +97,7 @@ require 'plivo'

include Plivo

client = RestClient.new
client = Plivo::RestClient.new
call_made = client.calls.create(
'your_source_number',
['your_destination_number'],
Expand Down