PHP code example of smartwaiver / smartwaiver-sdk

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

smartwaiver / smartwaiver-sdk example snippets

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// Now request a list of all the waiver templates
$templates = $sw->getWaiverTemplates();

foreach ($templates as $template) {
    echo $template->templateId . ': ' . $template->title . PHP_EOL;
}

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// The unique ID of the template to be retrieved
$templateId = '[INSERT TEMPLATE ID]';

// Retrieve a specific template (SmartwaiverTemplate object)
$template = $sw->getWaiverTemplate($templateId);

// Access properties of the template
echo PHP_EOL . 'List single template:' . PHP_EOL;
echo $template->templateId . ': ' . $template->title . PHP_EOL;

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// Get a list of summaries of waivers
$waiverSummaries = $sw->getWaiverSummaries();

// Loop through the waivers and access their properties
echo 'List all waivers:' . PHP_EOL;
foreach ($waiverSummaries as $waiverSummary) {
    echo $waiverSummary->waiverId . ': ' . $waiverSummary->title . PHP_EOL;
}

// Set the limit
$limit = 5;

// Get a list of summaries of waivers
$waiverSummaries = $sw->getWaiverSummaries($limit);

// Set the limit
$limit = 5;

// Set the verified parameter
$verified = false;

// Get a list of summaries of waivers
$waiverSummaries = $sw->getWaiverSummaries($limit, $verified);

// An example limiting the parameters
$limit = 5;                                     // Limit number returned to 5
$verified = true;                               // Limit only to waivers that were signed at a kiosk or verified over email
$templateId = '[INSERT TEMPLATE ID]';           // Limit query to waivers of this template ID
$fromDts = date('c', strtotime('2016-11-01'));  // Limit to waivers signed in November of 2016
$toDts = date('c', strtotime('2016-12-01'));
$firstName = 'Kyle';                            // Limit to waivers with a participant named Kyle Smith
$lastName = 'Smith';

// Get a list of summaries of waivers
$waiverSummaries = $sw->getWaiverSummaries($limit, $verified, $templateId, $fromDts, $toDts);

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// The unique ID of the signed waiver to be retrieved
$waiverId = '[INSERT WAIVER ID]';

// Get a specific waiver
$waiver = $sw->getWaiver($waiverId);

// Access properties of waiver
echo PHP_EOL . 'List single waiver:' . PHP_EOL;
echo $waiver->waiverId . ': ' . $waiver->title . PHP_EOL;

// The unique ID of the signed waiver to be retrieved
$waiverId = '[INSERT WAIVER ID]';

$pdf = true;

// Get the waiver object
$waiver = $sw->getWaiver($waiverId, $pdf);

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// TThe unique ID of the signed waiver to retrieve the photos for
$waiverId = '[INSERT WAIVER ID]';

// Get the photos for a specific waiver
$photos = $sw->getWaiverPhotos($waiverId);

// Print a little header
echo PHP_EOL . 'Waiver Photos for: ' . $photos->title . PHP_EOL;
// echo $photos->waiverId;
// echo $photos->templateId;
// echo $photos->createdOn;

// Loop through photos and print out some meta-data
foreach ($photos->photos as $photo) {
    echo $photo->photoId . ': ' . $photo->date;
    // Other fields
    // echo $photo->type;
    // echo $photo->tag;
    // echo $photo->fileType;
    // echo $photo->photo; // Base 64 encoded photo
}

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// Request all waivers signed in 2017
$search = $sw->search('', '2017-01-01 00:00:00');

// Print out some information about the result of the search
echo 'Search Complete:' . PHP_EOL;
echo "\t" . 'Search ID: ' . $search->guid . PHP_EOL;
echo "\t" . 'Waiver Count: ' . $search->count . PHP_EOL;
echo "\t" . $search->pages . ' pages of size ' . $search->pageSize . PHP_EOL . PHP_EOL;

// First we set up our list
$nameList = [];

