hellohi/api-client

MKA API client

2.0 2020-04-30 15:26 UTC

Requires

• php: >=7.0
• illuminate/http: ^5.6|^5.7|^5.8|^6.0|^7.0
• illuminate/pagination: ^5.6|^5.7|^5.8|^6.0|^7.0
• kamermans/guzzle-oauth2-subscriber: ^1.0
• tightenco/collect: 7.9.2

Proprietary

• Peter Mein
• Rens Reinders

README

PHP Client for the HelloHi API. This documentation uses the threads endpoint as example. For a a list of available endpionts, please refer to the client documentation. ##url-here-please##.

Setup

require_once __DIR__ . '/vendor/autoload.php'; 

use ApiClient\Client;
use ApiClient\Model;

Client::init(
	"https://api.staging.hellohi.nl/v1/oauth/token",
	"https://api.staging.hellohi.nl/v1",
	"your-oauth-client-id",
	"your-oauth-your-secret",
	"[e-mail]",
	"your-password",
	"your-tenant-id"
);

get threads with creator includes

$threads = Model::all('threads', ['creator']);

get all threads magic with creator includes

$threads = Model::threads(['creator']);

find a thread by id static

$thread = Model::byId('threads', "mjkvxl5qmwza68b9");

get thread items magic

$thread->all('items');

get thread_items magic

$thread->items; //$thread->items();

find a thread_item by id

$thread->byId('items', "mn9vlbrl4w8zjoqx");

get thread_items with includes

$items = $thread->items(['participant', 'participant.person']);

create a thread

$thread->create('threads', [
	'subject' => 'Rapportage',
	'company_id' => 'kyd9nprax5lajbv3',
	'participants' => [
		[
			'person_id' => '8bkgjnrmdrz63pvd',
			'customer_id' => 'kyd9nprax5lajbv3',
			'is_admin' => 0
		]
	],
	'dossier_item_groups' => [
		[
			'dossier_item_group_template_id' => '8bkgjnrmdrz63pvd',
			'year' => 2017,
			'period' => 'q2'
		]
	],
	'message' => 'branker'
]);

update a thread

$thread = Model::byId('threads', "kyd9nprax5lajbv3");
$thread->update([
  'subject' => 'Some subject'
]);

update a thread message with endpoint override

Sometimes it is necessary to override endpoints when using polymorphic relations. For example. Thread messages are fetched using their polymorphic master class 'item' trough /threads/{id}/items, but updated using their own endpoint /threads/{id}/messages.

$thread->all('items')[0]
  ->setEndpoint('messages')
  ->update(['message' => 'Different message']);

delete a thread

$thread->delete();