Skip to content

Commit 2b9f68c

Browse files
wuoriwuori
committed
Removes syntax examples.
1 parent 84876be commit 2b9f68c

File tree

7 files changed

+389
-589
lines changed

7 files changed

+389
-589
lines changed

‎source/includes/_bookings.md‎

Lines changed: 5 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,7 @@
22

33
## Get All bookings
44

5-
```shell
6-
curl "https://api.runara.com/kittens"
7-
-H "Authorization: Bearer:your.jwt.token"
8-
```
9-
10-
```javascript
11-
const runara = require('runara');
12-
13-
let api = runara.authorize('you.jwt.token');
14-
let kittens = api.kittens.get();
15-
```
16-
17-
> The above command returns JSON structured like this:
5+
> Example Response:
186
197
```json
208
[
@@ -30,19 +18,7 @@ This endpoint retrieves all bookings for the current user.
3018

3119
## Get a Specific Booking
3220

33-
```shell
34-
curl "https://api.runara.com/bookings"
35-
-H "Authorization: you.jwt.token"
36-
```
37-
38-
```javascript
39-
const runara = require('runara');
40-
41-
let api = runara.authorize('you.jwt.token');
42-
let max = api.kittens.get(2);
43-
```
44-
45-
> The above command returns JSON structured like this:
21+
> Example Response:
4622
4723
```json
4824
{
@@ -68,19 +44,7 @@ ID | The ID of the booking to retrieve
6844

6945
## Create a Booking
7046

71-
```shell
72-
curl "https://api.runara.com/bookings"
73-
-H "Authorization: you.jwt.token"
74-
```
75-
76-
```javascript
77-
const runara = require('runara');
78-
79-
let api = runara.authorize('you.jwt.token');
80-
let max = api.kittens.get(2);
81-
```
82-
83-
> The above command returns JSON structured like this:
47+
> Example Response:
8448
8549
```json
8650
{
@@ -151,19 +115,7 @@ complete | false | Boolean to process payment and finalize booking | `true`
151115

152116
## Update a Booking
153117

154-
```shell
155-
curl "https://api.runara.com/bookings"
156-
-H "Authorization: you.jwt.token"
157-
```
158-
159-
```javascript
160-
const runara = require('runara');
161-
162-
let api = runara.authorize('you.jwt.token');
163-
let max = api.kittens.get(2);
164-
```
165-
166-
> The above command returns JSON structured like this:
118+
> Example Response:
167119
168120
```json
169121
{
@@ -234,12 +186,7 @@ complete | false | Boolean to process payment and finalize booking | `true`
234186

235187
## Send a Message to all clients of a booking
236188

237-
```shell
238-
curl "https://api.runara.com/bookings/message/{booking_id}"
239-
-H "Authorization: Bearer:your.jwt.token"
240-
```
241-
242-
> The above command returns a 204 response on successful submission.
189+
> Example Response:
243190
244191
Sends a message to all clients registered for booking `booking_id`.
245192

@@ -255,13 +202,6 @@ message | true | Message to send to booked client(s). | "Due to inclement weathe
255202

256203
## Cancel a booking for a single client
257204

258-
```shell
259-
curl "https://api.runara.com/bookings/cancel"
260-
-H "Authorization: Bearer:your.jwt.token"
261-
```
262-
263-
> The above command returns a 204 response on successful submission.
264-
265205
Cancels a booking for a single client passed in body.
266206

267207
### HTTP Request
@@ -277,13 +217,6 @@ message | false | Message to send clients | "Due to inclement weather..."
277217

278218
## Check-In a Pre-Paid Client
279219

280-
```shell
281-
curl "https://api.runara.com/bookings/checkin"
282-
-H "Authorization: Bearer:your.jwt.token"
283-
```
284-
285-
> The above command returns a 200 response on successful submission.
286-
287220
Checks-in a prepaid client to a booking session.
288221

289222
### HTTP Request
@@ -300,13 +233,6 @@ undo | false | If `true`, reverts check-in status | `true`
300233

301234
## Re-Book a Session
302235

303-
```shell
304-
curl "https://api.runara.com/bookings/rebook/{session_id}"
305-
-H "Authorization: Bearer:your.jwt.token"
306-
```
307-
308-
> The above command returns a (200) booking response.
309-
310236
Retrieves booking information needed to create a re-booking request.
311237

312238
<aside class="notice">

‎source/includes/_clients.md‎

Lines changed: 143 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,7 @@
22

33
## View Clients
44

5-
```shell
6-
curl "https://api.runara.com/clients"
7-
-H "Authorization: Bearer:your.jwt.token"
8-
```
9-
10-
> The above command returns JSON structured like this:
5+
> Example Response:
116
127
```json
138
{
@@ -46,12 +41,7 @@ Views a list of clients associated with the requesters current account.
4641

4742
## View Client Details
4843

49-
```shell
50-
curl "https://api.runara.com/clients/{client}"
51-
-H "Authorization: Bearer:your.jwt.token"
52-
```
53-
54-
> The above command returns JSON structured like this:
44+
> Example Response:
5545
5646
```json
5747
{
@@ -113,12 +103,7 @@ client | true | ID of client. | `568b55febffebc91068d4579`
113103

114104
## Add a Client
115105

116-
```shell
117-
curl "https://api.runara.com/clients"
118-
-H "Authorization: you.jwt.token"
119-
```
120-
121-
> The above command returns JSON structured like this:
106+
> Example Response:
122107
123108
```json
124109
{
@@ -185,3 +170,143 @@ Parameter | Required | Description | Example
185170
email | true | Email address of the client. | `[email protected]`
186171
first_name | true | Client's First Name. | `Harry`
187172
last_name | true | Client's Last Name. | `August`
173+
174+
## Get recent activity
175+
176+
> Example Response:
177+
178+
```json
179+
{
180+
"data": {
181+
"recent": {
182+
"upcoming": [
183+
{
184+
"booking_id": "586c7d5e9a89201a3975a7a5",
185+
"type": "class",
186+
"type_id": "57f71b6a9a892007ef2acc69",
187+
"name": "30-Minute Yoga",
188+
"date": "1483956000",
189+
"date_short": "1\/09\/17",
190+
"date_long": "January 9th 2017",
191+
"time": "10:00am",
192+
"location": {
193+
"id": "57f71b1b9a892007ef2acc2f",
194+
"name": "Shields Ltd",
195+
"room": {
196+
"id": null,
197+
"name": null
198+
}
199+
},
200+
"staffed_by": {
201+
"_id": "581d41449a89200452530aca",
202+
"name": "Bianka Cassin"
203+
}
204+
},
205+
{
206+
"booking_id": "586c7d7e9a89200fe53be793",
207+
"type": "class",
208+
"type_id": "57f71b759a892007ef2acc78",
209+
"name": "5 Minute Abs",
210+
"date": "1484541000",
211+
"date_short": "1\/16\/17",
212+
"date_long": "January 16th 2017",
213+
"time": "4:30am",
214+
"location": {
215+
"id": "57f71b4f9a892008497f6169",
216+
"name": "Schuppe, Bergstrom and Carter",
217+
"room": {
218+
"id": "57f71b509a892008497f616b",
219+
"name": "MediumSpringGreen"
220+
}
221+
},
222+
"staffed_by": {
223+
"_id": null,
224+
"name": null
225+
}
226+
}
227+
],
228+
"past": [
229+
{
230+
"booking_id": "586c822d9a89201a3975a7a9",
231+
"type": "class",
232+
"type_id": "57f71b799a892007d959ee1d",
233+
"name": "Grow an Ass Wuori Would Love",
234+
"date": "1483763400",
235+
"date_short": "1\/07\/17",
236+
"date_long": "January 7th 2017",
237+
"time": "4:30am",
238+
"location": {
239+
"id": "57f71b329a892007ef2acc41",
240+
"name": "Ledner, Murphy and Pfeffer",
241+
"room": {
242+
"id": "57f71b339a892007ef2acc42",
243+
"name": "Tan"
244+
}
245+
},
246+
"staffed_by": {
247+
"_id": null,
248+
"name": null
249+
}
250+
},
251+
{
252+
"booking_id": "586d99399a892004494e6421",
253+
"type": "class",
254+
"type_id": "57f71b6a9a892007ef2acc69",
255+
"name": "30-Minute Yoga",
256+
"date": "1483603200",
257+
"date_short": "1\/05\/17",
258+
"date_long": "January 5th 2017",
259+
"time": "8:00am",
260+
"location": {
261+
"id": "57f71b249a892008497f6145",
262+
"name": "Botsford PLC",
263+
"room": {
264+
"id": null,
265+
"name": null
266+
}
267+
},
268+
"staffed_by": {
269+
"_id": "581d41489a8920045120499c",
270+
"name": "Joannie Becker"
271+
}
272+
}
273+
],
274+
"purchases": [
275+
276+
],
277+
"locations": [
278+
{
279+
"id": "57f71b259a892007ef2acc38",
280+
"name": "Mertz-Moore",
281+
"room": {
282+
"id": "57f71b269a892007ef2acc39",
283+
"name": "Red"
284+
}
285+
},
286+
{
287+
"id": "57f71b1b9a892007ef2acc2f",
288+
"name": "Shields Ltd",
289+
"room": {
290+
"id": null,
291+
"name": null
292+
}
293+
},
294+
{
295+
"id": "57f71b4f9a892008497f6169",
296+
"name": "Schuppe, Bergstrom and Carter",
297+
"room": {
298+
"id": "57f71b509a892008497f616b",
299+
"name": "MediumSpringGreen"
300+
}
301+
}
302+
]
303+
}
304+
}
305+
}
306+
```
307+
308+
Returns recent bookings, purchases and locations from the client's records.
309+
310+
### HTTP Request
311+
312+
`POST https://api.runara.com/me`

‎source/includes/_locations.md‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22

33
## Find Nearby Locations
44

5-
```shell
6-
curl "https://api.runara.com/locations/nearby"
7-
-H "Authorization: Bearer:your.jwt.token"
8-
```
9-
> The above command returns the JSON structure:
5+
> Example Response:
106
117
```json
128
{
@@ -103,11 +99,7 @@ category | string | false | Category to limit results to. | 'Spa'
10399

104100
## View Location Details
105101

106-
```shell
107-
curl "https://api.runara.com/locations/{ID}"
108-
-H "Authorization: Bearer:your.jwt.token"
109-
```
110-
> The above command returns the JSON structure:
102+
> Example Response:
111103
112104
```json
113105
{

0 commit comments

Comments
 (0)