Skip to content
Permalink
Browse files

Readme: added methods

  • Loading branch information...
fvdm committed Sep 24, 2012
1 parent a101a3f commit 7cef66dd18152cde73273b451848728d3be2ecaf
Showing with 140 additions and 0 deletions.
  1. +140 −0 README.md
140 README.md
@@ -47,6 +47,146 @@ passdock.templates.list( console.log )
`api.token` is required to authenticate your API calls.


Methods
=======

Each method takes a `callback` function to process the result. This callback receives two parameters: `result` and `error`. When an error occurs the `error` param is an **object** and `result` is the received unparsed text. When all is good `error` is **false** and `result` is the parsed JSON data.

**Warning:** the `error` object may contain your API-key! Make sure this won't go public.

```js
function callback( result, error ) {
if( error ) {
console.log( 'API trouble: '+ error.reason )
} else {
console.log( result )
}
}
```


Templates
---------

### templates.list ( callback )

List all templates in your account.

```js
passdock.templates.list( function( templates ) {
templates.forEach( function( template ) {
console.log( template.title )
})
})
```


### templates.show ( templateID, callback )

Get one template identified with `templateID`.

```js
passdock.templates.show( 2309, function( template ) {
console.log( template.title +' - '+ template.bar.message )
})
```


### templates.delete ( templateID, callback )

Delete a template `templateID` from your account.

```js
passdock.templates.delete( 2309, console.log )
```


Passes
------


### passes.list ( templateID, callback )

List all passes using template `templateID` in your account.

```js
passdock.passes.list( 2309, console.log )
```


### passes.show ( templateID, passID, callback )

Get one pass for `templateID` and `passID`.

```js
passdock.passes.show( 2309, 123, console.log )
```


### passes.delete ( templateID, passID, callback )

Delete one pass with `passID` using `templateID`.

```js
passdock.passes.delete( 2309, 123, console.log )
```


### passes.create ( templateID, passObject, callback )

Create a new pass using `templateID`.

`passObject` can have these properties:

```
serial_number required The serial number for the Pass, must be unique and
cannot be changed
bar.message optional The message to be put in the code
bar.altText optional The alternative text that will be put below the code
For template keys (KEY = keyname):
KEY.label optional The label for the field, usually placed above the value
KEY.value optional The value of the field, usually placed below the label
KEY.message optional The change message that will be shown in the lock screen
and as notification when the value for the field is
changed remotely
```

```js
// KFC pass
var pass = {
serial_number: 'helloWorld123',
bar: {
message: 'http://domain.tld/pass?id=123',
},
Date: {
value: '29-12-2012'
},
PROMOTION: {
value: 'blah'
},
ADDRESS: {
label: 'Different',
value: 'hello world'
}
}
passdock.passes.create( 2309, pass, console.log )
```


### passes.update( templateID, passID, pass, callback )

Update an existing pass `passID` that is using `templateID`.

`pass` can have the same properties as in `passes.create`, but only set the props you wish to change.

```js
passdock.passes.update( 2309, 432, {bar: {message: 'myapp://pass/123'}}, console.log )
```


Unlicense
=========

0 comments on commit 7cef66d

Please sign in to comment.
You can’t perform that action at this time.