guest-sdk

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>guest-sdk</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:guest-sdk:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/guest-sdk-1.0.0.jar
• target/lib/*.jar

Getting Started

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

import GuestSDK.AuditLogsApi;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        AuditLogsApi apiInstance = new AuditLogsApi();
        String auditLogId = null; // String | 
        try {
            AuditLog result = apiInstance.getAuditLog(auditLogId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#getAuditLog");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://us.tractionguest.com/api/v3

Class	Method	HTTP request	Description
AuditLogsApi	getAuditLog	GET /audit_logs/{audit_log_id}	Get an AuditLog
AuditLogsApi	getAuditLogs	GET /audit_logs	List all AuditLogs
BatchesApi	batchDeleteInvites	POST /invites/batch_delete	Delete Multiple Invites
BatchesApi	getBatch	GET /batches/{batch_id}	Get a BatchJob
CapacitiesApi	getCapacity	GET /locations/{location_id}/capacities	Get the current capacity details for a location
CapacitiesApi	getCapacityForecast	GET /locations/{location_id}/capacity_forecasts	Get the capacity details for a location
EmailTemplatesApi	getEmailTemplates	GET /email_templates	List all EmailTemplates
GroupVisitsApi	createGroupVisit	POST /group_visits	Create a new Group Visit (Appointment)
GroupVisitsApi	deleteGroupVisit	DELETE /group_visits/{group_visit_id}	Delete a Group Visit (Appointment)
GroupVisitsApi	getGroupVisit	GET /group_visits/{group_visit_id}	Get a Group Visit (Appointment)
GroupVisitsApi	getGroupVisits	GET /group_visits	List all Group Visits (Appointments)
GroupVisitsApi	updateGroupVisit	PUT /group_visits/{group_visit_id}	Update a Group Visit (Appointment)
HostsApi	createHost	POST /hosts	Create a Host
HostsApi	createHosts	POST /hosts/batch	Create multiple Hosts
HostsApi	getHosts	GET /hosts	List all Hosts
InvitesApi	batchDeleteInvites	POST /invites/batch_delete	Delete Multiple Invites
InvitesApi	createLocationInvite	POST /locations/{location_id}/invites	Create an Invite
InvitesApi	createRegistrationInvite	POST /registrations/{registration_id}/invites	Create an Invite from a Registration
InvitesApi	deleteInvite	DELETE /invites/{invite_id}	Deletes an Invite
InvitesApi	getInvite	GET /invites/{invite_id}	Get an Invite
InvitesApi	getInvites	GET /invites	List all Invites
InvitesApi	updateInvite	PUT /invites/{invite_id}	Update an Invite
LocationsApi	getLocation	GET /locations/{location_id}	Get the details of a location
LocationsApi	getLocations	GET /locations	List all Locations
PackagesApi	createPackage	POST /packages	Create package
PackagesApi	deletePackage	DELETE /packages/{package_id}
PackagesApi	getPackage	GET /packages/{package_id}	Get Package
PackagesApi	getPackages	GET /packages	Get packages
PackagesApi	updatePackage	PUT /packages/{package_id}	Update Package
RegistrationsApi	getRegistration	GET /registrations/{registration_id}	Get a Registration
RegistrationsApi	getRegistrations	GET /registrations	List all Registrations
SigninsApi	createSignin	POST /signins	Create Signin
SigninsApi	getSignin	GET /signins/{signin_id}	Get a Signin
SigninsApi	getSignins	GET /signins	List all Signins
SigninsApi	updateSignin	PUT /signins/{signin_id}	Update a Signin
UsersApi	getCurrentUser	GET /users/{user_id}	Get the current User
WatchlistsApi	createWatchlist	POST /watchlists	Create Watchlist
WatchlistsApi	deleteWatchlist	DELETE /watchlists/{watchlist_id}	Deletes a Watchlist
WatchlistsApi	getWatchlist	GET /watchlists/{watchlist_id}	Get a Watchlist
WatchlistsApi	getWatchlists	GET /watchlists	List all Watchlists
WatchlistsApi	updateWatchlist	PUT /watchlists/{watchlist_id}	Update a Watchlist

Documentation for Models

• AuditLog
• AuditLogChange
• BatchJob
• Capacity
• CapacityByHourResponse
• CapacityForecast
• CustomField
• Docusign
• EmailTemplate
• Error
• ErrorsList
• ExternalWatchlistResult
• GroupVisit
• GroupVisitCreateParams
• GroupVisitUpdateParams
• GuestResponse
• Host
• HostBatchCreateParams
• HostCreateParams
• IdentifierList
• Image
• InternalWatchlistResult
• Invite
• InviteCreateParams
• InviteDetail
• InviteUpdateParams
• InviteWatchlist
• Location
• ModelPackage
• NotificationTrigger
• NotificationTriggerCreateParams
• PackageCreateParams
• PackageUpdateParams
• PaginatedAuditLogsList
• PaginatedEmailTemplatesList
• PaginatedGroupVisitsList
• PaginatedHostsList
• PaginatedInvitesList
• PaginatedLocationsList
• PaginatedPackagesList
• PaginatedRegistrationsList
• PaginatedSigninsList
• PaginatedWatchlistList
• Pagination
• PermissionGroup
• Registration
• RegistrationDetail
• SignableDocument
• Signin
• SigninAcknowledgement
• SigninCreateParams
• SigninData
• SigninDetail
• SigninUpdateParams
• SigninWatchlist
• SimpleSignature
• User
• Visitor
• Watchlist
• WatchlistCreateParams
• WatchlistMatch
• WatchlistSearch

Documentation for Authorization

Authentication schemes defined for the API:

TractionGuestAuth

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@tractionguest.com