christohill / waiverforever-api-php
A PHP wrapper for the Waiver Forever API
dev-master
2019-02-22 21:27 UTC
Requires
- php: >=7.0
- guzzlehttp/guzzle: >=6.0
This package is auto-updated.
Last update: 2024-04-23 08:51:56 UTC
README
This is a simple PHP SDK for interacting with the Waiver Forever API. All API documentation can be found at https://docs.waiverforever.com
Installation
composer require christohill/waiverforever-api-php
Usage
Note: none of the API keys or ID below are valid
Simple usage
use WaiverForever\WaiverForever; $waivers = new WaiverForever('edf59be9216e66eb17093574376d4c5f'); $user = $waivers->UserInfo(); // Get user info for the API key $templates = $waivers->TemplateList(); // List all templates $signed = $waivers->SignedWaiver('aWd898gfdsa789ddf'); // Get a signed waiver
Methods
Method | Description | Docs |
---|---|---|
UserInfo() | Get user info for the API key | Read docs |
AllSubscriptions() | Get all webhooks subscriptions | Read docs |
CreateSubscription($target, $template, $event) | Subscribe an event/webhook | Read docs |
DeleteSubscription($subscriptionID) | Unsubscribe an event | Read docs |
TemplateList() | List all templates | Read docs |
WaiverRequest($template, $expiry) | Request a waiver to sign | Read docs |
TrackingWaiver($trackingID) | Query signed waiver by tracking id | Read docs |
SignedWaiver($waiver) | Get a signed waiver | Read docs |
SearchWaiver($filters) | Search waiver with keywords | Read docs |
WaiverPDF($waiver) | Download waiver in pdf | Read docs |
WaiverPicture($waiver, $picture) | Download waiver pictures | Read docs |