README.md

Rent Dynamics JS

CDN

Include jsSHA and our CDN

<script src="https://cdnjs.cloudflare.com/ajax/libs/jsSHA/2.3.1/sha.js"></script>
<script src="https://cdnjs.rentdynamics.com/rentdynamics.latest.js"></script>

var options = {
  apiKey: '<insert-key-here>',
  apiSecretKey: '<insert-secret-key-here>'
};
var rdClient = new RentDynamics.Client(options);
rdClient.login('<username>', '<password>').then(function(result) {
  ...
});
// Then you can make api calls
rdClient.get('/data').then(function(result) {
  ...
});

NPM

Install with npm: npm install rentdynamics

import { Client } from 'rentdynamics';

let options = {
  apiKey: '<insert-key-here>',
  apiSecretKey: '<insert-secret-key-here>'
};
let rdClient = new Client(options);
rdClient.login('<username>', '<password>').then((result: object) => {
  ...
});
// Then you can make api calls
rdClient.get('/data').then((result: array | object) => {
  ...
});

Values

ClientOptions

• apiKey: string (default is undefined)
• apiSecretKey: string (default is undefined)
• authToken: string (default is undefined)
• development: boolean (default is false)
• service: string (default is undefined)
• developmentUrl: string (default is undefined) (This will only be used if development is set to true)
• baseUrl: string (default is undefined) (This will only be used if development is set to false)

Client (requires a ClientOptions to be passed in)

• get(endpoint: string): Promise<any>
• put(endpoint: string, payload: object): Promise<any>
• post(endpoint: string, payload: object): Promise<any>
• delete(endpoint: string): Promise<any>
• login(username: string, password: string): Promise<any>
• logout(): Promise<any>

Available Endpoints

• /appointmentTimes/{communityGroupId}?appointmentDate=11/12/2018

Example Response

["10:00 AM","10:15 AM","10:30 AM","10:45 AM","11:00 AM","11:15 AM","11:30 AM","11:45 AM","12:00 PM","12:15 PM","12:30 PM","12:45 PM","01:00 PM","01:15 PM","01:30 PM","01:45 PM","02:00 PM","02:15 PM","02:30 PM","02:45 PM","03:00 PM","03:15 PM","03:30 PM","03:45 PM","04:00 PM","04:15 PM","04:30 PM","04:45 PM","05:00 PM","05:15 PM","05:30 PM"]

Testing

• npm test > Runs all the tests and checks the code coverage.