Skip to content

Commit b62ce25

Browse files
authored
Update USAGE.md
1 parent c731a6c commit b62ce25

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

USAGE.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Usage examples for SendGrid ruby-http-client
44

55
## Initialization
66

7-
```
7+
```ruby
88
require_relative '../lib/ruby_http_client'
99

1010
# This uses the SendGrid API as an example
@@ -25,12 +25,11 @@ client = SendGrid::Client.new(host: host, request_headers: headers)
2525
- [PUT](#put)
2626
- [PATCH](#patch)
2727

28-
<a name="get"></a>
2928
## GET
3029

3130
#### GET Collection
3231

33-
```
32+
```ruby
3433
query_params = { 'limit' => 100, 'offset' => 0 }
3534
response = client.version('v3').api_keys.get(query_params: query_params)
3635
puts response.status_code
@@ -40,26 +39,24 @@ puts response.headers
4039

4140
#### GET Single
4241

43-
```
42+
```ruby
4443
response = client.version('v3').api_keys._(api_key_id).get
4544
puts response.status_code
4645
puts response.body
4746
puts response.headers
4847
```
4948

50-
<a name="delete"></a>
5149
## DELETE
5250

53-
```
51+
```ruby
5452
response = client.api_keys._(api_key_id).delete
5553
puts response.status_code
5654
puts response.headers
5755
```
5856

59-
<a name="post"></a>
6057
## POST
6158

62-
```
59+
```ruby
6360
request_body = JSON.parse('
6461
{
6562
"name": "My API Key Ruby Test",
@@ -77,10 +74,9 @@ puts response.headers
7774
api_key_id = JSON.parse(response.body)['api_key_id']
7875
```
7976

80-
<a name="put"></a>
8177
## PUT
8278

83-
```
79+
```ruby
8480
request_body = JSON.parse('
8581
{
8682
"name": "A New Hope",
@@ -90,16 +86,16 @@ request_body = JSON.parse('
9086
]
9187
}
9288
')
89+
9390
response = client.api_keys._(api_key_id).put(request_body: request_body)
9491
puts response.status_code
9592
puts response.body
9693
puts response.headers
9794
```
9895

99-
<a name="patch"></a>
10096
## PATCH
10197

102-
```
98+
```ruby
10399
request_body = JSON.parse('
104100
{
105101
"name": "A New Hope"
@@ -109,4 +105,4 @@ response = client.api_keys._(api_key_id).patch(request_body: request_body)
109105
puts response.status_code
110106
puts response.body
111107
puts response.headers
112-
```
108+
```

0 commit comments

Comments
 (0)