README.md in promoter-0.1.5 vs README.md in promoter-0.1.6
- old
+ new
@@ -31,10 +31,12 @@
## Feedback
### Get all feedback
```ruby
Promoter::Feedback.all(score: 8) # => returns all feedback with a score of 8
+# this is paginated. Pass page: 2 to get the second page
+# (I know, this is different from the other api calls! This will be fixed in later versions)
```
Possible filters:
```score``` Filter by the score
```score_type``` Filters by the score type: ```promoter```, ```detractor```, ```passive```
@@ -50,13 +52,18 @@
## Contacts
### Get all contacts
```ruby
-Promoter::Contact.all(2) # => this is paginated - returns page 2 of results
+Promoter::Contact.all(page: 2) # => this is paginated - returns page 2 of results
```
+To find the a contact by an email pass in the ```email``` option:
+```ruby
+Promoter::Contact.all(email: "chris@lexoo.co.uk")
+```
+
### Get a specific contact
```ruby
Promoter::Contact.find(897)
```
@@ -99,10 +106,10 @@
```
### Get all campaigns
```ruby
-Promoter::Campaign.all(2) # => this is paginated - returns page 2 of results
+Promoter::Campaign.all(page: 2) # => this is paginated - returns page 2 of results
```
### Send surveys for a campaign
```ruby