// Loop through all the pages in the search result
for($i = 0; $i < $search->pages; $i++) {
    echo 'Requesting page: ' . $i . '/' . $search->pages . '...' . PHP_EOL;

    // Request each page from the server
    $waivers = $sw->searchResult($search, $i);

    echo 'Processing page: ' . $i . '/' . $search->pages . '...' . PHP_EOL;

    // Loop through the waivers and create a comma separated list of first names
    foreach ($waivers as $waiver) {
        array_push($nameList, $waiver->firstName);

        // View all accessible properties of a waiver object in:
        // examples/waivers/WaiverProperties.php
    }
}

// The unique ID of the template to search for
$templateId = '[INSERT TEMPLATE ID]';

// Request all waivers signed for this template
$search = $sw->search($templateId);

// Request all waivers signed that not have been email verified
$search = $sw->search('', '', '', '', '', false);

// Request all waivers signed for this template after the given date
$search = $sw->search($templateId, '2017-01-01 00:00:00');

// Request all waivers signed for this template before the given date
$search = $sw->search($templateId, '', '2017-01-01 00:00:00');

// Request all waivers signed for this template with a participant name Kyle
$search = $sw->search($templateId, '', '', 'Kyle');

// Request all waivers signed for this template with a participant name Kyle Smith
$search = $sw->search($templateId, '', '', 'Kyle', 'Smith');

// Request all waivers signed with a participant name Kyle that have been email verified
$search = $sw->search('', '', '', 'Kyle', '', true);

// Request all waivers signed in ascending sorted order
//$search = $sw->search($templateId, '', '', '', '', null, false);

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// Get the current webhook settings
$webhooks = $sw->getWebhookConfig();

// Access the webhook config
echo 'Endpoint: ' . $webhooks->endpoint . PHP_EOL;
echo 'EmailValidationRequired: ' . $webhooks->emailValidationRequired . PHP_EOL;

// The new values to set
$endpoint = 'http://endpoint.example.org';
$emailValidationRequired = SmartwaiverWebhook::WEBHOOK_AFTER_EMAIL_ONLY;

// Set the webhook to new values
$webhook = $sw->setWebhookConfig($endpoint, $emailValidationRequired);

// Access the new webhook config
echo 'Successfully set new configuration.' . PHP_EOL;
echo 'Endpoint: ' . $newWebhook->endpoint . PHP_EOL;
echo 'EmailValidationRequired: ' . $newWebhook->emailValidationRequired . PHP_EOL;

$sw->deleteWebhookConfig();

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// Get the current webhook queue information
$queues = $sw->getWebhookQueues();

// Access the account level webhook information
if (is_null($queues->accountQueue)) {
    echo 'Account Queue: N/A' . PHP_EOL;
} else {
    echo 'Account Queue:' . PHP_EOL;
    echo "\tTotal Messages: " . $queues->accountQueue->messagesTotal . PHP_EOL;
    echo "\tMessages Not Visible: " . $queues->accountQueue->messagesNotVisible . PHP_EOL;
    echo "\tMessages Delayed: " . $queues->accountQueue->messagesDelayed . PHP_EOL;
}

// Access the template level webhook information
foreach ($queues->templateQueues as $templateId => $templateQueue) {
    echo 'Template Queue (' . $templateId . '):' . PHP_EOL;
    echo "\tTotal Messages: " . $queues->accountQueue->messagesTotal . PHP_EOL;
    echo "\tMessages Not Visible: " . $queues->accountQueue->messagesNotVisible . PHP_EOL;
    echo "\tMessages Delayed: " . $queues->accountQueue->messagesDelayed . PHP_EOL;
}

// Retrieve a message from the account queue
$message = $sw->getWebhookQueueAccountMessage();

// The Unique ID of the waiver template
$templateId = '[INSERT TEMPLATE ID]';

// Retrieve a message from the template queue
$message = $sw->getWebhookQueueAccountMessage($templateId);

// Check for empty queue
if (is_null($message)) {
    echo 'No messages in account queue.' . PHP_EOL;
    exit;
}

// Print out message info
echo 'Message in Account Queue' . PHP_EOL;
echo "\tMessage ID: " . $message->messageId . PHP_EOL;
echo "\tMessage Payload: " . PHP_EOL;
echo "\t\tWaiver ID: " . $message->body->uniqueId . PHP_EOL;
echo "\t\tEvent: " . $message->body->event . PHP_EOL;

