Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
officert committed Jun 13, 2017
1 parent 8984c57 commit e9aeb75
Showing 1 changed file with 31 additions and 24 deletions.
55 changes: 31 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Node client for Sift Science API

Node JS, Promise Based HTTP Client for Sift Science's API.

## Installation
##Installation

```shell
npm install node-siftscience --save
```

## Quick Start
##Quick Start

Create a Sift Science HTTP Client using your API Key:

Expand All @@ -31,9 +31,14 @@ client.events.create({
});
```

## Events
##Table of Contents

### [Custom Events](https://siftscience.com/developers/docs/curl/events-api/custom-events)
* [Events](#events)
* [Labels](#labels)

##Events

###[Custom Events](https://siftscience.com/developers/docs/curl/events-api/custom-events)

```javascript
client.events.create({
Expand All @@ -45,7 +50,7 @@ client.events.create({

The library also supports shortcuts for Sift Science's [Reserved Events](https://siftscience.com/developers/docs/curl/events-api/reserved-events):

### [Create Order](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-order)
###[Create Order](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-order)

```javascript
client.events.createOrder({
Expand All @@ -54,7 +59,7 @@ client.events.createOrder({
});
```

### [Update Order](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-order)
###[Update Order](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-order)

```javascript
client.events.updateOrder({
Expand All @@ -63,7 +68,7 @@ client.events.updateOrder({
});
```

### [Transaction](https://siftscience.com/developers/docs/curl/events-api/reserved-events/transaction)
###[Transaction](https://siftscience.com/developers/docs/curl/events-api/reserved-events/transaction)

```javascript
client.events.transaction({
Expand All @@ -72,7 +77,7 @@ client.events.transaction({
});
```

### [Create Account](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-account)
###[Create Account](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-account)

```javascript
client.events.createAccount({
Expand All @@ -81,7 +86,7 @@ client.events.createAccount({
});
```

### [Update Account](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-account)
###[Update Account](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-account)

```javascript
client.events.updateAccount({
Expand All @@ -90,7 +95,7 @@ client.events.updateAccount({
});
```

### [Create Content](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-content)
###[Create Content](https://siftscience.com/developers/docs/curl/events-api/reserved-events/create-content)

```javascript
client.events.createContent({
Expand All @@ -99,7 +104,7 @@ client.events.createContent({
});
```

### [Update Content](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-content)
###[Update Content](https://siftscience.com/developers/docs/curl/events-api/reserved-events/update-content)

```javascript
client.events.updateContent({
Expand All @@ -108,7 +113,7 @@ client.events.updateContent({
});
```

### [Content Status](https://siftscience.com/developers/docs/curl/events-api/reserved-events/content-status)
###[Content Status](https://siftscience.com/developers/docs/curl/events-api/reserved-events/content-status)

```javascript
client.events.contentStatus({
Expand All @@ -117,7 +122,7 @@ client.events.contentStatus({
});
```

### [Flag Content](https://siftscience.com/developers/docs/curl/events-api/reserved-events/flag-content)
###[Flag Content](https://siftscience.com/developers/docs/curl/events-api/reserved-events/flag-content)

```javascript
client.events.flagContent({
Expand All @@ -126,7 +131,7 @@ client.events.flagContent({
});
```

### [Add Promotion](https://siftscience.com/developers/docs/curl/events-api/reserved-events/add-promotion)
###[Add Promotion](https://siftscience.com/developers/docs/curl/events-api/reserved-events/add-promotion)

```javascript
client.events.addPromotion({
Expand All @@ -135,7 +140,7 @@ client.events.addPromotion({
});
```

### [Add Item To Cart](https://siftscience.com/developers/docs/curl/events-api/reserved-events/add-item-to-cart)
###[Add Item To Cart](https://siftscience.com/developers/docs/curl/events-api/reserved-events/add-item-to-cart)

```javascript
client.events.addItemToCart({
Expand All @@ -144,7 +149,7 @@ client.events.addItemToCart({
});
```

### [Remove Item From Cart](https://siftscience.com/developers/docs/curl/events-api/reserved-events/remove-item-from-cart)
###[Remove Item From Cart](https://siftscience.com/developers/docs/curl/events-api/reserved-events/remove-item-from-cart)

```javascript
client.events.removeItemFromCart({
Expand All @@ -153,7 +158,7 @@ client.events.removeItemFromCart({
});
```

### [Submit Review](https://siftscience.com/developers/docs/curl/events-api/reserved-events/submit-review)
###[Submit Review](https://siftscience.com/developers/docs/curl/events-api/reserved-events/submit-review)

```javascript
client.events.submitReview({
Expand All @@ -162,7 +167,7 @@ client.events.submitReview({
});
```

### [Send Message](https://siftscience.com/developers/docs/curl/events-api/reserved-events/send-message)
###[Send Message](https://siftscience.com/developers/docs/curl/events-api/reserved-events/send-message)

```javascript
client.events.sendMessage({
Expand All @@ -171,7 +176,7 @@ client.events.sendMessage({
});
```

### [Login](https://siftscience.com/developers/docs/curl/events-api/reserved-events/login)
###[Login](https://siftscience.com/developers/docs/curl/events-api/reserved-events/login)

```javascript
client.events.login({
Expand All @@ -180,7 +185,7 @@ client.events.login({
});
```

### [Logout](https://siftscience.com/developers/docs/curl/events-api/reserved-events/logout)
###[Logout](https://siftscience.com/developers/docs/curl/events-api/reserved-events/logout)

```javascript
client.events.logout({
Expand All @@ -189,7 +194,7 @@ client.events.logout({
});
```

### [Link Session To User](https://siftscience.com/developers/docs/curl/events-api/reserved-events/link-session-to-user)
###[Link Session To User](https://siftscience.com/developers/docs/curl/events-api/reserved-events/link-session-to-user)

```javascript
client.events.linkSessionToUser({
Expand All @@ -198,7 +203,7 @@ client.events.linkSessionToUser({
});
```

### [Chargeback](https://siftscience.com/developers/docs/curl/events-api/reserved-events/chargeback)
###[Chargeback](https://siftscience.com/developers/docs/curl/events-api/reserved-events/chargeback)

```javascript
client.events.chargeback({
Expand All @@ -207,7 +212,7 @@ client.events.chargeback({
});
```

### [Order Status](https://siftscience.com/developers/docs/curl/events-api/reserved-events/order-status)
###[Order Status](https://siftscience.com/developers/docs/curl/events-api/reserved-events/order-status)

```javascript
client.events.orderStatus({
Expand All @@ -216,11 +221,13 @@ client.events.orderStatus({
});
```

### [Verification](https://siftscience.com/developers/docs/curl/events-api/reserved-events/verification)
###[Verification](https://siftscience.com/developers/docs/curl/events-api/reserved-events/verification)

```javascript
client.events.verification({
$user_id : '123',
$session_id: 'gigtleqddo84l8cm15qe4il'
});
```

##Labels

0 comments on commit e9aeb75

Please sign in to comment.