PHPackages smartwaiver/smartwaiver-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. smartwaiver/smartwaiver-sdk ActiveLibrary[API Development](/categories/api) smartwaiver/smartwaiver-sdk =========================== Smartwaiver SDK for version 4 of the API 4.3.1(7y ago)461.7k↓43.4%9[2 PRs](https://github.com/smartwaivercom/php-sdk/pulls)Apache-2.0PHPPHP >= 5.6 Since Jan 24Pushed 2y ago1 watchersCompare [ Source](https://github.com/smartwaivercom/php-sdk)[ Packagist](https://packagist.org/packages/smartwaiver/smartwaiver-sdk)[ RSS](/packages/smartwaiver-smartwaiver-sdk/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (2)Versions (7)Used By (0) [![](https://camo.githubusercontent.com/bf6bd8a3cd274ae97dedcca48b3ec4724efbe0ce223aff4e2442035ed8bb62b7/68747470733a2f2f64333632713474767931656c786a2e636c6f756466726f6e742e6e65742f6865616465725f6c6f676f6865616465722e706e67)](https://camo.githubusercontent.com/bf6bd8a3cd274ae97dedcca48b3ec4724efbe0ce223aff4e2442035ed8bb62b7/68747470733a2f2f64333632713474767931656c786a2e636c6f756466726f6e742e6e65742f6865616465725f6c6f676f6865616465722e706e67) PHP-SDK ======= [](#php-sdk) Table of Contents ================= [](#table-of-contents) - [Table of contents](#table-of-contents) - [Installation](#installation) - [Getting Started](#getting-started) - [Retrieve a Specific Template](#retrieve-a-specific-template) - [List all Signed Waivers](#list-all-signed-waivers) - [Retrieve a Specific Waiver](#retrieve-a-specific-waiver) - [Retrieve Photos on a Waiver](#retrieve-photos-on-a-waiver) - [Search for Waivers](#search-for-waivers) - [Retrieve/Set Webhook Config](#retrieveset-webhook-configuration) - [Retrieve Messages From Webhook Queues](#retrieve-messages-from-webhook-queues) - [Exception Handling](#exception-handling) - [Status Codes](#status-codes) - [Advanced](#advanced) - [Raw Responses](#raw-responses) - [URL Generation](#url-generation) - [Authentication](#authentication) - [API Documentation](#api-documentation) - [Smartwaiver/Exceptions/SmartwaiverHTTPException](#smartwaiverexceptionssmartwaiverhttpexception) - [Smartwaiver/Exceptions/SmartwaiverRateLimitException](#smartwaiverexceptionssmartwaiverratelimitexception) - [Smartwaiver/Exceptions/SmartwaiverSDKException](#smartwaiverexceptionssmartwaiversdkexception) - [Smartwaiver/Smartwaiver](#smartwaiversmartwaiver) - [Smartwaiver/SmartwaiverRawResponse](#smartwaiversmartwaiverrawresponse) - [Smartwaiver/SmartwaiverResponse](#smartwaiversmartwaiverresponse) - [Smartwaiver/SmartwaiverRoutes](#smartwaiversmartwaiverroutes) - [Smartwaiver/Types/Data/SmartwaiverTemplateData](#smartwaivertypesdatasmartwaivertemplatedata) - [Smartwaiver/Types/SmartwaiverCustomField](#smartwaivertypessmartwaivercustomfield) - [Smartwaiver/Types/SmartwaiverDynamicProcess](#smartwaivertypessmartwaiverdynamicprocess) - [Smartwaiver/Types/SmartwaiverDynamicTemplate](#smartwaivertypessmartwaiverdynamictemplate) - [Smartwaiver/Types/SmartwaiverFlag](#smartwaivertypessmartwaiverflag) - [Smartwaiver/Types/SmartwaiverGuardian](#smartwaivertypessmartwaiverguardian) - [Smartwaiver/Types/SmartwaiverParticipant](#smartwaivertypessmartwaiverparticipant) - [Smartwaiver/Types/SmartwaiverPhoto](#smartwaivertypessmartwaiverphoto) - [Smartwaiver/Types/SmartwaiverPhotos](#smartwaivertypessmartwaiverphotos) - [Smartwaiver/Types/SmartwaiverSearch](#smartwaivertypessmartwaiversearch) - [Smartwaiver/Types/SmartwaiverSignatures](#smartwaivertypessmartwaiversignatures) - [Smartwaiver/Types/SmartwaiverTemplate](#smartwaivertypessmartwaivertemplate) - [Smartwaiver/Types/SmartwaiverType](#smartwaivertypessmartwaivertype) - [Smartwaiver/Types/SmartwaiverWaiver](#smartwaivertypessmartwaiverwaiver) - [Smartwaiver/Types/SmartwaiverWaiverSummary](#smartwaivertypessmartwaiverwaiversummary) - [Smartwaiver/Types/SmartwaiverWebhook](#smartwaivertypessmartwaiverwebhook) - [Smartwaiver/Types/Template/SmartwaiverTemplateBody](#smartwaivertypestemplatesmartwaivertemplatebody) - [Smartwaiver/Types/Template/SmartwaiverTemplateCompletion](#smartwaivertypestemplatesmartwaivertemplatecompletion) - [Smartwaiver/Types/Template/SmartwaiverTemplateConfig](#smartwaivertypestemplatesmartwaivertemplateconfig) - [Smartwaiver/Types/Template/SmartwaiverTemplateElectronicConsent](#smartwaivertypestemplatesmartwaivertemplateelectronicconsent) - [Smartwaiver/Types/Template/SmartwaiverTemplateGuardian](#smartwaivertypestemplatesmartwaivertemplateguardian) - [Smartwaiver/Types/Template/SmartwaiverTemplateHeader](#smartwaivertypestemplatesmartwaivertemplateheader) - [Smartwaiver/Types/Template/SmartwaiverTemplateMeta](#smartwaivertypestemplatesmartwaivertemplatemeta) - [Smartwaiver/Types/Template/SmartwaiverTemplateParticipants](#smartwaivertypestemplatesmartwaivertemplateparticipants) - [Smartwaiver/Types/Template/SmartwaiverTemplateProcessing](#smartwaivertypestemplatesmartwaivertemplateprocessing) - [Smartwaiver/Types/Template/SmartwaiverTemplateSignatures](#smartwaivertypestemplatesmartwaivertemplatesignatures) - [Smartwaiver/Types/Template/SmartwaiverTemplateStandardQuestions](#smartwaivertypestemplatesmartwaivertemplatestandardquestions) - [Smartwaiver/Types/Template/SmartwaiverTemplateStyling](#smartwaivertypestemplatesmartwaivertemplatestyling) - [Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookMessage](#smartwaivertypeswebhookqueuessmartwaiverwebhookmessage) - [Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookMessageDelete](#smartwaivertypeswebhookqueuessmartwaiverwebhookmessagedelete) - [Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookMessagePayload](#smartwaivertypeswebhookqueuessmartwaiverwebhookmessagepayload) - [Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookQueue](#smartwaivertypeswebhookqueuessmartwaiverwebhookqueue) - [Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookQueues](#smartwaivertypeswebhookqueuessmartwaiverwebhookqueues) Installation ============ [](#installation) To add the Smartwaiver SDK to your [Composer](https://getcomposer.org/) project: ``` composer require smartwaiver/smartwaiver-sdk ``` Note: Smartwaiver SDK depends upon Guzzle so if you are not using composer you will need to handle those dependencies yourself. Getting Started =============== [](#getting-started) All that is required to start using the SDK is a Smartwaiver account and the API Key for that account. In all of the examples you will need to put the API Key into the code wherever it says: `[INSERT API KEY]` It's time to start making requests. A good first request is to list all waiver templates for your account. Here is the code to do that: ``` // 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(); ``` That's it! You've just requested all waiver templates in your account. But, now it's time to do something with them. Let's loop through those templates and print out the ID and Title of each template: ``` foreach ($templates as $template) { echo $template->templateId . ': ' . $template->title . PHP_EOL; } ``` Awesome! For more details on all the different properties a waiver template has, check out [TemplateProperties.php](examples/templates/TemplateProperties.php) Now that you've got your first request, check out the sections below to accomplish specific actions. Retrieve a Specific Template ---------------------------- [](#retrieve-a-specific-template) First let's set up the basic Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Now we can request information about a specific template. To do this we need the template ID. If you don't know a template ID for your account, try listing all waiver templates for you account, as shown [here](#getting-started), and copying one of the ID's that is printed out. Once we have a template ID we can execute a request to get the information about the template: ``` // The unique ID of the template to be retrieved $templateId = '[INSERT TEMPLATE ID]'; // Retrieve a specific template (SmartwaiverTemplate object) $template = $sw->getWaiverTemplate($templateId); ``` Now let's print out some information about this template. ``` // Access properties of the template echo PHP_EOL . 'List single template:' . PHP_EOL; echo $template->templateId . ': ' . $template->title . PHP_EOL; ``` To see all the different properties a waiver template has, check out [TemplateProperties.php](examples/templates/TemplateProperties.php) List All Signed Waivers ----------------------- [](#list-all-signed-waivers) First let's set up the basic Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Now we can request signed waivers from your account. ``` // Get a list of summaries of waivers $waiverSummaries = $sw->getWaiverSummaries(); ``` With this done, we can iterate over the returned summaries to see what is stored. The default limit is 20, which means if you have more than 20 in your account, only the most recent 20 will be returned ``` // 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; } ``` To see all the different properties a waiver summary has, check out [WaiverSummaryProperties.php](examples/waivers/WaiverSummaryProperties.php) Once we have a waiver summary, we can access all the detailed information about the waiver. To do that look [here](#retrieve-a-specific-waiver). But, we can also restrict our query with some parameters. For example, what if we only want to return 5 waivers, (the default is 20). Here is the code to do that: ``` // Set the limit $limit = 5; // Get a list of summaries of waivers $waiverSummaries = $sw->getWaiverSummaries($limit); ``` Or what if we only want any waivers that have not been verified (either by email or at the kiosk)? ``` // Set the limit $limit = 5; // Set the verified parameter $verified = false; // Get a list of summaries of waivers $waiverSummaries = $sw->getWaiverSummaries($limit, $verified); ``` What other parameters can you use? Here is an example using all of them: ``` // 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); ``` These examples are also available in [ListAllWaivers.php](examples/waivers/ListAllWaivers.php) ### Parameter Options [](#parameter-options) Parameter NameDefault ValueAccepted ValuesNoteslimit201 - 100Limit number of returned waiversverifiednulltrue/false/nullLimit selection to waiver that have been verified (true), not (false), or both (null)templateIdValid Template IDLimit signed waivers to only this templatefromDtsISO 8601 DateLimit to signed waivers between from and to dates (requires toDts)toDtsISO 8601 DateLimit to signed waivers between from and to dates (requires fromDts)firstNameAlpha-numericLimit to signed waivers that have a participant with this first name (Case Insensitive)lastNameAlpha-numericLimit to signed waivers that have a participant with this last name (Case Insensitive)Retrieve a Specific Waiver -------------------------- [](#retrieve-a-specific-waiver) What if we want to retrieve a specific waiver? All we need for that is a waiver ID. If you don't have a waiver ID to use, you can get a list of signed waivers in your account [here](#list-all-signed-waivers) First let's set up the basic Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Now, we can request the information about a specific waiver. Make sure to put your waiver ID in where it says `[INSERT WAIVER ID]` ``` // The unique ID of the signed waiver to be retrieved $waiverId = '[INSERT WAIVER ID]'; // Get a specific waiver $waiver = $sw->getWaiver($waiverId); ``` The waiver object has many different properties that can be accessed. For example, we can print out the waiver ID and title of the waiver. ``` // Access properties of waiver echo PHP_EOL . 'List single waiver:' . PHP_EOL; echo $waiver->waiverId . ': ' . $waiver->title . PHP_EOL; ``` To see a full list of all properties that a waiver object contains, check out [WaiverProperties.php](examples/waivers/WaiverProperties.php) We can also request that the PDF of the signed waiver as a Base 64 Encoded string be included. Here is the request to do that: ``` // 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 code provided here is also combined in to one example in [RetrieveSingleWaiver.php](examples/waivers/RetrieveSingleWaiver.php) Retrieve Photos on a Waiver --------------------------- [](#retrieve-photos-on-a-waiver) We can also use the API to retrieve any photos taken when the waiver was signed or attached later with the console. All we need is you're API key and the ID of a signed waiver, which has attached photos. If you don't have a waiver ID to use, you can get a list of signed waivers in your account [here](#list-all-signed-waivers) First let's set up the basic Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Now, we can request the photos on a specific waiver. Make sure to put your waiver ID in where it says `[INSERT WAIVER ID]` ``` // 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); ``` This photos object has a little meta-data we can print out: ``` // Print a little header echo PHP_EOL . 'Waiver Photos for: ' . $photos->title . PHP_EOL; // echo $photos->waiverId; // echo $photos->templateId; // echo $photos->createdOn; ``` Using this photos object, we can loop through all the photos and process them however we like: ``` // 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 code provided here is also combined in to one example in [RetrieveWaiverPhotos.php](examples/waivers/RetrieveWaiverPhotos.php) Search for Waivers ------------------ [](#search-for-waivers) First let's set up the basic Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Now we can request a search for signed waivers from your account. ``` // Request all waivers signed in 2017 $search = $sw->search('', '2017-01-01 00:00:00'); ``` **Note: The search route is a blocking search. Thus, a request to search for large amounts of data can take up to a few seconds. As such, this route should not be used for anything where real-time performance is important. Instead use the Waivers route.** This will return a search object containing metadata about the results of our search. We can easily print out all that information: ``` // 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; ``` The server has stored the results of our search request under the GUID given. We can now loop through the pages and request each page, which will be a list of up to 100 waivers. For example, if we wanted to created a list of all first names from our search, we would do that like this: ``` // 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 } } ``` To see all the different properties a waiver has, check out [WaiverProperties.php](examples/waivers/WaiverProperties.php) This examples is also available in [BasicSearch.php](examples/search/BasicSearch.php) ### Search Parameters [](#search-parameters) We can also restrict our search with more parameters. For example, what if we only want to return waivers for one of the templates in our account. Here is the code to do that: ``` // The unique ID of the template to search for $templateId = '[INSERT TEMPLATE ID]'; // Request all waivers signed for this template $search = $sw->search($templateId); ``` Or what if we only want any waivers that have not been verified (either by email or at the kiosk)? ``` // Request all waivers signed that not have been email verified $search = $sw->search('', '', '', '', '', false); ``` What other parameters can you use? Here are some more examples: ``` // 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); ``` These examples are also available in [SearchParams.php](examples/search/SearchParams.php) ### Parameter Options [](#parameter-options-1) Parameter NameDefault ValueAccepted ValuesNotestemplateIdValid Template IDLimit signed waivers to only this templatefromDtsISO 8601 DateLimit to signed waivers between after this datetoDtsISO 8601 DateLimit to signed waivers between before this datefirstNameAlpha-numericLimit to signed waivers that have a participant with this first name (Case Insensitive)lastNameAlpha-numericLimit to signed waivers that have a participant with this last name (Case Insensitive)verifiednulltrue/false/nullLimit selection to waiver that have been verified (true), not (false), or both (null)sortDesctruetrue/falseSort results in descending (latest signed waiver first) orderRetrieve/Set Webhook Configuration ---------------------------------- [](#retrieveset-webhook-configuration) You can both retrieve and set your account's webhook configuration through this SDK with a couple simple calls. To view your current webhook settings, we first need to set a Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Now, it's easy to request the webhook configuration: ``` // Get the current webhook settings $webhooks = $sw->getWebhookConfig(); ``` And, now we can print out the information: ``` // Access the webhook config echo 'Endpoint: ' . $webhooks->endpoint . PHP_EOL; echo 'EmailValidationRequired: ' . $webhooks->emailValidationRequired . PHP_EOL; ``` The Email Validation Required is whether the webhook will fire before, after, or before and after a waiver is verified. The endpoint is simply the endpoint URL for the webhook. And changing your webhook configuration is just as easy. The new configuration will be returned from the request and can be access just like the read request above. ``` // 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; ``` If you wish to remove a webhook completely from the account you may also do that like this: ``` $sw->deleteWebhookConfig(); ``` This code is also provided in [RetrieveWebhooks.php](examples/webhooks/RetrieveWebhooks.php), [SetWebhooks.php](examples/webhooks/SetWebhooks.php), and [DeleteWebhooks.php](examples/webhooks/DeleteWebhooks.php) Retrieve Messages From Webhook Queues ------------------------------------- [](#retrieve-messages-from-webhook-queues) Instead of using a public webhook endpoint you can set up your account to put webhooks in a queue system, which can be accessed using this API. Webhooks will be placed in the queue as soon as the waiver is finished processing and will remain there for 7 days. Our webhook queues also have support for separate queues for every template if you wish. To view your current webhook settings, we first need to set a Smartwaiver object. Make sure to put in your account's API Key where it says `[INSERT API KEY]` ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` First we can see how many webhook queues we have set up! ``` // Get the current webhook queue information $queues = $sw->getWebhookQueues(); ``` This returns a nice obejct that has information about how many messages are in our queues. If our queues don't exist yet, there won't be any information! ``` // 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; } ``` Now, if we have some messages in our queue (or not) we can poll to retrieve a message. ``` // Retrieve a message from the account queue $message = $sw->getWebhookQueueAccountMessage(); ``` Or if we want to get a message from a template queue: ``` // The Unique ID of the waiver template $templateId = '[INSERT TEMPLATE ID]'; // Retrieve a message from the template queue $message = $sw->getWebhookQueueAccountMessage($templateId); ``` This will retrieve one message and we can then access the body of the message. If there are no messages a null object will be returned. ``` // 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; ``` Now that we have processed the message we can delete it. ``` $delete = $sw->deleteWebhookQueueAccountMessage($message->messageId); echo 'Deletion Success: ' . ($delete->success ? 'true' : 'false') . PHP_EOL; ``` If we instead wanted to delete it while we retrieved (not recommended since if errors occur in your processing that webhook is lost) we could do this: ``` // Optionally we can delete the message when we retrieve it, by passing a delete flag $message = $sw->getWebhookQueueAccountMessage(true); ``` This code is also provided in [RetrieveWebhookQueues.php](examples/queues/RetrieveWebhookQueues.php), RetrieveTemplateMessage.php\](examples/queues/RetrieveTemplateMessage.php) and [RetrieveAccountMessage.php](examples/queues/RetrieveAccountMessage.php) Exception Handling ================== [](#exception-handling) Exceptions in this SDK are grouped into three different types. - A **SmartwaiverSDKException** occurs when the SDK itself encounters a problem. Examples of this include problems connecting to the API server, an unexpected response from the API server, bad input data, etc. - A **SmartwaiverHTTPException** occurs when the API encounters an error and properly relays that information back. Examples of this include '401 Unauthorized' or '404 Not Found' errors. - A **SmartwaiverRateLimitException** occurs when your account hits the rate limit. Info is contained in the object to figure out how long to wait before trying again. Note that a **SmartwaiverRateLimitException** is a type **SmartwaiverHTTPException**, which is a type of **SmartwaiverSDKException** so it is possible to catch all possible exceptions at the same time. Here is an example of catching an HTTP exception. First we set up the Smartwaiver account: ``` // The API Key for your account $apiKey = '[INSERT API KEY]'; // Set up your Smartwaiver connection using your API Key $sw = new Smartwaiver($apiKey); ``` Next, we attempt to get a waiver that does not exist: ``` // The Waiver ID to access $waiverId = 'InvalidWaiverId'; // Try to get the waiver object $waiver = $sw->getWaiver($waiverId); ``` This will throw an exception because a waiver with that ID does not exist. So let's change the code to catch that exception: ``` 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; } ``` But there is lot's of useful information in the exception object. Let's print some of that out too: ``` // 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 included in the exception is the header information returned about // the response. $responseInfo = $se->getResponseInfo(); echo 'API Version: ' . $responseInfo['version'] . PHP_EOL; echo 'UUID: ' . $responseInfo['id'] . PHP_EOL; echo 'Timestamp: ' . $responseInfo['ts'] . PHP_EOL; ``` The code provided here is also combined in to one example in [ExceptionHandling.php](examples/intro/ExceptionHandling.php) The **SmartwaiverRateLimitException** is a special type of **SmartwaiverHTTPException** and provides some additional information. The exception can be caught in exactly the same way: ``` 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; } ``` And the exception object has some additional information, seen being printed out above. Status Codes ------------ [](#status-codes) The code of the exception will match the HTTP Status Code of the response and the message will be an informative string informing on what exactly was wrong with the request. Possible status codes and their meanings: Status CodeError NameDescription400Parameter ErrorIndicates that something was wrong with the parameters of the request (e.g. extra parameters, missing required parameters, etc.).401UnauthorizedIndicates the request was missing an API Key or contained an invalid API Key.402Data ErrorIndicates that the parameters of the request was valid, but the data in those parameters was not.404Not FoundIndicates that whatever was being searched for (specific waiver, etc.) could not be found.406Wrong Content TypeIndicates that the Content Type of the request is inappropriate for the request.429Too Many RequestsIndicates that your account rate limit has been hit and you should cease making requests.500Internal Server ErrorIndicates that the server encountered an internal error while processing the request.Advanced ======== [](#advanced) This section contains notes about several more ways to use the SDK that are slightly more low level. Raw Responses ------------- [](#raw-responses) If you do not wish to use the Smartwaiver object types to facilitate easy use of the data you can also access the raw response from the API server. Here is an example of getting the raw response from the server for retrieving a list of waiver summaries: ``` // 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; ``` All the standard methods have a 'Raw' counterpart that just has 'Raw' added to the function name. The code provided here is also in [RawResponses.php](examples/advanced/RawResponses.php) URL Generation -------------- [](#url-generation) If you would like handle all aspects of the request's yourself, you can simply use **SmartwaiverRoutes** class to generate the approriate URLs for your requests. For example, to create the URL to list all templates is only one line: ``` SmartwaiverRoutes::getWaiverTemplates(); ``` For the list of possible routes see [SmartwaiverRoutes.php](src/Smartwaiver/SmartwaiverRoutes.php) Note: to use this you must handle the proper authentication headers yourself. Authentication -------------- [](#authentication) If you are making custom requests you must include the proper authentication. The Smartwaiver API expects a header called 'sw-api-key' to contain the API for the account you are accessing. ``` sw-api-key: [INSERT API KEY] ``` If you do not have a Smartwaiver API key go [here](https://www.smartwaiver.com/p/API) to find out how to create one. API Documentation ================= [](#api-documentation) Smartwaiver/Exceptions/SmartwaiverHTTPException ----------------------------------------------- [](#smartwaiverexceptionssmartwaiverhttpexception) Class SmartwaiverHTTPException This class handles all exceptions that have to do with communicating with the API and interpreting the responses. - Full name: \\Smartwaiver\\Exceptions\\SmartwaiverHTTPException - Parent class: \\Smartwaiver\\Exceptions\\SmartwaiverSDKException **Properties:** VisibilityNameTypeprivate`response`**array**### \_\_construct [](#__construct) SmartwaiverHTTPException constructor. ``` SmartwaiverHTTPException::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse, string $guzzleBody, string $content ) ``` **Parameters:** ParameterTypeDescription`$guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**The guzzle response object from the bad request`$guzzleBody`**string**The body of the guzzle response from the bad request`$content`**string**The processed content of the API response--- ### getGuzzleResponse [](#getguzzleresponse) Access the Guzzle Response object from the request that generated this exception. ``` SmartwaiverHTTPException::getGuzzleResponse( ): \GuzzleHttp\Psr7\Response ``` **Return Value:** The response object --- ### getGuzzleBody [](#getguzzlebody) Access the body of the guzzle response. This is provided since the body is a stream that will be empty in the $guzzleResponse object. ``` SmartwaiverHTTPException::getGuzzleBody( ): string ``` **Return Value:** The body contents of the response --- ### getResponseInfo [](#getresponseinfo) This method provides access to the parsed information from the API error response. This includes the version, timestamp, and UUID of the response ``` SmartwaiverHTTPException::getResponseInfo( ): array ``` **Return Value:** The response header information --- Smartwaiver/Exceptions/SmartwaiverRateLimitException ---------------------------------------------------- [](#smartwaiverexceptionssmartwaiverratelimitexception) Class SmartwaiverRateLimitException This class handles all exceptions that have to do with communicating with the API and interpreting the responses. - Full name: \\Smartwaiver\\Exceptions\\SmartwaiverRateLimitException - Parent class: \\Smartwaiver\\Exceptions\\SmartwaiverHTTPException **Properties:** VisibilityNameTypepublic`requests`**integer**public`max`**integer**public`retryAfter`**integer**### \_\_construct [](#__construct-1) SmartwaiverRateLimitException constructor. ``` SmartwaiverRateLimitException::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse, string $guzzleBody, string $content ) ``` **Parameters:** ParameterTypeDescription`$guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**The guzzle response object from the bad request`$guzzleBody`**string**The body of the guzzle response from the bad request`$content`**string**The processed content of the API response--- ### getResponseInfo [](#getresponseinfo-1) This method provides access to the parsed information from the API error response. This includes the version, timestamp, and UUID of the response ``` SmartwaiverRateLimitException::getResponseInfo( ): array ``` **Return Value:** The response header information --- ### getGuzzleResponse [](#getguzzleresponse-1) Access the Guzzle Response object from the request that generated this exception. ``` SmartwaiverRateLimitException::getGuzzleResponse( ): \GuzzleHttp\Psr7\Response ``` **Return Value:** The response object --- ### getGuzzleBody [](#getguzzlebody-1) Access the body of the guzzle response. This is provided since the body is a stream that will be empty in the $guzzleResponse object. ``` SmartwaiverRateLimitException::getGuzzleBody( ): string ``` **Return Value:** The body contents of the response --- Smartwaiver/Exceptions/SmartwaiverSDKException ---------------------------------------------- [](#smartwaiverexceptionssmartwaiversdkexception) Class SmartwaiverSDKException This class handles all exceptions that have to do with communicating with the API and interpreting the responses. - Full name: \\Smartwaiver\\Exceptions\\SmartwaiverSDKException - Parent class: **Properties:** VisibilityNameTypeprivate`guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**private`guzzleBody`**string**### \_\_construct [](#__construct-2) SmartwaiverSDKException constructor. ``` SmartwaiverSDKException::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse, string $guzzleBody, string $message, integer $code ) ``` **Parameters:** ParameterTypeDescription`$guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**`$guzzleBody`**string**`$message`**string**`$code`**integer**--- ### getGuzzleResponse [](#getguzzleresponse-2) Access the Guzzle Response object from the request that generated this exception. ``` SmartwaiverSDKException::getGuzzleResponse( ): \GuzzleHttp\Psr7\Response ``` **Return Value:** The response object --- ### getGuzzleBody [](#getguzzlebody-2) Access the body of the guzzle response. This is provided since the body is a stream that will be empty in the $guzzleResponse object. ``` SmartwaiverSDKException::getGuzzleBody( ): string ``` **Return Value:** The body contents of the response --- Smartwaiver/Smartwaiver ----------------------- [](#smartwaiversmartwaiver) Main class, which provides basic methods to interact with Smartwaiver API. - Full name: \\Smartwaiver\\Smartwaiver **Properties:** VisibilityNameTypeprotected`client`**\\GuzzleHttp\\Client**protected`lastResponse`**\\Smartwaiver\\SmartwaiverResponse|null**### \_\_construct [](#__construct-3) Creates a new Smartwaiver object. ``` Smartwaiver::__construct( string $apiKey, array<mixed,array> $guzzleOptions = array() ) ``` **Parameters:** ParameterTypeDescription`$apiKey`**string**The API Key for the account`$guzzleOptions`**array<mixed,array>**Optional options to pass to guzzle client--- ### getWaiverTemplates [](#getwaivertemplates) Retrieve a list of all waiver templates in the account. ``` Smartwaiver::getWaiverTemplates( ): array<mixed,\Smartwaiver\Types\SmartwaiverTemplate> ``` **Return Value:** An array (may be empty) of SmartwaiverTemplates --- ### getWaiverTemplate [](#getwaivertemplate) Retrieve information about a specific waiver template. ``` Smartwaiver::getWaiverTemplate( string $templateId ): \Smartwaiver\Types\SmartwaiverTemplate ``` If the waiver template is not found a NotFoundException will be thrown. **Parameters:** ParameterTypeDescription`$templateId`**string**The Unique ID of waiver template to get**Return Value:** The requested template --- ### getWaiverSummaries [](#getwaiversummaries) Retrieve a list of waiver summaries matching the given criteria. ``` 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> ``` **Parameters:** ParameterTypeDescription`$limit`**integer**Limit to this number of the most recent waivers.`$verified`**boolean|null**Limit to waivers that have been verified by email (true), not verified (false), or both (null).`$templateId`**string**Limit to waivers of the given waiver template ID.`$fromDts`**string**Limit to waivers between this ISO 8601 date and the toDts parameter (requires toDts parameter).`$toDts`**string**Limit to waivers between fromDts and this ISO 8601 date (requires fromDts parameter).`$firstName`**string**Limit to waivers with any participant having this for a first name (Case Insensitive).`$lastName`**string**Limit to waivers with any participant having this for a last name (Case Insensitive).`$tag`**string**Limit to waivers with this primary tag.**Return Value:** The list of signed waiver summary objects --- ### getWaiver [](#getwaiver) Retrieve a waiver with the given waiver ID ``` Smartwaiver::getWaiver( string $waiverId, boolean $pdf = false ): \Smartwaiver\Types\SmartwaiverWaiver ``` **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver to retrieve`$pdf`**boolean**Whether to include the Base64 Encoded PDF**Return Value:** The waiver object corresponding to the given waiver ID --- ### getWaiverPhotos [](#getwaiverphotos) Retrieve all waiver photos for the given waiver ID ``` Smartwaiver::getWaiverPhotos( string $waiverId ): \Smartwaiver\Types\SmartwaiverPhotos ``` **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver**Return Value:** The photos object containing all the photos --- ### getWaiverSignatures [](#getwaiversignatures) Retrieve all drawn signatures for the given waiver ID ``` Smartwaiver::getWaiverSignatures( string $waiverId ): \Smartwaiver\Types\SmartwaiverSignatures ``` **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver**Return Value:** The signatures object containing all the signatures --- ### search [](#search) Perform a large search matching the given criteria. This will return a guid that can then be used to access the results of the search. ``` Smartwaiver::search( string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', boolean|null $verified = null, boolean $sortDesc = true, string $tag = '' ): \Smartwaiver\Types\SmartwaiverSearch ``` **Parameters:** ParameterTypeDescription`$templateId`**string**Limit to waivers of the given waiver template ID.`$fromDts`**string**Limit to waivers after this ISO 8601 date.`$toDts`**string**Limit to waivers before this ISO 8601 date.`$firstName`**string**Limit to waivers with any participant having this for a first name (Case Insensitive).`$lastName`**string**Limit to waivers with any participant having this for a last name (Case Insensitive).`$verified`**boolean|null**Limit to waivers that have been verified by email (true), not verified (false) or both (null).`$sortDesc`**boolean**Sort results in descending (latest signed waiver first) order.`$tag`**string**Limit to waivers with this primary tag.**Return Value:** The object representing the results of the search --- ### searchResult [](#searchresult) Retrieve a page of the given search. ``` Smartwaiver::searchResult( \Smartwaiver\Types\SmartwaiverSearch $search, integer $page ): array<mixed,\Smartwaiver\Types\SmartwaiverWaiver> ``` **Parameters:** ParameterTypeDescription`$search`**\\Smartwaiver\\Types\\SmartwaiverSearch**The search object to get the results of`$page`**integer**The page number to retrieve**Return Value:** A list of the waiver objects in the given page --- ### searchResultByGuid [](#searchresultbyguid) Retrieve a page of the given search. ``` Smartwaiver::searchResultByGuid( string $guid, integer $page ): array<mixed,\Smartwaiver\Types\SmartwaiverWaiver> ``` **Parameters:** ParameterTypeDescription`$guid`**string**The guid of the search results`$page`**integer**The page number to retrieve**Return Value:** A list of the waiver objects in the given page --- ### getWebhookConfig [](#getwebhookconfig) Retrieve the current webhook configuration for the account ``` Smartwaiver::getWebhookConfig( ): \Smartwaiver\Types\SmartwaiverWebhook ``` **Return Value:** The current webhook configuration --- ### setWebhookConfig [](#setwebhookconfig) Set the webhook configuration for this account ``` Smartwaiver::setWebhookConfig( string $endpoint, string $emailValidationRequired ): \Smartwaiver\Types\SmartwaiverWebhook ``` **Parameters:** ParameterTypeDescription`$endpoint`**string**A valid url to set as the webhook endpoint`$emailValidationRequired`**string**Sets when the webhook is fired (use constants from SmartwaiverWebhook).**Return Value:** The new webhook configuration will be returned --- ### setWebhook [](#setwebhook) Set the webhook configuration for this account ``` Smartwaiver::setWebhook( \Smartwaiver\Types\SmartwaiverWebhook $webhook ): \Smartwaiver\Types\SmartwaiverWebhook ``` **Parameters:** ParameterTypeDescription`$webhook`**\\Smartwaiver\\Types\\SmartwaiverWebhook**The webhook configuration to set**Return Value:** The new webhook configuration will be returned --- ### getWebhookQueues [](#getwebhookqueues) Retrieve the current message counts for all webhook queues enabled ``` Smartwaiver::getWebhookQueues( ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookQueues ``` **Return Value:** The status information for all queues --- ### getWebhookQueueAccountMessage [](#getwebhookqueueaccountmessage) Retrieve a message from the webhook account queue ``` Smartwaiver::getWebhookQueueAccountMessage( boolean $delete = false ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessage|null ``` **Parameters:** ParameterTypeDescription`$delete`**boolean**Whether to delete the message as it's retrieved**Return Value:** A message from the account queue --- ### getWebhookQueueTemplateMessage [](#getwebhookqueuetemplatemessage) Retrieve a message from a webhook template queue ``` Smartwaiver::getWebhookQueueTemplateMessage( string $templateId, boolean $delete = false ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessage ``` **Parameters:** ParameterTypeDescription`$templateId`**string**The template ID to retrieve the message from`$delete`**boolean**Whether to delete the message as it's retrieved**Return Value:** A message from the template queue --- ### deleteWebhookQueueAccountMessage [](#deletewebhookqueueaccountmessage) Delete a message from the webhook account queue ``` Smartwaiver::deleteWebhookQueueAccountMessage( string $messageId ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessageDelete ``` **Parameters:** ParameterTypeDescription`$messageId`**string**The message to delete from the queue**Return Value:** Whether the message was deleted --- ### deleteWebhookQueueTemplateMessage [](#deletewebhookqueuetemplatemessage) Delete a message from a webhook template queue ``` Smartwaiver::deleteWebhookQueueTemplateMessage( string $templateId, string $messageId ): \Smartwaiver\Types\WebhookQueues\SmartwaiverWebhookMessageDelete ``` **Parameters:** ParameterTypeDescription`$templateId`**string**The template ID to retrieve the message from`$messageId`**string**The message to delete from the queue**Return Value:** Whether the message was deleted --- ### createDynamicTemplate [](#createdynamictemplate) Create a dynamic template for your participant to fill out ``` Smartwaiver::createDynamicTemplate( \Smartwaiver\Types\Template\SmartwaiverTemplateConfig $templateConfig, \Smartwaiver\Types\Data\SmartwaiverTemplateData $data, integer $expiration ): \Smartwaiver\Types\SmartwaiverDynamicTemplate ``` **Parameters:** ParameterTypeDescription`$templateConfig`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateConfig**The config for display of the dyanamic template`$data`**\\Smartwaiver\\Types\\Data\\SmartwaiverTemplateData**The data to fill on the dynamic template`$expiration`**integer**The expiration of the dynamic template**Return Value:** An object representing your new dynamic template --- ### processDynamicTemplate [](#processdynamictemplate) Create a dynamic template for your participant to fill out ``` Smartwaiver::processDynamicTemplate( string $transactionId ): \Smartwaiver\Types\SmartwaiverDynamicProcess ``` **Parameters:** ParameterTypeDescription`$transactionId`**string**The transaction ID you are requesting processing of**Return Value:** An object representing info about your processed waiver --- ### getWaiverTemplatesRaw [](#getwaivertemplatesraw) Retrieve a list of all waiver templates in the account. ``` Smartwaiver::getWaiverTemplatesRaw( ): \Smartwaiver\SmartwaiverRawResponse ``` **Return Value:** An object that holds the status code and unprocessed json. --- ### getWaiverTemplateRaw [](#getwaivertemplateraw) Retrieve information about a specific waiver template. ``` Smartwaiver::getWaiverTemplateRaw( string $templateId ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$templateId`**string**The Unique ID of waiver template to get**Return Value:** An object that holds the status code and unprocessed json. --- ### getWaiverSummariesRaw [](#getwaiversummariesraw) Retrieve a list of waiver summaries matching the given criteria. ``` Smartwaiver::getWaiverSummariesRaw( integer $limit = 20, boolean|null $verified = null, string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', string $tag = '' ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$limit`**integer**Limit to this number of the most recent waivers.`$verified`**boolean|null**Limit to waivers that have been verified by email (true), not verified (false), or both (null).`$templateId`**string**Limit to waivers of the given waiver template ID.`$fromDts`**string**Limit to waivers between this ISO 8601 date and the toDts parameter (requires toDts parameter).`$toDts`**string**Limit to waivers between fromDts and this ISO 8601 date (requires fromDts parameter).`$firstName`**string**Limit to waivers with any participant having this for a first name (Case Insensitive).`$lastName`**string**Limit to waivers with any participant having this for a last name (Case Insensitive).`$tag`**string**Limit to waivers with this primary tag.**Return Value:** An object that holds the status code and unprocessed json. --- ### getWaiverRaw [](#getwaiverraw) Retrieve a waiver with the given waiver ID ``` Smartwaiver::getWaiverRaw( string $waiverId, boolean $pdf = false ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver to retrieve`$pdf`**boolean**Include the Base64 Encoded PDF**Return Value:** An object that holds the status code and unprocessed json. --- ### getWaiverPhotosRaw [](#getwaiverphotosraw) Retrieve all photos attached to the given waiver ID ``` Smartwaiver::getWaiverPhotosRaw( string $waiverId ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver**Return Value:** An object that holds the status code and unprocessed json. --- ### getWaiverSignaturesRaw [](#getwaiversignaturesraw) Retrieve all drawn signatures attached to the given waiver ID ``` Smartwaiver::getWaiverSignaturesRaw( string $waiverId ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver**Return Value:** An object that holds the status code and unprocessed json. --- ### searchRaw [](#searchraw) Perform a large search matching the given criteria. This will return a guid that can then be used to access the results of the search. ``` Smartwaiver::searchRaw( string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', boolean|null $verified = null, boolean $sortDesc = true, string $tag = '' ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$templateId`**string**Limit to waivers of the given waiver template ID.`$fromDts`**string**Limit to waivers after this ISO 8601 date.`$toDts`**string**Limit to waivers before this ISO 8601 date.`$firstName`**string**Limit to waivers with any participant having this for a first name (Case Insensitive).`$lastName`**string**Limit to waivers with any participant having this for a last name (Case Insensitive).`$verified`**boolean|null**Limit to waivers that have been verified by email (true), not verified (false) or both (null).`$sortDesc`**boolean**Sort results in descending (latest signed waiver first) order.`$tag`**string**Limit to waivers with this primary tag.**Return Value:** An object that holds the status code and unprocessed json. --- ### searchResultByGuidRaw [](#searchresultbyguidraw) Retrieve a page of the given search. ``` Smartwaiver::searchResultByGuidRaw( string $guid, integer $page ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$guid`**string**The guid of the search results`$page`**integer**The page number to retrieve**Return Value:** An object that holds the status code and unprocessed json. --- ### getWebhookConfigRaw [](#getwebhookconfigraw) Retrieve the current webhook configuration for the account ``` Smartwaiver::getWebhookConfigRaw( ): \Smartwaiver\SmartwaiverRawResponse ``` **Return Value:** An object that holds the status code and unprocessed json. --- ### setWebhookConfigRaw [](#setwebhookconfigraw) Set the webhook configuration for this account ``` Smartwaiver::setWebhookConfigRaw( string $endpoint, string $emailValidationRequired ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$endpoint`**string**A valid url to set as the webhook endpoint`$emailValidationRequired`**string**Sets when the webhook is fired (use constants from SmartwaiverWebhook).**Return Value:** An object that holds the status code and unprocessed json. --- ### getWebhookQueuesRaw [](#getwebhookqueuesraw) Retrieve the current message counts for all webhook queues enabled ``` Smartwaiver::getWebhookQueuesRaw( ): \Smartwaiver\SmartwaiverRawResponse ``` **Return Value:** An object that holds the status code and unprocessed json. --- ### getWebhookQueueAccountMessageRaw [](#getwebhookqueueaccountmessageraw) Retrieve a message from the webhook account queue ``` Smartwaiver::getWebhookQueueAccountMessageRaw( boolean $delete = false ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$delete`**boolean**Whether to delete the message as it's retrieved**Return Value:** An object that holds the status code and unprocessed json. --- ### getWebhookQueueTemplateMessageRaw [](#getwebhookqueuetemplatemessageraw) Retrieve a message from a webhook template queue ``` Smartwaiver::getWebhookQueueTemplateMessageRaw( string $templateId, boolean $delete = false ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$templateId`**string**The template ID to retrieve the message from`$delete`**boolean**Whether to delete the message as it's retrieved**Return Value:** An object that holds the status code and unprocessed json. --- ### deleteWebhookQueueAccountMessageRaw [](#deletewebhookqueueaccountmessageraw) Delete a message from the webhook account queue ``` Smartwaiver::deleteWebhookQueueAccountMessageRaw( string $messageId ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$messageId`**string**The message to delete from the queue**Return Value:** An object that holds the status code and unprocessed json. --- ### deleteWebhookQueueTemplateMessageRaw [](#deletewebhookqueuetemplatemessageraw) Delete a message from a webhook template queue ``` Smartwaiver::deleteWebhookQueueTemplateMessageRaw( string $templateId, string $messageId ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$templateId`**string**The template ID to retrieve the message from`$messageId`**string**The message to delete from the queue**Return Value:** An object that holds the status code and unprocessed json. --- ### createDynamicTemplateRaw [](#createdynamictemplateraw) Create a dynamic template for your participant to fill out ``` Smartwaiver::createDynamicTemplateRaw( \Smartwaiver\Types\Template\SmartwaiverTemplateConfig $templateConfig, \Smartwaiver\Types\Data\SmartwaiverTemplateData $data, integer $expiration ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$templateConfig`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateConfig**The config for display of the dyanamic template`$data`**\\Smartwaiver\\Types\\Data\\SmartwaiverTemplateData**The data to fill on the dynamic template`$expiration`**integer**The expiration of the dynamic template**Return Value:** An object that holds the status code and unprocessed json. --- ### processDynamicTemplateRaw [](#processdynamictemplateraw) Create a dynamic template for your participant to fill out ``` Smartwaiver::processDynamicTemplateRaw( string $transactionId ): \Smartwaiver\SmartwaiverRawResponse ``` **Parameters:** ParameterTypeDescription`$transactionId`**string**The transaction ID you are requesting processing of**Return Value:** An object that holds the status code and unprocessed json. --- ### getLastResponse [](#getlastresponse) Get the SmartwaiverResponse objected created for the most recent API request. Useful for error handling if an exception is thrown. ``` Smartwaiver::getLastResponse( ): \Smartwaiver\SmartwaiverResponse|null ``` **Return Value:** The last response this object received from the API --- Smartwaiver/SmartwaiverRawResponse ---------------------------------- [](#smartwaiversmartwaiverrawresponse) Class SmartwaiverRawResponse This class provides a simple response from the API server containing the status code and raw body. - Full name: \\Smartwaiver\\SmartwaiverRawResponse **Properties:** VisibilityNameTypepublic`statusCode`**integer**public`body`**string**### \_\_construct [](#__construct-4) Pulls out the appropriate information from the Guzzle Response ``` SmartwaiverRawResponse::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse ) ``` **Parameters:** ParameterTypeDescription`$guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**The entire Guzzle HTTP Response from the request--- Smartwaiver/SmartwaiverResponse ------------------------------- [](#smartwaiversmartwaiverresponse) Class SmartwaiverResponse This class processes general information for all HTTP responses from the API server. Version, Unique ID, and Timestamp information for every request are stored in this class. - Full name: \\Smartwaiver\\SmartwaiverResponse **Properties:** VisibilityNameTypepublic`version`**string**public`id`**string**public`ts`**string**public`type`**string**public`responseData`**array**private`guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**### \_\_construct [](#__construct-5) Parses all responses from the server and throws an exception if any error occurred. ``` SmartwaiverResponse::__construct( \GuzzleHttp\Psr7\Response $guzzleResponse ) ``` **Parameters:** ParameterTypeDescription`$guzzleResponse`**\\GuzzleHttp\\Psr7\\Response**The entire Guzzle HTTP Response from the request--- ### getGuzzleResponse [](#getguzzleresponse-3) Get the actual Guzzle response object that underlies the data in this response object. Note that the body will be empty because it is read by this class's constructor. If you need the body, call getGuzzleBody() ``` SmartwaiverResponse::getGuzzleResponse( ): \GuzzleHttp\Psr7\Response ``` **Return Value:** The underlying Guzzle response object --- ### getGuzzleBody [](#getguzzlebody-3) Access the body of the guzzle response. This is provided since the body is a stream that will be empty in the $guzzleResponse object. ``` SmartwaiverResponse::getGuzzleBody( ): string ``` --- Smartwaiver/SmartwaiverRoutes ----------------------------- [](#smartwaiversmartwaiverroutes) Class SmartwaiverRoutes This class provides and easy way to create the actual URLs for the routes. - Full name: \\Smartwaiver\\SmartwaiverRoutes ### getWaiverTemplates [](#getwaivertemplates-1) Get the URL to retrieve a list of all waiver templates in the account. ``` SmartwaiverRoutes::getWaiverTemplates( ): string ``` - This method is **static**. **Return Value:** The URL to retrieve the information. --- ### getWaiverTemplate [](#getwaivertemplate-1) Get the URL to retrieve information about a specific waiver template. ``` SmartwaiverRoutes::getWaiverTemplate( string $templateId ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$templateId`**string**The Unique ID of waiver template to get**Return Value:** The URL to retrieve the information. --- ### getWaiverSummaries [](#getwaiversummaries-1) Get the URL to retrieve a list of waiver summaries matching the given criteria. ``` SmartwaiverRoutes::getWaiverSummaries( integer $limit = 20, boolean|null $verified = null, string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', string $tag = '' ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$limit`**integer**Limit to this number of the most recent waivers.`$verified`**boolean|null**Limit to waivers that have been verified by email (true), not verified (false), or both (null).`$templateId`**string**Limit to waivers of the given waiver template ID.`$fromDts`**string**Limit to waivers between this ISO 8601 date and the toDts parameter (requires toDts parameter).`$toDts`**string**Limit to waivers between fromDts and this ISO 8601 date (requires fromDts parameter).`$firstName`**string**Limit to waivers with any participant having this for a first name (Case Insensitive).`$lastName`**string**Limit to waivers with any participant having this for a last name (Case Insensitive).`$tag`**string**Limit to waivers with this primary tag.**Return Value:** The URL to retrieve the information. --- ### getWaiver [](#getwaiver-1) Get the URL to retrieve a waiver with the given waiver ID ``` SmartwaiverRoutes::getWaiver( string $waiverId, boolean $pdf = false ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver to retrieve`$pdf`**boolean**Whether to include the Base64 Encoded PDF**Return Value:** The URL to retrieve the information. --- ### getWaiverPhotos [](#getwaiverphotos-1) Get the URL to retrieve all photos attached to the given waiver ID ``` SmartwaiverRoutes::getWaiverPhotos( string $waiverId ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver**Return Value:** The URL to retrieve the information. --- ### getWaiverSignatures [](#getwaiversignatures-1) Get the URL to retrieve all drawn signatures attached to the given waiver ID ``` SmartwaiverRoutes::getWaiverSignatures( string $waiverId ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$waiverId`**string**The Unique identifier of the waiver**Return Value:** The URL to retrieve the information. --- ### search [](#search-1) Get the URL to search for waivers matching the given criteria. ``` SmartwaiverRoutes::search( string $templateId = '', string $fromDts = '', string $toDts = '', string $firstName = '', string $lastName = '', boolean|null $verified = null, boolean $sortDesc = true, string $tag = '' ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$templateId`**string**Limit query to signed waivers of the given waiver template ID.`$fromDts`**string**Limit query to signed waivers after this ISO 8601 date.`$toDts`**string**Limit query to signed waivers before this ISO 8601 date.`$firstName`**string**Limit query to signed waivers with any participant having this for a first name (Case Insensitive).`$lastName`**string**Limit query to signed waivers with any participant having this for a last name (Case Insensitive).`$verified`**boolean|null**Limit query to waivers that have been verified by email (true), not verified (false) or both (null).`$sortDesc`**boolean**Sort results in descending (latest signed waiver first) order.`$tag`**string**Limit to waivers with this primary tag.**Return Value:** The URL to retrieve the information. --- ### searchResults [](#searchresults) Get the URL to retrieve a specific page of a search result ``` SmartwaiverRoutes::searchResults( string $guid, integer $page ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$guid`**string**The guid returned by the search request`$page`**integer**Which page to retrieve**Return Value:** The URL to retrieve the information. --- ### getWebhookConfig [](#getwebhookconfig-1) Get the URL to retrieve the current webhook configuration for the account ``` SmartwaiverRoutes::getWebhookConfig( ): string ``` - This method is **static**. **Return Value:** The URL to retrieve the information. --- ### setWebhookConfig [](#setwebhookconfig-1) Get the URL to set the webhook configuration for this account ``` SmartwaiverRoutes::setWebhookConfig( ): string ``` - This method is **static**. **Return Value:** The URL to retrieve the information. --- ### getWebhookQueues [](#getwebhookqueues-1) Get the URL to retrieve information about state of all webhook queues ``` SmartwaiverRoutes::getWebhookQueues( ): string ``` - This method is **static**. **Return Value:** The URL to retrieve the information. --- ### getWebhookQueueAccountMessage [](#getwebhookqueueaccountmessage-1) Get the URL to retrieve a message from the account queue ``` SmartwaiverRoutes::getWebhookQueueAccountMessage( boolean $delete = false ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$delete`**boolean****Return Value:** The URL to retrieve the information. --- ### getWebhookQueueTemplateMessage [](#getwebhookqueuetemplatemessage-1) Get the URL to retrieve a message from the account queue ``` SmartwaiverRoutes::getWebhookQueueTemplateMessage( string $templateId, boolean $delete = false ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$templateId`**string**The ID of the waiver template specifying the queue to retrieve from`$delete`**boolean**Whether the message should be deleted from the queue while it's retrieved**Return Value:** The URL to retrieve the information. --- ### deleteWebhookQueueAccountMessage [](#deletewebhookqueueaccountmessage-1) Get the URL to delete a message from the account queue ``` SmartwaiverRoutes::deleteWebhookQueueAccountMessage( string $messageId ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$messageId`**string**The ID of the message to delete**Return Value:** The URL to retrieve the information. --- ### deleteWebhookQueueTemplateMessage [](#deletewebhookqueuetemplatemessage-1) Get the URL to delete a message from the account queue ``` SmartwaiverRoutes::deleteWebhookQueueTemplateMessage( string $templateId, string $messageId ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$templateId`**string**The ID of the waiver template specifying the queue to delete from`$messageId`**string**The ID of the message to delete**Return Value:** The URL to retrieve the information. --- ### createDynamicTemplate [](#createdynamictemplate-1) Get the URL to create a new dynamic template ``` SmartwaiverRoutes::createDynamicTemplate( ): string ``` - This method is **static**. **Return Value:** The URL to create the template. --- ### processDynamicTemplate [](#processdynamictemplate-1) Get the URL to request the processing of a signed dynamic waiver ``` SmartwaiverRoutes::processDynamicTemplate( string $transactionId ): string ``` - This method is **static**. **Parameters:** ParameterTypeDescription`$transactionId`**string**The returned transaction Id after the waiver is signed**Return Value:** The URL to request processing. --- Smartwaiver/Types/Data/SmartwaiverTemplateData ---------------------------------------------- [](#smartwaivertypesdatasmartwaivertemplatedata) Class SmartwaiverTemplateData This class the settings for the body section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Data\\SmartwaiverTemplateData - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`adult`**boolean**public`addressLineOne`**string**public`addressLineTwo`**string**public`addressCountry`**string**public`addressCity`**string**public`addressState`**string**public`addressZip`**string**public`email`**string**public`emergencyContactName`**string**public`emergencyContactPhone`**string**public`insuranceCarrier`**string**public`insurancePolicyNumber`**string**public`driversLicenseState`**string**public`driversLicenseNumber`**string**protected`participants`**array**protected`guardian`**array**### addParticipant [](#addparticipant) Add a participant to the end of the participant array. First Name and Last Name are required, everything else is optional. ``` SmartwaiverTemplateData::addParticipant( string $firstName, string $lastName, string|null $middleName = null, string|null $phone = null, string|null $gender = null, string|null $dob = null ) ``` **Parameters:** ParameterTypeDescription`$firstName`**string**The first name of the participant`$lastName`**string**The last name of the participant`$middleName`**string|null**The middle name of the participant`$phone`**string|null**The phone number of the participant`$gender`**string|null**The gender of the participant`$dob`**string|null**The DOB of the participant in ISO 8601 format.--- ### setGuardian [](#setguardian) Set prefill data for the guardian ``` SmartwaiverTemplateData::setGuardian( string $firstName, string $lastName, string|null $middleName = null, string|null $relationship = null, string|null $phone = null, string|null $gender = null, string|null $dob = null, boolean|null $participant = null ) ``` **Parameters:** ParameterTypeDescription`$firstName`**string**The first name of the guardian`$lastName`**string**The last name of the guardian`$middleName`**string|null**The middle name of the guardian`$relationship`**string|null**The relationship of the guardian to the minor`$phone`**string|null**The phone number of the guardian`$gender`**string|null**The gender of the guardian`$dob`**string|null**The DOB of the guardian`$participant`**boolean|null**Whether the guardian is also a participant or not--- ### apiArray [](#apiarray) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateData::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/SmartwaiverCustomField ---------------------------------------- [](#smartwaivertypessmartwaivercustomfield) Class SmartwaiverCustomField This class represents a custom field inside of a signed waiver. - Full name: \\Smartwaiver\\Types\\SmartwaiverCustomField - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`value`**string**public`displayText`**string**### \_\_construct [](#__construct-6) Create a SmartwaiverCustomField object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverCustomField::__construct( array $field ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$field`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput) Retrieve the input array this object was constructed from ``` SmartwaiverCustomField::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverDynamicProcess ------------------------------------------- [](#smartwaivertypessmartwaiverdynamicprocess) Class SmartwaiverDynamicProcess This class represents a newly created dynamic template response. - Full name: \\Smartwaiver\\Types\\SmartwaiverDynamicProcess - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`transactionId`**string**public`waiverId`**string**### \_\_construct [](#__construct-7) Create a SmartwaiverDynamicProcess object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverDynamicProcess::__construct( array $dynamicProcess ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$dynamicProcess`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-1) Retrieve the input array this object was constructed from ``` SmartwaiverDynamicProcess::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverDynamicTemplate -------------------------------------------- [](#smartwaivertypessmartwaiverdynamictemplate) Class SmartwaiverDynamicTemplate This class represents a newly created dynamic template response. - Full name: \\Smartwaiver\\Types\\SmartwaiverDynamicTemplate - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`expiration`**integer**public`uuid`**string**public`url`**string**### \_\_construct [](#__construct-8) Create a SmartwaiverDynamicTemplate object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverDynamicTemplate::__construct( array $dynamicTemplate ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$dynamicTemplate`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-2) Retrieve the input array this object was constructed from ``` SmartwaiverDynamicTemplate::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverFlag --------------------------------- [](#smartwaivertypessmartwaiverflag) Class SmartwaiverFlag This class represents a flag on a signed waiver. - Full name: \\Smartwaiver\\Types\\SmartwaiverFlag - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`displayText`**string**public`reason`**string**### \_\_construct [](#__construct-9) Create a SmartwaiverFlag object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverFlag::__construct( array $field ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$field`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-3) Retrieve the input array this object was constructed from ``` SmartwaiverFlag::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverGuardian ------------------------------------- [](#smartwaivertypessmartwaiverguardian) Class SmartwaiverGuardian This class represents all the data for the guardian field - Full name: \\Smartwaiver\\Types\\SmartwaiverGuardian - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`firstName`**string**public`middleName`**string**public`lastName`**string**public`phone`**string**public`relationship`**string**### \_\_construct [](#__construct-10) Create a SmartwaiverGuardian object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverGuardian::__construct( array $guardian ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$guardian`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-4) Retrieve the input array this object was constructed from ``` SmartwaiverGuardian::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverParticipant ---------------------------------------- [](#smartwaivertypessmartwaiverparticipant) Class SmartwaiverParticipant This class represents a single participant on a signed waiver. - Full name: \\Smartwaiver\\Types\\SmartwaiverParticipant - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`firstName`**string**public`middleName`**string**public`lastName`**string**public`dob`**string**public`isMinor`**boolean**public`gender`**string**public`phone`**string**public`tags`**array<mixed,string>**public`flags`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverFlag>**public`customParticipantFields`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverCustomField>**public`customParticipantFieldsByGuid`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverCustomField>**### \_\_construct [](#__construct-11) Create a SmartwaiverParticipant object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverParticipant::__construct( array $participant ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$participant`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-5) Retrieve the input array this object was constructed from ``` SmartwaiverParticipant::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverPhoto ---------------------------------- [](#smartwaivertypessmartwaiverphoto) Class SmartwaiverPhoto This class represents all the data a single photo on a waiver - Full name: \\Smartwaiver\\Types\\SmartwaiverPhoto - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`type`**string**public`date`**string**public`tag`**string**public`fileType`**string**public`photoId`**string**public`photo`**string**### \_\_construct [](#__construct-12) Create a SmartwaiverPhoto object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverPhoto::__construct( array $photo ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$photo`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-6) Retrieve the input array this object was constructed from ``` SmartwaiverPhoto::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverPhotos ----------------------------------- [](#smartwaivertypessmartwaiverphotos) Class SmartwaiverPhotos This class represents all the data for the photos of a waiver - Full name: \\Smartwaiver\\Types\\SmartwaiverPhotos - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`waiverId`**string**public`templateId`**string**public`title`**string**public`createdOn`**string**public`photos`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverPhoto>**### \_\_construct [](#__construct-13) Create a SmartwaiverPhotos object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverPhotos::__construct( array $photos ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$photos`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-7) Retrieve the input array this object was constructed from ``` SmartwaiverPhotos::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverSearch ----------------------------------- [](#smartwaivertypessmartwaiversearch) Class SmartwaiverSearch This class represents all the data for the result of a search - Full name: \\Smartwaiver\\Types\\SmartwaiverSearch - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`guid`**string**public`count`**string**public`pages`**string**public`pageSize`**string**### \_\_construct [](#__construct-14) Create a SmartwaiverSearch object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverSearch::__construct( array $search ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$search`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-8) Retrieve the input array this object was constructed from ``` SmartwaiverSearch::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverSignatures --------------------------------------- [](#smartwaivertypessmartwaiversignatures) Class SmartwaiverSignatures This class represents the data for signatures drawn on a waiver - Full name: \\Smartwaiver\\Types\\SmartwaiverSignatures - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`waiverId`**string**public`templateId`**string**public`title`**string**public`createdOn`**string**public`participantSignatures`**array<mixed,string>**public`guardianSignatures`**array<mixed,string>**public`bodySignatures`**array<mixed,string>**public`bodyInitials`**array<mixed,string>**### \_\_construct [](#__construct-15) Create a SmartwaiverSignatures object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverSignatures::__construct( array $signatures ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$signatures`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-9) Retrieve the input array this object was constructed from ``` SmartwaiverSignatures::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverTemplate ------------------------------------- [](#smartwaivertypessmartwaivertemplate) Class SmartwaiverTemplate This class represents a waiver template response from the API. - Full name: \\Smartwaiver\\Types\\SmartwaiverTemplate - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`templateId`**string**public`title`**string**public`publishedVersion`**string**public`publishedOn`**string**public`webUrl`**string**public`kioskUrl`**string**public`vanityUrls`**array<mixed,string>**### \_\_construct [](#__construct-16) Create a SmartwaiverWaiver object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplate::__construct( array $template ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$template`**array**An array to create the template object from--- ### getArrayInput [](#getarrayinput-10) Retrieve the input array this object was constructed from ``` SmartwaiverTemplate::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverType --------------------------------- [](#smartwaivertypessmartwaivertype) Class SmartwaiverType Base class for all types of returned objects from the API. - Full name: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypeprotected`input`**array**### \_\_construct [](#__construct-17) SmartwaiverType constructor. ``` SmartwaiverType::__construct( array $input, array $requiredKeys, string $type ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$input`**array**All the data to be put into the object`$requiredKeys`**array**The required keys in the input`$type`**string**The name of the object type (for errors)--- ### getArrayInput [](#getarrayinput-11) Retrieve the input array this object was constructed from ``` SmartwaiverType::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverWaiver ----------------------------------- [](#smartwaivertypessmartwaiverwaiver) Class SmartwaiverWaiver This class represents a waiver response from the API. Fields from the response are placed in public variables. - Full name: \\Smartwaiver\\Types\\SmartwaiverWaiver - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`waiverId`**string**public`templateId`**string**public`title`**string**public`createdOn`**string**public`expirationDate`**string**public`expired`**boolean**public`verified`**boolean**public`kiosk`**boolean**public`firstName`**string**public`middleName`**string**public`lastName`**string**public`dob`**string**public`isMinor`**boolean**public`clientIP`**string**public`tags`**array<mixed,string>**public`flags`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverFlag>**public`participants`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverParticipant>**public`email`**string**public`marketingAllowed`**boolean**public`addressLineOne`**string**public`addressLineTwo`**string**public`addressCity`**string**public`addressState`**string**public`addressZip`**string**public`addressCountry`**string**public`emergencyContactName`**string**public`emergencyContactPhone`**string**public`insuranceCarrier`**string**public`insurancePolicyNumber`**string**public`driversLicenseNumber`**string**public`driversLicenseState`**string**public`customWaiverFields`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverCustomField>**public`customWaiverFieldsByGuid`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverCustomField>**public`guardian`**\\Smartwaiver\\Types\\SmartwaiverGuardian**public`photos`**integer**public`pdf`**string**### \_\_construct [](#__construct-18) Create a SmartwaiverWaiver object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWaiver::__construct( array $waiver ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$waiver`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-12) Retrieve the input array this object was constructed from ``` SmartwaiverWaiver::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverWaiverSummary ------------------------------------------ [](#smartwaivertypessmartwaiverwaiversummary) Class SmartwaiverWaiverSummary This class represents a waiver summary response from the API. These are found in the waiver list call. - Full name: \\Smartwaiver\\Types\\SmartwaiverWaiverSummary - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`waiverId`**string**public`templateId`**string**public`title`**string**public`createdOn`**string**public`expirationDate`**string**public`expired`**boolean**public`verified`**boolean**public`kiosk`**boolean**public`firstName`**string**public`middleName`**string**public`lastName`**string**public`dob`**string**public`isMinor`**boolean**public`tags`**array<mixed,string>**public`flags`**array<mixed,\\Smartwaiver\\Types\\SmartwaiverFlag>**### \_\_construct [](#__construct-19) Create a SmartwaiverWaiverSummary object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWaiverSummary::__construct( array $summary ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$summary`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-13) Retrieve the input array this object was constructed from ``` SmartwaiverWaiverSummary::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/SmartwaiverWebhook ------------------------------------ [](#smartwaivertypessmartwaiverwebhook) Class SmartwaiverWebhook This class represents a webhook configuration. - Full name: \\Smartwaiver\\Types\\SmartwaiverWebhook - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`endpoint`**string**public`emailValidationRequired`**string**### \_\_construct [](#__construct-20) Create a SmartwaiverWebhook object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWebhook::__construct( array $webhook ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$webhook`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-14) Retrieve the input array this object was constructed from ``` SmartwaiverWebhook::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/Template/SmartwaiverTemplateBody -------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplatebody) Class SmartwaiverTemplateBody This class the settings for the body section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateBody - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`text`**string**### \_\_construct [](#__construct-21) Create a SmartwaiverTemplateBody object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateBody::__construct( array $body = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$body`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-15) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateBody::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-1) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateBody::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateCompletion -------------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplatecompletion) Class SmartwaiverTemplateCompletion This class the settings for the completion section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateCompletion - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`redirectSuccess`**string**public`redirectCancel`**string**### \_\_construct [](#__construct-22) Create a SmartwaiverTemplateCompletion object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateCompletion::__construct( array $completion = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$completion`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-16) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateCompletion::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-2) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateCompletion::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateConfig ---------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplateconfig) Class SmartwaiverTemplateConfig This class the settings for the config section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateConfig - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`meta`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateMeta**public`header`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateHeader**public`body`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateBody**public`participants`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateParticipants**public`standardQuestions`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateStandardQuestions**public`guardian`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateGuardian**public`electronicConsent`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateElectronicConsent**public`styling`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateStyling**public`completion`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateCompletion**public`signatures`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateSignatures**public`processing`**\\Smartwaiver\\Types\\Template\\SmartwaiverTemplateProcessing**### \_\_construct [](#__construct-23) Create a SmartwaiverTemplateConfig object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateConfig::__construct( array $config = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$config`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-17) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateConfig::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-3) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateConfig::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateElectronicConsent --------------------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplateelectronicconsent) Class SmartwaiverTemplateElectronicConsent This class the settings for the electronicConsent section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateElectronicConsent - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`title`**string**public`verbiage`**string**### \_\_construct [](#__construct-24) Create a SmartwaiverTemplateElectronicConsent object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateElectronicConsent::__construct( array $electronicConsent = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$electronicConsent`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-18) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateElectronicConsent::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-4) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateElectronicConsent::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateGuardian ------------------------------------------------------ [](#smartwaivertypestemplatesmartwaivertemplateguardian) Class SmartwaiverTemplateGuardian This class the settings for the guardian section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateGuardian - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`verbiage`**string**public`verbiageParticipantAddendum`**string**public`label`**string**public`relationship`**boolean**public`ageVerification`**boolean**### \_\_construct [](#__construct-25) Create a SmartwaiverTemplateGuardian object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateGuardian::__construct( array $guardian = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$guardian`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-19) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateGuardian::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-5) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateGuardian::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateHeader ---------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplateheader) Class SmartwaiverTemplateHeader This class the settings for the header section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateHeader - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`logoImage`**string**public`text`**string**### \_\_construct [](#__construct-26) Create a SmartwaiverTemplateHeader object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateHeader::__construct( array $header = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$header`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-20) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateHeader::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-6) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateHeader::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateMeta -------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplatemeta) Class SmartwaiverTemplateMeta This class the settings for the meta section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateMeta - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`title`**string**public`language`**string**### \_\_construct [](#__construct-27) Create a SmartwaiverTemplateMeta object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateMeta::__construct( array $meta = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$meta`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-21) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateMeta::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-7) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateMeta::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateParticipants ---------------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplateparticipants) Class SmartwaiverTemplateParticipants This class the settings for the participants section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateParticipants - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`adults`**boolean**public`minorsEnabled`**boolean**public`multipleMinors`**boolean**public`minorsWithoutAdults`**boolean**public`adultsAndMinors`**boolean**public`ageOfMajority`**integer**public`participantLabel`**string**public`participatingText`**string**public`middleName`**boolean**public`phone`**boolean**public`gender`**boolean**public`dobType`**string**### \_\_construct [](#__construct-28) Create a SmartwaiverTemplateParticipants object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateParticipants::__construct( array $participants = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$participants`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-22) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateParticipants::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-8) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateParticipants::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateProcessing -------------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplateprocessing) Class SmartwaiverTemplateProcessing This class the settings for the processing section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateProcessing - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`emailBusinessName`**string**public`emailReplyTo`**string**public`emailCustomTextEnabled`**boolean**public`emailCustomTextWeb`**string**public`emailCCEnabled`**boolean**public`emailCCWebEnabled`**boolean**public`emailCCEmails`**array**public`emailIncludeBarcodes`**boolean**### \_\_construct [](#__construct-29) Create a SmartwaiverTemplateProcessing object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateProcessing::__construct( array $processing = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$processing`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-23) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateProcessing::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-9) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateProcessing::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateSignatures -------------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplatesignatures) Class SmartwaiverTemplateSignatures This class the settings for the signatures section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateSignatures - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`type`**string**public`minor`**boolean**public`defaultChoice`**string**### \_\_construct [](#__construct-30) Create a SmartwaiverTemplateSignatures object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateSignatures::__construct( array $signatures = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$signatures`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-24) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateSignatures::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-10) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateSignatures::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateStandardQuestions --------------------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplatestandardquestions) Class SmartwaiverTemplateStandardQuestions This class the settings for the standardQuestions section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateStandardQuestions - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`addressEnabled`**boolean**public`addressRequired`**boolean**public`addressDefaultCountry`**string**public`addressDefaultState`**string**public`emailVerification`**boolean**public`emailMarketingEnabled`**boolean**public`emailMarketingOptInText`**string**public`emailMarketingDefaultChecked`**boolean**public`emergencyContactEnabled`**boolean**public`insuranceEnabled`**boolean**public`idCardEnabled`**boolean**### \_\_construct [](#__construct-31) Create a SmartwaiverTemplateStandardQuestions object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateStandardQuestions::__construct( array $standardQuestions = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$standardQuestions`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-25) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateStandardQuestions::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-11) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateStandardQuestions::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/Template/SmartwaiverTemplateStyling ----------------------------------------------------- [](#smartwaivertypestemplatesmartwaivertemplatestyling) Class SmartwaiverTemplateStyling This class the settings for the styling section of a Smartwaiver Template - Full name: \\Smartwaiver\\Types\\Template\\SmartwaiverTemplateStyling - Parent class: \\Smartwaiver\\Types\\SmartwaiverType - This class implements: \\Smartwaiver\\Types\\SmartwaiverInputType **Properties:** VisibilityNameTypepublic`style`**string**public`customBackground`**string**public`customBorder`**string**public`customShadow`**string**### \_\_construct [](#__construct-32) Create a SmartwaiverTemplateStyling object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverTemplateStyling::__construct( array $styling = array() ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$styling`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-26) Retrieve the input array this object was constructed from ``` SmartwaiverTemplateStyling::getArrayInput( ): array ``` **Return Value:** The input array --- ### apiArray [](#apiarray-12) Return the array to be passed to the api representing this object ``` SmartwaiverTemplateStyling::apiArray( ): \ArrayObject ``` --- Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookMessage --------------------------------------------------------- [](#smartwaivertypeswebhookqueuessmartwaiverwebhookmessage) Class SmartwaiverWebhookMessage This class represents information about a smartwaiver webhook message - Full name: \\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookMessage - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`messageId`**string**public`payload`**\\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookMessagePayload**### \_\_construct [](#__construct-33) Create a SmartwaiverWebhookMessage object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWebhookMessage::__construct( array $webhookMessage ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$webhookMessage`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-27) Retrieve the input array this object was constructed from ``` SmartwaiverWebhookMessage::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookMessageDelete --------------------------------------------------------------- [](#smartwaivertypeswebhookqueuessmartwaiverwebhookmessagedelete) Class SmartwaiverWebhookMessageDelete This class represents information returned from deleting a webhook message - Full name: \\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookMessageDelete - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`success`**boolean**### \_\_construct [](#__construct-34) Create a SmartwaiverWebhookMessageDelete object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWebhookMessageDelete::__construct( array $webhookMessageDelete ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$webhookMessageDelete`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-28) Retrieve the input array this object was constructed from ``` SmartwaiverWebhookMessageDelete::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookMessagePayload ---------------------------------------------------------------- [](#smartwaivertypeswebhookqueuessmartwaiverwebhookmessagepayload) Class SmartwaiverWebhookMessagePayload This class represents information about a webhook message payload - Full name: \\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookMessagePayload - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`uniqueId`**string**public`event`**string**### \_\_construct [](#__construct-35) Create a SmartwaiverWebhookMessagePayload object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWebhookMessagePayload::__construct( array $webhookMessagePayload ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$webhookMessagePayload`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-29) Retrieve the input array this object was constructed from ``` SmartwaiverWebhookMessagePayload::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookQueue ------------------------------------------------------- [](#smartwaivertypeswebhookqueuessmartwaiverwebhookqueue) Class SmartwaiverWebhookQueue This class represents information about a smartwaiver webhook queue - Full name: \\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookQueue - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`messagesTotal`**integer**public`messagesNotVisible`**integer**public`messagesDelayed`**integer**### \_\_construct [](#__construct-36) Create a SmartwaiverWebhookQueue object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWebhookQueue::__construct( array $webhookQueue ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$webhookQueue`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-30) Retrieve the input array this object was constructed from ``` SmartwaiverWebhookQueue::getArrayInput( ): array ``` **Return Value:** The input array --- Smartwaiver/Types/WebhookQueues/SmartwaiverWebhookQueues -------------------------------------------------------- [](#smartwaivertypeswebhookqueuessmartwaiverwebhookqueues) Class SmartwaiverWebhookQueues This class contains information about counts in all your webhook queues. - Full name: \\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookQueues - Parent class: \\Smartwaiver\\Types\\SmartwaiverType **Properties:** VisibilityNameTypepublic`accountQueue`**\\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookQueue**public`templateQueues`**array<mixed,\\Smartwaiver\\Types\\WebhookQueues\\SmartwaiverWebhookQueue>**### \_\_construct [](#__construct-37) Create a SmartwaiverWebhookQueues object by providing an array with all the required keys. See REQUIRED\_KEYS for that information. ``` SmartwaiverWebhookQueues::__construct( array $webhookQueues ) ``` Checks that all the required keys for the given object type exist **Parameters:** ParameterTypeDescription`$webhookQueues`**array**The input array containing all the information--- ### getArrayInput [](#getarrayinput-31) Retrieve the input array this object was constructed from ``` SmartwaiverWebhookQueues::getArrayInput( ): array ``` **Return Value:** The input array --- ### Health Score 36 — LowBetter than 82% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity35 Limited adoption so far Community11 Small or concentrated contributor base Maturity62 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~144 days Recently: every ~92 days Total 6 Last Release 2680d ago PHP version history (2 changes)4.0.0PHP ^5.6 4.2.3PHP >= 5.6 ### Community Maintainers ![](https://www.gravatar.com/avatar/aba42d56d20a48e3adc25ff0121a5b6eb72124e9f2db0f35f3a54ca693047214?d=identicon)[smartwaiver](/maintainers/smartwaiver) --- Top Contributors [![smartwaivercom](https://avatars.githubusercontent.com/u/3791581?v=4)](https://github.com/smartwaivercom "smartwaivercom (8 commits)") --- Tags sdksmartwaiver ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/smartwaiver-smartwaiver-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/smartwaiver-smartwaiver-sdk/health.svg)](https://phpackages.com/packages/smartwaiver-smartwaiver-sdk) ``` ### Alternatives [openai-php/laravel OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API 3.7k7.6M74](/packages/openai-php-laravel)[saloonphp/saloon Build beautiful API integrations and SDKs with Saloon 2.4k9.6M468](/packages/saloonphp-saloon)[facebook/php-business-sdk PHP SDK for Facebook Business 90821.9M34](/packages/facebook-php-business-sdk)[php-opencloud/openstack PHP SDK for OpenStack APIs. Supports BlockStorage, Compute, Identity, Images, Networking and Metric Gnocchi 2292.2M24](/packages/php-opencloud-openstack)[mailchimp/transactional 458.9M16](/packages/mailchimp-transactional)[resend/resend-php Resend PHP library. 574.7M21](/packages/resend-resend-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)