aleahy/saasu-connect

Connect to and use the Saasu API

0.1 2022-03-20 05:52 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.3
• kamermans/guzzle-oauth2-subscriber: ^1.0
• spatie/guzzle-rate-limiter-middleware: ^2.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Alexander Leahy

README

Overview

This php package allows for a connection to Saasu to make requests on the Saasu API.

It caters for searches, inserts and updates.

It uses spatie/guzzle-rate-limiter-middleware to meet the rate limitation of 1 request per second according to the API Limits.

Installing the package

Use composer to install the package.

composer require aleahy/saasu-connect

Usage

In order to connect to a Saasu file, you need a username, password and file ID.

Connecting

$client = SaasuAPI::createClient($username, $password);
$connection = new SaasuAPI($client, $fileID);

Requests can then be made with the connection.

use Aleahy\SaasuConnect\Entities\Invoice as SaasuInvoice;

$connection->findEntity(SaasuInvoice::class, [
  'AmountOwed' => 490.0
]);

Available Methods

The following methods currently exist:

findEntity - Finds the provided entity with the search attributes. Returns a collection of entities.

insertEntity - Makes a post request for the given entity with the provided attributes.

getEntity - Returns the specific entity with the given id.

getAllEntities - Returns all the entities in a single array.

Available Entities

• Company
• Contact
• Invoice