@edropin/events-svc NPM

e_dropin_events

EDropinEvents - JavaScript client for e_dropin_events Events service for eDropin This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install e_dropin_events --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your e_dropin_events from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('e_dropin_events') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var EDropinEvents = require('e_dropin_events');

var defaultClient = EDropinEvents.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix['Authorization'] = "Token"

// Configure API key authorization: ClientKey
var ClientKey = defaultClient.authentications['ClientKey'];
ClientKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ClientKey.apiKeyPrefix['X-Client-Key'] = "Token"

var api = new EDropinEvents.EeEventAttendeesApi()

var eventId = "eventId_example"; // {String} Event Id

var ticketId = "ticketId_example"; // {String} 

var attendeeProps = new EDropinEvents.EeEventAttendeeUpdate(); // {EeEventAttendeeUpdate} Attendee object to be created


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAttendee(eventIdticketId, attendeeProps, callback);

Documentation for API Endpoints

All URIs are relative to https://events-dot-edropin-amalgam.appspot.com

Class	Method	HTTP request	Description
EDropinEvents.EeEventAttendeesApi	createAttendee	POST /events/{eventId}/attendees	Add an Attendee to an event
EDropinEvents.EeEventAttendeesApi	createEmailLookup	POST /attendees/email-lookup	Create and send a secret code to an email with all tickets linked to this email. This endpoint requires captcha verification to make sure only humans can make this request.
EDropinEvents.EeEventAttendeesApi	deleteAttendee	DELETE /attendees/{attendeeId}	Delete an Event Attendee
EDropinEvents.EeEventAttendeesApi	exportAttendees	GET /events/{eventId}/attendees/export	Export event attendee data
EDropinEvents.EeEventAttendeesApi	listAttendees	GET /events/{eventId}/attendees	List all event attendees
EDropinEvents.EeEventAttendeesApi	listEmailLookupAttendees	GET /attendees/email-lookup/{code}	Search tickets that are associated with the lookup email provided in the encrypted code. This code is generated by making a POST request to /attendees/email-lookup
EDropinEvents.EeEventAttendeesApi	listUserAttendees	GET /attendees	Search user attendees
EDropinEvents.EeEventAttendeesApi	retrieveAttendee	GET /attendees/{attendeeId}	Retrieve an attendee
EDropinEvents.EeEventAttendeesApi	retrieveAttendeesByCode	GET /attendees/code/{code}	List all attendees linked to the code
EDropinEvents.EeEventAttendeesApi	sendAttendeeLink	POST /attendees/{attendeeId}/link	Send attendee link
EDropinEvents.EeEventAttendeesApi	transferAttendees	POST /attendees/transfer	Transfer attendees from one ticket to another ticket (can also be two tickets from two separate events)
EDropinEvents.EeEventAttendeesApi	updateAccountTickets	POST /attendees/account-import	Import tickets into an account after they are created. This action is authorized by providing a list of attendee ids and an encrypted authorization code for the tickets
EDropinEvents.EeEventAttendeesApi	updateAttendee	PUT /attendees/{attendeeId}	Update an attendee
EDropinEvents.EeEventCertificatesApi	createAttendeeCertificate	PUT /certificates/{certificateId}/attendees	Create certificate for attendees
EDropinEvents.EeEventCertificatesApi	createCertificate	POST /events/{eventId}/certificates	Create a certificate for an event
EDropinEvents.EeEventCertificatesApi	deleteAttendeeCertificate	DELETE /certificates/{certificateId}/attendees	Delete certificate from attendees
EDropinEvents.EeEventCertificatesApi	deleteCertificate	DELETE /certificates/{certificateId}	Delete an existing certificate
EDropinEvents.EeEventCertificatesApi	downloadCertificate	POST /certificates/download/{certificateCode}	Download a certificate [certificateCode is eeEventAttendee.certificates[].code]
EDropinEvents.EeEventCertificatesApi	inspectTemplate	GET /certificates/inspectTemplate	Inspect a template for all the placeholders
EDropinEvents.EeEventCertificatesApi	listCertificateTemplates	GET /certificate-templates	List all certificate templates
EDropinEvents.EeEventCertificatesApi	listCertificates	GET /events/{eventId}/certificates	List all event certificates
EDropinEvents.EeEventCertificatesApi	listCertificatesByProfile	GET /profiles/{profileId}/certificates	List all profile certificates
EDropinEvents.EeEventCertificatesApi	previewCertificate	POST /certificates/{certificateId}/preview	Preview a certificate
EDropinEvents.EeEventCertificatesApi	retrieveCertificate	GET /certificates/{certificateId}	Retrieve a certificate
EDropinEvents.EeEventCertificatesApi	retrieveUserCertificate	GET /certificates/{certificateId}/attendees/{attendeeId}	Retrieve a user certificate
EDropinEvents.EeEventCertificatesApi	updateCertificate	PUT /certificates/{certificateId}	Update certificate to event
EDropinEvents.EeEventCertificatesApi	updateUserCertificate	PUT /certificates/{certificateId}/attendees/{attendeeId}	Update user certificate to event
EDropinEvents.EeEventCertificatesApi	upsertAssignmentRule	POST /certificates/{certificateId}/rules	Update certificate assignment rules
EDropinEvents.EeEventCreditsApi	createCredit	POST /events/{eventId}/credits	Create a credit for an event
EDropinEvents.EeEventCreditsApi	deleteCredit	DELETE /credits/{creditId}	Delete an existing credit
EDropinEvents.EeEventCreditsApi	listCreditsByEvent	GET /events/{eventId}/credits	List all event credits
EDropinEvents.EeEventCreditsApi	retrieveCredit	GET /credits/{creditId}	Retrieve a credit
EDropinEvents.EeEventCreditsApi	updateCredit	PUT /credits/{creditId}	Update credit to event
EDropinEvents.EeEventDropinsApi	createAttendeeDropin	PUT /dropins/{dropinId}/attendees	Assign dropins to attendees
EDropinEvents.EeEventDropinsApi	createDropin	POST /events/{eventId}/dropins	Create a dropin to an event
EDropinEvents.EeEventDropinsApi	deleteAttendeeDropin	DELETE /dropins/{dropinId}/attendees	Remove dropins from attendees
EDropinEvents.EeEventDropinsApi	deleteDropin	DELETE /dropins/{dropinId}	Delete an existing dropin
EDropinEvents.EeEventDropinsApi	listDropins	GET /events/{eventId}/dropins	List all event dropins
EDropinEvents.EeEventDropinsApi	retrieveDropin	GET /dropins/{dropinId}	Retrieve a dropin
EDropinEvents.EeEventDropinsApi	updateDropin	PUT /dropins/{dropinId}	Update dropin to event
EDropinEvents.EeEventsApi	createEvent	POST /events	Create Event
EDropinEvents.EeEventsApi	deleteEvent	DELETE /events/{eventId}	Delete an existing Event
EDropinEvents.EeEventsApi	getAllEvents	GET /events	Get Events
EDropinEvents.EeEventsApi	getEvent	GET /events/{eventId}	Get a Event from the directory
EDropinEvents.EeEventsApi	getMultipleEvents	GET /events/get-multi	Get Multiple Events
EDropinEvents.EeEventsApi	removeTicket	DELETE /events/{eventId}/tickets/{ticketId}	Remove ticket from event
EDropinEvents.EeEventsApi	searchEvent2	GET /events/search/2	Search Events
EDropinEvents.EeEventsApi	searchEventFacets	GET /events/facets/{facetName}	Search for event facets
EDropinEvents.EeEventsApi	updateEvent	PUT /events/{eventId}	Update an existing Event
EDropinEvents.EeEventsApi	upsertTicket	POST /events/{eventId}/tickets/{ticketId}	Add Ticket to event
EDropinEvents.EeKioskApi	activateKiosk	POST /kiosks	Activate a kiosk
EDropinEvents.EeKioskApi	deactivateKiosk	DELETE /kiosks	Deactivate kiosk
EDropinEvents.EeKioskApi	getKiosk	GET /kiosks/{kioskId}	Get a kiosk
EDropinEvents.EeKioskApi	linkKiosk	PUT /kiosks/{kioskId}	Link a kiosk to my account
EDropinEvents.EeKioskApi	listAllKiosks	GET /kiosks	List all user's kiosks
EDropinEvents.EeKioskApi	unlinkKiosk	DELETE /kiosks/{kioskId}/unlink	Unlink a kiosk
EDropinEvents.EeMessagesApi	createMessage	POST /events/{eventId}/messages	Create message for event attendees
EDropinEvents.EeMessagesApi	listMessages	GET /events/{eventId}/messages	List messages for event attendees
EDropinEvents.EeMessagesApi	removeMessage	DELETE /messages/{messageId}	Delete message for event attendees
EDropinEvents.EeMessagesApi	retrieveMessage	GET /messages/{messageId}	List messages for event attendees
EDropinEvents.EeMessagesApi	updateMessage	PUT /messages/{messageId}	Update message for event attendees
EDropinEvents.EePACEApi	deleteProvider	DELETE /pace-providers/{profileId}	Delete a provider
EDropinEvents.EePACEApi	listProviders	GET /pace-providers	Paginate all PACE providers
EDropinEvents.EePACEApi	retrieveProvider	GET /pace-providers/{profileId}	Retrieve a provider
EDropinEvents.EePACEApi	upsertPaceProvider	POST /pace-providers/{profileId}	Create or update a pace provider
EDropinEvents.EePermissionsApi	acceptPermissionInvite	POST /permissions/accept-invite/{inviteToken}	Accept a permission invite
EDropinEvents.EePermissionsApi	hasPermission	GET /permissions/{entityType}/{entityId}/accounts/{accountId}	Check account has permission
EDropinEvents.EePermissionsApi	paginatePermissions	GET /permissions/{entityType}/{entityId}/accounts	Get permissions for entity
EDropinEvents.EePermissionsApi	removePermissionsForAccount	DELETE /permissions/{entityType}/{entityId}/accounts/{accountId}	Remove all permissions for account
EDropinEvents.EePermissionsApi	sendPermissionInvite	POST /permissions/{entityType}/{entityId}/send-invite	Send a permission invite
EDropinEvents.EePermissionsApi	setPermission	PUT /permissions/{entityType}/{entityId}/accounts/{accountId}	Set account permission
EDropinEvents.EeQrCodeApi	getQRCode	GET /qr-code/{data}	Get a qr code
EDropinEvents.EeSurveysApi	bulkCreateResponses	POST /surveys/{surveyId}/responses	Create responses for a survey with the given id
EDropinEvents.EeSurveysApi	bulkDeleteResponses	DELETE /surveys-responses/bulk	Bulk delete responses
EDropinEvents.EeSurveysApi	bulkRetrieveAggregates	GET /surveys-aggregates/bulk	Retrieve survey aggregate with the given surveyID
EDropinEvents.EeSurveysApi	bulkRetrieveResponses	GET /surveys-responses/bulk	Bulk Retrieve response for survey
EDropinEvents.EeSurveysApi	bulkRetrieveSurveys	GET /surveys/bulk	List all surveys by surveyIDs
EDropinEvents.EeSurveysApi	createResponse	POST /survey-responses/{surveyId}	Create responses for a survey with the given id
EDropinEvents.EeSurveysApi	createSurvey	POST /events/{eventId}/surveys	Create a survey
EDropinEvents.EeSurveysApi	deleteSurvey	DELETE /surveys/{surveyId}	Delete a survey
EDropinEvents.EeSurveysApi	listResponses	GET /organizers/{organizerId}/survey-responses	Retrieves all survey responses for the given organizerID
EDropinEvents.EeSurveysApi	listSurveyResponses	GET /surveys/{surveyId}/responses	List responses for a survey
EDropinEvents.EeSurveysApi	listSurveys	GET /organizers/{organizerId}/surveys	List all surveys for the organizers
EDropinEvents.EeSurveysApi	retrieveAllSurveys	GET /surveys/get-multi	List all surveys by surveyIDs
EDropinEvents.EeSurveysApi	retrieveResponse	GET /surveys-responses/get-multi	Retrieve response for survey
EDropinEvents.EeSurveysApi	retrieveSurvey	GET /surveys/{surveyId}	Retrieve a survey with the given surveyID
EDropinEvents.EeSurveysApi	retrieveSurveyAggregate	GET /surveys-aggregate/get-multi	Retrieve survey aggregate with the given surveyID
EDropinEvents.EeSurveysApi	updateSurvey	PUT /surveys/{surveyId}	Update a survey
EDropinEvents.EeUserEventsApi	listUserEvents	GET /user/events	List all events for which a user has tickets. Each record contains the list of all tickets under the user account for the event
EDropinEvents.EeUserEventsApi	retrieveUserEvent	GET /user/events/{eventId}	Retrieve a record for event with a given id for the user if one exists. This record contains a list of all the tickets bought by the user for this event