$delete = $sw->deleteWebhookQueueAccountMessage($message->messageId);

echo 'Deletion Success: ' . ($delete->success ? 'true' : 'false') . PHP_EOL;

// Optionally we can delete the message when we retrieve it, by passing a delete flag
$message = $sw->getWebhookQueueAccountMessage(true);

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// The Waiver ID to access
$waiverId = 'InvalidWaiverId';

// Try to get the waiver object
$waiver = $sw->getWaiver($waiverId);

try
{
    // Try to get the waiver object
    $waiver = $sw->getWaiver($waiverId);
}
catch (SmartwaiverHTTPException $se)
{
    // Print out that we encountered an error
    echo 'Error retrieving waiver from API server...' . PHP_EOL . PHP_EOL;
}

// The code will be the HTTP Status Code returned
echo 'Error Code: ' . $se->getCode() . PHP_EOL;
// The message will be informative about what was wrong with the request
echo 'Error Message: ' . $se->getMessage() . PHP_EOL . PHP_EOL;

// Also 

try
{
    // Try to get the waiver object
    $waiver = $sw->getWaiver($waiverId);
}
catch (SmartwaiverRateLimitException $se)
{
    // The number of requests that have taken place in the current window
    echo 'Number of requests: ' . $se->requests . PHP_EOL;
    // The max number of requests for routes of this type in the current window
    echo 'Max requests: ' . $se->max . PHP_EOL;
    // The number of seconds to wait until trying again
    echo 'Retry after: ' . $se->retryAfter . PHP_EOL;
}

// The API Key for your account
$apiKey = '[INSERT API KEY]';

// Set up your Smartwaiver connection using your API Key
$sw = new Smartwaiver($apiKey);

// Get a list of all signed waivers for this account
$response = $sw->getWaiverSummariesRaw();

// The response object has two variables, status code and response body
echo 'Status Code: ' . $response->statusCode . PHP_EOL;
echo 'Body: ' . $response->body . PHP_EOL;

SmartwaiverRoutes::getWaiverTemplates();

SmartwaiverHTTPException::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse, string $guzzleBody, string $content )

SmartwaiverHTTPException::getGuzzleResponse(  ): \GuzzleHttp\Psr7\Response

SmartwaiverHTTPException::getGuzzleBody(  ): string

SmartwaiverHTTPException::getResponseInfo(  ): array

SmartwaiverRateLimitException::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse, string $guzzleBody, string $content )

SmartwaiverRateLimitException::getResponseInfo(  ): array

SmartwaiverRateLimitException::getGuzzleResponse(  ): \GuzzleHttp\Psr7\Response

SmartwaiverRateLimitException::getGuzzleBody(  ): string

SmartwaiverSDKException::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse, string $guzzleBody, string $message, integer $code )

SmartwaiverSDKException::getGuzzleResponse(  ): \GuzzleHttp\Psr7\Response

SmartwaiverSDKException::getGuzzleBody(  ): string

Smartwaiver::__construct( string $apiKey, array<mixed,array> $guzzleOptions = array() )

Smartwaiver::getWaiverTemplates(  ): array<mixed,\Smartwaiver\Types\SmartwaiverTemplate>

Smartwaiver::getWaiverTemplate( string $templateId ): \Smartwaiver\Types\SmartwaiverTemplate

