Skip to content

Commit 8edb066

Browse files
committed
update README
1 parent 8c6d426 commit 8edb066

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,73 @@ To start, create a new `TestingBot\TestingBotAPI` object and pass in the key and
3434

3535
Now you can use the various methods we've made available to interact with the API:
3636

37+
### getUserInfo
38+
Gets your user information
39+
40+
```php
41+
$api->getUserInfo();
42+
```
43+
44+
### updateUserInfo
45+
Updates your user information
46+
47+
```php
48+
$api->updateUserInfo(array('first_name' => 'test'));
49+
```
50+
3751
### updateJob
3852
Updates a Test with Meta-data to display on TestingBot.
3953
For example, you can specify the test name and whether the test succeeded or failed:
4054

4155
```php
4256
$api->updateJob($webdriverSessionID, array('name' => 'mytest', 'success' => true));
57+
```
58+
59+
### getJob
60+
Gets meta information for a job (test) by passing in the WebDriver sessionID of the test you ran on TestingBot:
61+
62+
```php
63+
$api->getJob($webdriverSessionID);
64+
```
65+
66+
### getJobs
67+
Gets a list of previous jobs/tests that you ran on TestingBot, order by last run:
68+
69+
```php
70+
$api->getJobs(0, 10); // last 10 tests
71+
```
72+
73+
### deleteJob
74+
Deletes a test from TestingBot
75+
76+
```php
77+
$api->deleteJob($webdriverSessionID);
78+
```
79+
80+
### stopJob
81+
Stops a running test on TestingBot
82+
83+
```php
84+
$api->stopJob($webdriverSessionID);
85+
```
86+
87+
### getBuilds
88+
Gets a list of builds that you ran on TestingBot, order by last run:
89+
90+
```php
91+
$api->getBuilds(0, 10); // last 10 builds
92+
```
93+
94+
### getBuild
95+
Gets a build from TestingBot (a group of tests)
96+
97+
```php
98+
$api->getBuild($buildIdentifier);
99+
```
100+
101+
### getTunnels
102+
Gets a list of active tunnels for your account.
103+
104+
```php
105+
$api->getTunnels();
43106
```

0 commit comments

Comments
 (0)