Download the PHP package indeximstudio/shipengine without Composer
On this page you can find all versions of the php package indeximstudio/shipengine. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download indeximstudio/shipengine
More information about indeximstudio/shipengine
Files in indeximstudio/shipengine
Package shipengine
Short Description PHP library for the ShipEngine API.
License Apache-2.0
Homepage https://github.com/indeximstudio/shipengine-php
Informations about the package shipengine
ShipEngine PHP
A PHP library built on the ShipEngine API offering low-level access as well as convenience methods.
Table of Contents
- Quick Start
- Examples
- Methods
- Class Objects
- Instantiate ShipEngine Class
- Testing
- Linting
- Contributing
Quick Start
Install ShipEngine via Composer:
- The only configuration requirement is an API Key.
The following example assumes that you have already set the
SHIPENGIEN_API_KEY
environment variable with your Api Key usingputenv()
.
Examples
Methods
- validateAddress - Indicates whether the provided address is valid. If the address is valid, the method returns a normalized version of the address based on the standards of the country in which the address resides.
- normalizeAddress - Returns a normalized, or standardized, version of the address. If the address cannot be normalized, an error is returned.
- trackPackage - Track a package by
packageId
or bycarrierCode
andtrackingNumber
. This method returns the all tracking events for a given shipment.
Class Objects
- [ShipEngine]() - A configurable entry point to the ShipEngine API SDK, this class provides convenience methods for various ShipEngine API Services.
Instantiate ShipEngine Class
- You can also pass the ShipEngine object an array containing
configuration
options instead of a string.
Testing
- You can now run all tests using PHPUnit: phpunit
Linting
You can utilize the composer
script that runs phpcs, phpstan, and php-cs-fixer.
Contributing
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
We are managing php environment
with Nix
and Direnv, and we recommend downloading
them before contributing to this project.
-
The quickest way to install Nix is to open a terminal and run the following command, make sure to follow the instructions output by the installation script:
-
Next, install
Direnv
using one of th methods outlined on their install page here: Direnv Installation -
Lastly, you will need open your terminal and while this repository the current working directory and run
direnv allow
, this will allowdirenv
to auto-load every time you navigate to the repo. This will automatically load theNix
environment which is running the proper version ofPHP and Xdebug (PHP 7.4)
this repository supports/requires.- You will need to
cd
out of the project directory after you first installdirenv
and rundirenv allow
from within the project directory, and thencd
back into the project directory fordirenv
to auto-load theNix
environment properly.
- You will need to
This project also makes use of pre-commit hooks
to help run lint and tests at time of commit, to leverage this you will
need to install pre-commit and run the following command while in this repo:
All versions of shipengine with dependencies
cbschuld/php-uuid-base58 Version ^1.0
guzzlehttp/guzzle Version ^7.0
php-http/client-common Version ^2.3.0
php-http/discovery Version ^1.12.0
php-http/httplug Version ^2.2.0
php-http/message Version ^1.10.0
php-http/message-factory Version ^1.0.2
psr/http-client Version ^1.0.1
psr/http-message Version ^1.0
symfony/event-dispatcher Version ^6.2
symfony/property-access Version ^6.2
symfony/serializer Version ^6.2