Skip to content

Commit

Permalink
Add Readme contents
Browse files Browse the repository at this point in the history
Unify function methods names
  • Loading branch information
Ismail Ashour committed Nov 8, 2019
2 parents 966a241 + 3cd94d9 commit 6f728a0
Show file tree
Hide file tree
Showing 17 changed files with 106 additions and 17 deletions.
91 changes: 90 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,91 @@
# Laravel Aramex.
# Laravel Aramex

Adds Aramex Functionality to Laravel.

This repo is a rebuild of digitalcloud/aramex.

## Table of Contents

* Installation
* QuickStart
* Location
* Rate
* Shipping
* Tracking

## Installation

Run the following command to install the latest applicable version of the package:

composer require extremesa/aramex

## QuickStart

### Location

#### Fetch Countries

Aramex::FetchCountries()->make();

#### Fetch Country

Aramex::FetchCountry()->make();

#### Fetch States

Aramex::FetchStates()->make();

#### Fetch Cities

Aramex::FetchCities()->make();

#### Validate Address

Aramex::ValidateAddress()->make();

### Rate

### Calculate Rate

Aramex::CalculateRate()->make();

### Shipping

#### Create Pickup

Aramex::CreatePickup()->make();

#### Cancel Pickup

Aramex::CancelPickup()->make();

#### Create Shipments

Aramex::CreateShipments()->make();

#### Get Last Shipments Numbers Range

Aramex::GetLastShipmentsNumbersRange()->make();

#### Print Label

Aramex::PrintLabel()->make();

#### Reserve Shipment Number Range

Aramex::ReserveShipmentNumberRange()->make();

#### Schedule Delivery

Aramex::ScheduleDelivery()->make();

### Tracking

#### Track Pickup

Aramex::TrackPickup()->make();

#### Track Shipments

Aramex::TrackShipments()->make();

2 changes: 1 addition & 1 deletion src/API/Requests/Location/FetchCities.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class FetchCities extends API implements Normalize
* @return CitiesFetchingResponse
* @throws \Exception
*/
public function fetch()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Location/FetchCountries.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class FetchCountries extends API implements Normalize
* @return CountriesFetchingResponse
* @throws \Exception
*/
public function fetch()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Location/FetchCountry.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class FetchCountry extends API implements Normalize
* @return CountryFetchingResponse
* @throws Exception
*/
public function fetch()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Location/FetchOffices.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class FetchOffices extends API implements Normalize
* @return OfficesFetchingResponse
* @throws Exception
*/
public function fetch()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Location/FetchStates.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class FetchStates extends API implements Normalize
* @return StatesFetchingResponse
* @throws Exception
*/
public function fetch()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Location/ValidateAddress.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ValidateAddress extends API implements Normalize
* @return AddressValidationResponse
* @throws \Exception
*/
public function check()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Rate/CalculateRate.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public function __construct()
* @return RateCalculatorResponse
* @throws Exception
*/
public function calculate()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/CancelPickup.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class CancelPickup extends API implements Normalize
* @return PickupCancellationResponse
* @throws Exception
*/
public function create(): PickupCancellationResponse
public function make(): PickupCancellationResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/CreatePickup.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class CreatePickup extends API implements Normalize
* @return PickupCreationResponse
* @throws Exception
*/
public function create(): PickupCreationResponse
public function make(): PickupCreationResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/CreateShipments.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class CreateShipments extends API implements Normalize
* @return ShipmentCreationResponse
* @throws Exception
*/
public function create(): ShipmentCreationResponse
public function make(): ShipmentCreationResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/GetLastShipmentsNumbersRange.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class GetLastShipmentsNumbersRange extends API implements Normalize
* @return LastReservedShipmentNumberRangeResponse
* @throws Exception
*/
public function create(): LastReservedShipmentNumberRangeResponse
public function make(): LastReservedShipmentNumberRangeResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/PrintLabel.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class PrintLabel extends API implements Normalize
* @return LabelPrintingResponse
* @throws Exception
*/
public function create(): LabelPrintingResponse
public function make(): LabelPrintingResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/ReserveShipmentNumberRange.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class ReserveShipmentNumberRange extends API implements Normalize
* @return ReserveRangeResponse
* @throws Exception
*/
public function create(): ReserveRangeResponse
public function make(): ReserveRangeResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Shipping/ScheduleDelivery.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class ScheduleDelivery extends API implements Normalize
* @return ScheduledDeliveryResponse
* @throws Exception
*/
public function create(): ScheduledDeliveryResponse
public function make(): ScheduledDeliveryResponse
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Tracking/TrackPickup.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class TrackPickup extends API implements Normalize
* @return PickupTrackingResponse
* @throws Exception
*/
public function track()
public function make()
{
$this->validate();

Expand Down
2 changes: 1 addition & 1 deletion src/API/Requests/Tracking/TrackShipments.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class TrackShipments extends API implements Normalize
* @return ShipmentTrackingResponse
* @throws Exception
*/
public function track()
public function make()
{
$this->validate();

Expand Down

0 comments on commit 6f728a0

Please sign in to comment.