smartwaiver-sdk 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f7db8097383e5239cf525bdf325c02b7115a2154
-  data.tar.gz: de13abd5f6f4a0a9c9ada27ebdf613433c8e0b74
+SHA256:
+  metadata.gz: 559daaed2e60bb9bd05128bb3c9a61bf2ee9c63e862cf4add5a66444331a3d23
+  data.tar.gz: dc80881ed8c83fc99b5091d6c9f6d6f98847a7de06b478f5cc5c324c0c9e2eac
 SHA512:
-  metadata.gz: 478a58a44cca53de3bc84cfd123cabb198fe17c4605018db4c963ffd1f3163984e0e79f9af168c8d22ac888ea45ca519172d8c99724058e4740c76f115fcbcdf
-  data.tar.gz: f0e8475bbb8a6b3668447b2e0d230f5ef1e074ca1d751f5e76b20d0f4909317d46329c021a66ad19ed4c747e511de918971490c2f1983a7f513db5a3edba23cf
+  metadata.gz: 61e416b05563dd6c29b430198cf5083f8037b3476f1b1daab254367bf0129c813bd09a48795bd86188e6520ad963e335bd8fa8143d5274b9b48c923881c40459
+  data.tar.gz: 204c4d8f057947d2e8b3bf4e0137f3ddfa31c04055bc03514d73d35557f7ab54a4ef3140e2e7faf664aaf67eb34ffdcf6c3e6fa72a0dbc8c2307361a75c01c70

data/README.md

