From 07ceff58b81a28615659392c6bee09a784df6d00 Mon Sep 17 00:00:00 2001 From: Ben Galloway <ben.galloway@gsc.org.uk> Date: Tue, 5 Jun 2018 11:14:05 +0100 Subject: [PATCH] Update README with new name and URL --- README.md | 88 +++++++++++++++++++++++++++---------------------------- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index c6a9a7e..d377ee4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Gamma in JS +# GammaJS A library of async JavaScript functions that make the corresponding calls to the GSC Gamma API. ## Installation ```bash -yarn add git+ssh://git@gscgit:utils/gamma-in-js.git +yarn add git+ssh://git@gscgit:utils/gammajs.git ``` ## Config @@ -283,7 +283,7 @@ If the Gamma API throws an error, an error will also be thrown from the JavaScri ## TODO -* **Endpoints** - the multi-endpoint API architecture has not yet been introduced to the live Gamma environment. `config.js` will require updating when this occurs. +- **Endpoints** - the multi-endpoint API architecture has not yet been introduced to the live Gamma environment. `config.js` will require updating when this occurs. ## Methods List @@ -293,73 +293,73 @@ See the full Gamma documentation in the `docs/` directory for complete details o All of these methods are destructive - i.e. if called correctly they push new data into Gamma or remove existing data from Gamma. They therefore require correspondingly more care in their use. -* `gammaAmendBooking` -* `gammaBookingAllSave` -* `gammaCancelBookingRequest` -* `gammaRemoveContactInterests` -* `gammaSaveCustomerDetails` -* `gammaUpdateBooking` -* `gammaUpdateBookingStatus` +- `gammaAmendBooking` +- `gammaBookingAllSave` +- `gammaCancelBookingRequest` +- `gammaRemoveContactInterests` +- `gammaSaveCustomerDetails` +- `gammaUpdateBooking` +- `gammaUpdateBookingStatus` ### Reservation methods These methods are not destructive but do cause some side-effects. They have a separate endpoint as they can be called live/in real time by the website. -* `gammaBookAvailableSpacesRequest` -* `gammaCancelBookAvailableSpaces` -* `gammaReserveXTSeats` -* `gammaCancelSeats` +- `gammaBookAvailableSpacesRequest` +- `gammaCancelBookAvailableSpaces` +- `gammaReserveXTSeats` +- `gammaCancelSeats` ### Membership methods These are methods which relate purely to memberships. There are some which are destructive: -* `gammaChangeMemberDetails` -* `gammaMembershipPurchase` -* `gammaMembershipCancellation` +- `gammaChangeMemberDetails` +- `gammaMembershipPurchase` +- `gammaMembershipCancellation` and some which are not: -* `gammaMembershipSubscriptionsLoad` -* `gammaModifiedMembers` +- `gammaMembershipSubscriptionsLoad` +- `gammaModifiedMembers` ### Availability methods All of these methods are non-destructive, i.e. they do not push any data into Gamma, only pull data from it. -* `gammaAllContactInterests` -* `gammaBookingETicketExportRequest` -* `gammaBookingStatusUpdateCheck` -* `gammaContactInterests` -* `gammaCustomerLoad` -* `gammaEventEditList` -* `gammaEventListLoad` -* `gammaEventsOnlyListLoad` -* `gammaGetBookingHistory` -* `gammaGetBookingStatusList` -* `gammaGetTourList` -* `gammaProductListLoad` -* `gammaProductMapListLoad` -* `gammaRedeemedBookings` -* `gammaResourceDatesListLoad` -* `gammaResourceListByViewByDateLoad` -* `gammaResourceListByViewLoad` -* `gammaResourceListLoad` -* `gammaResourceViewListLoad` -* `gammaViewResourcesLoad` -* `gammaVoucherDiscountCheck` -* `gammaVoucherListLoad` +- `gammaAllContactInterests` +- `gammaBookingETicketExportRequest` +- `gammaBookingStatusUpdateCheck` +- `gammaContactInterests` +- `gammaCustomerLoad` +- `gammaEventEditList` +- `gammaEventListLoad` +- `gammaEventsOnlyListLoad` +- `gammaGetBookingHistory` +- `gammaGetBookingStatusList` +- `gammaGetTourList` +- `gammaProductListLoad` +- `gammaProductMapListLoad` +- `gammaRedeemedBookings` +- `gammaResourceDatesListLoad` +- `gammaResourceListByViewByDateLoad` +- `gammaResourceListByViewLoad` +- `gammaResourceListLoad` +- `gammaResourceViewListLoad` +- `gammaViewResourcesLoad` +- `gammaVoucherDiscountCheck` +- `gammaVoucherListLoad` #### Methods from the docs that are unavailable in this library The following availability methods seem to be unsupported by the Gamma API. They are defined within the library but not made available on the export: -* `ResourceDatesNotAvailable` -* `ResourceListByViewByDateLoadLight` +- `ResourceDatesNotAvailable` +- `ResourceListByViewByDateLoadLight` #### Methods available in this library that are not in the docs -* `gammaVisitorStats` +- `gammaVisitorStats` This is a call written specifically for GSC's visitor stats requirement and is therefore not in the main Gamma documentation. It will return a number of adults and children visiting on each date in a given date range - this is comprised of pre-booked public and education visitors to the Science Mall, as well as walk-in Science Mall sales processed through the front desk. It will update throughout the day on any given day, allowing it to be used as a monitor for how busy the building is, but does not return any results for future dates. -- GitLab