README

A PHP SDK for the YourStoryz API, built on top of Saloon. Provides a fluent interface to interact with companies, departments, stories, users, and published videos.

Installation

You can install the package via composer:

composer require sharestoryz/yourstoryz-php-sdk

Usage

Initialization

use YourStoryz\PhpSdk\YourStoryz;

$client = new YourStoryz('your-api-token');

Companies

// List all companies
$response = $client->companies()->all();

// Get a single company
$response = $client->companies()->get(id: 1);

// Get company settings
$response = $client->companies()->settings(companyId: 1);

// Get company departments
$response = $client->companies()->departments(companyId: 1);

// Get company stories
$response = $client->companies()->stories(companyId: 1);

// Get company published videos
$response = $client->companies()->publishedVideos(companyId: 1);

Departments

// List all departments
$response = $client->departments()->all();

// Get a single department
$response = $client->departments()->get(id: 1);

// Get department settings
$response = $client->departments()->settings(departmentId: 1);

// Get department stories
$response = $client->departments()->stories(departmentId: 1);

// Get department published videos
$response = $client->departments()->publishedVideos(departmentId: 1);

Stories

// List all stories
$response = $client->stories()->all();

// Get a single story
$response = $client->stories()->get(id: 1);

// Create a story
$response = $client->stories()->create();

// Update a story
$response = $client->stories()->update(id: 1);

// Delete a story
$response = $client->stories()->delete(id: 1);

Users

// Get the authenticated user
$response = $client->users()->me();

// Get user stories
$response = $client->users()->stories(userId: 1);

// Get user published videos
$response = $client->users()->publishedVideos(userId: 1);

Published Videos

// Get a single published video
$response = $client->publishedVideos()->get(id: 1);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Jan Henk Hazelaar
• All Contributors

License

The MIT License (MIT). Please see License File for more information.