@@ -11,6 +11,8 @@ Table of Contents
     * [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)
   * [Exception Handling](#exception-handling)
     * [Status Codes](#status-codes)
@@ -246,6 +248,179 @@ result = client.get(waiver_id, pdf)
 
 The code provided here is also combined in to one example in [retrieve_single_waiver.rb](examples/waivers/retrieve_single_waiver.rb)
 
+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]`
+
+```ruby
+require 'smartwaiver-sdk/waiver_client'
+
+# The API Key for your account
+api_key='[INSERT API KEY]'
+
+client = SmartwaiverWaiverClient.new(api_key)
+```
+
+Now, we can request the photos on a specific waiver.
+Make sure to put your waiver ID in where it says `[INSERT WAIVER ID]`
+
+```ruby
+# The unique ID of the signed waiver to be retrieved
+waiver_id='[INSERT WAIVER ID]'
+
+result = client.photos(waiver_id)
+
+photos = result[:photos]
+```
+
+This photos object has a little meta-data we can print out:
+
+```ruby
+# Print a little header
+puts "Waiver Photos for: #{photos[:title]}"
+
+photos[:photos].each do |photo|
+  puts "#{photo[:photoId]}: #{photo[:date]}"
+end
+```
+
+The code provided here is also combined in to one example in [retrieve_waiver_photos.rb](examples/waivers/retrieve_waiver_photos.rb)
+
+
+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]`
+
+```ruby
+require 'smartwaiver-sdk/search_client'
+
+# The API Key for your account
+api_key='[INSERT API KEY]'
+
+client = SmartwaiverSearchClient.new(api_key)
+```
+
+Now we can request a search for signed waivers from your account.
+
+```ruby
+# Request all waivers signed in 2018
+results = client.search('', '2018-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:
+
+```ruby
+search = results[:search]
+# Print out some information about the result of the search
+puts "Search Complete:"
+puts "  Search ID: #{search[:guid]}"
+puts "  Waiver Count: #{search[:count]}"
+puts "  #{search[:pages]} pages of size #{search[:pageSize]}"
+```
+
+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:
+
+```ruby
+# We're going to create a list of all the first names on all the waivers
+name_list = [];
+
+pages = search[:pages]
+current_page = 0
+search_guid = search[:guid]
+
+while current_page < pages
+  puts "Requesting page: #{current_page}/#{pages} ..."
+
+  waivers = client.results(search_guid, current_page)
+
+  puts "Processing page: #{current_page}/#{pages} ..."
+
+  waivers[:search_results].each do |waiver|
+    name_list.push(waiver[:firstName])
+  end
+
+  current_page = current_page + 1
+end
+```
+
+To see all the different properties a waiver has, check out [waiver_properties.rb](examples/waivers/waiver_properties.rb)
+
+This examples is also available in [basic_search.rb](examples/search/basic_search.rb)
+
+### 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:
+
+```ruby
+# The unique ID of the template to search for
+
+template_id='[INSERT TEMPLATE ID]'
+
+# Request all waivers signed for this template
+results = client.search(template_id)
+```
+
+Or what if we only want any waivers that have not been verified (either by email or at the kiosk)?
+
+```ruby
+# Request all waivers signed that not have been email verified
+results = client.search(template_id, '', '', '', '', true)
+```
+
+What other parameters can you use? Here are some more examples:
+
+```ruby
+# Request all waivers signed for this template after the given date
+results = client.search(template_id, '2017-01-01 00:00:00')
+
+# Request all waivers signed for this template before the given date
+results = client.search(template_id, '', '2017-01-01 00:00:00')
+
+# Request all waivers signed for this template with a participant name Kyle
+results = client.search(template_id, '', '', 'Kyle') 
+
+# Request all waivers signed for this template with a participant name Kyle Smith
+results = client.search(template_id, '', '', 'Kyle', 'Smith') 
+
+# Request all waivers signed with a participant name Kyle that have been email verified
+results = client.search(template_id, '', '', 'Kyle', '', true) 
+
+# Request all waivers signed in ascending sorted order
+results = client.search(template_id, '', '', '', '', '', false)
+```
+
+These examples are also available in [search_params.rb](examples/search/search_params.rb)
+
+### Parameter Options
+
+| Parameter Name | Default Value | Accepted Values   | Notes                                                                                   |
+| -------------- | ------------- | ----------------- | --------------------------------------------------------------------------------------- |
+| templateId     |               | Valid Template ID | Limit signed waivers to only this template                                              |
+| fromDts        |               | ISO 8601 Date     | Limit to signed waivers between after this date                                         |
+| toDts          |               | ISO 8601 Date     | Limit to signed waivers between before this date                                        |
+| firstName      |               | Alpha-numeric     | Limit to signed waivers that have a participant with this first name (Case Insensitive) |
+| lastName       |               | Alpha-numeric     | Limit to signed waivers that have a participant with this last name (Case Insensitive)  |
+| verified       | null          | true/false/null   | Limit selection to waiver that have been verified (true), not (false), or both (null)   |
+| sortDesc       | true          | true/false        | Sort results in descending (latest signed waiver first) order                           |
+
+
+
 Retrieve/Set Webhook Configuration
 ----------
 

data/lib/smartwaiver-sdk/dynamic_template.rb

@@ -0,0 +1,387 @@
+#
+# Copyright 2018 Smartwaiver
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'smartwaiver-sdk/smartwaiver_base'
+require 'smartwaiver-sdk/dynamic_template_data'
+
+class SmartwaiverDynamicTemplate
+
+  EXPIRATION_DEFAULT = 300
+
+  attr_accessor :expiration, :template_config, :data
+
+  def initialize(expiration = EXPIRATION_DEFAULT)
+    @expiration = expiration
+    @template_config = SmartwaiverDynamicTemplateConfig.new
+    @data = SmartwaiverDynamicTemplateData.new
+  end
+
+  def to_json
+    {:template => @template_config.for_json, :data => @data.for_json}.to_json
+  end
+end
+
+
+class SmartwaiverDynamicTemplateConfig
+
+  attr_accessor :meta, :header, :body, :participants,
+                :standard_questions, :guardian, :electronic_consent,
+                :styling, :completion, :signatures, :processing
+
+  def initialize()
+    @meta = SmartwaiverTemplateMeta.new
+    @header = SmartwaiverTemplateHeader.new
+    @body = SmartwaiverTemplateBody.new
+    @participants = SmartwaiverTemplateParticipants.new
+    @standard_questions = SmartwaiverTemplateStandardQuestions.new
+    @guardian = SmartwaiverTemplateGuardian.new
+    @electronic_consent = SmartwaiverTemplateElectronicConsent.new
+    @styling = SmartwaiverTemplateStyling.new
+    @completion = SmartwaiverTemplateCompletion.new
+    @signatures = SmartwaiverTemplateSignatures.new
+    @processing = SmartwaiverTemplateProcessing.new
+  end
+
+  def for_json
+    {
+      'meta' => @meta.for_json,
+      'header' => @header.for_json,
+      'body' => @body.for_json,
+      'participants' => @participants.for_json,
+      'standardQuestions' => @standard_questions.for_json,
+      'guardian' => @guardian.for_json,
+      'electronicConsent' => @electronic_consent.for_json,
+      'styling' => @styling.for_json,
+      'completion' => @completion.for_json,
+      'signatures' => @signatures.for_json,
+      'processing' => @processing.for_json
+     }
+  end
+end
+
+class SmartwaiverTemplateMeta
+
+  attr_accessor :title, :locale
+
+  def initialize()
+    @title = nil
+    @locale = nil
+  end
+
+  def for_json
+    json = {}
+    json['title'] = @title if (!@title.nil?)
+    json['locale'] = {'locale' => @locale} if (!@locale.nil?)
+    json
+  end
+end
+
+class SmartwaiverTemplateHeader
+
+  MEDIA_TYPE_PNG = 'image/png'
+  MEDIA_TYPE_JPEG = 'image/jpeg'
+
+  attr_accessor :text, :image_base_64
+
+  def initialize()
+    @text = nil
+    @image_base_64 = nil
+  end
+
+  def format_image_inline(media_type, encoded_image)
+    @image_base_64 = "data:#{media_type};base64,#{encoded_image}"
+  end
+
+  def for_json
+    json = {}
+    json['text'] = @text if (!@text.nil?)
+    json['logo'] = {'image' => @image_base_64} if (!@image_base_64.nil?)
+    json
+  end
+end
+
+class SmartwaiverTemplateBody
+
+  attr_accessor :text
+
+  def initialize()
+    @text = nil
+  end
+
+  def for_json
+    json = {}
+    json['text'] = @text if (!@text.nil?)
+    json
+  end
+end
+
+class SmartwaiverTemplateParticipants
+
+  ADULTS_AND_MINORS = 'adultsAndMinors'
+  MINORS_WITHOUT_ADULTS = 'minorsWithoutAdults'
+
+  PHONE_ADULTS_ONLY = 'adults'
+  PHOHE_ADULTS_AND_MINORS = 'adultsAndMinors'
+
+  DOB_CHECKBOX = 'checkbox'
+  DOB_SELECT = 'select'
+
+  attr_accessor :adults, :minors_enabled, :allow_multiple_minors, :allow_without_adults,
+                :allows_adults_and_minors, :age_of_majority, :participant_label, :participating_text,
+                :show_middle_name, :show_phone, :show_gender, :dob_type
+
+  def initialize()
+    @adults = true
+    @minors_enabled = nil
+    @allow_multiple_minors = nil
+    @allow_without_adults = nil
+    @allows_adults_and_minors = nil
+    @age_of_majority = nil
+    @participant_label = nil
+    @participating_text = nil
+    @show_middle_name = nil
+    @show_phone = nil
+    @show_gender = nil
+    @dob_type = nil
+  end
+
+  def for_json
+    json = {}
+    json['adults'] = @adults if (!@adults.nil?)
+
+    minors = {}
+    minors['enabled'] = @minors_enabled if (!@minors_enabled.nil?)
+    minors['multipleMinors'] = @allow_multiple_minors if (!@allow_multiple_minors.nil?)
+    minors['minorsWithoutAdults'] = @allow_without_adults if (!@allow_without_adults.nil?)
+    minors['adultsAndMinors'] = @allows_adults_and_minors if (!@allows_adults_and_minors.nil?)
+    json['minors'] = minors if (minors != {})
+
+    json['ageOfMajority'] = @age_of_majority if (!@age_of_majority.nil?)
+    json['participantLabel'] = @participant_label if (!@participant_label.nil?)
+    json['participatingText'] = @participating_text if (!@participating_text.nil?)
+
+    config = {}
+    config['middleName'] = @show_middle_name if (!@show_middle_name.nil?)
+    config['phone'] = @show_phone if (!@show_phone.nil?)
+    config['gender'] = @show_gender if (!@show_gender.nil?)
+    config['dobType'] = @dob_type if (!@dob_type.nil?)
+    json['config'] = config if (config != {})
+
+    json
+  end
+end
+
+
+class SmartwaiverTemplateStandardQuestions
+
+  attr_accessor :address_enabled, :address_required, :default_country_code, :default_state_code,
+                :email_verification_enabled, :email_marketing_enabled, :marketing_opt_in_text,
+                :marketing_opt_in_checked, :emergency_contact_enabled, :insurance_enabled, :id_card_enabled
+  def initialize()
+    @address_enabled = nil
+    @address_required = nil
+    @default_country_code = nil
+    @default_state_code = nil
+    @email_verification_enabled = nil
+    @email_marketing_enabled = nil
+    @marketing_opt_in_text = nil
+    @marketing_opt_in_checked = nil
+    @emergency_contact_enabled = nil
+    @insurance_enabled = nil
+    @id_card_enabled = nil
+  end
+
+  def for_json
+    json = {}
+    address = {}
+    address['enabled'] = @address_enabled if (!@address_enabled.nil?)
+    address['required'] = @address_required if (!@address_required.nil?)
+    defaults = {}
+    defaults['country'] = @default_country_code if (!@default_country_code.nil?)
+    defaults['state'] = @default_state_code if (!@default_state_code.nil?)
+    address['defaults'] = defaults if (defaults != {})
+    json['address'] = address if (address != {})
+
+    email = {}
+    email['verification'] = @email_verification_enabled if (!@email_verification_enabled.nil?)
+    email_marketing = {}
+    email_marketing['enabled'] = @email_marketing_enabled if (!@email_marketing_enabled.nil?)
+    email_marketing['optInText'] = @marketing_opt_in_text if (!@marketing_opt_in_text.nil?)
+    email_marketing['defaultChecked'] = @marketing_opt_in_checked if (!@marketing_opt_in_checked.nil?)
+    email['marketing'] = email_marketing if (email_marketing != {})
+    json['email'] = email if (email != {})
+
+    emergency_contact = {}
+    emergency_contact['enabled'] = @emergency_contact_enabled if (!@emergency_contact_enabled.nil?)
+    json['emergencyContact'] = emergency_contact if (emergency_contact != {})
+
+    insurance = {}
+    insurance['enabled'] = @insurance_enabled if (!@insurance_enabled.nil?)
+    json['insurance'] = emergency_contact if (emergency_contact != {})
+
+    id_card = {}
+    id_card['enabled'] = @id_card_enabled if (!@id_card_enabled.nil?)
+    json['idCard'] = id_card if (id_card != {})
+    json
+  end
+end
+
+class SmartwaiverTemplateGuardian
+
+  attr_accessor :verbiage, :verbiage_participant_addendum, :label, :relationship, :age_verification
+
+  def initialize()
+    @verbiage = nil
+    @verbiage_participant_addendum = nil
+    @label = nil
+    @relationship = nil
+    @age_verification = nil
+  end
+
+  def for_json
+    json = {}
+    json['verbiage'] = @verbiage if (!@verbiage.nil?)
+    json['verbiageParticipantAddendum'] = @verbiage_participant_addendum if (!@verbiage_participant_addendum.nil?)
+    json['label'] = @label if (!@label.nil?)
+    json['relationship'] = @relationship if (!@relationship.nil?)
+    json['ageVerification'] = @age_verification if (!@age_verification.nil?)
+    json
+  end
+end
+
+class SmartwaiverTemplateElectronicConsent
+
+  attr_accessor :title, :verbiage
+
+  def initialize()
+    @title = nil
+    @verbiage = nil
+  end
+
+  def for_json
+    json = {}
+    json['title'] = @title if (!@title.nil?)
+    json['verbiage'] = @verbiage if (!@verbiage.nil?)
+    json
+  end
+end
+
+class SmartwaiverTemplateStyling
+
+  attr_accessor :style, :custom_background_color, :custom_border_color, :custom_shadow_color
+
+  def initialize()
+    @style = nil
+    @custom_background_color = nil
+    @custom_border_color = nil
+    @custom_shadow_color = nil
+  end
+
+  def for_json
+    json = {}
+    json['style'] = @style if (!@style.nil?)
+
+    custom = {}
+    custom['background'] = @custom_background_color if (!@custom_background_color.nil?)
+    custom['border'] = @custom_border_color if (!@custom_border_color.nil?)
+    custom['shadow'] = @custom_shadow_color if (!@custom_shadow_color.nil?)
+    json['custom'] = custom if (custom != {})
+
+    json
+  end
+end
+
+class SmartwaiverTemplateCompletion
+
+  attr_accessor :redirect_success, :redirect_cancel
+
+  def initialize()
+    @redirect_success = nil
+    @redirect_cancel = nil
+  end
+
+  def for_json
+    json = {}
+    redirect = {}
+    redirect['success'] = @redirect_success if (!@redirect_success.nil?)
+    redirect['cancel'] = @redirect_cancel  if (!@redirect_cancel .nil?)
+    json['redirect'] = redirect if (redirect != {})
+    json
+  end
+end
+
+class SmartwaiverTemplateSignatures
+
+  SIGNATURE_DRAW = 'draw'
+  SIGNATURE_TYPE = 'type'
+  SIGNATURE_CHOICE = 'choice'
+
+  attr_accessor :type, :minors, :default_choice
+
+  def initialize()
+    @type = nil
+    @minors = nil
+    @default_choice = nil
+  end
+
+  def for_json
+    json = {}
+    json['type'] = @type if (!@type.nil?)
+    json['minors'] = @minors if (!@minors.nil?)
+    json['defaultChoice'] = @default_choice if (!@default_choice.nil?)
+    json
+  end
+end
+
+class SmartwaiverTemplateProcessing
+
+  attr_accessor :email_business_name, :email_reply_to, :email_custom_text_enabled,
+                :email_custom_text_web, :email_cc_enabled, :email_cc_web_completed,
+                :email_cc_addresses, :include_bar_codes
+
+  def initialize()
+    @email_business_name  = nil
+    @email_reply_to = nil
+    @email_custom_text_enabled = nil
+    @email_custom_text_web = nil
+    @email_cc_enabled = nil
+    @email_cc_web_completed = nil
+    @email_cc_addresses = nil
+    @include_bar_codes = nil
+  end
+
+  def for_json
+    json = {}
+    emails = {}
+
+    emails['businessName'] = @email_business_name if (!@email_business_name.nil?)
+    emails['replyTo'] = @email_reply_to if (!@email_reply_to.nil?)
+
+    customText = {}
+    customText['enabled'] = @email_custom_text_enabled if (!@email_custom_text_enabled.nil?)
+    customText['web'] = @email_custom_text_web if (!@email_custom_text_web.nil?)
+    emails['customText'] = customText if (customText != {})
+
+    cc = {}
+    cc['enabled'] = @email_cc_enabled if (!@email_cc_enabled.nil?)
+    cc['web'] = @email_cc_web_completed if (!@email_cc_web_completed.nil?)
+    cc['emails'] = @email_cc_addresses if (!@email_cc_addresses.nil?)
+    emails['cc'] = cc if (cc != {})
+
+    emails['includeBarcodes'] = @include_bar_codes if (!@include_bar_codes.nil?)
+    json['emails'] = emails if (emails != {})
+    json
+  end
+end