Download the PHP package spatie/laravel-float-sdk without Composer
On this page you can find all versions of the php package spatie/laravel-float-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/laravel-float-sdk
More information about spatie/laravel-float-sdk
Files in spatie/laravel-float-sdk
Package laravel-float-sdk
Short Description A Laravel SDK for the Float.com API
License MIT
Homepage https://github.com/spatie/laravel-float-sdk
Informations about the package laravel-float-sdk
A Laravel SDK for the Float.com API
A Laravel-friendly SDK to interact with the Float API (v3).
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
Add the following environment variables to your .env file:
You can publish the config file with:
This is the contents of the published config file:
Usage
Instantiating the Client
You can use the FloatClient
class to interact with the Float API.
Why is it called FloatClient
and not just Float
, you ask? Well, float is a reserved keyword in PHP.
The FloatClient
is bound to the Laravel service container and can be injected:
Available endpoints
The FloatClient
exposes the following resource groups:
- users()
- projects()
- projectTasks()
- clients()
- allocations()
Each group has methods to fetch individual records or lists with optional filters.
Users
Get user by ID
Get all users
Projects
Get project by ID
Get all projects
Project tasks
Get project task by ID
Get all project tasks
Clients
Get client by ID
Get all clients
Allocations
Get allocations by ID
Get all allocations
Pagination & Sorting
You can pass a parameter object to the all()
methods. All parameters are optional.
page
(int): Page number (default: 1)perPage
(int): Number of items per page (default: 50)sort
(string): Sort field (e.g., "name", "modified_since")
Selecting fields
Limit which fields are returned by passing the fields
array:
Expanding relationships
Some endpoints support expanding related data using the expand
array:
Testing
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
- Niels Vanpachtenbeke
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-float-sdk with dependencies
illuminate/contracts Version ^11.0|^12.0
saloonphp/laravel-plugin Version ^3.0
spatie/laravel-package-tools Version ^1.16