retsly-js-backbone

Use Retsly with Backbone.

Install with npm

``sh
npm install --save retsly-js-backbone
`


Install directly from github

`sh
git clone https://github.com/Retsly/retsly-js-backbone.git
cd retsly-js-backbone
npm install # this will also build the javascript
`

Usage

Get a collection of listings

`javascript

/**
* Main.js
*/

var RetslyBackbone = require('retsly-js-backbone')

// Enter your credentials
RetslyBackbone.create(, );

var collection = new RetslyBackbone.Collections.Listings({vendorID: });

// Fetch collection
collection.fetch({success: function (response) {

// response is a collection of listing models
// do something with response

// Optional step - Fetch a specific model
var firstListing = response.models[0];

// Option 1: Enter an ID
var listing = new RetslyBackbone.Models.Listing({_id: firstListing.get('id'), vendorID: });

listing.fetch({success: function (item) {
// do something with listing
console.log(item);
}});

// Option 2: Call fetch directly on the model
firstListing.fetch({success: function (item) {
// do something with listing
console.log(item);
}});

}});
`

To run in your browser:

`sh
browserify main.js -o .js
`

Include the the script in your header
`html



`

API

Example
`js
Retsly.create('asdfkjhgkl', '1234876590abc');
`

- {String} clientId
- {String} browserToken

$3

Example
`js
var collection = new Retsly.Collections.Listings({vendorID: 'test'});
`

##### #RESOURCE:
- Listings
- Agents
- Offices
- OpenHouses
- Vendors
- Parcels
- Assessments
- Transactions

- {String} vendorID
Sets the user tokens and ids

More info regarding Resources can be found in the Retsly Documentation

To get listings is the same as the Backbone fetch` commands.

- collection.fetch(cb)

More info regarding backbone can be found in the Backbone Documentation

Repo Owner

Jason Wan

License

(The MIT License)

Copyright (c) 2013 Retsly Software Inc

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the 'Software'),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.