Download the PHP package trycourier/courier without Composer
On this page you can find all versions of the php package trycourier/courier. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download trycourier/courier
More information about trycourier/courier
Files in trycourier/courier
Informations about the package courier
Courier PHP SDK
The Courier PHP library provides convenient access to the Courier API from PHP.
Requirements
Use of the Courier PHP SDK requires:
- PHP ^8.1
Installation
Use Composer to configure and install the Courier PHP SDK:
Usage
Instantiation
To get started with the Courier SDK, instantiate the CourierClient
class as follows:
Alternatively, you can omit the token when constructing the client.
In this case, the SDK will automatically read the token from the
COURIER_AUTH_TOKEN
environment variable:
Environment and Custom URLs
This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.
Environments
Custom URL
Enums
This SDK leverages PHP 8.1's first-class enums to improve type safety and usability. In order to maintain forward
compatibility with the API—where new enum values may be introduced in the future—we define enum properties as string
and use value-of
annotations to specify the corresponding enum type.
Example Usage
PHPDoc Annotations
Exception Handling
When the API returns a non-zero status code, (4xx
or 5xx
response), a CourierApiException
will be thrown:
Advanced
Pagination
The SDK supports pagination for endpoints that return lists of items:
Custom HTTP Client
This SDK is built to work with any HTTP client that implements Guzzle's ClientInterface
. By default, if no client
is provided, the SDK will use Guzzle's default HTTP client. However, you can pass your own client that adheres to
ClientInterface
:
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!