Smartwaiver::getWaiverSummaries( integer $limit = 20, boolean|null $verified = null, string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', string $tag = '' ): array<mixed,\Smartwaiver\Types\SmartwaiverWaiverSummary>

Smartwaiver::getWaiver( string $waiverId, boolean $pdf = false ): \Smartwaiver\Types\SmartwaiverWaiver

Smartwaiver::getWaiverPhotos( string $waiverId ): \Smartwaiver\Types\SmartwaiverPhotos

Smartwaiver::getWaiverSignatures( string $waiverId ): \Smartwaiver\Types\SmartwaiverSignatures

Smartwaiver::search( string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', boolean|null $verified = null, boolean $sortDesc = true, string $tag = '' ): \Smartwaiver\Types\SmartwaiverSearch

Smartwaiver::searchResult( \Smartwaiver\Types\SmartwaiverSearch $search, integer $page ): array<mixed,\Smartwaiver\Types\SmartwaiverWaiver>

Smartwaiver::searchResultByGuid( string $guid, integer $page ): array<mixed,\Smartwaiver\Types\SmartwaiverWaiver>

Smartwaiver::getWebhookConfig(  ): \Smartwaiver\Types\SmartwaiverWebhook

Smartwaiver::setWebhookConfig( string $endpoint, string $emailValidationRequired ): \Smartwaiver\Types\SmartwaiverWebhook

Smartwaiver::setWebhook( \Smartwaiver\Types\SmartwaiverWebhook $webhook ): \Smartwaiver\Types\SmartwaiverWebhook

Smartwaiver::getWebhookQueues(  ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookQueues

Smartwaiver::getWebhookQueueAccountMessage( boolean $delete = false ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessage|null

Smartwaiver::getWebhookQueueTemplateMessage( string $templateId, boolean $delete = false ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessage

Smartwaiver::deleteWebhookQueueAccountMessage( string $messageId ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessageDelete

Smartwaiver::deleteWebhookQueueTemplateMessage( string $templateId, string $messageId ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessageDelete

Smartwaiver::createDynamicTemplate( \Smartwaiver\Types\Template\SmartwaiverTemplateConfig $templateConfig, \Smartwaiver\Types\Data\SmartwaiverTemplateData $data, integer $expiration ): \Smartwaiver\Types\SmartwaiverDynamicTemplate

Smartwaiver::processDynamicTemplate( string $transactionId ): \Smartwaiver\Types\SmartwaiverDynamicProcess

Smartwaiver::getWaiverTemplatesRaw(  ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWaiverTemplateRaw( string $templateId ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWaiverSummariesRaw( integer $limit = 20, boolean|null $verified = null, string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', string $tag = '' ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWaiverRaw( string $waiverId, boolean $pdf = false ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWaiverPhotosRaw( string $waiverId ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWaiverSignaturesRaw( string $waiverId ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::searchRaw( string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', boolean|null $verified = null, boolean $sortDesc = true, string $tag = '' ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::searchResultByGuidRaw( string $guid, integer $page ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWebhookConfigRaw(  ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::setWebhookConfigRaw( string $endpoint, string $emailValidationRequired ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWebhookQueuesRaw(  ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWebhookQueueAccountMessageRaw( boolean $delete = false ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getWebhookQueueTemplateMessageRaw( string $templateId, boolean $delete = false ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::deleteWebhookQueueAccountMessageRaw( string $messageId ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::deleteWebhookQueueTemplateMessageRaw( string $templateId, string $messageId ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::createDynamicTemplateRaw( \Smartwaiver\Types\Template\SmartwaiverTemplateConfig $templateConfig, \Smartwaiver\Types\Data\SmartwaiverTemplateData $data, integer $expiration ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::processDynamicTemplateRaw( string $transactionId ): \Smartwaiver\SmartwaiverRawResponse

Smartwaiver::getLastResponse(  ): \Smartwaiver\SmartwaiverResponse|null

SmartwaiverRawResponse::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse )

SmartwaiverResponse::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse )

SmartwaiverResponse::getGuzzleResponse(  ): \GuzzleHttp\Psr7\Response

SmartwaiverResponse::getGuzzleBody(  ): string

SmartwaiverRoutes::getWaiverTemplates(  ): string

php
SmartwaiverTemplateData::apiArray(  ): \ArrayObject

php
SmartwaiverCustomField::__construct( array $field )

php
SmartwaiverCustomField::getArrayInput(  ): array

php
SmartwaiverDynamicProcess::__construct( array $dynamicProcess )

php
SmartwaiverDynamicProcess::getArrayInput(  ): array

php
SmartwaiverDynamicTemplate::__construct( array $dynamicTemplate )

php
SmartwaiverDynamicTemplate::getArrayInput(  ): array

php
SmartwaiverFlag::__construct( array $field )

php
SmartwaiverFlag::getArrayInput(  ): array

php
SmartwaiverGuardian::__construct( array $guardian )

php
SmartwaiverGuardian::getArrayInput(  ): array

php
SmartwaiverParticipant::__construct( array $participant )

php
SmartwaiverParticipant::getArrayInput(  ): array

php
SmartwaiverPhoto::__construct( array $photo )

php
SmartwaiverPhoto::getArrayInput(  ): array

php
SmartwaiverPhotos::__construct( array $photos )

php
SmartwaiverPhotos::getArrayInput(  ): array

php
SmartwaiverSearch::__construct( array $search )

php
SmartwaiverSearch::getArrayInput(  ): array

php
SmartwaiverSignatures::__construct( array $signatures )

php
SmartwaiverSignatures::getArrayInput(  ): array

php
SmartwaiverTemplate::__construct( array $template )

php
SmartwaiverTemplate::getArrayInput(  ): array

php
SmartwaiverType::__construct( array $input, array $

php
SmartwaiverType::getArrayInput(  ): array

php
SmartwaiverWaiver::__construct( array $waiver )

php
SmartwaiverWaiver::getArrayInput(  ): array

php
SmartwaiverWaiverSummary::__construct( array $summary )

php
SmartwaiverWaiverSummary::getArrayInput(  ): array

php
SmartwaiverWebhook::__construct( array $webhook )

php
SmartwaiverWebhook::getArrayInput(  ): array

php
SmartwaiverTemplateBody::__construct( array $body = array() )

php
SmartwaiverTemplateBody::getArrayInput(  ): array

php
SmartwaiverTemplateBody::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateCompletion::__construct( array $completion = array() )

php
SmartwaiverTemplateCompletion::getArrayInput(  ): array

php
SmartwaiverTemplateCompletion::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateConfig::__construct( array $config = array() )

php
SmartwaiverTemplateConfig::getArrayInput(  ): array

php
SmartwaiverTemplateConfig::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateElectronicConsent::__construct( array $electronicConsent = array() )

php
SmartwaiverTemplateElectronicConsent::getArrayInput(  ): array

php
SmartwaiverTemplateElectronicConsent::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateGuardian::__construct( array $guardian = array() )

php
SmartwaiverTemplateGuardian::getArrayInput(  ): array

php
SmartwaiverTemplateGuardian::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateHeader::__construct( array $header = array() )

php
SmartwaiverTemplateHeader::getArrayInput(  ): array

php
SmartwaiverTemplateHeader::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateMeta::__construct( array $meta = array() )

php
SmartwaiverTemplateMeta::getArrayInput(  ): array

php
SmartwaiverTemplateMeta::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateParticipants::__construct( array $participants = array() )

php
SmartwaiverTemplateParticipants::getArrayInput(  ): array

php
SmartwaiverTemplateParticipants::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateProcessing::__construct( array $processing = array() )

php
SmartwaiverTemplateProcessing::getArrayInput(  ): array

php
SmartwaiverTemplateProcessing::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateSignatures::__construct( array $signatures = array() )

php
SmartwaiverTemplateSignatures::getArrayInput(  ): array

php
SmartwaiverTemplateSignatures::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateStandardQuestions::__construct( array $standardQuestions = array() )

php
SmartwaiverTemplateStandardQuestions::getArrayInput(  ): array

php
SmartwaiverTemplateStandardQuestions::apiArray(  ): \ArrayObject

php
SmartwaiverTemplateStyling::__construct( array $styling = array() )

php
SmartwaiverTemplateStyling::getArrayInput(  ): array

php
SmartwaiverTemplateStyling::apiArray(  ): \ArrayObject

php
SmartwaiverWebhookMessage::__construct( array $webhookMessage )

php
SmartwaiverWebhookMessage::getArrayInput(  ): array

php
SmartwaiverWebhookMessageDelete::__construct( array $webhookMessageDelete )

php
SmartwaiverWebhookMessageDelete::getArrayInput(  ): array

php
SmartwaiverWebhookMessagePayload::__construct( array $webhookMessagePayload )

php
SmartwaiverWebhookMessagePayload::getArrayInput(  ): array

php
SmartwaiverWebhookQueue::__construct( array $webhookQueue )

php
SmartwaiverWebhookQueue::getArrayInput(  ): array

php
SmartwaiverWebhookQueues::__construct( array $webhookQueues )

php
SmartwaiverWebhookQueues::getArrayInput(  ): array