Skip to content

Commit c731a6c

Browse files
committed
Add USAGE.md
1 parent a616876 commit c731a6c

File tree

1 file changed

+112
-0
lines changed

1 file changed

+112
-0
lines changed

USAGE.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Usage
2+
3+
Usage examples for SendGrid ruby-http-client
4+
5+
## Initialization
6+
7+
```
8+
require_relative '../lib/ruby_http_client'
9+
10+
# This uses the SendGrid API as an example
11+
headers = JSON.parse('
12+
{
13+
"Authorization": "Bearer ' + ENV['SENDGRID_API_KEY'] + '"
14+
}
15+
')
16+
host = 'https://api.sendgrid.com'
17+
client = SendGrid::Client.new(host: host, request_headers: headers)
18+
```
19+
20+
## Table of Contents
21+
22+
- [GET](#get)
23+
- [DELETE](#delete)
24+
- [POST](#post)
25+
- [PUT](#put)
26+
- [PATCH](#patch)
27+
28+
<a name="get"></a>
29+
## GET
30+
31+
#### GET Collection
32+
33+
```
34+
query_params = { 'limit' => 100, 'offset' => 0 }
35+
response = client.version('v3').api_keys.get(query_params: query_params)
36+
puts response.status_code
37+
puts response.body
38+
puts response.headers
39+
```
40+
41+
#### GET Single
42+
43+
```
44+
response = client.version('v3').api_keys._(api_key_id).get
45+
puts response.status_code
46+
puts response.body
47+
puts response.headers
48+
```
49+
50+
<a name="delete"></a>
51+
## DELETE
52+
53+
```
54+
response = client.api_keys._(api_key_id).delete
55+
puts response.status_code
56+
puts response.headers
57+
```
58+
59+
<a name="post"></a>
60+
## POST
61+
62+
```
63+
request_body = JSON.parse('
64+
{
65+
"name": "My API Key Ruby Test",
66+
"scopes": [
67+
"mail.send",
68+
"alerts.create",
69+
"alerts.read"
70+
]
71+
}
72+
')
73+
response = client.version('v3').api_keys.post(request_body: request_body)
74+
puts response.status_code
75+
puts response.body
76+
puts response.headers
77+
api_key_id = JSON.parse(response.body)['api_key_id']
78+
```
79+
80+
<a name="put"></a>
81+
## PUT
82+
83+
```
84+
request_body = JSON.parse('
85+
{
86+
"name": "A New Hope",
87+
"scopes": [
88+
"user.profile.read",
89+
"user.profile.update"
90+
]
91+
}
92+
')
93+
response = client.api_keys._(api_key_id).put(request_body: request_body)
94+
puts response.status_code
95+
puts response.body
96+
puts response.headers
97+
```
98+
99+
<a name="patch"></a>
100+
## PATCH
101+
102+
```
103+
request_body = JSON.parse('
104+
{
105+
"name": "A New Hope"
106+
}
107+
')
108+
response = client.api_keys._(api_key_id).patch(request_body: request_body)
109+
puts response.status_code
110+
puts response.body
111+
puts response.headers
112+
```

0 commit comments

Comments
 (0)