Download the PHP package jolicode/forecast-php-api without Composer
On this page you can find all versions of the php package jolicode/forecast-php-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jolicode/forecast-php-api
More information about jolicode/forecast-php-api
Files in jolicode/forecast-php-api
Package forecast-php-api
Short Description An up to date PHP client for Harvest Forecast's API
License MIT
Informations about the package forecast-php-api
A PHP Client for Harvest Forecast API
Harvest Forecast is a planification tool built by Harvest.
This PHP SDK is generated automatically with JanePHP using a Forecast OpenAPI specification. It means that:
- the code in the
generated
dorectory is not hand-written but generated; - if the API changes and you need to fix an API call, please edit the OpenAPI specification file, then regenerate the SDK.
Installation
This library is built atop of PSR-7 and PSR-18. So you will need to install some implementations for those interfaces.
If no PSR-18 client or PSR-7 message factory is available yet in your project or you don't care which one to use, just install some default:
You can now install the Forecast client:
Usage
First, you need to retrieve an access token. Please checkout Harvest's documentation about the OAuth2 Authorization Flow.
Then, use the factory that is provided to create the client:
In the above example, the $client
variable is an instance of the Client class, which you can browse through to learn more about the API features.
Want more example or documentation? See the documentation.
Available operations
Instead of the listClients()
method above, you can use all of these methods:
- Account:
getAccount()
- Aggregations:
countScheduledHours()
getRemainingBudgetedHours()
- Assignments:
createAssignment()
deleteAssignment()
editAssignment()
getAssignment()
listAssignments()
- Clients:
getClient()
listClients()
- Persons:
createPerson()
deletePerson()
editPerson()
getPerson()
listPeople()
- Placeholders:
createPlaceholder()
deletePlaceholder()
editPlaceholder()
getPlaceholder()
listPlaceholders()
- Profile:
whoAmI()
- Projects:
getProject()
listProjects()
- RepeatedAssignmentSets:
createRepeatedAssignmentSet()
deleteRepeatedAssignmentSet()
editRepeatedAssignmentSet()
getRepeatedAssignmentSet()
listRepeatedAssignmentSets()
- Roles:
createRole()
deleteRole()
editRole()
getRole()
listRoles()
Troubleshoot
Got some problems using this library? Need a missing feature? Do not hesitate to open an issue and share it with us.
If some operation is missing or not working correctly, please follow the steps to regenerate the SDK.
Further documentation
You can see the current and past versions using one of the following:
- the
git tag
command - the releases page on Github
- the file listing the changes between versions
And finally some meta documentation:
- versioning and branching models
- contribution instructions
License
This library is licensed under the MIT License - see the LICENSE file for details.
All versions of forecast-php-api with dependencies
jane-php/open-api-runtime Version ^7.6
php-http/client-implementation Version *
php-http/client-common Version ^1.9 || ^2.0