TelephoneAppointments

Provides Telephone Appointment Planner API access.

Installation

Add this line to your application's Gemfile:

gem 'telephone_appointments'

And then execute:

$ bundle

Or install it yourself as:

$ gem install telephone_appointments

Usage

summary_document = TelephoneAppointments::SummaryDocumentActivity.new(
  appointment_id: id,
  owner_uid: uid, 
  delivery_method: message # 'postal' or 'digital'
)
summary_document.save # returns true or false

summary_document.errors # returns a hash of errors if save is unsuccessful

The library provides a stubbed adapter:

require 'telephone_appointments/stub_api'
TelephoneAppointments.api = TelephoneAppointments::StubApi.new

This returns canned responses when creating a summary document.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/guidance-guarantee-programme/telephone_appointments.

License

The gem is available as open source under the terms of the MIT License.